class pandera.api.pandas.components.Index(dtype=None, checks=None, parsers=None, nullable=False, unique=False, report_duplicates='all', coerce=False, name=None, title=None, description=None, default=None, metadata=None, drop_invalid_rows=False)[source]

Validate types and properties of a pandas DataFrame Index.

Initialize array schema.

  • dtype (Optional[Any, None]) – datatype of the column.

  • checks (Union[Check, 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 the data object (Series, DataFrame).

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

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

  • report_duplicates (Union[Literal[‘exclude_first’], Literal[‘exclude_last’], Literal[‘all’]]) – how to report unique errors - exclude_first: report all duplicates except first occurence - exclude_last: report all duplicates except last occurence - all: (default) report all duplicates

  • 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 dtype=None.

  • name (Any) – column name in dataframe to validate.

  • title (Optional[str, None]) – A human-readable label for the series.

  • description (Optional[str, None]) – An arbitrary textual description of the series.

  • metadata (Optional[dict, None]) – An optional key-value data.

  • default (Optional[Any, None]) – The default value for missing values in the series.

  • drop_invalid_rows (bool) – if True, drop invalid rows on validation.




Get the pandas dtype


Get index names in the Index schema component.


Get the properties of the schema for serialization purposes.



Generate an example of a particular size.


Create a hypothesis strategy for generating an Index.


Generate column data object for use by MultiIndex strategy.


Alias for validate method.