omnipy.components.nested.datasets

Datasets for recursively nested data structures that can contain tables or scalar values.

CLASS	DESCRIPTION
GenericNestedDataset	Represent recursively nested datasets with configurable leaf value type.
NestedDataset	Store heterogeneously nested values across dataset, table, list, and scalar forms.

ATTRIBUTE	DESCRIPTION
ColumnAndTableModels	TYPE: TypeAlias
NestedAnyUnionT
NestedUnion	TYPE: TypeAlias
TableModels	TYPE: TypeAlias

ColumnAndTableModels module-attribute

ColumnAndTableModels: TypeAlias = JsonScalarColumnModel | TableModels

NestedAnyUnionT module-attribute

NestedAnyUnionT = TypeVar('NestedAnyUnionT', bound='Dataset | Model', default=JsonScalarModel)

Subclassed by:

• Reference Code reference omnipy components nested  datasets  GenericNestedDataset

NestedUnion module-attribute

NestedUnion: TypeAlias = (
    "ColumnAndTableModels | NestedDataset | JsonScalarModel | ListAsNestedDatasetModel"
)

Subclassed by:

• Reference Code reference
  •  omnipy  NestedDataset
  • omnipy components nested  datasets  NestedDataset

TableModels module-attribute

TableModels: TypeAlias = JsonScalarColumnWiseTableWithColNamesModel | RowWiseTableWithColNamesModel

Used by:

• Reference Code reference omnipy components nested  datasets  ColumnAndTableModels

GenericNestedDataset

Bases: Dataset[NestedAnyUnionT], Generic[NestedAnyUnionT]

              flowchart BT
              omnipy.components.nested.datasets.GenericNestedDataset[GenericNestedDataset]
              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.nested.datasets.GenericNestedDataset
                                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.nested.datasets.GenericNestedDataset href "" "omnipy.components.nested.datasets.GenericNestedDataset"
              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"
            

Represent recursively nested datasets with configurable leaf value type.

Values may be nested datasets or scalar-like leaf models, depending on the active generic parameter.

Subclassed by:

• Reference Code reference
  •  omnipy  NestedDataset
  • omnipy components nested  datasets  NestedDataset

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

class GenericNestedDataset(Dataset[NestedAnyUnionT], Generic[NestedAnyUnionT]):
    """Represent recursively nested datasets with configurable leaf value type.

    Values may be nested datasets or scalar-like leaf models, depending on the
    active generic parameter.
    """

    ...

NestedDataset

Bases: GenericNestedDataset[NestedUnion]

              flowchart BT
              omnipy.components.nested.datasets.NestedDataset[NestedDataset]
              omnipy.components.nested.datasets.GenericNestedDataset[GenericNestedDataset]
              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.components.nested.datasets.GenericNestedDataset --> omnipy.components.nested.datasets.NestedDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.nested.datasets.GenericNestedDataset
                                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.nested.datasets.NestedDataset href "" "omnipy.components.nested.datasets.NestedDataset"
              click omnipy.components.nested.datasets.GenericNestedDataset href "" "omnipy.components.nested.datasets.GenericNestedDataset"
              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 heterogeneously nested values across dataset, table, list, and scalar forms.

This concrete nested dataset accepts recursive nested datasets, table models, list-as-dataset models, and JSON scalar models as values.

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

class NestedDataset(GenericNestedDataset[NestedUnion]):
    """Store heterogeneously nested values across dataset, table, list, and scalar forms.

    This concrete nested dataset accepts recursive nested datasets, table models,
    list-as-dataset models, and JSON scalar models as values.
    """
    ...