API Reference

Schemas

DataFrameSchema

A light-weight pandas DataFrame validator.

SeriesSchema

Series validator.

Schema Components

Column

Validate types and properties of DataFrame columns.

Index

Validate types and properties of a DataFrame Index.

MultiIndex

Validate types and properties of a DataFrame MultiIndex.

Checks

Check

Check a pandas Series or DataFrame for certain properties.

Hypothesis

Special type of Check that defines hypothesis tests on data.

Pandas Data Types

PandasDtype

Enumerate all valid pandas data types.

Decorators

check_input

Validate function argument when function is called.

check_output

Validate function output.

Schema Inference

infer_schema

Infer schema for pandas DataFrame or Series object.

IO Utils

io.from_yaml

Create DataFrameSchema from yaml file.

io.to_yaml

Write DataFrameSchema to yaml file.

io.to_script

Write DataFrameSchema to a python script.

Errors

errors.SchemaError

Raised when object does not pass schema validation constraints.

errors.SchemaErrors

Raised when multiple schema are lazily collected into one error.

errors.SchemaInitError

Raised when schema initialization fails.

errors.SchemaDefinitionError

Raised when schema definition is invalid on object validation.