Repository files navigation

The bidirectional mapping library for Python.

• has been used for many years by several teams atGoogle, Venmo, CERN, Bank of America Merrill Lynch, Bloomberg, Two Sigma, and many others
• has carefully designed APIs forsafety, simplicity, flexibility, and ergonomics
• isfast, lightweight, and has no runtime dependencies other than Python's standard library
• integrates natively with Python’scollections.abc interfaces
• providestype hints for all public APIs
• is implemented inconcise, well-factored, pure (PyPy-compatible) Python codethat isoptimized for running efficientlyas well as forreading and learning[1]
• hasextensive docs and test coverage(including property-based tests and benchmarks)run continuously on all supported Python versions

pip install bidict

>>>frombidictimportbidict>>>element_by_symbol=bidict({'H':'hydrogen'})>>>element_by_symbol['H']'hydrogen'>>>element_by_symbol.inverse['hydrogen']'H'

For more usage documentation,head to theintro[3]and proceed from there.

Please feel free to leave a message in thebidict chatroomor open a new issue on GitHubfor voluntary community support.You can search throughexisting issuesbefore creating a new onein case your issue has been addressed already.

Enterprise-level support for bidict can be obtained via theTidelift subscription.

If you use bidict,and especially if your usage or your organization is significant in some way,please let me know in any of the following ways:

• star bidict on GitHub
• create an issue
• leave a message in thechat room
• email me

See thechangelog[2]for a history of notable changes to bidict.

Watch releaseson GitHub orlibraries.ioto be notified when new versions of bidict are released.

One of the best things about bidictis that it touches a surprising number ofinteresting Python corners,especially given its small size and scope.

Check outlearning-from-bidict[1]if you're interested in learning more.

bidict is currently a one-person operationmaintained on a voluntary basis.

Your help would be most welcome!See thecontributors-guide[4]for more information.

Bidict is the product of thousands of hours of my unpaid workover the 12+ years I've been maintaining it.

If bidict has helped you accomplish your work,especially work you've been paid for,it's easy tosponsor me through GitHub.

Choose a tier and GitHub handles everything else.The sponsorship just goes on your regular GitHub bill;there's nothing extra to do.You can also sponsor me throughGumroad orPayPal.

Read more aboutcompanies supporting open source developers.

If you're viewing this onhttps://bidict.readthedocs.io,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 documentationthat corresponds to the version of bidict you'd like to use.

If you're viewing this on GitHub, PyPI, or some other placethat can't render and link this documentation properlyand are seeing broken links,try these alternate links instead:

Next:intro[3]