pandera.SeriesSchema

class pandera.SeriesSchema(pandas_dtype=None, checks=None, index=None, nullable=False, allow_duplicates=True, coerce=False, name=None)[source]

Series validator.

Initialize series schema base object.

Parameters
  • pandas_dtype (Union[str, type, PandasDtype, ExtensionDtype, 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 (callable) –

    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.

  • allow_duplicates (bool) –

Attributes

allow_duplicates

Whether to allow duplicate values.

checks

Return list of checks or hypotheses.

coerce

Whether to coerce series to specified type.

dtype

String representation of the dtype.

name

Get SeriesSchema name.

nullable

Whether the series is nullable.

pandas_dtype

Get the pandas dtype

Methods

__init__

Initialize series schema base object.

validate

Validate a Series object.

__call__

Alias for SeriesSchema.validate() method.