How to use SeriesSchema with pydantic?

[cleboo]

Hi!

I am having trouble getting a Series to work with pydantic. The closest I got was something like this:

import pandera as pa
from pydantic import BaseModel
import pandas as pd

class TestModel(BaseModel):
   s: pa.SeriesSchema

s = pd.Series(
   {
       "XXX": "AAA",
       "YYY": "BBB"
   }
)

# check that the series passes validation
validated = pa.SeriesSchema().validate(s)

model = TestModel(s=s)

print(model)

Output:

Traceback (most recent call last):
  File "test.py", line 17, in <module>
    model = TestModel(s=s)
  File "pydantic/main.py", line 406, in pydantic.main.BaseModel.__init__
pydantic.error_wrappers.ValidationError: 1 validation error for TestModel
s
  XXX    AAA
YYY    BBB
dtype: object is not a <class 'pandera.schemas.SeriesSchema'>. (type=type_error)

The Integrations Documentation mentions that SeriesSchema should work with pydantic.

Can anybody point me in the right direction on this?

Thanks in advance!

[cosmicBboy]

hey @cleboo ! So currently pydantic models don't allow for validating pd.Series against pandera.SeriesSchema

Basically the code you have there will only validate whether or not s is a SeriesSchema object or not, see the schemas defined in the unit tests here and its usage here as an example

Once #688 is addressed you'll be able to validate series against Series-specific models

[cleboo]

Thanks @cosmicBboy!