Skip to content

Commit

Permalink
BUG: Rename pandera.SchemaModel -> DataFrameModel, fix #265
Browse files Browse the repository at this point in the history
  • Loading branch information
NickleDave committed Jul 1, 2024
1 parent 6ccbbf0 commit 9531704
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 12 deletions.
8 changes: 6 additions & 2 deletions src/crowsetta/formats/bbox/audbbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,12 @@ def df_to_lines(df: pd.DataFrame) -> list[str]:
return lines


class AudBBoxSchema(pandera.SchemaModel):
"""A :class:`pandera.SchemaModel` that
class AudBBoxSchema(pandera.DataFrameModel

):
"""A :class:`pandera.DataFrameModel
` that
validates :mod:`pandas` dataframes
loaded from Audacity label tracks
in extended format, exported to txt files
Expand Down
8 changes: 6 additions & 2 deletions src/crowsetta/formats/bbox/raven.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@
from crowsetta.typing import PathLike


class RavenSchema(pandera.SchemaModel):
"""A :class:`pandera.SchemaModel` that validates :type:`pandas.DataFrame`s
class RavenSchema(pandera.DataFrameModel

):
"""A :class:`pandera.DataFrameModel
` that validates :type:`pandas.DataFrame`s
loaded from a txt file, created by exporting a Selection Table
from Raven.
"""
Expand Down
8 changes: 6 additions & 2 deletions src/crowsetta/formats/seq/audseq.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,12 @@
from crowsetta.typing import PathLike


class AudSeqSchema(pandera.SchemaModel):
"""A :class:`pandera.SchemaModel`
class AudSeqSchema(pandera.DataFrameModel

):
"""A :class:`pandera.DataFrameModel
`
that validates :type:`pandas.DataFrame`s
loaded from Audacity Labeltrack annotations
exported to txt files in the standard format.
Expand Down
8 changes: 6 additions & 2 deletions src/crowsetta/formats/seq/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,12 @@
"""


class GenericSeqSchema(pandera.SchemaModel):
"""A :class: `pandera.SchemaModel` that validates
class GenericSeqSchema(pandera.DataFrameModel

):
"""A :class: `pandera.DataFrameModel
` that validates
:type:`pandas.DataFrame`s
loaded from a csv file in the ``'generic-seq'`` annotation
format.
Expand Down
8 changes: 6 additions & 2 deletions src/crowsetta/formats/seq/simple.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,12 @@
from crowsetta.typing import PathLike


class SimpleSeqSchema(pandera.SchemaModel):
"""A :class:`pandera.SchemaModel`
class SimpleSeqSchema(pandera.DataFrameModel

):
"""A :class:`pandera.DataFrameModel
`
that validates :type:`pandas.DataFrame`s
loaded from a csv or txt file in a 'simple-seq' format.
Expand Down
8 changes: 6 additions & 2 deletions src/crowsetta/formats/seq/timit.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,12 @@
from crowsetta.typing import PathLike


class TimitTranscriptSchema(pandera.SchemaModel):
"""A :class:`pandera.SchemaModel` that validates :type:`pandas.DataFrame`s
class TimitTranscriptSchema(pandera.DataFrameModel

):
"""A :class:`pandera.DataFrameModel
` that validates :type:`pandas.DataFrame`s
loaded from a phn or wrd file in the TIMIT[1]_ transcription format.
References
Expand Down

0 comments on commit 9531704

Please sign in to comment.