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

33 lines
505 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:
API
===
This page contains auto-generated documentation from the bidict source code.
bidict
------
.. automodule:: bidict
:members:
code and documentation improvements - Use __slots__ to speed up attribute access and decrease memory usage (adding _SlotPickleMixin to preserve pickleability) - "Code review nav" comments - Remove _clear from frozenbidict, leaving only the public `clear` methods on the mutable bidict types. Much clearer now! (ducks) - Improve `pop` and `popitem` signatures. No need for them to take *args/**kw. - Make bidict extend MutableMapping directly rather than registering it as a virtual subclass. Leave a comment explaining that it inherits MutableMapping's setdefault implementation now that it isn't added manually. - Make the DuplicationPolicy class just a namespace holding RAISE, OVERWRITE, and IGNORE, not a _Marker itself. Make RAISE, OVERWRITE, and IGNORE just _Markers, not `DuplicationPolicy`s. - Various other code and docs improvements.
2018-02-19 02:40:01 +00:00
:member-order: bysource
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
:special-members:
code and documentation improvements - Use __slots__ to speed up attribute access and decrease memory usage (adding _SlotPickleMixin to preserve pickleability) - "Code review nav" comments - Remove _clear from frozenbidict, leaving only the public `clear` methods on the mutable bidict types. Much clearer now! (ducks) - Improve `pop` and `popitem` signatures. No need for them to take *args/**kw. - Make bidict extend MutableMapping directly rather than registering it as a virtual subclass. Leave a comment explaining that it inherits MutableMapping's setdefault implementation now that it isn't added manually. - Make the DuplicationPolicy class just a namespace holding RAISE, OVERWRITE, and IGNORE, not a _Marker itself. Make RAISE, OVERWRITE, and IGNORE just _Markers, not `DuplicationPolicy`s. - Various other code and docs improvements.
2018-02-19 02:40:01 +00:00
:show-inheritance:
:undoc-members:
:exclude-members: __abstractmethods__,__dict__,__module__,__weakref__
split back out (Ordered)BidictBase classes, improve namedbidict validation, docs
2018-02-26 23:29:56 +00:00
: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
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
:members: