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

280 lines
9.2 KiB
ReStructuredText
Raw Normal View History

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
.. Forward declarations for all the custom interpreted text roles that
Sphinx defines and that are used below. This helps Sphinx-unaware tools
(e.g. rst2html, PyPI's and GitHub's renderers, etc.).
.. role:: doc
docs improvements
2020-01-11 03:31:17 +00:00
.. Use :doc: rather than :ref: references below for better interop as well.
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
docs improvements
2020-01-11 03:31:17 +00:00
``bidict``
==========
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
The bidirectional mapping library for Python.
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
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
.. image:: https://raw.githubusercontent.com/jab/bidict/master/assets/logo-sm.png
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
:target: https://bidict.readthedocs.io/
:alt: bidict logo
logo, badges, docs, support via gumroad
2015-11-28 13:15:39 +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
Status
------
numerous fixes and improvements (#43) - .travis.yml and setup.py tweaks - add regression tests for -O bug and document fix - Make OrderedBidict equality comparison order-sensitive in more cases. - Add bidict.BidictBase.ordered class attribute. - Replacing OrderedBidictBase._should_compare_order_sensitive() with OrderedBidictBase.should_compare_order_sensitive_to(). - Revert the optimizations in v0.13.0 to make FrozenOrderedBidict instances that have the same items in different order have different hash values. - Remove FrozenBidictBase. - Remove frozenbidict._USE_ITEMSVIEW_HASH and frozenorderedbidict._HASH_NITEMS_MAX
2017-11-18 03:35:40 +00:00
.. image:: https://img.shields.io/pypi/v/bidict.svg
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
:target: https://pypi.org/project/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
:alt: Latest release
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
various code and CI improvements + dependency updates (#42)
2017-11-16 20:44:51 +00:00
.. image:: https://img.shields.io/readthedocs/bidict/master.svg
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
:target: https://bidict.readthedocs.io/en/master/
:alt: Documentation
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
tiny cosmetic docs tweaks
2018-02-13 12:13:24 +00:00
.. image:: https://api.travis-ci.org/jab/bidict.svg?branch=master
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
:target: https://travis-ci.org/jab/bidict
:alt: Travis-CI build status
various code and CI improvements + dependency updates (#42)
2017-11-16 20:44:51 +00:00
switch to codecov for automatic combining of coverage reports
2017-11-20 15:01:49 +00:00
.. image:: https://codecov.io/gh/jab/bidict/branch/master/graph/badge.svg
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
:target: https://codecov.io/gh/jab/bidict
:alt: Test coverage
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
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
.. Hide to reduce clutter
Various API changes and other improvements. * Deprecate ``bidict.OVERWRITE`` and ``bidict.IGNORE``. A :class:`UserWarning` will now be emitted if these are used. :attr:`bidict.DROP_OLD` and :attr:`bidict.DROP_NEW` should be used instead. * Rename ``DuplicationPolicy`` to :class:`~bidict.OnDupAction` (and implement it via an :class:`~enum.Enum`). A :class:`~bidict.OnDupAction` may be one of :attr:`~bidict.RAISE`, :attr:`~bidict.DROP_OLD`, or :attr:`~bidict.DROP_NEW`. * Expose the new :class:`~bidict.OnDup` class, a named (*key*, *val*, *kv*) tuple of :class:`~bidict.OnDupAction`\s that should be taken upon encountering the 3 kinds of duplication that can occur. * Provide the :attr:`~bidict.ON_DUP_DEFAULT`, :attr:`~bidict.ON_DUP_RAISE`, and :attr:`~bidict.ON_DUP_DROP_OLD` :class:`~bidict.OnDup` convenience instances. * Deprecate the ``on_dup_key``, ``on_dup_val``, and ``on_dup_kv`` arguments of :meth:`~bidict.bidict.put` and :meth:`~bidict.bidict.putall`. A :class:`UserWarning` will now be emitted if these are used. They have been subsumed by the new *on_dup* argument, which takes an :class:`~bidict.OnDup` instance. Use it like this: ``bi.put(1, 2, OnDup(key=DROP_NEW))``. Or better yet, pass one of the ``ON_DUP_*`` convenience instances instead if possible. See the updated :ref:`basic-usage:Values Must Be Unique` docs for more info. * Deprecate the ``on_dup_key``, ``on_dup_val``, and ``on_dup_kv`` bidict class attributes. A :class:`UserWarning` will now be emitted if these are used. They have been subsumed by the new :attr:`~bidict.bidict.on_dup` class attribute, which takes an :class:`~bidict.OnDup` instance. See the updated :doc:`extending` docs for example usage. * Move :meth:`bidict.BidictBase.values` to :meth:`bidict.BidirectionalMapping.values`, since the implementation is generic. * No longer use ``__all__`` in ``bidict/__init__.py``. * Cap max_size rather than disabling health checks and deadline as a less heavyhanded way to improve hypothesis test reliability on Travis.
2020-01-07 22:20:20 +00:00
.. image:: https://img.shields.io/lgtm/alerts/github/jab/bidict.svg
:target: https://lgtm.com/projects/g/jab/bidict/
:alt: LGTM alerts
.. image:: https://api.codacy.com/project/badge/Grade/6628756a73254cd895656348236833b8
:target: https://www.codacy.com/app/jab/bidict
:alt: Codacy grade
.. image:: https://bestpractices.coreinfrastructure.org/projects/2354/badge
:target: https://bestpractices.coreinfrastructure.org/en/projects/2354
:alt: CII best practices badge
.. image:: https://img.shields.io/badge/tidelift-pro%20support-orange.svg
:target: https://tidelift.com/subscription/pkg/pypi-bidict?utm_source=pypi-bidict&utm_medium=referral&utm_campaign=docs
:alt: Paid support available via Tidelift
restore download count badge \O/ + improvements to custom.css
2018-08-15 01:44:39 +00:00
.. image:: https://ci.appveyor.com/api/projects/status/gk133415udncwto3/branch/master?svg=true
:target: https://ci.appveyor.com/project/jab/bidict
:alt: AppVeyor (Windows) build status
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
.. image:: https://img.shields.io/pypi/pyversions/bidict.svg
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
:target: https://pypi.org/project/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
:alt: Supported Python versions
.. image:: https://img.shields.io/pypi/implementation/bidict.svg
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
:target: https://pypi.org/project/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
:alt: Supported Python implementations
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
docs improvements
2015-04-27 22:20:03 +00:00
.. image:: https://img.shields.io/pypi/l/bidict.svg
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
:target: https://raw.githubusercontent.com/jab/bidict/master/LICENSE
:alt: License
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
restore download count badge \O/ + improvements to custom.css
2018-08-15 01:44:39 +00:00
.. image:: https://img.shields.io/badge/dynamic/json.svg?label=downloads&url=https%3A%2F%2Fpypistats.org%2Fapi%2Fpackages%2Fbidict%2Frecent%3Fperiod%3Dmonth&query=%24.data.last_month&colorB=blue&suffix=%2fmonth
:target: https://pypistats.org/packages/bidict
:alt: Downloads past month
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
``bidict``:
^^^^^^^^^^^
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
- has been used for many years by several teams at
Google, Venmo, CERN, Bank of America Merrill Lynch, Bloomberg, Two Sigma, and others
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
- has carefully designed APIs for
Various improvements. - Refactor proxied- (i.e. delegated-) to-``_fwdm`` logic for better composability and interoperability. Drop the ``_Proxied*`` mixin classes and instead move their methods into :class:`~bidict.BidictBase`, which now checks for an object defined by the :attr:`~bidict.BidictBase.__delegate__` attribute. The :attr:`~bidict.BidictBase.__delegate__` object will be delegated to if the method is available on it, otherwise a default implementation (e.g. inherited from :class:`~collections.abc.Mapping`) will be used otherwise. Subclasses may set ``__delegate__ = None`` to opt out. - Consolidate ``_MutableBidict`` into :class:`bidict.bidict` now that the dropped mixin classes make it unnecessary. - Change :attr:`~bidict.BidictBase.__repr_delegate__` to take simply a type like :class:`dict` or :class:`list`. - Upgrade to latest major `sortedcontainers <https://github.com/grantjenks/python-sortedcontainers>`__ version (from v1 to v2) for the :ref:`extending:Sorted Bidict Recipes`. - ``bidict.compat.{view,iter}{keys,values,items}`` on Python2 no longer assumes the target object implements these methods, as they're not actually part of the :class:`~collections.abc.Mapping` interface, and provides fallback implementations when the methods are unavailable. This allows the :ref:`extending:Sorted Bidict Recipes` to continue to work with sortedcontainers v2 on Python2. - Test code in docs via Sphinx rather than pytest. Enables running Python version-dependent tests conditionally rather than skipping them altogether, as well as hiding import statements (via `testsetup`) that otherwise just add noise. Run tests (viz. pytest and Sphinx doctest) via a new run-tests.py script.
2018-11-05 20:52:59 +00:00
safety, simplicity, flexibility, and ergonomics
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
- is fast, lightweight, and has no runtime dependencies other than Python's standard library
- integrates natively with Python’s collections interfaces
- is implemented in concise, well-factored, pure (PyPy-compatible) Python code
optimized both for reading and learning from [#fn-learning]_
as well as for running efficiently
- has extensive docs and test coverage
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
(including property-based tests and benchmarks)
Various improvements. - Refactor proxied- (i.e. delegated-) to-``_fwdm`` logic for better composability and interoperability. Drop the ``_Proxied*`` mixin classes and instead move their methods into :class:`~bidict.BidictBase`, which now checks for an object defined by the :attr:`~bidict.BidictBase.__delegate__` attribute. The :attr:`~bidict.BidictBase.__delegate__` object will be delegated to if the method is available on it, otherwise a default implementation (e.g. inherited from :class:`~collections.abc.Mapping`) will be used otherwise. Subclasses may set ``__delegate__ = None`` to opt out. - Consolidate ``_MutableBidict`` into :class:`bidict.bidict` now that the dropped mixin classes make it unnecessary. - Change :attr:`~bidict.BidictBase.__repr_delegate__` to take simply a type like :class:`dict` or :class:`list`. - Upgrade to latest major `sortedcontainers <https://github.com/grantjenks/python-sortedcontainers>`__ version (from v1 to v2) for the :ref:`extending:Sorted Bidict Recipes`. - ``bidict.compat.{view,iter}{keys,values,items}`` on Python2 no longer assumes the target object implements these methods, as they're not actually part of the :class:`~collections.abc.Mapping` interface, and provides fallback implementations when the methods are unavailable. This allows the :ref:`extending:Sorted Bidict Recipes` to continue to work with sortedcontainers v2 on Python2. - Test code in docs via Sphinx rather than pytest. Enables running Python version-dependent tests conditionally rather than skipping them altogether, as well as hiding import statements (via `testsetup`) that otherwise just add noise. Run tests (viz. pytest and Sphinx doctest) via a new run-tests.py script.
2018-11-05 20:52:59 +00:00
run continuously on all supported Python versions and OSes
add "learning from bidict" docs
2018-01-02 20:32:06 +00:00
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
Note: Python 3 Now Required
~~~~~~~~~~~~~~~~~~~~~~~~~~~
prepare for 0.13.1 release
2017-03-15 20:43:23 +00:00
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
As promised in the 0.18.2 release (see :doc:`changelog` [#fn-changelog]_),
**Python 2 is no longer supported**.
Version 0.18.3
docs improvements
2020-01-11 03:31:17 +00:00
is the last release of ``bidict`` that supports Python 2.
This makes ``bidict`` more efficient on Python 3
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
and enables further improvement to bidict in the future.
See `python3statement.org <https://python3statement.org>`__
for more info.
Warn that PY2 support will be dropped in a future release. Also: * Raise ImportError on Python < 2.7, rather than allowing the SyntaxError caused by 2.7+ syntax (e.g. dict comprehensions). * Cosmetic, small refactor of _update().
2019-09-08 13:00:51 +00:00
include usage example in README
2018-02-12 23:51:08 +00:00
Installation
------------
``pip install bidict``
tiny cosmetic docs tweaks
2018-02-13 12:13:24 +00:00
Quick Start
include usage example in README
2018-02-12 23:51:08 +00:00
-----------
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
.. code:: python
>>> from bidict import bidict
>>> element_by_symbol = bidict({'H': 'hydrogen'})
>>> element_by_symbol['H']
'hydrogen'
Rename .inv to .inverse and add an alias for .inv. bidict.BidirectionalMapping.__subclasshook__ now requires an ``inverse`` attribute rather than an ``inv`` attribute for a class to qualify as a virtual subclass. Closes #86.
2019-02-12 03:46:19 +00:00
>>> element_by_symbol.inverse['hydrogen']
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
'H'
include usage example in README
2018-02-12 23:51:08 +00:00
For more usage documentation,
head to the :doc:`intro` [#fn-intro]_
and proceed from there.
Docs tweaks * Fix Tidelift badges. Tidelift broke their URLs: https://forum.tidelift.com/t/new-urls-for-project-badges/288 * hack around more Alabaster CSS issues
2019-09-08 00:04:06 +00:00
Community Support
-----------------
docs tweaks
2017-11-18 04:54:53 +00:00
.. image:: https://img.shields.io/badge/chat-on%20gitter-5AB999.svg?logo=gitter-white
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
:target: https://gitter.im/jab/bidict
:alt: Chat
docs tweaks
2017-11-18 04:54:53 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
If you are thinking of using ``bidict`` in your work,
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
or if you have any questions, comments, or suggestions,
I'd love to know about your use case
Docs tweaks * Fix Tidelift badges. Tidelift broke their URLs: https://forum.tidelift.com/t/new-urls-for-project-badges/288 * hack around more Alabaster CSS issues
2019-09-08 00:04:06 +00:00
and provide as much voluntary support for it as possible.
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
Please feel free to leave a message in the
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
`chatroom <https://gitter.im/jab/bidict>`__
Docs tweaks * Fix Tidelift badges. Tidelift broke their URLs: https://forum.tidelift.com/t/new-urls-for-project-badges/288 * hack around more Alabaster CSS issues
2019-09-08 00:04:06 +00:00
or open a new issue on GitHub.
improve docs
2018-02-24 09:14:42 +00:00
You can search through
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
`existing issues <https://github.com/jab/bidict/issues>`__
improve docs
2018-02-24 09:14:42 +00:00
before creating a new one
in case your questions or concerns have been adressed there already.
docs tweaks
2017-03-17 16:16:45 +00:00
squashed changes for 0.12.0
2016-06-28 04:05:22 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
Enterprise-Grade Support via Tidelift
-------------------------------------
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
Bump to Python 3.8 on Travis and 3.7 on AppVeyor (no 3.8 yet), update to latest pylint (2.4.3) + astroid (2.1.0) + associated code style changes to appease them
2019-10-26 15:03:04 +00:00
.. image:: https://img.shields.io/badge/tidelift-pro%20support-orange.svg
include referral query params in tidelift urls
2018-10-17 15:21:45 +00:00
:target: https://tidelift.com/subscription/pkg/pypi-bidict?utm_source=pypi-bidict&utm_medium=referral&utm_campaign=readme
Docs tweaks * Fix Tidelift badges. Tidelift broke their URLs: https://forum.tidelift.com/t/new-urls-for-project-badges/288 * hack around more Alabaster CSS issues
2019-09-08 00:04:06 +00:00
:alt: Paid support available via Tidelift
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
If your use case requires a greater level of support,
docs improvements
2020-01-11 03:31:17 +00:00
enterprise-grade support for ``bidict`` can be obtained via the
include referral query params in tidelift urls
2018-10-17 15:21:45 +00:00
`Tidelift subscription <https://tidelift.com/subscription/pkg/pypi-bidict?utm_source=pypi-bidict&utm_medium=referral&utm_campaign=readme>`__.
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
docs tweaks
2017-11-18 04:54:53 +00:00
Notice of Usage
---------------
docs improvements
2020-01-11 03:31:17 +00:00
If you use ``bidict``,
improve docs
2018-02-24 09:14:42 +00:00
and especially if your usage or your organization is significant in some way,
please let me know.
readme tweaks
2018-01-16 03:02:08 +00:00
improve docs
2018-02-24 09:14:42 +00:00
You can:
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
- `star bidict on GitHub <https://github.com/jab/bidict>`__
- `create an issue <https://github.com/jab/bidict/issues/new?title=Notice+of+Usage&body=I+am+using+bidict+for...>`__
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
- leave a message in the `chat room <https://gitter.im/jab/bidict>`__
- `email me <mailto:jab@math.brown.edu?subject=bidict&body=I%20am%20using%20bidict%20for...>`__
docs tweaks
2017-11-18 04:54:53 +00:00
various code and CI improvements + dependency updates (#42)
2017-11-16 20:44:51 +00:00
Changelog
---------
more API and code improvements including: - simplify type hierarchy, merging the frozen types into the base types - upgrade to latest hypothesis (3.38.0) - use Reversible for order-sensitive FrozenOrderedBidict.__eq__ - fix bug where bidict._on_dup_kv was not set to ON_DUP_VAL as documented - drop leading underscore from attrs that should be public - improve setup.py/metadata - rename DuplicationBehavior -> DuplicationPolicy - drop ON_DUP_VAL duplication policy in preference to just using None - reduce ordered bidict memory usage and speed up copy
2017-11-20 03:24:08 +00:00
See the :doc:`changelog` [#fn-changelog]_
docs improvements
2020-01-11 03:31:17 +00:00
for a history of notable changes to ``bidict``.
various code and CI improvements + dependency updates (#42)
2017-11-16 20:44:51 +00:00
docs: factor out versioneye prompt from changelog and include in readme too
2017-03-31 18:58:44 +00:00
Release Notifications
various code and CI improvements + dependency updates (#42)
2017-11-16 20:44:51 +00:00
---------------------
docs: factor out versioneye prompt from changelog and include in readme too
2017-03-31 18:58:44 +00:00
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
.. duplicated in CHANGELOG.rst:
(would use `.. include::` but GitHub doesn't understand it)
docs: factor out versioneye prompt from changelog and include in readme too
2017-03-31 18:58:44 +00:00
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
.. image:: https://img.shields.io/badge/libraries.io-subscribe-5BC0DF.svg
:target: https://libraries.io/pypi/bidict
:alt: Follow on libraries.io
docs: factor out versioneye prompt from changelog and include in readme too
2017-03-31 18:58:44 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
Subscribe to releases
`on GitHub <https://github.blog/changelog/2018-11-27-watch-releases/>`__ or
`libraries.io <https://libraries.io/pypi/bidict>`__
to be notified when new versions of ``bidict`` are released.
docs: factor out versioneye prompt from changelog and include in readme too
2017-03-31 18:58:44 +00:00
squashed changes for 0.12.0
2016-06-28 04:05:22 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
Learning from ``bidict``
------------------------
add "learning from bidict" docs
2018-01-02 20:32:06 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
One of the best things about ``bidict``
is that it touches a surprising number of
interesting Python corners,
especially given its small size and scope.
flesh out "learning from bidict" outline
2018-01-03 00:24:44 +00:00
improve docs
2018-02-24 09:14:42 +00:00
Check out :doc:`learning-from-bidict` [#fn-learning]_
if you're interested in learning more.
add "learning from bidict" docs
2018-01-02 20:32:06 +00:00
squashed changes for 0.12.0
2016-06-28 04:05:22 +00:00
Contributing
------------
docs improvements
2020-01-11 03:31:17 +00:00
``bidict`` is currently a one-person operation
maintained on a voluntary basis.
improve docs
2018-02-24 09:14:42 +00:00
Your help would be most welcome!
Reviewers Wanted!
^^^^^^^^^^^^^^^^^
docs improvements
2020-01-11 03:31:17 +00:00
One of the most valuable ways to contribute to ``bidict`` –
and to explore some interesting Python corners [#fn-learning]_
while you're at it –
is to review the relatively small codebase.
improve docs
2018-02-24 09:14:42 +00:00
docs tweaks
2018-03-04 03:16:04 +00:00
Please create an issue or pull request with any improvements you'd propose
or any other results you found.
docs improvements
2020-01-11 03:31:17 +00:00
Submitting a `draft PR <https://github.blog/2019-02-14-introducing-draft-pull-requests/>`__
with feedback in inline code comments, or a
`"Review results" issue <https://github.com/jab/bidict/issues/new?title=Review+results>`__,
would each work well.
improve docs
2018-02-24 09:14:42 +00:00
docs tweaks
2018-03-04 03:16:04 +00:00
You can also
+1 `this issue <https://github.com/jab/bidict/issues/63>`__
to sign up to give feedback on future proposed changes
that are in need of a reviewer.
improve docs
2018-02-24 09:14:42 +00:00
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
Giving Back
^^^^^^^^^^^
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
.. duplicated in CONTRIBUTING.rst
(would use `.. include::` but GitHub doesn't understand it)
docs tweaks
2017-03-17 16:16:45 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
``bidict`` is the product of hundreds of hours of unpaid, voluntary work.
docs tweaks, tidelift
2018-10-17 15:16:43 +00:00
docs improvements
2020-01-11 03:31:17 +00:00
If ``bidict`` has helped you accomplish your work,
docs tweaks
2017-03-17 16:16:45 +00:00
especially work you've been paid for,
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
please consider chipping in toward the costs
docs improvements
2020-01-11 03:31:17 +00:00
of its maintenance and development
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
and/or ask your organization to do the same.
deps, docs linking fixes/improvements, skip benchmarking for now
2016-12-06 23:09:45 +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
.. image:: https://raw.githubusercontent.com/jab/bidict/master/assets/support-on-gumroad.png
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
:target: https://gumroad.com/l/bidict
:alt: Support bidict
squashed changes for 0.12.0
2016-06-28 04:05:22 +00:00
more API and code improvements including: - simplify type hierarchy, merging the frozen types into the base types - upgrade to latest hypothesis (3.38.0) - use Reversible for order-sensitive FrozenOrderedBidict.__eq__ - fix bug where bidict._on_dup_kv was not set to ON_DUP_VAL as documented - drop leading underscore from attrs that should be public - improve setup.py/metadata - rename DuplicationBehavior -> DuplicationPolicy - drop ON_DUP_VAL duplication policy in preference to just using None - reduce ordered bidict memory usage and speed up copy
2017-11-20 03:24:08 +00:00
Finding Documentation
---------------------
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
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
If you're viewing this on `<https://bidict.readthedocs.io>`__,
more API and code improvements including: - simplify type hierarchy, merging the frozen types into the base types - upgrade to latest hypothesis (3.38.0) - use Reversible for order-sensitive FrozenOrderedBidict.__eq__ - fix bug where bidict._on_dup_kv was not set to ON_DUP_VAL as documented - drop leading underscore from attrs that should be public - improve setup.py/metadata - rename DuplicationBehavior -> DuplicationPolicy - drop ON_DUP_VAL duplication policy in preference to just using None - reduce ordered bidict memory usage and speed up copy
2017-11-20 03:24:08 +00:00
note that multiple versions of the documentation are available,
and you can choose a different version using the popup menu at the bottom-right.
Please make sure you're viewing the version of the documentation
docs improvements
2020-01-11 03:31:17 +00:00
that corresponds to the version of ``bidict`` you'd like to use.
more API and code improvements including: - simplify type hierarchy, merging the frozen types into the base types - upgrade to latest hypothesis (3.38.0) - use Reversible for order-sensitive FrozenOrderedBidict.__eq__ - fix bug where bidict._on_dup_kv was not set to ON_DUP_VAL as documented - drop leading underscore from attrs that should be public - improve setup.py/metadata - rename DuplicationBehavior -> DuplicationPolicy - drop ON_DUP_VAL duplication policy in preference to just using None - reduce ordered bidict memory usage and speed up copy
2017-11-20 03:24:08 +00:00
If you're viewing this on GitHub, PyPI, or some other place
that can't render and link this documentation properly
and are seeing broken links,
try these alternate links instead:
update to latest deps; tests + docs improvements
2017-10-11 14:26:20 +00:00
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
.. [#fn-learning] `<docs/learning-from-bidict.rst>`__ | `<https://bidict.readthedocs.io/learning-from-bidict.html>`__
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
.. [#fn-changelog] `<CHANGELOG.rst>`__ | `<https://bidict.readthedocs.io/changelog.html>`__
Docs improvements (incl. refreshed tag line).
2020-01-01 19:11:46 +00:00
.. [#fn-intro] `<docs/intro.rst>`__ | `<https://bidict.readthedocs.io/intro.html>`__
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
various improvements - Make :func:`bidict.FrozenOrderedBidict.__iter__` slightly more efficient. - :func:`~bidict.frozenbidict.__repr__` no longer dynamically checks for a ``__reversed__`` method to determine whether to use an ordered or unordered ``__repr__`` delegate. Now it always just calls the new :func:`~bidict.frozenbidict.__repr_delegate__` instead, which may be explicitly overridden as needed.
2018-02-13 01:34:33 +00:00
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
----
more API and code improvements including: - simplify type hierarchy, merging the frozen types into the base types - upgrade to latest hypothesis (3.38.0) - use Reversible for order-sensitive FrozenOrderedBidict.__eq__ - fix bug where bidict._on_dup_kv was not set to ON_DUP_VAL as documented - drop leading underscore from attrs that should be public - improve setup.py/metadata - rename DuplicationBehavior -> DuplicationPolicy - drop ON_DUP_VAL duplication policy in preference to just using None - reduce ordered bidict memory usage and speed up copy
2017-11-20 03:24:08 +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
Next: :doc:`intro` [#fn-intro]_