leaf_engine.adapt.schema.schema_utilities
=========================================

.. py:module:: leaf_engine.adapt.schema.schema_utilities


Functions
---------

.. autoapisummary::

   leaf_engine.adapt.schema.schema_utilities.field


Module Contents
---------------

.. py:function:: field(nullable=True, unique=False, **kwargs) -> pandera.Field

   Returns a Field obj with the parameters.

   :param nullable: Whether or not the column/index can contain null values.
   :param unique: Whether column values should be unique.
   :param coerce: coerces the data type if ``True``.
   :param regex: whether or not the field name or alias is a regex pattern.
   :param ignore_na: whether or not to ignore null values in the checks.
   :param raise_warning: raise a warning instead of an Exception.
   :param n_failure_cases: report the first n unique failure cases. If None,
       report all failure cases.
   :param alias: The public name of the column/index.
   :param 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.
   :param dtype_kwargs: The parameters to be forwarded to the type of the
       field.
   :param title: A human-readable label for the field.
   :param description: An arbitrary textual description of the field.
   :param kwargs: Specify custom checks that have been registered with the
       :class:`~pandera.extensions.register_check_method` decorator.