Validate pandas.Period with Pandera schema

Question

I have a dataframe with a column "Period" which should have a dtype of pandas.Period.

I would like to validate this, using a Pandera Schema (either DataFrameModel or DataFrameSchema).

My attempts so far return errors.

If I try the code below, then I get an error

Data type '<class 'pandas._libs.tslibs.period.Period'>' not understood by Engine.

Code:


import pandas as pd
import pandera as pa
from pandera.typing import Series


class Schema(pa.DataFrameModel):
   period: Series[pd.Period]


df = pd.DataFrame({"period" : pd.period_range("31/01/2024", "31/12/2024", freq='M')})

Schema.validate(df)

Any advice is much appreciated!

e-motta · Accepted Answer · 2024-03-06 15:44:32Z

1

You need to use PeriodDtype;
PeriodDtype takes a parameter freq, that needs to be specified using typing.Annotated:

from typing import Annotated

class Schema(pa.DataFrameModel):
    period: Series[Annotated[pd.PeriodDtype, "M"]]  # <= change this

df = pd.DataFrame({"period": pd.period_range("31/01/2024", "31/12/2024", freq="M")})

You can read more about it here.

answered Mar 6, 2024 at 15:44

e-motta

7,5953 gold badges10 silver badges32 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Wael Jlassi · Accepted Answer · 2024-03-06 15:39:51Z

0

can you check this solution

import pandas as pd
import pandera as pa
from pandera import Column, Check
def is_period(series): return series.apply(lambda x: isinstance(x, pd.Period)).all()
schema = pa.DataFrameSchema({ "period": Column(object, checks=Check(is_period)), })
df = pd.DataFrame({"period": pd.period_range("31/01/2024", "31/12/2024", freq='M')})
schema.validate(df)

answered Mar 6, 2024 at 15:39

Wael Jlassi

1332 silver badges9 bronze badges

Collectives™ on Stack Overflow

Validate pandas.Period with Pandera schema

2 Answers 2

Comments

Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Related