Rooba
/
bidict
mirror of https://github.com/jab/bidict.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bidict/docs/api.rst

41 lines
761 B
ReStructuredText
Raw Normal View History

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
===
This page contains auto-generated documentation from the bidict source code.
bidict
------
.. automodule:: bidict
bidict.pairs -> _iteritems_args_kw, docs + other small improvements - improve coverage - use latest pip on travis - update to tox 3 - guard Python < 3.3 warning with PYMAJOR == 3 condition - docs improvements, esp. for viewing on GitHub: - fix `foo <bar>`__ link syntax (always use two underscores) - use `.. code: python` for code blocks to enable GitHub syntax highlighting - ditch `.. include::` which GitHub does not support - use sphinx.ext.autosectionlabel - only wrap linkcheck with travis_retry - s/sibbell/libraries.io
2018-04-06 04:28:44 +00:00
:members:
:member-order: bysource
:special-members:
:show-inheritance:
:undoc-members:
:exclude-members: __abstractmethods__,__dict__,__module__,__weakref__
:inherited-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
numerous code improvements - Refactor _dedup_item, _write_item, and _undo_write methods to use higher-level abstractions (_DedupResult and _WriteResult classes). - Add internal _OnDup class to bundle (on_dup_key, on_dup_val, on_dup_kv) together into a single abstraction. Signatures of methods like _put and _update are cleaner as a result. - Add the "_NOOP" _DedupResult abstraction. - Make _Marker extend namedtuple, no need for it to be mutable. - Enable the pylint messages that were disabled now that the code is cleaner. - Make DuplicationPolicy extend _Marker and make RAISE, OVERWRITE, and IGNORE instances of DuplicationPolicy once again. This time deprecate access via DuplicationPolicy.(IGNORE|RAISE|OVERWRITE) to prevent infinite chaining. - Misc. code and docs improvements.
2018-02-20 10:23:04 +00:00
.. autodata:: bidict.RAISE
.. autodata:: bidict.OVERWRITE
.. autodata:: bidict.IGNORE
bidict.pairs -> _iteritems_args_kw, docs + other small improvements - improve coverage - use latest pip on travis - update to tox 3 - guard Python < 3.3 warning with PYMAJOR == 3 condition - docs improvements, esp. for viewing on GitHub: - fix `foo <bar>`__ link syntax (always use two underscores) - use `.. code: python` for code blocks to enable GitHub syntax highlighting - ditch `.. include::` which GitHub does not support - use sphinx.ext.autosectionlabel - only wrap linkcheck with travis_retry - s/sibbell/libraries.io
2018-04-06 04:28:44 +00:00
.. autofunction:: bidict._util._iteritems_mapping_or_iterable
.. autofunction:: bidict._util._iteritems_args_kw
numerous code improvements - Refactor _dedup_item, _write_item, and _undo_write methods to use higher-level abstractions (_DedupResult and _WriteResult classes). - Add internal _OnDup class to bundle (on_dup_key, on_dup_val, on_dup_kv) together into a single abstraction. Signatures of methods like _put and _update are cleaner as a result. - Add the "_NOOP" _DedupResult abstraction. - Make _Marker extend namedtuple, no need for it to be mutable. - Enable the pylint messages that were disabled now that the code is cleaner. - Make DuplicationPolicy extend _Marker and make RAISE, OVERWRITE, and IGNORE instances of DuplicationPolicy once again. This time deprecate access via DuplicationPolicy.(IGNORE|RAISE|OVERWRITE) to prevent infinite chaining. - Misc. code and docs improvements.
2018-02-20 10:23:04 +00:00
tweak docs, setup.py, travis, and hypothesis tests - improve basic usage and "Why can't I just use a dict?" docs - rename _static -> assets - use forward declarations of custom rst interpreted text roles we use that sphinx defines and that PyPI and GitHub couldn't handle otherwise (e.g. :doc:), rather than stripping them out in setup.py - move __keywords__ and __url__ from setup.py into bidict/metadata.py - add __version_info__ metadata attribute - import bidict/metadata.py in setup.py rather than `exec`ing it - add back Python 3.4 to Travis test matrix - improve hypothesis settings for max_examples_5000 profile (used in nightly CI builds) - suppress hypothesis's hung_test health check for max_examples_5000 profile to prevent flaky tests caused by failed health checks. Avoids errors like: E hypothesis.errors.FailedHealthCheck: Your test has been running for at least five minutes. This is probably not what you intended, so by default Hypothesis turns it into an error. E See https://hypothesis.readthedocs.io/en/latest/healthchecks.html for more information about this. If you want to disable just this health check, add HealthCheck.hung_test to the suppress_health_check settings for this test.
2018-04-19 08:22:07 +00:00
.. attribute:: __version__
The version of bidict represented as a string.
.. attribute:: __version_info__
The version of bidict represented as a tuple.
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.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
bidict.pairs -> _iteritems_args_kw, docs + other small improvements - improve coverage - use latest pip on travis - update to tox 3 - guard Python < 3.3 warning with PYMAJOR == 3 condition - docs improvements, esp. for viewing on GitHub: - fix `foo <bar>`__ link syntax (always use two underscores) - use `.. code: python` for code blocks to enable GitHub syntax highlighting - ditch `.. include::` which GitHub does not support - use sphinx.ext.autosectionlabel - only wrap linkcheck with travis_retry - s/sibbell/libraries.io
2018-04-06 04:28:44 +00:00
:members: