bidict/docs/api.rst

.. _api:

API
===

This page contains auto-generated documentation from the bidict source code.

bidict
------

.. automodule:: bidict
    :members:
    :special-members:
    :exclude-members: __dict__,__weakref__
    :private-members:

bidict.util
-----------

.. automodule:: bidict.util
    :members:

bidict.compat
-------------

.. automodule:: bidict.compat
    :members:
refactor, tests + docs improvements - break up single bidict.py module into multiple separate modules inside "bidict" package - new bidict.util and bidict.compat modules - move/rename bidict.fancy_iteritems to bidict.util.pairs - move bidict.iteritems and bidict.viewitems to bidict.compat - condense docstrings by moving more documentation into separate sphinx pages in "docs" dir and doctests into separate files in new "tests" dir - initial work on property-based testing using hypothesis - adopt pytest - bump to 0.9.0-dev 2015-03-22 18:21:15 +00:00			`.. _api:`

			`API`
			`===`

			`This page contains auto-generated documentation from the bidict source code.`

			`bidict`
			`------`

			`.. automodule:: bidict`
			`:members:`
			`:special-members:`
implement stricter 1-to-1 checking + many fixes + improvements See the changelog for full details. Closes #21. 2015-12-21 03:05:20 +00:00			`:exclude-members: __dict__,__weakref__`
squashed changes for 0.13.0 - support Python 3.6, refactor CI/test setup, increase test coverage - refactor BidirectionalMapping, BidictBase, OrderedBidictBase, FrozenBidictBase, and subclasses - move frozenorderedbidict into _frozen and looseorderedbidict into _loose - register bidict as a virtual subclass of MutableMapping rather than inheriting from it directly. This makes it clearer that it does not use any of the concrete generic methods that MutableMapping provides. - improve performance and flexibility of frozenbidict and frozenorderedbidict hashing - docs, including new type-hierarchy.png diagram - rm unused imap, ifilter, izip_longest from compat, add PYPY - update to latest versions of dependencies - restore benchmarking on travis 2017-01-09 15:37:31 +00:00			`:private-members:`
refactor, tests + docs improvements - break up single bidict.py module into multiple separate modules inside "bidict" package - new bidict.util and bidict.compat modules - move/rename bidict.fancy_iteritems to bidict.util.pairs - move bidict.iteritems and bidict.viewitems to bidict.compat - condense docstrings by moving more documentation into separate sphinx pages in "docs" dir and doctests into separate files in new "tests" dir - initial work on property-based testing using hypothesis - adopt pytest - bump to 0.9.0-dev 2015-03-22 18:21:15 +00:00
			`bidict.util`
			`-----------`

			`.. automodule:: bidict.util`
			`:members:`

			`bidict.compat`
docs improvements 2015-04-27 22:20:03 +00:00			`-------------`
refactor, tests + docs improvements - break up single bidict.py module into multiple separate modules inside "bidict" package - new bidict.util and bidict.compat modules - move/rename bidict.fancy_iteritems to bidict.util.pairs - move bidict.iteritems and bidict.viewitems to bidict.compat - condense docstrings by moving more documentation into separate sphinx pages in "docs" dir and doctests into separate files in new "tests" dir - initial work on property-based testing using hypothesis - adopt pytest - bump to 0.9.0-dev 2015-03-22 18:21:15 +00:00
			`.. automodule:: bidict.compat`
			`:members:`