leaf_engine.adapt.schema.schema_utilities

Functions

field(→ pandera.Field)

Returns a Field obj with the parameters.

Module Contents

leaf_engine.adapt.schema.schema_utilities.field(nullable=True, unique=False, **kwargs) → pandera.Field

Returns a Field obj with the parameters.

Parameters:

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

  • unique – Whether column values should be unique.

  • coerce – coerces the data type if True.

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

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

  • raise_warning – raise a warning instead of an Exception.

  • n_failure_cases – report the first n unique failure cases. If None, report all failure cases.

  • alias – The public name of the column/index.

  • check_name – 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 – The parameters to be forwarded to the type of the field.

  • title – A human-readable label for the field.

  • description – An arbitrary textual description of the field.

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

Return type:

pandera.Field