omnipy.components.json.datasets

JSON dataset types for collections of items with specific JSON shapes.

CLASS	DESCRIPTION
JsonBaseDataset	Base dataset for collections of JSON-model items.
JsonDataset	Dataset whose files accept any valid JSON value.
JsonDictDataset	Dataset for JSON files with a top-level object.
JsonDictOfDictsDataset	Dataset for JSON objects whose values are JSON objects.
JsonDictOfDictsOfScalarsDataset	Dataset for nested objects with scalar leaves.
JsonDictOfListsDataset	Dataset for JSON objects whose values are JSON lists.
JsonDictOfListsOfDictsDataset	Dataset for JSON objects whose values are lists of objects.
JsonDictOfListsOfScalarsDataset	Dataset for objects whose values are scalar-only JSON lists.
JsonDictOfNestedListsDataset	Dataset for JSON objects whose values are nested lists.
JsonDictOfScalarsDataset	Dataset for JSON objects with scalar values.
JsonListDataset	Dataset for JSON files with a top-level list.
JsonListOfDictsDataset	Dataset for JSON files containing lists of JSON objects.
JsonListOfDictsOfScalarsDataset	Dataset for lists of scalar-valued JSON objects.
JsonListOfListsDataset	Dataset for JSON files containing lists of JSON lists.
JsonListOfListsOfScalarsDataset	Dataset for JSON files containing nested scalar-only lists.
JsonListOfNestedDictsDataset	Dataset for JSON lists whose items are nested objects.
JsonListOfScalarsDataset	Dataset for JSON files containing scalar-only lists.
JsonListOrDictDataset	Dataset for JSON files constrained to top-level arrays or objects.
JsonNestedDictsDataset	Dataset for nested JSON objects with scalar leaves.
JsonNestedListsDataset	Dataset for nested JSON lists with scalar leaves.
JsonOnlyDictsDataset	Dataset for JSON content composed of objects and scalar leaves.
JsonOnlyListsDataset	Dataset for JSON content composed of lists and scalar leaves.
JsonScalarDataset	Dataset for JSON scalar files.

JsonBaseDataset

Bases: Dataset[_JsonModelT], Generic[_JsonModelT]

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

Base dataset for collections of JSON-model items.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to JSON-compatible values that can be parsed by _JsonModelT. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonBaseDataset	Dataset instance containing validated JSON-model files.

RAISES	DESCRIPTION
Exception	Propagates validation errors from the bound JSON model type.

Example

dataset = JsonBaseDatasetJsonModel tuple(dataset.keys()) ('item',)

Subclassed by:

• Reference Code reference
  •  omnipy
    •  JsonDataset
    •  JsonDictDataset
    •  JsonDictOfDictsDataset
    •  JsonDictOfDictsOfScalarsDataset
    •  JsonDictOfListsDataset
    •  JsonDictOfListsOfDictsDataset
    •  JsonDictOfListsOfScalarsDataset
    •  JsonDictOfNestedListsDataset
    •  JsonDictOfScalarsDataset
    •  JsonListDataset
    •  JsonListOfDictsDataset
    •  JsonListOfDictsOfScalarsDataset
    •  JsonListOfListsDataset
    •  JsonListOfListsOfScalarsDataset
    •  JsonListOfNestedDictsDataset
    •  JsonListOfScalarsDataset
    •  JsonListOrDictDataset
    •  JsonNestedDictsDataset
    •  JsonNestedListsDataset
    •  JsonOnlyDictsDataset
    •  JsonOnlyListsDataset
    •  JsonScalarDataset
  • omnipy components json
    •  datasets
      •  JsonDataset
      •  JsonDictDataset
      •  JsonDictOfDictsDataset
      •  JsonDictOfDictsOfScalarsDataset
      •  JsonDictOfListsDataset
      •  JsonDictOfListsOfDictsDataset
      •  JsonDictOfListsOfScalarsDataset
      •  JsonDictOfNestedListsDataset
      •  JsonDictOfScalarsDataset
      •  JsonListDataset
      •  JsonListOfDictsDataset
      •  JsonListOfDictsOfScalarsDataset
      •  JsonListOfListsDataset
      •  JsonListOfListsOfScalarsDataset
      •  JsonListOfNestedDictsDataset
      •  JsonListOfScalarsDataset
      •  JsonListOrDictDataset
      •  JsonNestedDictsDataset
      •  JsonNestedListsDataset
      •  JsonOnlyDictsDataset
      •  JsonOnlyListsDataset
      •  JsonScalarDataset
    •  serializers  JsonDatasetToTarFileSerializer

Used by:

• Reference Code reference omnipy components json  serializers  JsonDatasetToTarFileSerializer  serialize

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

class JsonBaseDataset(Dataset[_JsonModelT], Generic[_JsonModelT]):
    """Base dataset for collections of JSON-model items.

    Args:
        data: Optional mapping from file keys to JSON-compatible values that
            can be parsed by ``_JsonModelT``.

    Returns:
        JsonBaseDataset: Dataset instance containing validated JSON-model files.

    Raises:
        Exception: Propagates validation errors from the bound JSON model type.

    Example:
        >>> dataset = JsonBaseDataset[JsonModel]({'item': {'a': 1}})
        >>> tuple(dataset.keys())
        ('item',)
    """
    ...

JsonDataset

Bases: JsonBaseDataset[JsonModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDataset[JsonDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDataset href "" "omnipy.components.json.datasets.JsonDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset whose files accept any valid JSON value.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to JSON-compatible values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDataset	Dataset where each file is validated as a JsonModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors from JsonModel.

Example

dataset = JsonDataset({'item': [1, {'a': True}]}) dataset['item'].to_data() [1, {'a': True}]

Returned by:

• Reference Code reference
  •  omnipy  convert_dataset_string_to_json
  • omnipy components json
    •  serializers  JsonDatasetToTarFileSerializer  deserialize
    •  tasks  convert_dataset_string_to_json

Used by:

• Reference Code reference
  •  omnipy
    •  async_load_urls_into_new_dataset
    •  load_urls_into_new_dataset
  • omnipy components remote  tasks
    •  async_load_urls_into_new_dataset
    •  load_urls_into_new_dataset

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

class JsonDataset(JsonBaseDataset[JsonModel]):
    """Dataset whose files accept any valid JSON value.

    Args:
        data: Optional mapping from file keys to JSON-compatible values.

    Returns:
        JsonDataset: Dataset where each file is validated as a ``JsonModel``.

    Raises:
        Exception: Propagates validation errors from ``JsonModel``.

    Example:
        >>> dataset = JsonDataset({'item': [1, {'a': True}]})
        >>> dataset['item'].to_data()
        [1, {'a': True}]
    """
    ...

JsonDictDataset

Bases: JsonBaseDataset[JsonDictModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictDataset[JsonDictDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictDataset href "" "omnipy.components.json.datasets.JsonDictDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files with a top-level object.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict-shaped JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictDataset	Dataset validated by JsonDictModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when top-level values are not JSON objects.

Example

dataset = JsonDictDataset({'obj': {'a': [1, 2]}}) dataset['obj'].to_data() {'a': [1, 2]}

Used by:

• Reference Code reference
  •  omnipy  transpose_dicts_2_lists
  • omnipy components json  tasks  transpose_dicts_2_lists

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

class JsonDictDataset(JsonBaseDataset[JsonDictModel]):
    """Dataset for JSON files with a top-level object.

    Args:
        data: Optional mapping from file keys to dict-shaped JSON values.

    Returns:
        JsonDictDataset: Dataset validated by ``JsonDictModel``.

    Raises:
        Exception: Propagates validation errors when top-level values are not
            JSON objects.

    Example:
        >>> dataset = JsonDictDataset({'obj': {'a': [1, 2]}})
        >>> dataset['obj'].to_data()
        {'a': [1, 2]}
    """
    ...

JsonDictOfDictsDataset

Bases: JsonBaseDataset[JsonDictOfDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfDictsDataset[JsonDictOfDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfDictsDataset href "" "omnipy.components.json.datasets.JsonDictOfDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON objects whose values are JSON objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict-of-dict JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfDictsDataset	Dataset validated by JsonDictOfDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not JSON objects.

Example

dataset = JsonDictOfDictsDataset({'item': {'a': {'x': 1}}}) dataset['item'].to_data() {'a': {'x': 1}}

Used by:

• Reference Code reference
  •  omnipy  transpose_dict_of_dicts_2_list_of_dicts
  • omnipy components json  flows  transpose_dict_of_dicts_2_list_of_dicts

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

class JsonDictOfDictsDataset(JsonBaseDataset[JsonDictOfDictsModel]):
    """Dataset for JSON objects whose values are JSON objects.

    Args:
        data: Optional mapping from file keys to dict-of-dict JSON values.

    Returns:
        JsonDictOfDictsDataset: Dataset validated by ``JsonDictOfDictsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not JSON
            objects.

    Example:
        >>> dataset = JsonDictOfDictsDataset({'item': {'a': {'x': 1}}})
        >>> dataset['item'].to_data()
        {'a': {'x': 1}}
    """
    ...

JsonDictOfDictsOfScalarsDataset

Bases: JsonBaseDataset[JsonDictOfDictsOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfDictsOfScalarsDataset[JsonDictOfDictsOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfDictsOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfDictsOfScalarsDataset href "" "omnipy.components.json.datasets.JsonDictOfDictsOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for nested objects with scalar leaves.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict-of-dict JSON values with scalar leaves. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfDictsOfScalarsDataset	Dataset validated by JsonDictOfDictsOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when nested values are not JSON scalars.

Example

dataset = JsonDictOfDictsOfScalarsDataset({'item': {'a': {'x': 1}}}) dataset['item'].to_data() {'a': {'x': 1}}

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

class JsonDictOfDictsOfScalarsDataset(JsonBaseDataset[JsonDictOfDictsOfScalarsModel]):
    """Dataset for nested objects with scalar leaves.

    Args:
        data: Optional mapping from file keys to dict-of-dict JSON values with
            scalar leaves.

    Returns:
        JsonDictOfDictsOfScalarsDataset: Dataset validated by
        ``JsonDictOfDictsOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when nested values are not JSON
            scalars.

    Example:
        >>> dataset = JsonDictOfDictsOfScalarsDataset({'item': {'a': {'x': 1}}})
        >>> dataset['item'].to_data()
        {'a': {'x': 1}}
    """
    ...

JsonDictOfListsDataset

Bases: JsonBaseDataset[JsonDictOfListsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfListsDataset[JsonDictOfListsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfListsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfListsDataset href "" "omnipy.components.json.datasets.JsonDictOfListsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON objects whose values are JSON lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict JSON values containing lists. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfListsDataset	Dataset validated by JsonDictOfListsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not JSON lists.

Example

dataset = JsonDictOfListsDataset({'item': {'a': [1], 'b': [2, 3]}}) dataset['item'].to_data() {'a': [1], 'b': [2, 3]}

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

class JsonDictOfListsDataset(JsonBaseDataset[JsonDictOfListsModel]):
    """Dataset for JSON objects whose values are JSON lists.

    Args:
        data: Optional mapping from file keys to dict JSON values containing
            lists.

    Returns:
        JsonDictOfListsDataset: Dataset validated by ``JsonDictOfListsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not JSON
            lists.

    Example:
        >>> dataset = JsonDictOfListsDataset({'item': {'a': [1], 'b': [2, 3]}})
        >>> dataset['item'].to_data()
        {'a': [1], 'b': [2, 3]}
    """
    ...

JsonDictOfListsOfDictsDataset

Bases: JsonBaseDataset[JsonDictOfListsOfDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfListsOfDictsDataset[JsonDictOfListsOfDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfListsOfDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfListsOfDictsDataset href "" "omnipy.components.json.datasets.JsonDictOfListsOfDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON objects whose values are lists of objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict JSON values of list-of-object structures. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfListsOfDictsDataset	Dataset validated by JsonDictOfListsOfDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not list-of-object JSON structures.

Example

dataset = JsonDictOfListsOfDictsDataset({'item': {'a': [{'b': 1}]}}) dataset['item'].to_data() {'a': [{'b': 1}]}

Used by:

• Reference Code reference
  •  omnipy  transpose_dicts_of_lists_of_dicts_2_lists_of_dicts
  • omnipy components json  flows  transpose_dicts_of_lists_of_dicts_2_lists_of_dicts

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

class JsonDictOfListsOfDictsDataset(JsonBaseDataset[JsonDictOfListsOfDictsModel]):
    """Dataset for JSON objects whose values are lists of objects.

    Args:
        data: Optional mapping from file keys to dict JSON values of
            list-of-object structures.

    Returns:
        JsonDictOfListsOfDictsDataset: Dataset validated by
        ``JsonDictOfListsOfDictsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not
            list-of-object JSON structures.

    Example:
        >>> dataset = JsonDictOfListsOfDictsDataset({'item': {'a': [{'b': 1}]}})
        >>> dataset['item'].to_data()
        {'a': [{'b': 1}]}
    """
    ...

JsonDictOfListsOfScalarsDataset

Bases: JsonBaseDataset[JsonDictOfListsOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfListsOfScalarsDataset[JsonDictOfListsOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfListsOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfListsOfScalarsDataset href "" "omnipy.components.json.datasets.JsonDictOfListsOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for objects whose values are scalar-only JSON lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict JSON values with scalar-only list values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfListsOfScalarsDataset	Dataset validated by JsonDictOfListsOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when nested list values are not JSON scalars.

Example

dataset = JsonDictOfListsOfScalarsDataset({'item': {'a': [1], 'b': [2, 3]}}) dataset['item'].to_data() {'a': [1], 'b': [2, 3]}

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

class JsonDictOfListsOfScalarsDataset(JsonBaseDataset[JsonDictOfListsOfScalarsModel]):
    """Dataset for objects whose values are scalar-only JSON lists.

    Args:
        data: Optional mapping from file keys to dict JSON values with
            scalar-only list values.

    Returns:
        JsonDictOfListsOfScalarsDataset: Dataset validated by
        ``JsonDictOfListsOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when nested list values are not
            JSON scalars.

    Example:
        >>> dataset = JsonDictOfListsOfScalarsDataset({'item': {'a': [1], 'b': [2, 3]}})
        >>> dataset['item'].to_data()
        {'a': [1], 'b': [2, 3]}
    """
    ...

JsonDictOfNestedListsDataset

Bases: JsonBaseDataset[JsonDictOfNestedListsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfNestedListsDataset[JsonDictOfNestedListsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfNestedListsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfNestedListsDataset href "" "omnipy.components.json.datasets.JsonDictOfNestedListsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON objects whose values are nested lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict JSON values containing nested lists. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfNestedListsDataset	Dataset validated by JsonDictOfNestedListsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not nested JSON lists.

Example

dataset = JsonDictOfNestedListsDataset({'item': {'a': [[1], [2]]}}) dataset['item'].to_data() {'a': [[1], [2]]}

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

class JsonDictOfNestedListsDataset(JsonBaseDataset[JsonDictOfNestedListsModel]):
    """Dataset for JSON objects whose values are nested lists.

    Args:
        data: Optional mapping from file keys to dict JSON values containing
            nested lists.

    Returns:
        JsonDictOfNestedListsDataset: Dataset validated by
        ``JsonDictOfNestedListsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not
            nested JSON lists.

    Example:
        >>> dataset = JsonDictOfNestedListsDataset({'item': {'a': [[1], [2]]}})
        >>> dataset['item'].to_data()
        {'a': [[1], [2]]}
    """
    ...

JsonDictOfScalarsDataset

Bases: JsonBaseDataset[JsonDictOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonDictOfScalarsDataset[JsonDictOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonDictOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonDictOfScalarsDataset href "" "omnipy.components.json.datasets.JsonDictOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON objects with scalar values.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to dict JSON values where each value is scalar. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonDictOfScalarsDataset	Dataset validated by JsonDictOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not JSON scalars.

Example

dataset = JsonDictOfScalarsDataset({'item': {'a': 1, 'b': True}}) dataset['item'].to_data() {'a': 1, 'b': True}

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

class JsonDictOfScalarsDataset(JsonBaseDataset[JsonDictOfScalarsModel]):
    """Dataset for JSON objects with scalar values.

    Args:
        data: Optional mapping from file keys to dict JSON values where each
            value is scalar.

    Returns:
        JsonDictOfScalarsDataset: Dataset validated by
        ``JsonDictOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not
            JSON scalars.

    Example:
        >>> dataset = JsonDictOfScalarsDataset({'item': {'a': 1, 'b': True}})
        >>> dataset['item'].to_data()
        {'a': 1, 'b': True}
    """
    ...

JsonListDataset

Bases: JsonBaseDataset[JsonListModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListDataset[JsonListDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListDataset href "" "omnipy.components.json.datasets.JsonListDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files with a top-level list.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to list-shaped JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListDataset	Dataset validated by JsonListModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when top-level values are not lists.

Example

dataset = JsonListDataset({'numbers': [1, 2, 3]}) dataset['numbers'].to_data() [1, 2, 3]

Returned by:

• Reference Code reference
  •  omnipy  transpose_dicts_2_lists
  • omnipy components json  tasks  transpose_dicts_2_lists

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

class JsonListDataset(JsonBaseDataset[JsonListModel]):
    """Dataset for JSON files with a top-level list.

    Args:
        data: Optional mapping from file keys to list-shaped JSON values.

    Returns:
        JsonListDataset: Dataset validated by ``JsonListModel``.

    Raises:
        Exception: Propagates validation errors when top-level values are not
            lists.

    Example:
        >>> dataset = JsonListDataset({'numbers': [1, 2, 3]})
        >>> dataset['numbers'].to_data()
        [1, 2, 3]
    """
    ...

JsonListOfDictsDataset

Bases: JsonBaseDataset[JsonListOfDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfDictsDataset[JsonListOfDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfDictsDataset href "" "omnipy.components.json.datasets.JsonListOfDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files containing lists of JSON objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to list-of-dict JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfDictsDataset	Dataset validated by JsonListOfDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when top-level items are not JSON objects.

Example

dataset = JsonListOfDictsDataset({'records': [{'a': 1}, {'a': 2}]}) dataset['records'].to_data() [{'a': 1}, {'a': 2}]

Returned by:

• Reference Code reference
  •  omnipy
    •  remove_columns
    •  transpose_dict_of_dicts_2_list_of_dicts
    •  transpose_dicts_of_lists_of_dicts_2_lists_of_dicts
  • omnipy components
    • json  flows
      •  transpose_dict_of_dicts_2_list_of_dicts
      •  transpose_dicts_of_lists_of_dicts_2_lists_of_dicts
    • tables  tasks  remove_columns

Used by:

• Reference Code reference
  •  omnipy
    •  flatten_nested_json
    •  remove_columns
  • omnipy components
    • json  flows  flatten_nested_json
    • tables  tasks  remove_columns

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

class JsonListOfDictsDataset(JsonBaseDataset[JsonListOfDictsModel]):
    """Dataset for JSON files containing lists of JSON objects.

    Args:
        data: Optional mapping from file keys to list-of-dict JSON values.

    Returns:
        JsonListOfDictsDataset: Dataset validated by ``JsonListOfDictsModel``.

    Raises:
        Exception: Propagates validation errors when top-level items are not
            JSON objects.

    Example:
        >>> dataset = JsonListOfDictsDataset({'records': [{'a': 1}, {'a': 2}]})
        >>> dataset['records'].to_data()
        [{'a': 1}, {'a': 2}]
    """
    ...

JsonListOfDictsOfScalarsDataset

Bases: JsonBaseDataset[JsonListOfDictsOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfDictsOfScalarsDataset[JsonListOfDictsOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfDictsOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfDictsOfScalarsDataset href "" "omnipy.components.json.datasets.JsonListOfDictsOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for lists of scalar-valued JSON objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to lists of dicts with scalar JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfDictsOfScalarsDataset	Dataset validated by JsonListOfDictsOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when object values are not JSON scalars.

Example

dataset = JsonListOfDictsOfScalarsDataset({'records': [{'a': 1}, {'a': 2}]}) dataset['records'].to_data() [{'a': 1}, {'a': 2}]

Returned by:

• Reference Code reference
  •  omnipy  flatten_nested_json
  • omnipy components json  flows  flatten_nested_json

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

class JsonListOfDictsOfScalarsDataset(JsonBaseDataset[JsonListOfDictsOfScalarsModel]):
    """Dataset for lists of scalar-valued JSON objects.

    Args:
        data: Optional mapping from file keys to lists of dicts with scalar
            JSON values.

    Returns:
        JsonListOfDictsOfScalarsDataset: Dataset validated by
        ``JsonListOfDictsOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when object values are not JSON
            scalars.

    Example:
        >>> dataset = JsonListOfDictsOfScalarsDataset({'records': [{'a': 1}, {'a': 2}]})
        >>> dataset['records'].to_data()
        [{'a': 1}, {'a': 2}]
    """
    ...

JsonListOfListsDataset

Bases: JsonBaseDataset[JsonListOfListsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfListsDataset[JsonListOfListsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfListsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfListsDataset href "" "omnipy.components.json.datasets.JsonListOfListsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files containing lists of JSON lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to list-of-list JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfListsDataset	Dataset validated by JsonListOfListsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when top-level items are not JSON lists.

Example

dataset = JsonListOfListsDataset({'matrix': [[1], [2, 3]]}) dataset['matrix'].to_data() [[1], [2, 3]]

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

class JsonListOfListsDataset(JsonBaseDataset[JsonListOfListsModel]):
    """Dataset for JSON files containing lists of JSON lists.

    Args:
        data: Optional mapping from file keys to list-of-list JSON values.

    Returns:
        JsonListOfListsDataset: Dataset validated by ``JsonListOfListsModel``.

    Raises:
        Exception: Propagates validation errors when top-level items are not
            JSON lists.

    Example:
        >>> dataset = JsonListOfListsDataset({'matrix': [[1], [2, 3]]})
        >>> dataset['matrix'].to_data()
        [[1], [2, 3]]
    """
    ...

JsonListOfListsOfScalarsDataset

Bases: JsonBaseDataset[JsonListOfListsOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfListsOfScalarsDataset[JsonListOfListsOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfListsOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfListsOfScalarsDataset href "" "omnipy.components.json.datasets.JsonListOfListsOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files containing nested scalar-only lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to lists of scalar-only JSON lists. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfListsOfScalarsDataset	Dataset validated by JsonListOfListsOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when nested values are not JSON scalars.

Example

dataset = JsonListOfListsOfScalarsDataset({'matrix': [[1, 2], [3, 4]]}) dataset['matrix'].to_data() [[1, 2], [3, 4]]

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

class JsonListOfListsOfScalarsDataset(JsonBaseDataset[JsonListOfListsOfScalarsModel]):
    """Dataset for JSON files containing nested scalar-only lists.

    Args:
        data: Optional mapping from file keys to lists of scalar-only JSON
            lists.

    Returns:
        JsonListOfListsOfScalarsDataset: Dataset validated by
        ``JsonListOfListsOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when nested values are not JSON
            scalars.

    Example:
        >>> dataset = JsonListOfListsOfScalarsDataset({'matrix': [[1, 2], [3, 4]]})
        >>> dataset['matrix'].to_data()
        [[1, 2], [3, 4]]
    """
    ...

JsonListOfNestedDictsDataset

Bases: JsonBaseDataset[JsonListOfNestedDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfNestedDictsDataset[JsonListOfNestedDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfNestedDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfNestedDictsDataset href "" "omnipy.components.json.datasets.JsonListOfNestedDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON lists whose items are nested objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to list JSON values of nested objects. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfNestedDictsDataset	Dataset validated by JsonListOfNestedDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when list items are not nested JSON objects.

Example

dataset = JsonListOfNestedDictsDataset({'item': [{'a': {'b': 1}}]}) dataset['item'].to_data() [{'a': {'b': 1}}]

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

class JsonListOfNestedDictsDataset(JsonBaseDataset[JsonListOfNestedDictsModel]):
    """Dataset for JSON lists whose items are nested objects.

    Args:
        data: Optional mapping from file keys to list JSON values of nested
            objects.

    Returns:
        JsonListOfNestedDictsDataset: Dataset validated by
        ``JsonListOfNestedDictsModel``.

    Raises:
        Exception: Propagates validation errors when list items are not nested
            JSON objects.

    Example:
        >>> dataset = JsonListOfNestedDictsDataset({'item': [{'a': {'b': 1}}]})
        >>> dataset['item'].to_data()
        [{'a': {'b': 1}}]
    """
    ...

JsonListOfScalarsDataset

Bases: JsonBaseDataset[JsonListOfScalarsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOfScalarsDataset[JsonListOfScalarsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOfScalarsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOfScalarsDataset href "" "omnipy.components.json.datasets.JsonListOfScalarsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files containing scalar-only lists.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to lists of JSON scalar values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOfScalarsDataset	Dataset validated by JsonListOfScalarsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when list items are not scalar JSON values.

Example

dataset = JsonListOfScalarsDataset({'scores': [1, 2, 3]}) dataset['scores'].to_data() [1, 2, 3]

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

class JsonListOfScalarsDataset(JsonBaseDataset[JsonListOfScalarsModel]):
    """Dataset for JSON files containing scalar-only lists.

    Args:
        data: Optional mapping from file keys to lists of JSON scalar values.

    Returns:
        JsonListOfScalarsDataset: Dataset validated by
        ``JsonListOfScalarsModel``.

    Raises:
        Exception: Propagates validation errors when list items are not scalar
            JSON values.

    Example:
        >>> dataset = JsonListOfScalarsDataset({'scores': [1, 2, 3]})
        >>> dataset['scores'].to_data()
        [1, 2, 3]
    """
    ...

JsonListOrDictDataset

Bases: JsonBaseDataset[JsonListOrDictModel]

              flowchart BT
              omnipy.components.json.datasets.JsonListOrDictDataset[JsonListOrDictDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonListOrDictDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonListOrDictDataset href "" "omnipy.components.json.datasets.JsonListOrDictDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON files constrained to top-level arrays or objects.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to list/dict JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonListOrDictDataset	Dataset validated by JsonListOrDictModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when scalar JSON values are provided.

Example

dataset = JsonListOrDictDataset({'item': {'a': 1}}) dataset['item'].to_data() {'a': 1}

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

class JsonListOrDictDataset(JsonBaseDataset[JsonListOrDictModel]):
    """Dataset for JSON files constrained to top-level arrays or objects.

    Args:
        data: Optional mapping from file keys to list/dict JSON values.

    Returns:
        JsonListOrDictDataset: Dataset validated by ``JsonListOrDictModel``.

    Raises:
        Exception: Propagates validation errors when scalar JSON values are
            provided.

    Example:
        >>> dataset = JsonListOrDictDataset({'item': {'a': 1}})
        >>> dataset['item'].to_data()
        {'a': 1}
    """
    ...

JsonNestedDictsDataset

Bases: JsonBaseDataset[JsonNestedDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonNestedDictsDataset[JsonNestedDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonNestedDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonNestedDictsDataset href "" "omnipy.components.json.datasets.JsonNestedDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for nested JSON objects with scalar leaves.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to nested-object JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonNestedDictsDataset	Dataset validated by JsonNestedDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when nested values include JSON arrays.

Example

dataset = JsonNestedDictsDataset({'item': {'a': {'b': 1}}}) dataset['item'].to_data() {'a': {'b': 1}}

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

class JsonNestedDictsDataset(JsonBaseDataset[JsonNestedDictsModel]):
    """Dataset for nested JSON objects with scalar leaves.

    Args:
        data: Optional mapping from file keys to nested-object JSON values.

    Returns:
        JsonNestedDictsDataset: Dataset validated by ``JsonNestedDictsModel``.

    Raises:
        Exception: Propagates validation errors when nested values include JSON
            arrays.

    Example:
        >>> dataset = JsonNestedDictsDataset({'item': {'a': {'b': 1}}})
        >>> dataset['item'].to_data()
        {'a': {'b': 1}}
    """
    ...

JsonNestedListsDataset

Bases: JsonBaseDataset[JsonNestedListsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonNestedListsDataset[JsonNestedListsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonNestedListsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonNestedListsDataset href "" "omnipy.components.json.datasets.JsonNestedListsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for nested JSON lists with scalar leaves.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to nested list JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonNestedListsDataset	Dataset validated by JsonNestedListsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when nested values include JSON objects.

Example

dataset = JsonNestedListsDataset({'item': [[1], [2, [3]]]}) dataset['item'].to_data() [[1], [2, [3]]]

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

class JsonNestedListsDataset(JsonBaseDataset[JsonNestedListsModel]):
    """Dataset for nested JSON lists with scalar leaves.

    Args:
        data: Optional mapping from file keys to nested list JSON values.

    Returns:
        JsonNestedListsDataset: Dataset validated by ``JsonNestedListsModel``.

    Raises:
        Exception: Propagates validation errors when nested values include JSON
            objects.

    Example:
        >>> dataset = JsonNestedListsDataset({'item': [[1], [2, [3]]]})
        >>> dataset['item'].to_data()
        [[1], [2, [3]]]
    """
    ...

JsonOnlyDictsDataset

Bases: JsonBaseDataset[JsonOnlyDictsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonOnlyDictsDataset[JsonOnlyDictsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonOnlyDictsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonOnlyDictsDataset href "" "omnipy.components.json.datasets.JsonOnlyDictsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON content composed of objects and scalar leaves.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to scalar-or-nested-object JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonOnlyDictsDataset	Dataset validated by JsonOnlyDictsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when list values are present.

Example

dataset = JsonOnlyDictsDataset({'item': {'a': {'b': 1}}}) dataset['item'].to_data() {'a': {'b': 1}}

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

class JsonOnlyDictsDataset(JsonBaseDataset[JsonOnlyDictsModel]):
    """Dataset for JSON content composed of objects and scalar leaves.

    Args:
        data: Optional mapping from file keys to scalar-or-nested-object JSON
            values.

    Returns:
        JsonOnlyDictsDataset: Dataset validated by ``JsonOnlyDictsModel``.

    Raises:
        Exception: Propagates validation errors when list values are present.

    Example:
        >>> dataset = JsonOnlyDictsDataset({'item': {'a': {'b': 1}}})
        >>> dataset['item'].to_data()
        {'a': {'b': 1}}
    """
    ...

JsonOnlyListsDataset

Bases: JsonBaseDataset[JsonOnlyListsModel]

              flowchart BT
              omnipy.components.json.datasets.JsonOnlyListsDataset[JsonOnlyListsDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonOnlyListsDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonOnlyListsDataset href "" "omnipy.components.json.datasets.JsonOnlyListsDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON content composed of lists and scalar leaves.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to scalar-or-nested-list JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonOnlyListsDataset	Dataset validated by JsonOnlyListsModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when dict values are present.

Example

dataset = JsonOnlyListsDataset({'item': [1, [2, 3]]}) dataset['item'].to_data() [1, [2, 3]]

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

class JsonOnlyListsDataset(JsonBaseDataset[JsonOnlyListsModel]):
    """Dataset for JSON content composed of lists and scalar leaves.

    Args:
        data: Optional mapping from file keys to scalar-or-nested-list JSON
            values.

    Returns:
        JsonOnlyListsDataset: Dataset validated by ``JsonOnlyListsModel``.

    Raises:
        Exception: Propagates validation errors when dict values are present.

    Example:
        >>> dataset = JsonOnlyListsDataset({'item': [1, [2, 3]]})
        >>> dataset['item'].to_data()
        [1, [2, 3]]
    """
    ...

JsonScalarDataset

Bases: JsonBaseDataset[JsonScalarModel]

              flowchart BT
              omnipy.components.json.datasets.JsonScalarDataset[JsonScalarDataset]
              omnipy.components.json.datasets.JsonBaseDataset[JsonBaseDataset]
              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.json.datasets.JsonBaseDataset --> omnipy.components.json.datasets.JsonScalarDataset
                                omnipy.data.dataset.Dataset --> omnipy.components.json.datasets.JsonBaseDataset
                                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.json.datasets.JsonScalarDataset href "" "omnipy.components.json.datasets.JsonScalarDataset"
              click omnipy.components.json.datasets.JsonBaseDataset href "" "omnipy.components.json.datasets.JsonBaseDataset"
              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"
            

Dataset for JSON scalar files.

PARAMETER	DESCRIPTION
data	Optional mapping from file keys to scalar JSON values. TYPE: Mapping[str, object] | UndefinedType DEFAULT: Undefined

RETURNS	DESCRIPTION
JsonScalarDataset	Dataset validated by JsonScalarModel.

RAISES	DESCRIPTION
Exception	Propagates validation errors when non-scalar values are provided.

Example

dataset = JsonScalarDataset({'answer': 42}) dataset['answer'].to_data() 42

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

class JsonScalarDataset(JsonBaseDataset[JsonScalarModel]):
    """Dataset for JSON scalar files.

    Args:
        data: Optional mapping from file keys to scalar JSON values.

    Returns:
        JsonScalarDataset: Dataset validated by ``JsonScalarModel``.

    Raises:
        Exception: Propagates validation errors when non-scalar values are
            provided.

    Example:
        >>> dataset = JsonScalarDataset({'answer': 42})
        >>> dataset['answer'].to_data()
        42
    """
    ...