Skip to content

bases.rst

Latest commit

 

History

History
99 lines (62 loc) · 1.91 KB

bases.rst

File metadata and controls

99 lines (62 loc) · 1.91 KB
Raw

:mod:`~domdf_python_tools.bases`

.. autosummary-widths:: 5/16


.. automodule:: domdf_python_tools.bases
        :autosummary-members:
        :no-members:

Type Variables

.. autotypevar:: domdf_python_tools.bases._F

.. autotypevar:: domdf_python_tools.bases._LU

.. autotypevar:: domdf_python_tools.bases._S


.. autotypevar:: domdf_python_tools.bases._T

.. autotypevar:: domdf_python_tools.bases._V

Dictable

.. autoclass:: domdf_python_tools.bases.Dictable
        :inherited-members:
        :special-members:

UserList

.. autoclass:: domdf_python_tools.bases.UserList
        :inherited-members:
        :special-members:

NamedList

Both :class:`~.NamedList` and :func:`~.namedlist` can be used to create a named list.

:func:`~.namedlist` can be used as follows:

>>> ShoppingList = namedlist("ShoppingList")
>>> shopping_list = ShoppingList(["egg and bacon", "egg sausage and bacon", "egg and spam", "egg bacon and spam"])
>>>

If you wish to create a subclass with additional features it is recommended to subclass from :class:`NamedList` rather than from :func:`~.namedlist`. For example, do this:

>>> class ShoppingList(NamedList):
...     pass
>>>

and not this:

>>> class ShoppingList(namedlist())
...     pass
>>>

This avoids any potential issues with :github:repo:`mypy <python/mypy>`.

.. autoclass:: domdf_python_tools.bases.NamedList
        :no-autosummary:
        :exclude-members: __repr__,__str__


.. autofunction:: domdf_python_tools.bases.namedlist

UserFloat

.. autoclass:: domdf_python_tools.bases.UserFloat
        :inherited-members:
        :special-members:
        :exclude-members: __ceil__,__floor__,conjugate,imag,real


.. latex:clearpage::

Lineup

.. autoclass:: domdf_python_tools.bases.Lineup