:py:mod:`core.typing_`
======================

.. py:module:: core.typing_

.. autodoc2-docstring:: core.typing_
   :allowtitles:

Module Contents
---------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`is_primitive_scalar <core.typing_.is_primitive_scalar>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_scalar
          :summary:
   * - :py:obj:`is_primitive_index <core.typing_.is_primitive_index>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_index
          :summary:
   * - :py:obj:`is_primitive_type <core.typing_.is_primitive_type>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_type
          :summary:
   * - :py:obj:`is_primitive_set <core.typing_.is_primitive_set>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_set
          :summary:
   * - :py:obj:`is_primitive_list <core.typing_.is_primitive_list>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_list
          :summary:
   * - :py:obj:`is_primitive_dict <core.typing_.is_primitive_dict>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_dict
          :summary:
   * - :py:obj:`is_primitive_collection <core.typing_.is_primitive_collection>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_collection
          :summary:
   * - :py:obj:`is_set_of_str <core.typing_.is_set_of_str>`
     - .. autodoc2-docstring:: core.typing_.is_set_of_str
          :summary:
   * - :py:obj:`is_list_of_str <core.typing_.is_list_of_str>`
     - .. autodoc2-docstring:: core.typing_.is_list_of_str
          :summary:
   * - :py:obj:`is_primitive_list_of_dict <core.typing_.is_primitive_list_of_dict>`
     - .. autodoc2-docstring:: core.typing_.is_primitive_list_of_dict
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`PrimitiveScalar <core.typing_.PrimitiveScalar>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveScalar
          :summary:
   * - :py:obj:`PrimitiveIndex <core.typing_.PrimitiveIndex>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveIndex
          :summary:
   * - :py:obj:`PrimitiveType <core.typing_.PrimitiveType>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveType
          :summary:
   * - :py:obj:`PrimitiveSet <core.typing_.PrimitiveSet>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveSet
          :summary:
   * - :py:obj:`PrimitiveList <core.typing_.PrimitiveList>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveList
          :summary:
   * - :py:obj:`PrimitiveDict <core.typing_.PrimitiveDict>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveDict
          :summary:
   * - :py:obj:`PrimitiveCollection <core.typing_.PrimitiveCollection>`
     - .. autodoc2-docstring:: core.typing_.PrimitiveCollection
          :summary:

API
~~~

.. py:data:: PrimitiveScalar
   :canonical: core.typing_.PrimitiveScalar
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveScalar

.. py:data:: PrimitiveIndex
   :canonical: core.typing_.PrimitiveIndex
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveIndex

.. py:data:: PrimitiveType
   :canonical: core.typing_.PrimitiveType
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveType

.. py:data:: PrimitiveSet
   :canonical: core.typing_.PrimitiveSet
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveSet

.. py:data:: PrimitiveList
   :canonical: core.typing_.PrimitiveList
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveList

.. py:data:: PrimitiveDict
   :canonical: core.typing_.PrimitiveDict
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveDict

.. py:data:: PrimitiveCollection
   :canonical: core.typing_.PrimitiveCollection
   :type: typing.TypeAlias
   :value: None

   .. autodoc2-docstring:: core.typing_.PrimitiveCollection

.. py:function:: is_primitive_scalar(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveScalar]
   :canonical: core.typing_.is_primitive_scalar

   .. autodoc2-docstring:: core.typing_.is_primitive_scalar

.. py:function:: is_primitive_index(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveIndex]
   :canonical: core.typing_.is_primitive_index

   .. autodoc2-docstring:: core.typing_.is_primitive_index

.. py:function:: is_primitive_type(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveType]
   :canonical: core.typing_.is_primitive_type

   .. autodoc2-docstring:: core.typing_.is_primitive_type

.. py:function:: is_primitive_set(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveSet]
   :canonical: core.typing_.is_primitive_set

   .. autodoc2-docstring:: core.typing_.is_primitive_set

.. py:function:: is_primitive_list(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveList]
   :canonical: core.typing_.is_primitive_list

   .. autodoc2-docstring:: core.typing_.is_primitive_list

.. py:function:: is_primitive_dict(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveDict]
   :canonical: core.typing_.is_primitive_dict

   .. autodoc2-docstring:: core.typing_.is_primitive_dict

.. py:function:: is_primitive_collection(obj: typing.Any) -> typing.TypeGuard[core.typing_.PrimitiveCollection]
   :canonical: core.typing_.is_primitive_collection

   .. autodoc2-docstring:: core.typing_.is_primitive_collection

.. py:function:: is_set_of_str(obj: typing.Any) -> typing.TypeGuard[set[str]]
   :canonical: core.typing_.is_set_of_str

   .. autodoc2-docstring:: core.typing_.is_set_of_str

.. py:function:: is_list_of_str(obj: typing.Any) -> typing.TypeGuard[list[str]]
   :canonical: core.typing_.is_list_of_str

   .. autodoc2-docstring:: core.typing_.is_list_of_str

.. py:function:: is_primitive_list_of_dict(obj: typing.Any) -> typing.TypeGuard[list[core.typing_.PrimitiveDict]]
   :canonical: core.typing_.is_primitive_list_of_dict

   .. autodoc2-docstring:: core.typing_.is_primitive_list_of_dict
