mirror of https://github.com/jab/bidict.git
49 lines
1.4 KiB
ReStructuredText
49 lines
1.4 KiB
ReStructuredText
.. _other-bidict-types:
|
|
|
|
Other ``bidict`` Types
|
|
======================
|
|
|
|
Now that we've covered
|
|
:ref:`basic usage <basic-usage>`,
|
|
let's look at the remaining bidict types
|
|
and the hierarchy they belong to.
|
|
|
|
.. _bidict-type-hierarchy:
|
|
|
|
``bidict`` Type Hierarchy
|
|
-------------------------
|
|
|
|
.. image:: _static/type-hierarchy.png
|
|
:alt: bidict type hierarchy
|
|
|
|
At the top of the hierarchy of types that bidict provides is
|
|
:class:`bidict.BidirectionalMapping`.
|
|
This extends the :class:`collections.abc.Mapping` ABC
|
|
with the
|
|
:attr:`"inv" <bidict.BidirectionalMapping.inv>`
|
|
:func:`abstractproperty <abc.abstractproperty>`,
|
|
as well as a concrete, generic implementation of
|
|
:attr:`__inverted__ <bidict.BidirectionalMapping.__inverted__>`.
|
|
:class:`BidirectionalMapping <bidict.BidirectionalMapping>` also implements
|
|
:attr:`__subclasshook__ <bidict.BidirectionalMapping.__subclasshook__>`,
|
|
so that any class providing a conforming API is considered a virtual subclass
|
|
of :class:`BidirectionalMapping <bidict.BidirectionalMapping>` automatically.
|
|
|
|
Implementing
|
|
:class:`BidirectionalMapping <bidict.BidirectionalMapping>` is
|
|
:class:`frozenbidict <bidict.frozenbidict>`,
|
|
which provides a hashable, immutable bidict type,
|
|
and serves as a base class for mutable bidict types to extend.
|
|
|
|
.. include:: frozenbidict.rst.inc
|
|
|
|
.. include:: orderedbidict.rst.inc
|
|
|
|
.. include:: namedbidict.rst.inc
|
|
|
|
.. include:: polymorphism.rst.inc
|
|
|
|
.. include:: extending.rst.inc
|
|
|
|
Proceed to :ref:`other-functionality`.
|