Hide navigation sidebar

Hide table of contents sidebar

📢 Pandera 0.19.0 now supports Polars 🎉. If you like this project, give us a star ⭐️!

Toggle site navigation sidebar

pandera documentation

Toggle table of contents sidebar

pandera documentation

Introduction

Welcome to Pandera
▶️ Try Pandera
Official Website

User Guide

DataFrame Schemas
DataFrame Models
Series Schemas
Data Type Validation
Validating with Checks
Hypothesis Testing
Preprocessing with Parsers
Pandera Data Types
Decorators for Pipeline Integration
Dropping Invalid Rows
Schema Inference
Lazy Validation
Error Reports
Data Synthesis Strategies
Extensions
Data Format Conversion
Supported DataFrame Libraries
Toggle navigation of Supported DataFrame Libraries
- GeoPandas
- Dask
- Fugue
- Modin
- Polars
- Pyspark Pandas
- Pyspark SQL
Integrations
Toggle navigation of Integrations
- FastAPI
- Frictionless
- Hypothesis
- Mypy
- Pydantic
Configuration

Reference

API
Toggle navigation of API
- Core
  Toggle navigation of Core
- Data Types
  Toggle navigation of Data Types
  - pandera.dtypes.DataType
    Toggle navigation of pandera.dtypes.DataType
  - pandera.dtypes.Bool
    Toggle navigation of pandera.dtypes.Bool
  - pandera.dtypes.Timestamp
    Toggle navigation of pandera.dtypes.Timestamp
  - pandera.dtypes.DateTime
  - pandera.dtypes.Timedelta
    Toggle navigation of pandera.dtypes.Timedelta
  - pandera.dtypes.Category
    Toggle navigation of pandera.dtypes.Category
  - pandera.dtypes.Float
    Toggle navigation of pandera.dtypes.Float
  - pandera.dtypes.Float16
    Toggle navigation of pandera.dtypes.Float16
  - pandera.dtypes.Float32
    Toggle navigation of pandera.dtypes.Float32
  - pandera.dtypes.Float64
    Toggle navigation of pandera.dtypes.Float64
  - pandera.dtypes.Float128
    Toggle navigation of pandera.dtypes.Float128
  - pandera.dtypes.Int
    Toggle navigation of pandera.dtypes.Int
  - pandera.dtypes.Int8
    Toggle navigation of pandera.dtypes.Int8
  - pandera.dtypes.Int16
    Toggle navigation of pandera.dtypes.Int16
  - pandera.dtypes.Int32
    Toggle navigation of pandera.dtypes.Int32
  - pandera.dtypes.Int64
    Toggle navigation of pandera.dtypes.Int64
  - pandera.dtypes.UInt
    Toggle navigation of pandera.dtypes.UInt
  - pandera.dtypes.UInt8
    Toggle navigation of pandera.dtypes.UInt8
  - pandera.dtypes.UInt16
    Toggle navigation of pandera.dtypes.UInt16
  - pandera.dtypes.UInt32
    Toggle navigation of pandera.dtypes.UInt32
  - pandera.dtypes.UInt64
    Toggle navigation of pandera.dtypes.UInt64
  - pandera.dtypes.Complex
    Toggle navigation of pandera.dtypes.Complex
  - pandera.dtypes.Complex64
    Toggle navigation of pandera.dtypes.Complex64
  - pandera.dtypes.Complex128
    Toggle navigation of pandera.dtypes.Complex128
  - pandera.dtypes.Complex256
    Toggle navigation of pandera.dtypes.Complex256
  - pandera.dtypes.Decimal
    Toggle navigation of pandera.dtypes.Decimal
  - pandera.dtypes.String
    Toggle navigation of pandera.dtypes.String
  - pandera.engines.pandas_engine.BOOL
    Toggle navigation of pandera.engines.pandas_engine.BOOL
  - pandera.engines.pandas_engine.INT8
    Toggle navigation of pandera.engines.pandas_engine.INT8
  - pandera.engines.pandas_engine.INT16
    Toggle navigation of pandera.engines.pandas_engine.INT16
  - pandera.engines.pandas_engine.INT32
    Toggle navigation of pandera.engines.pandas_engine.INT32
  - pandera.engines.pandas_engine.INT64
    Toggle navigation of pandera.engines.pandas_engine.INT64
  - pandera.engines.pandas_engine.UINT8
    Toggle navigation of pandera.engines.pandas_engine.UINT8
  - pandera.engines.pandas_engine.UINT16
    Toggle navigation of pandera.engines.pandas_engine.UINT16
  - pandera.engines.pandas_engine.UINT32
    Toggle navigation of pandera.engines.pandas_engine.UINT32
  - pandera.engines.pandas_engine.UINT64
    Toggle navigation of pandera.engines.pandas_engine.UINT64
  - pandera.engines.pandas_engine.STRING
    Toggle navigation of pandera.engines.pandas_engine.STRING
  - pandera.engines.numpy_engine.Object
    Toggle navigation of pandera.engines.numpy_engine.Object
  - pandera.engines.pandas_engine.DateTime
  - pandera.engines.pandas_engine.Date
    Toggle navigation of pandera.engines.pandas_engine.Date
  - pandera.engines.pandas_engine.Decimal
    Toggle navigation of pandera.engines.pandas_engine.Decimal
  - pandera.engines.pandas_engine.Category
    Toggle navigation of pandera.engines.pandas_engine.Category
  - pandera.engines.pandas_engine.Geometry
    Toggle navigation of pandera.engines.pandas_engine.Geometry
  - pandera.engines.pandas_engine.PydanticModel
    Toggle navigation of pandera.engines.pandas_engine.PydanticModel
  - pandera.engines.polars_engine.Int8
    Toggle navigation of pandera.engines.polars_engine.Int8
  - pandera.engines.polars_engine.Int16
    Toggle navigation of pandera.engines.polars_engine.Int16
  - pandera.engines.polars_engine.Int32
    Toggle navigation of pandera.engines.polars_engine.Int32
  - pandera.engines.polars_engine.Int64
    Toggle navigation of pandera.engines.polars_engine.Int64
  - pandera.engines.polars_engine.UInt8
    Toggle navigation of pandera.engines.polars_engine.UInt8
  - pandera.engines.polars_engine.UInt16
    Toggle navigation of pandera.engines.polars_engine.UInt16
  - pandera.engines.polars_engine.UInt32
    Toggle navigation of pandera.engines.polars_engine.UInt32
  - pandera.engines.polars_engine.UInt64
    Toggle navigation of pandera.engines.polars_engine.UInt64
  - pandera.engines.polars_engine.Float32
    Toggle navigation of pandera.engines.polars_engine.Float32
  - pandera.engines.polars_engine.Float64
    Toggle navigation of pandera.engines.polars_engine.Float64
  - pandera.engines.polars_engine.Decimal
    Toggle navigation of pandera.engines.polars_engine.Decimal
  - pandera.engines.polars_engine.Date
    Toggle navigation of pandera.engines.polars_engine.Date
  - pandera.engines.polars_engine.DateTime
  - pandera.engines.polars_engine.Time
    Toggle navigation of pandera.engines.polars_engine.Time
  - pandera.engines.polars_engine.Timedelta
    Toggle navigation of pandera.engines.polars_engine.Timedelta
  - pandera.engines.polars_engine.Array
    Toggle navigation of pandera.engines.polars_engine.Array
  - pandera.engines.polars_engine.List
    Toggle navigation of pandera.engines.polars_engine.List
  - pandera.engines.polars_engine.Struct
    Toggle navigation of pandera.engines.polars_engine.Struct
  - pandera.engines.polars_engine.Bool
    Toggle navigation of pandera.engines.polars_engine.Bool
  - pandera.engines.polars_engine.String
    Toggle navigation of pandera.engines.polars_engine.String
  - pandera.engines.polars_engine.Categorical
    Toggle navigation of pandera.engines.polars_engine.Categorical
  - pandera.engines.polars_engine.Category
    Toggle navigation of pandera.engines.polars_engine.Category
  - pandera.engines.polars_engine.Null
    Toggle navigation of pandera.engines.polars_engine.Null
  - pandera.engines.polars_engine.Object
    Toggle navigation of pandera.engines.polars_engine.Object
  - pandera.dtypes.is_subdtype
  - pandera.dtypes.is_float
  - pandera.dtypes.is_int
  - pandera.dtypes.is_uint
  - pandera.dtypes.is_complex
  - pandera.dtypes.is_numeric
  - pandera.dtypes.is_bool
  - pandera.dtypes.is_string
  - pandera.dtypes.is_datetime
  - pandera.dtypes.is_timedelta
  - pandera.dtypes.immutable
  - pandera.engines.engine.Engine
    Toggle navigation of pandera.engines.engine.Engine
  - pandera.engines.numpy_engine.Engine
    Toggle navigation of pandera.engines.numpy_engine.Engine
    - pandera.engines.numpy_engine.Engine.dtype
  - pandera.engines.pandas_engine.Engine
    Toggle navigation of pandera.engines.pandas_engine.Engine
    - pandera.engines.pandas_engine.Engine.dtype
    - pandera.engines.pandas_engine.Engine.numpy_dtype
- DataFrame Models
  Toggle navigation of DataFrame Models
  - pandera.api.pandas.model.DataFrameModel
    Toggle navigation of pandera.api.pandas.model.DataFrameModel
    - pandera.api.pandas.model.DataFrameModel.build_schema_
    - pandera.api.pandas.model.DataFrameModel.to_json_schema
  - pandera.api.polars.model.DataFrameModel
    Toggle navigation of pandera.api.polars.model.DataFrameModel
    - pandera.api.polars.model.DataFrameModel.build_schema_
    - pandera.api.polars.model.DataFrameModel.to_json_schema
  - pandera.api.pyspark.model.DataFrameModel
    Toggle navigation of pandera.api.pyspark.model.DataFrameModel
  - pandera.api.dataframe.model_components.Field
  - pandera.api.dataframe.model_components.check
  - pandera.api.dataframe.model_components.dataframe_check
  - pandera.api.dataframe.model_components.parser
  - pandera.api.dataframe.model_components.dataframe_parser
  - pandera.typing
    Toggle navigation of pandera.typing
    - pandera.typing.fastapi.UploadFile
      Toggle navigation of pandera.typing.fastapi.UploadFile
      - pandera.typing.fastapi.UploadFile.__init__
      - pandera.typing.fastapi.UploadFile.pydantic_validate_v2
    - pandera.typing.formats.Formats
  - pandera.api.pandas.model_config.BaseConfig
  - pandera.api.polars.model_config.BaseConfig
  - pandera.api.pyspark.model_config.BaseConfig
- Decorators
  Toggle navigation of Decorators
- Schema Inference
  Toggle navigation of Schema Inference
  - pandera.schema_inference.pandas.infer_schema
- IO Utilities
  Toggle navigation of IO Utilities
- Data Synthesis Strategies
  Toggle navigation of Data Synthesis Strategies
  - pandera.strategies
- Extensions
  Toggle navigation of Extensions
  - pandera.extensions
- Errors
  Toggle navigation of Errors

Community

Contributing

v: latest

Versions: latest; stable; v0.18.3; v0.18.2; v0.18.1; v0.18.0; v0.17.2; v0.17.1; v0.17.0; v0.16.1; v0.16.0; v0.15.2; v0.14.5; v0.13.4

Downloads

On Read the Docs: Project Home; Builds

Toggle table of contents sidebar

pandera.api.pyspark.model.DataFrameModel.to_yaml¶

classmethod DataFrameModel.to_yaml(stream=None)[source]¶: Convert Schema to yaml using io.to_yaml.

pandera.api.pyspark.model.DataFrameModel.validate

pandera.api.pyspark.model.DataFrameModel.to_structtype

Copyright © 2019, Pandera developers

Made with Sphinx and @pradyunsg's Furo

On this page

pandera.api.pyspark.model.DataFrameModel.to_yaml
- DataFrameModel.to_yaml()