omnipy.components.tables.datasets

Datasets for grouped tabular data in row-wise, column-wise, CSV, TSV, and record forms.

CLASS	DESCRIPTION
CsvTableDataset	Store CSV text parsed into header-aware row-wise tables.
TableDictOfDictsOfJsonScalarsDataset	Store indexed tables keyed by row identifier.
TableDictOfListsOfJsonScalarsDataset
TableListOfDictsOfJsonScalarsDataset	Store row-wise tables keyed by column names.
TableListOfListsOfJsonScalarsDataset	Store row-wise tables represented as lists of scalar rows.
TableOfPydanticRecordsDataset	Store tables parsed into Pydantic-validated record lists.
TableWithColNamesDataset	Store row-wise tables that derive headers from the first row.
TsvTableDataset	Store TSV text parsed into header-aware row-wise tables.

CsvTableDataset

Bases: Dataset[CsvTableModel]

              flowchart BT
              omnipy.components.tables.datasets.CsvTableDataset[CsvTableDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.CsvTableDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.CsvTableDataset href "" "omnipy.components.tables.datasets.CsvTableDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store CSV text parsed into header-aware row-wise tables.

Each dataset entry contains a :class:CsvTableModel where the first row is used as column headers for the parsed table rows.

Source code in src/omnipy/components/tables/datasets.py

class CsvTableDataset(Dataset[CsvTableModel]):
    """Store CSV text parsed into header-aware row-wise tables.

    Each dataset entry contains a :class:`CsvTableModel` where the first row is used
    as column headers for the parsed table rows.
    """
    ...

TableDictOfDictsOfJsonScalarsDataset

Bases: Dataset[ColumnWiseTableWithColNamesAndIndexModel]

              flowchart BT
              omnipy.components.tables.datasets.TableDictOfDictsOfJsonScalarsDataset[TableDictOfDictsOfJsonScalarsDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableDictOfDictsOfJsonScalarsDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableDictOfDictsOfJsonScalarsDataset href "" "omnipy.components.tables.datasets.TableDictOfDictsOfJsonScalarsDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store indexed tables keyed by row identifier.

Each dataset entry contains a :class:ColumnWiseTableWithColNamesAndIndexModel where each outer key identifies a row and maps to a column-name/value mapping.

Source code in src/omnipy/components/tables/datasets.py

class TableDictOfDictsOfJsonScalarsDataset(Dataset[ColumnWiseTableWithColNamesAndIndexModel]):
    """Store indexed tables keyed by row identifier.

    Each dataset entry contains a :class:`ColumnWiseTableWithColNamesAndIndexModel`
    where each outer key identifies a row and maps to a column-name/value mapping.
    """
    ...

TableDictOfListsOfJsonScalarsDataset

Bases: Dataset[JsonScalarColumnWiseTableWithColNamesModel]

              flowchart BT
              omnipy.components.tables.datasets.TableDictOfListsOfJsonScalarsDataset[TableDictOfListsOfJsonScalarsDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableDictOfListsOfJsonScalarsDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableDictOfListsOfJsonScalarsDataset href "" "omnipy.components.tables.datasets.TableDictOfListsOfJsonScalarsDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Source code in src/omnipy/components/tables/datasets.py

class TableDictOfListsOfJsonScalarsDataset(Dataset[JsonScalarColumnWiseTableWithColNamesModel]):
    ...

TableListOfDictsOfJsonScalarsDataset

Bases: Dataset[RowWiseTableWithColNamesModel]

              flowchart BT
              omnipy.components.tables.datasets.TableListOfDictsOfJsonScalarsDataset[TableListOfDictsOfJsonScalarsDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableListOfDictsOfJsonScalarsDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableListOfDictsOfJsonScalarsDataset href "" "omnipy.components.tables.datasets.TableListOfDictsOfJsonScalarsDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store row-wise tables keyed by column names.

Each dataset entry contains a :class:RowWiseTableWithColNamesModel where each row is a dictionary from column name to JSON scalar cell value.

Source code in src/omnipy/components/tables/datasets.py

class TableListOfDictsOfJsonScalarsDataset(Dataset[RowWiseTableWithColNamesModel]):
    """Store row-wise tables keyed by column names.

    Each dataset entry contains a :class:`RowWiseTableWithColNamesModel` where each
    row is a dictionary from column name to JSON scalar cell value.
    """
    ...

TableListOfListsOfJsonScalarsDataset

Bases: Dataset[RowWiseTableModel]

              flowchart BT
              omnipy.components.tables.datasets.TableListOfListsOfJsonScalarsDataset[TableListOfListsOfJsonScalarsDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableListOfListsOfJsonScalarsDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableListOfListsOfJsonScalarsDataset href "" "omnipy.components.tables.datasets.TableListOfListsOfJsonScalarsDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store row-wise tables represented as lists of scalar rows.

Each dataset entry contains a :class:RowWiseTableModel where rows are ordered lists of JSON scalar values without explicit column-name metadata.

Source code in src/omnipy/components/tables/datasets.py

class TableListOfListsOfJsonScalarsDataset(Dataset[RowWiseTableModel]):
    """Store row-wise tables represented as lists of scalar rows.

    Each dataset entry contains a :class:`RowWiseTableModel` where rows are ordered
    lists of JSON scalar values without explicit column-name metadata.
    """
    ...

TableOfPydanticRecordsDataset

Bases: Dataset[TableOfPydanticRecordsModel[_PydanticModelT]], Generic[_PydanticModelT]

              flowchart BT
              omnipy.components.tables.datasets.TableOfPydanticRecordsDataset[TableOfPydanticRecordsDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableOfPydanticRecordsDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableOfPydanticRecordsDataset href "" "omnipy.components.tables.datasets.TableOfPydanticRecordsDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store tables parsed into Pydantic-validated record lists.

Each entry contains a :class:TableOfPydanticRecordsModel parameterized by the target Pydantic record schema.

Source code in src/omnipy/components/tables/datasets.py

class TableOfPydanticRecordsDataset(Dataset[TableOfPydanticRecordsModel[_PydanticModelT]],
                                    Generic[_PydanticModelT]):
    """Store tables parsed into Pydantic-validated record lists.

    Each entry contains a :class:`TableOfPydanticRecordsModel` parameterized by the
    target Pydantic record schema.
    """
    ...

TableWithColNamesDataset

Bases: Dataset[RowWiseTableFirstRowAsColNamesModel]

              flowchart BT
              omnipy.components.tables.datasets.TableWithColNamesDataset[TableWithColNamesDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TableWithColNamesDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TableWithColNamesDataset href "" "omnipy.components.tables.datasets.TableWithColNamesDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store row-wise tables that derive headers from the first row.

Entries are normalized into :class:RowWiseTableFirstRowAsColNamesModel values, where the first row becomes the header for subsequent row dictionaries.

Used by:

• Reference Code reference
  •  omnipy  transpose_columns_with_data_files
  • omnipy components tables  tasks  transpose_columns_with_data_files

ATTRIBUTE	DESCRIPTION
col_names	Return distinct column names seen across all dataset entries. TYPE: tuple[str]

Source code in src/omnipy/components/tables/datasets.py

class TableWithColNamesDataset(Dataset[RowWiseTableFirstRowAsColNamesModel]):
    """Store row-wise tables that derive headers from the first row.

    Entries are normalized into :class:`RowWiseTableFirstRowAsColNamesModel` values,
    where the first row becomes the header for subsequent row dictionaries.
    """
    @property
    def col_names(self) -> tuple[str]:
        """Return distinct column names seen across all dataset entries.

        Returns:
            tuple[str]: Column names aggregated in first-seen order while iterating
                through dataset values.
        """
        col_names = {}
        for data_file in self.values():
            col_names.update(dict.fromkeys(data_file.col_names))
        return tuple(col_names.keys())

col_names property

col_names: tuple[str]

Return distinct column names seen across all dataset entries.

RETURNS	DESCRIPTION
tuple[str]	tuple[str]: Column names aggregated in first-seen order while iterating through dataset values.

TsvTableDataset

Bases: Dataset[TsvTableModel]

              flowchart BT
              omnipy.components.tables.datasets.TsvTableDataset[TsvTableDataset]
              omnipy.data.dataset.Dataset[Dataset]
              omnipy.data._mixins.display.DatasetDisplayMixin[DatasetDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._mixins.task.TaskDatasetMixin[TaskDatasetMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.dataset.Dataset --> omnipy.components.tables.datasets.TsvTableDataset
                                omnipy.data._mixins.display.DatasetDisplayMixin --> omnipy.data.dataset.Dataset
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.DatasetDisplayMixin
                

                omnipy.data._mixins.task.TaskDatasetMixin --> omnipy.data.dataset.Dataset
                
                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.dataset.Dataset
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.dataset.Dataset
                



              click omnipy.components.tables.datasets.TsvTableDataset href "" "omnipy.components.tables.datasets.TsvTableDataset"
              click omnipy.data.dataset.Dataset href "" "omnipy.data.dataset.Dataset"
              click omnipy.data._mixins.display.DatasetDisplayMixin href "" "omnipy.data._mixins.display.DatasetDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._mixins.task.TaskDatasetMixin href "" "omnipy.data._mixins.task.TaskDatasetMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"
            

Store TSV text parsed into header-aware row-wise tables.

Each dataset entry contains a :class:TsvTableModel where the first row is used as column headers for the parsed table rows.

Source code in src/omnipy/components/tables/datasets.py

class TsvTableDataset(Dataset[TsvTableModel]):
    """Store TSV text parsed into header-aware row-wise tables.

    Each dataset entry contains a :class:`TsvTableModel` where the first row is used
    as column headers for the parsed table rows.
    """
    ...