omnipy.components.remote.datasets

Datasets for HTTP URLs and automatically decoded HTTP response content.

CLASS	DESCRIPTION
AutoResponseContentDataset	Store named HTTP responses decoded to JSON, text, or bytes.
HttpUrlDataset	Store named HTTP or HTTPS URLs.

AutoResponseContentDataset

Bases: Dataset[AutoResponseContentModel]

              flowchart BT
              omnipy.components.remote.datasets.AutoResponseContentDataset[AutoResponseContentDataset]
              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.remote.datasets.AutoResponseContentDataset
                                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.remote.datasets.AutoResponseContentDataset href "" "omnipy.components.remote.datasets.AutoResponseContentDataset"
              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 named HTTP responses decoded to JSON, text, or bytes.

PARAMETER	DESCRIPTION
*args	Positional data forwarded to :class:~omnipy.data.dataset.Dataset.
**kwargs	Keyword arguments forwarded to :class:~omnipy.data.dataset.Dataset. TYPE: object DEFAULT: {}

RETURNS	DESCRIPTION
AutoResponseContentDataset	Dataset containing AutoResponseContentModel entries.

RAISES	DESCRIPTION
TypeError	If provided values cannot be converted to AutoResponseContentModel.

Example

responses = AutoResponseContentDataset({'a': b'data'}) 'a' in responses True

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

class AutoResponseContentDataset(Dataset[AutoResponseContentModel]):
    """Store named HTTP responses decoded to JSON, text, or bytes.

    Args:
        *args: Positional data forwarded to :class:`~omnipy.data.dataset.Dataset`.
        **kwargs: Keyword arguments forwarded to
            :class:`~omnipy.data.dataset.Dataset`.

    Returns:
        AutoResponseContentDataset: Dataset containing ``AutoResponseContentModel`` entries.

    Raises:
        TypeError: If provided values cannot be converted to ``AutoResponseContentModel``.

    Example:
        >>> responses = AutoResponseContentDataset({'a': b'data'})
        >>> 'a' in responses
        True
    """
    ...

HttpUrlDataset

Bases: Dataset[HttpUrlModel]

              flowchart BT
              omnipy.components.remote.datasets.HttpUrlDataset[HttpUrlDataset]
              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.remote.datasets.HttpUrlDataset
                                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.remote.datasets.HttpUrlDataset href "" "omnipy.components.remote.datasets.HttpUrlDataset"
              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 named HTTP or HTTPS URLs.

PARAMETER	DESCRIPTION
*args	Positional data forwarded to :class:~omnipy.data.dataset.Dataset.
**kwargs	Keyword arguments forwarded to :class:~omnipy.data.dataset.Dataset. TYPE: object DEFAULT: {}

RETURNS	DESCRIPTION
HttpUrlDataset	Dataset containing HttpUrlModel entries.

RAISES	DESCRIPTION
TypeError	If provided values cannot be converted to HttpUrlModel.

Example

urls = HttpUrlDataset({'users': 'https://example.com/users'}) str(urls['users']) 'https://example.com/users'

Returned by:

• Reference Code reference
  •  omnipy
    •  async_get_github_repo_urls
    •  get_github_repo_urls
  • omnipy components remote  tasks
    •  async_get_github_repo_urls
    •  get_github_repo_urls

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/remote/datasets.py

class HttpUrlDataset(Dataset[HttpUrlModel]):
    """Store named HTTP or HTTPS URLs.

    Args:
        *args: Positional data forwarded to :class:`~omnipy.data.dataset.Dataset`.
        **kwargs: Keyword arguments forwarded to
            :class:`~omnipy.data.dataset.Dataset`.

    Returns:
        HttpUrlDataset: Dataset containing ``HttpUrlModel`` entries.

    Raises:
        TypeError: If provided values cannot be converted to ``HttpUrlModel``.

    Example:
        >>> urls = HttpUrlDataset({'users': 'https://example.com/users'})
        >>> str(urls['users'])
        'https://example.com/users'
    """
    ...