pandera.schemas.SeriesSchema.__init__

SeriesSchema.__init__(dtype=None, checks=None, index=None, nullable=False, unique=False, allow_duplicates=None, coerce=False, name=None, pandas_dtype=None)[source]

Initialize series schema base object.

Parameters

  • dtype (Union[str, type, DataType, ExtensionDtype, dtype, None]) – datatype of the column. If a string is specified, then assumes one of the valid pandas string values: http://pandas.pydata.org/pandas-docs/stable/basics.html#dtypes

  • checks (Union[Check, Hypothesis, List[Union[Check, Hypothesis]], None]) –

    If element_wise is True, then callable signature should be:

    Callable[Any, bool] where the Any input is a scalar element in the column. Otherwise, the input is assumed to be a pandas.Series object.

  • index – specify the datatypes and properties of the index.

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

  • unique (bool) – Whether or not column can contain duplicate values.

  • allow_duplicates (Optional[bool]) – Whether or not column can contain duplicate values.

Warning

This option will be deprecated in 0.8.0. Use the unique argument instead.

Parameters

  • coerce (bool) – If True, when schema.validate is called the column will be coerced into the specified dtype. This has no effect on columns where pandas_dtype=None.

  • name (Optional[str]) – series name.

  • pandas_dtype (Union[str, type, DataType, ExtensionDtype, dtype, None]) –

    alias of dtype for backwards compatibility.

    Warning

    This option will be deprecated in 0.8.0