pandera.api.pandas.model_components.Field#
- pandera.api.pandas.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]#
Used to provide extra information about a field 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 from
eq
tostr_startswith
are dispatched to the built-inCheck
methods.- Parameters
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 ifTrue
.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 (
Optional
[int
]) – report the first n unique failure cases. If None, report all failure cases.alias (
Optional
[Any
]) – The public name of the column/index.check_name (
Optional
[bool
]) – 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 (
Optional
[Dict
[str
,Any
]]) – The parameters to be forwarded to the type of the field.title (
Optional
[str
]) – A human-readable label for the field.description (
Optional
[str
]) – An arbitrary textual description of the field.default (
Optional
[Any
]) – Optional default value of the field.kwargs – Specify custom checks that have been registered with the
register_check_method
decorator.
- Return type