pandera.api.dataframe.model_components.Field¶

pandera.api.dataframe.model_components.Field(*, eq=None, ne=None, gt=None, ge=None, lt=None, le=None, in_range=None, isin=None, notin=None, str_contains=None, str_endswith=None, str_length=None, str_matches=None, str_startswith=None, nullable=False, unique=False, coerce=False, regex=False, ignore_na=True, raise_warning=False, n_failure_cases=None, alias=None, check_name=None, dtype_kwargs=None, title=None, description=None, default=None, metadata=None, **kwargs)[source]¶

DataFrameModel的列或索引字段规范。

0.5.0 中的新功能

某些参数仅适用于数值数据类型，而某些参数仅适用于 str。有关更多信息，请参见用户指南。

从 eq 到 str_startswith 的关键字参数被分配给内置的 Check 方法。

Parameters:

nullable (bool) – 列/索引是否可以包含空值。
unique (bool) – 列值是否应为唯一。
强制转换 (bool) – 如果 True，则强制转换数据类型。
正则表达式 (布尔值) – 字段名称或别名是否为正则表达式模式。
ignore_na (bool) – 在检查中是否忽略空值。
raise_warning (bool) – 提出警告而不是异常。
n_failure_cases (可选[int, None]) – 报告前 n 个唯一失败案例。如果是 None，报告所有失败案例。
别名 (可选[任何, 无]) – 列/索引的公共名称。
check_name (Optional[bool, None]) – 在验证过程中是否检查列/索引的名称。 None 是默认行为，对于列和多重索引翻译为 True，对于单个索引翻译为 False。
dtype_kwargs (可选[字典[字符串, 任意], 无]) – 将转发到字段类型的参数。
标题 (可选[str, None]) – 字段的可读标签。
描述 (可选[str, None]) – 字段的任意文本描述。
默认值 (可选[任意, 无]) – 字段的可选默认值。
元数据 (可选[字典, 无]) – 一个可选的键值数据。
kwargs – 指定已通过register_check_method装饰器注册的自定义检查。

Return type:

Any