pandera.api.polars.model.DataFrameModel

class pandera.api.polars.model.DataFrameModel(*args, **kwargs)

极坐标模型 DataFrameSchema。

请参阅 用户指南 以获取更多信息。

根据模式规范验证数据框。

Parameters:

• check_obj (pd.DataFrame) – 要验证的数据框。

• head – 验证前n行。与 tail 或 sample 重叠的行会被去重。

• tail – 验证最后 n 行。与 head 或 sample 重叠的行会被去重。

• sample – 验证 n 行的随机样本。与 head 或 tail 重叠的行将被去重。

• random_state – sample 参数的随机种子。

• lazy – 如果为 True，则懒惰地对数据框进行所有验证检查，并引发一个 SchemaErrors。否则，一旦发生错误，立即引发 SchemaError。

• inplace – 如果为True，应用强制转换到验证对象， 否则创建数据的副本。

Returns:

验证过的 DataFrame

Raises:

SchemaError – 当 DataFrame 违反内置或自定义检查时。

方法

classmethod build_schema_(**kwargs)

classmethod to_json_schema()

将模式元数据序列化为 json-schema 格式。

Parameters:

dataframe_schema – 以json-schema格式写入的模式。

注意

此函数目前并未完全指定 pandera 模式，主要用于通过 FastAPI 集成内部渲染 OpenAPI 文档。