bidict/docs/inverted.doctest.rst

33 lines
919 B
ReStructuredText
Raw Normal View History

.. _inverted:
inverted
========
bidict provides the :class:`inverted() <bidict.inverted>` iterator
to help you take the inverse of any kind of object that can be inverted.
If you've ever worked with the :func:`reversed` built-in,
:class:`inverted() <bidict.inverted>` should feel familiar.
Pass in a mapping to get the inverse mapping::
>>> from bidict import inverted
>>> it = inverted({1: 'one'})
>>> {k: v for (k, v) in it}
{'one': 1}
an iterable of pairs to get the pairs' inverses::
>>> list(inverted([(1, 'one'), (2, 'two')]))
[('one', 1), ('two', 2)]
>>> list(inverted((i*i, i) for i in range(2, 5)))
[(2, 4), (3, 9), (4, 16)]
or any object implementing an ``__inverted__`` method,
which objects that already know their own inverses (such as bidicts)
can implement themselves::
>>> from bidict import bidict
>>> dict(inverted(bidict({1: 'one'})))
{'one': 1}