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)

Column or index field specification of a DataFrameModel.

new in 0.5.0

Some arguments apply only to numeric dtypes and some apply only to str. See the User Guide for more information.

The keyword-only arguments for argument names eq to str_startswith are dispatched to the built-in Check methods if the value is a dictionary. If the value is a tuple, it is unpacked as positional arguments.

Parameters:

• eq (UnionType[Any, None]) – Check that the column/index is equal to a value. See equal_to() for more information.

• ne (UnionType[Any, None]) – Check that the column/index is not equal to a value. See not_equal_to() for more information.

• gt (UnionType[Any, None]) – Check that the column/index is greater than a value. See greater_than() for more information.

• ge (UnionType[Any, None]) – Check that the column/index is greater than or equal to a value. See greater_than_or_equal_to() for more information.

• lt (UnionType[Any, None]) – Check that the column/index is less than a value. See less_than() for more information.

• le (UnionType[Any, None]) – Check that the column/index is less than or equal to a value. See less_than_or_equal_to() for more information.

• in_range (UnionType[dict[str, Any], None]) – Check that the column/index is within a range. See in_range() for more information.

• isin (UnionType[Iterable[Any], None]) – Check that the column/index is in a set of values. See isin() for more information.

• notin (UnionType[Iterable[Any], None]) – Check that the column/index is not in a set of values. See notin() for more information.

• str_contains (UnionType[str, None]) – Check that the column/index contains a substring. See str_contains() for more information.

• str_endswith (UnionType[str, None]) – Check that the column/index ends with a substring. See str_endswith() for more information.

• str_length (UnionType[int, tuple[int], tuple[int, int], dict[str, int], None]) – Check that the length of the column/index is within a range. See str_length() for more information.

• str_matches (UnionType[str, None]) – Check that the column/index matches a regex pattern. See str_matches() for more information.

• str_startswith (UnionType[str, None]) – Check that the column/index starts with a substring. See str_startswith() for more information.

• nullable (bool) – Whether or not the column/index can contain null values.

• unique (bool) – Whether column values should be unique.

• coerce (bool) – coerces the data type if True.

• regex (bool) – whether or not the field name or alias is a regex pattern.

• ignore_na (bool) – whether or not to ignore null values in the checks.

• raise_warning (bool) – raise a warning instead of an Exception.

• n_failure_cases (UnionType[int, None]) – report the first n unique failure cases. If None, report all failure cases.

• alias (UnionType[Any, None]) – The public name of the column/index.

• check_name (UnionType[bool, None]) – Whether to check the name of the column/index during validation. None is the default behavior, which translates to True for columns and multi-index, and to False for a single index.

• dtype_kwargs (UnionType[dict[str, Any], None]) – The parameters to be forwarded to the type of the field.

• title (UnionType[str, None]) – A human-readable label for the field.

• description (UnionType[str, None]) – An arbitrary textual description of the field.

• default (UnionType[Any, None]) – Optional default value of the field.

• metadata (UnionType[dict[str, Any], None]) – An optional key-value data.

• kwargs (Any) – Specify custom checks that have been registered with the register_check_method decorator.

Return type:

Any