Contents Menu Expand Light mode Dark mode Auto light/dark mode
pandera
Logo
pandera

Introduction

  • A Statistical Data Testing Toolkit

User Guide

  • DataFrame Schemas
  • Schema Models
  • Series Schemas
  • Checks
  • Hypothesis Testing
  • Pandera Data Types
  • Decorators for Pipeline Integration
  • Schema Inference
  • Lazy Validation
  • Data Synthesis Strategies
  • Extensions
  • Data Format Conversion
  • Supported DataFrame Libraries
    • GeoPandas
    • Dask
    • Fugue
    • Koalas
    • Pyspark ⭐️ (New)
    • Modin
  • Integrations
    • FastAPI
    • Frictionless
    • Hypothesis
    • Mypy
    • Pydantic

Reference

  • API
    • Core
      • pandera.schemas.DataFrameSchema
        • pandera.schemas.DataFrameSchema.__init__
        • pandera.schemas.DataFrameSchema.add_columns
        • pandera.schemas.DataFrameSchema.coerce_dtype
        • pandera.schemas.DataFrameSchema.example
        • pandera.schemas.DataFrameSchema.from_yaml
        • pandera.schemas.DataFrameSchema.get_dtypes
        • pandera.schemas.DataFrameSchema.remove_columns
        • pandera.schemas.DataFrameSchema.rename_columns
        • pandera.schemas.DataFrameSchema.reset_index
        • pandera.schemas.DataFrameSchema.select_columns
        • pandera.schemas.DataFrameSchema.set_index
        • pandera.schemas.DataFrameSchema.strategy
        • pandera.schemas.DataFrameSchema.to_script
        • pandera.schemas.DataFrameSchema.to_yaml
        • pandera.schemas.DataFrameSchema.update_column
        • pandera.schemas.DataFrameSchema.update_columns
        • pandera.schemas.DataFrameSchema.validate
        • pandera.schemas.DataFrameSchema.__call__
      • pandera.schemas.SeriesSchema
        • pandera.schemas.SeriesSchema.__init__
        • pandera.schemas.SeriesSchema.validate
        • pandera.schemas.SeriesSchema.__call__
      • pandera.schema_components.Column
        • pandera.schema_components.Column.__init__
        • pandera.schema_components.Column.coerce_dtype
        • pandera.schema_components.Column.example
        • pandera.schema_components.Column.get_regex_columns
        • pandera.schema_components.Column.set_name
        • pandera.schema_components.Column.strategy
        • pandera.schema_components.Column.strategy_component
        • pandera.schema_components.Column.validate
        • pandera.schema_components.Column.__call__
      • pandera.schema_components.Index
        • pandera.schema_components.Index.example
        • pandera.schema_components.Index.strategy
        • pandera.schema_components.Index.strategy_component
        • pandera.schema_components.Index.validate
        • pandera.schema_components.Index.__call__
      • pandera.schema_components.MultiIndex
        • pandera.schema_components.MultiIndex.__init__
        • pandera.schema_components.MultiIndex.coerce_dtype
        • pandera.schema_components.MultiIndex.example
        • pandera.schema_components.MultiIndex.strategy
        • pandera.schema_components.MultiIndex.validate
        • pandera.schema_components.MultiIndex.__call__
      • pandera.checks.Check
        • pandera.checks.Check.eq
        • pandera.checks.Check.equal_to
        • pandera.checks.Check.ge
        • pandera.checks.Check.greater_than
        • pandera.checks.Check.greater_than_or_equal_to
        • pandera.checks.Check.gt
        • pandera.checks.Check.in_range
        • pandera.checks.Check.isin
        • pandera.checks.Check.le
        • pandera.checks.Check.less_than
        • pandera.checks.Check.less_than_or_equal_to
        • pandera.checks.Check.lt
        • pandera.checks.Check.ne
        • pandera.checks.Check.not_equal_to
        • pandera.checks.Check.notin
        • pandera.checks.Check.str_contains
        • pandera.checks.Check.str_endswith
        • pandera.checks.Check.str_length
        • pandera.checks.Check.str_matches
        • pandera.checks.Check.str_startswith
        • pandera.checks.Check.__call__
      • pandera.hypotheses.Hypothesis
        • pandera.hypotheses.Hypothesis.__init__
        • pandera.hypotheses.Hypothesis.one_sample_ttest
        • pandera.hypotheses.Hypothesis.two_sample_ttest
        • pandera.hypotheses.Hypothesis.__call__
    • Data Types
      • pandera.dtypes.DataType
        • pandera.dtypes.DataType.__init__
        • pandera.dtypes.DataType.check
        • pandera.dtypes.DataType.coerce
        • pandera.dtypes.DataType.coerce_value
        • pandera.dtypes.DataType.try_coerce
        • pandera.dtypes.DataType.__call__
      • pandera.dtypes.Bool
        • pandera.dtypes.Bool.__init__
        • pandera.dtypes.Bool.check
        • pandera.dtypes.Bool.coerce
        • pandera.dtypes.Bool.coerce_value
        • pandera.dtypes.Bool.try_coerce
        • pandera.dtypes.Bool.__call__
      • pandera.dtypes.Timestamp
        • pandera.dtypes.Timestamp.__init__
        • pandera.dtypes.Timestamp.check
        • pandera.dtypes.Timestamp.coerce
        • pandera.dtypes.Timestamp.coerce_value
        • pandera.dtypes.Timestamp.try_coerce
        • pandera.dtypes.Timestamp.__call__
      • pandera.dtypes.DateTime
      • pandera.dtypes.Timedelta
        • pandera.dtypes.Timedelta.__init__
        • pandera.dtypes.Timedelta.check
        • pandera.dtypes.Timedelta.coerce
        • pandera.dtypes.Timedelta.coerce_value
        • pandera.dtypes.Timedelta.try_coerce
        • pandera.dtypes.Timedelta.__call__
      • pandera.dtypes.Category
        • pandera.dtypes.Category.__init__
        • pandera.dtypes.Category.check
        • pandera.dtypes.Category.coerce
        • pandera.dtypes.Category.coerce_value
        • pandera.dtypes.Category.try_coerce
        • pandera.dtypes.Category.__call__
      • pandera.dtypes.Float
        • pandera.dtypes.Float.__init__
        • pandera.dtypes.Float.check
        • pandera.dtypes.Float.coerce
        • pandera.dtypes.Float.coerce_value
        • pandera.dtypes.Float.try_coerce
        • pandera.dtypes.Float.__call__
      • pandera.dtypes.Float16
        • pandera.dtypes.Float16.__init__
        • pandera.dtypes.Float16.check
        • pandera.dtypes.Float16.coerce
        • pandera.dtypes.Float16.coerce_value
        • pandera.dtypes.Float16.try_coerce
        • pandera.dtypes.Float16.__call__
      • pandera.dtypes.Float32
        • pandera.dtypes.Float32.__init__
        • pandera.dtypes.Float32.check
        • pandera.dtypes.Float32.coerce
        • pandera.dtypes.Float32.coerce_value
        • pandera.dtypes.Float32.try_coerce
        • pandera.dtypes.Float32.__call__
      • pandera.dtypes.Float64
        • pandera.dtypes.Float64.__init__
        • pandera.dtypes.Float64.check
        • pandera.dtypes.Float64.coerce
        • pandera.dtypes.Float64.coerce_value
        • pandera.dtypes.Float64.try_coerce
        • pandera.dtypes.Float64.__call__
      • pandera.dtypes.Float128
        • pandera.dtypes.Float128.__init__
        • pandera.dtypes.Float128.check
        • pandera.dtypes.Float128.coerce
        • pandera.dtypes.Float128.coerce_value
        • pandera.dtypes.Float128.try_coerce
        • pandera.dtypes.Float128.__call__
      • pandera.dtypes.Int
        • pandera.dtypes.Int.__init__
        • pandera.dtypes.Int.check
        • pandera.dtypes.Int.coerce
        • pandera.dtypes.Int.coerce_value
        • pandera.dtypes.Int.try_coerce
        • pandera.dtypes.Int.__call__
      • pandera.dtypes.Int8
        • pandera.dtypes.Int8.__init__
        • pandera.dtypes.Int8.check
        • pandera.dtypes.Int8.coerce
        • pandera.dtypes.Int8.coerce_value
        • pandera.dtypes.Int8.try_coerce
        • pandera.dtypes.Int8.__call__
      • pandera.dtypes.Int16
        • pandera.dtypes.Int16.__init__
        • pandera.dtypes.Int16.check
        • pandera.dtypes.Int16.coerce
        • pandera.dtypes.Int16.coerce_value
        • pandera.dtypes.Int16.try_coerce
        • pandera.dtypes.Int16.__call__
      • pandera.dtypes.Int32
        • pandera.dtypes.Int32.__init__
        • pandera.dtypes.Int32.check
        • pandera.dtypes.Int32.coerce
        • pandera.dtypes.Int32.coerce_value
        • pandera.dtypes.Int32.try_coerce
        • pandera.dtypes.Int32.__call__
      • pandera.dtypes.Int64
        • pandera.dtypes.Int64.__init__
        • pandera.dtypes.Int64.check
        • pandera.dtypes.Int64.coerce
        • pandera.dtypes.Int64.coerce_value
        • pandera.dtypes.Int64.try_coerce
        • pandera.dtypes.Int64.__call__
      • pandera.dtypes.UInt
        • pandera.dtypes.UInt.__init__
        • pandera.dtypes.UInt.check
        • pandera.dtypes.UInt.coerce
        • pandera.dtypes.UInt.coerce_value
        • pandera.dtypes.UInt.try_coerce
        • pandera.dtypes.UInt.__call__
      • pandera.dtypes.UInt8
        • pandera.dtypes.UInt8.__init__
        • pandera.dtypes.UInt8.check
        • pandera.dtypes.UInt8.coerce
        • pandera.dtypes.UInt8.coerce_value
        • pandera.dtypes.UInt8.try_coerce
        • pandera.dtypes.UInt8.__call__
      • pandera.dtypes.UInt16
        • pandera.dtypes.UInt16.__init__
        • pandera.dtypes.UInt16.check
        • pandera.dtypes.UInt16.coerce
        • pandera.dtypes.UInt16.coerce_value
        • pandera.dtypes.UInt16.try_coerce
        • pandera.dtypes.UInt16.__call__
      • pandera.dtypes.UInt32
        • pandera.dtypes.UInt32.__init__
        • pandera.dtypes.UInt32.check
        • pandera.dtypes.UInt32.coerce
        • pandera.dtypes.UInt32.coerce_value
        • pandera.dtypes.UInt32.try_coerce
        • pandera.dtypes.UInt32.__call__
      • pandera.dtypes.UInt64
        • pandera.dtypes.UInt64.__init__
        • pandera.dtypes.UInt64.check
        • pandera.dtypes.UInt64.coerce
        • pandera.dtypes.UInt64.coerce_value
        • pandera.dtypes.UInt64.try_coerce
        • pandera.dtypes.UInt64.__call__
      • pandera.dtypes.Complex
        • pandera.dtypes.Complex.__init__
        • pandera.dtypes.Complex.check
        • pandera.dtypes.Complex.coerce
        • pandera.dtypes.Complex.coerce_value
        • pandera.dtypes.Complex.try_coerce
        • pandera.dtypes.Complex.__call__
      • pandera.dtypes.Complex64
        • pandera.dtypes.Complex64.__init__
        • pandera.dtypes.Complex64.check
        • pandera.dtypes.Complex64.coerce
        • pandera.dtypes.Complex64.coerce_value
        • pandera.dtypes.Complex64.try_coerce
        • pandera.dtypes.Complex64.__call__
      • pandera.dtypes.Complex128
        • pandera.dtypes.Complex128.__init__
        • pandera.dtypes.Complex128.check
        • pandera.dtypes.Complex128.coerce
        • pandera.dtypes.Complex128.coerce_value
        • pandera.dtypes.Complex128.try_coerce
        • pandera.dtypes.Complex128.__call__
      • pandera.dtypes.Complex256
        • pandera.dtypes.Complex256.__init__
        • pandera.dtypes.Complex256.check
        • pandera.dtypes.Complex256.coerce
        • pandera.dtypes.Complex256.coerce_value
        • pandera.dtypes.Complex256.try_coerce
        • pandera.dtypes.Complex256.__call__
      • pandera.dtypes.String
        • pandera.dtypes.String.__init__
        • pandera.dtypes.String.check
        • pandera.dtypes.String.coerce
        • pandera.dtypes.String.coerce_value
        • pandera.dtypes.String.try_coerce
        • pandera.dtypes.String.__call__
      • pandera.engines.pandas_engine.BOOL
        • pandera.engines.pandas_engine.BOOL.__init__
        • pandera.engines.pandas_engine.BOOL.check
        • pandera.engines.pandas_engine.BOOL.coerce
        • pandera.engines.pandas_engine.BOOL.coerce_value
        • pandera.engines.pandas_engine.BOOL.try_coerce
        • pandera.engines.pandas_engine.BOOL.__call__
      • pandera.engines.pandas_engine.INT8
        • pandera.engines.pandas_engine.INT8.__init__
        • pandera.engines.pandas_engine.INT8.check
        • pandera.engines.pandas_engine.INT8.coerce
        • pandera.engines.pandas_engine.INT8.coerce_value
        • pandera.engines.pandas_engine.INT8.try_coerce
        • pandera.engines.pandas_engine.INT8.__call__
      • pandera.engines.pandas_engine.INT16
        • pandera.engines.pandas_engine.INT16.__init__
        • pandera.engines.pandas_engine.INT16.check
        • pandera.engines.pandas_engine.INT16.coerce
        • pandera.engines.pandas_engine.INT16.coerce_value
        • pandera.engines.pandas_engine.INT16.try_coerce
        • pandera.engines.pandas_engine.INT16.__call__
      • pandera.engines.pandas_engine.INT32
        • pandera.engines.pandas_engine.INT32.__init__
        • pandera.engines.pandas_engine.INT32.check
        • pandera.engines.pandas_engine.INT32.coerce
        • pandera.engines.pandas_engine.INT32.coerce_value
        • pandera.engines.pandas_engine.INT32.try_coerce
        • pandera.engines.pandas_engine.INT32.__call__
      • pandera.engines.pandas_engine.INT64
        • pandera.engines.pandas_engine.INT64.__init__
        • pandera.engines.pandas_engine.INT64.check
        • pandera.engines.pandas_engine.INT64.coerce
        • pandera.engines.pandas_engine.INT64.coerce_value
        • pandera.engines.pandas_engine.INT64.try_coerce
        • pandera.engines.pandas_engine.INT64.__call__
      • pandera.engines.pandas_engine.UINT8
        • pandera.engines.pandas_engine.UINT8.__init__
        • pandera.engines.pandas_engine.UINT8.check
        • pandera.engines.pandas_engine.UINT8.coerce
        • pandera.engines.pandas_engine.UINT8.coerce_value
        • pandera.engines.pandas_engine.UINT8.try_coerce
        • pandera.engines.pandas_engine.UINT8.__call__
      • pandera.engines.pandas_engine.UINT16
        • pandera.engines.pandas_engine.UINT16.__init__
        • pandera.engines.pandas_engine.UINT16.check
        • pandera.engines.pandas_engine.UINT16.coerce
        • pandera.engines.pandas_engine.UINT16.coerce_value
        • pandera.engines.pandas_engine.UINT16.try_coerce
        • pandera.engines.pandas_engine.UINT16.__call__
      • pandera.engines.pandas_engine.UINT32
        • pandera.engines.pandas_engine.UINT32.__init__
        • pandera.engines.pandas_engine.UINT32.check
        • pandera.engines.pandas_engine.UINT32.coerce
        • pandera.engines.pandas_engine.UINT32.coerce_value
        • pandera.engines.pandas_engine.UINT32.try_coerce
        • pandera.engines.pandas_engine.UINT32.__call__
      • pandera.engines.pandas_engine.UINT64
        • pandera.engines.pandas_engine.UINT64.__init__
        • pandera.engines.pandas_engine.UINT64.check
        • pandera.engines.pandas_engine.UINT64.coerce
        • pandera.engines.pandas_engine.UINT64.coerce_value
        • pandera.engines.pandas_engine.UINT64.try_coerce
        • pandera.engines.pandas_engine.UINT64.__call__
      • pandera.engines.pandas_engine.STRING
        • pandera.engines.pandas_engine.STRING.__init__
        • pandera.engines.pandas_engine.STRING.check
        • pandera.engines.pandas_engine.STRING.coerce
        • pandera.engines.pandas_engine.STRING.coerce_value
        • pandera.engines.pandas_engine.STRING.from_parametrized_dtype
        • pandera.engines.pandas_engine.STRING.try_coerce
        • pandera.engines.pandas_engine.STRING.__call__
      • pandera.engines.numpy_engine.Object
        • pandera.engines.numpy_engine.Object.__init__
        • pandera.engines.numpy_engine.Object.check
        • pandera.engines.numpy_engine.Object.coerce
        • pandera.engines.numpy_engine.Object.coerce_value
        • pandera.engines.numpy_engine.Object.try_coerce
        • pandera.engines.numpy_engine.Object.__call__
      • pandera.engines.pandas_engine.DateTime
      • pandera.engines.pandas_engine.Geometry
        • pandera.engines.pandas_engine.Geometry.__init__
        • pandera.engines.pandas_engine.Geometry.check
        • pandera.engines.pandas_engine.Geometry.coerce
        • pandera.engines.pandas_engine.Geometry.coerce_value
        • pandera.engines.pandas_engine.Geometry.try_coerce
        • pandera.engines.pandas_engine.Geometry.__call__
      • pandera.engines.pandas_engine.PydanticModel
        • pandera.engines.pandas_engine.PydanticModel.__init__
        • pandera.engines.pandas_engine.PydanticModel.check
        • pandera.engines.pandas_engine.PydanticModel.coerce
        • pandera.engines.pandas_engine.PydanticModel.coerce_value
        • pandera.engines.pandas_engine.PydanticModel.try_coerce
        • pandera.engines.pandas_engine.PydanticModel.__call__
      • 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
        • pandera.engines.engine.Engine.dtype
        • pandera.engines.engine.Engine.get_registered_dtypes
        • pandera.engines.engine.Engine.register_dtype
        • pandera.engines.engine.Engine.__call__
      • pandera.engines.numpy_engine.Engine
        • pandera.engines.numpy_engine.Engine.dtype
      • pandera.engines.pandas_engine.Engine
        • pandera.engines.pandas_engine.Engine.dtype
        • pandera.engines.pandas_engine.Engine.numpy_dtype
    • Schema Models
      • pandera.model.SchemaModel
        • pandera.model.SchemaModel.example
        • pandera.model.SchemaModel.strategy
        • pandera.model.SchemaModel.to_schema
        • pandera.model.SchemaModel.to_yaml
        • pandera.model.SchemaModel.validate
      • pandera.model_components.Field
      • pandera.model_components.check
      • pandera.model_components.dataframe_check
      • pandera.typing
        • pandera.typing.fastapi.UploadFile
        • pandera.typing.formats.Formats
      • pandera.model.BaseConfig
    • Decorators
      • pandera.decorators.check_input
      • pandera.decorators.check_output
      • pandera.decorators.check_io
      • pandera.decorators.check_types
    • Schema Inference
      • pandera.schema_inference.infer_schema
    • IO Utilities
      • pandera.io.from_yaml
      • pandera.io.to_yaml
      • pandera.io.to_script
    • Data Synthesis Strategies
      • pandera.strategies
    • Extensions
      • pandera.extensions
    • Errors
      • pandera.errors.SchemaError
      • pandera.errors.SchemaErrors
      • pandera.errors.SchemaInitError
      • pandera.errors.SchemaDefinitionError

Community

  • Contributing

pandera.engines.pandas_engine.STRING.coerce¶

STRING.coerce(data_container)[source]¶

Pure coerce without catching exceptions.

Return type

Union[Series, Index, DataFrame]

Next
pandera.engines.pandas_engine.STRING.coerce_value
Previous
pandera.engines.pandas_engine.STRING.check
Copyright © 2019, Niels Bantilan, Nigel Markey, Jean-Francois Zinque | Built with Sphinx and @pradyunsg's Furo theme. | Show Source