.. image:: https://github.com/hearsaycorp/richenum/actions/workflows/python-version-tests.yml/badge.svg :alt: Build Status
.. image:: https://img.shields.io/pypi/v/richenum.svg :alt: Latest PyPI Version :target: https://pypi.python.org/pypi/richenum/
.. image:: https://img.shields.io/pypi/pyversions/richenum.svg :alt: Python versions :target: https://pypi.org/project/richenum/
.. image:: https://img.shields.io/pypi/dm/richenum.svg :alt: Pypi Downloads :target: https://pypi.org/project/richenum/
A enum library for Python.
enum A simple enum implementation that maps a "variable" to a constant. RichEnum An enum implementation that offers more functionality than a basic enum, hence the name: RichEnum. Provided functionality include specifying a canonical name and a display name. The canonical name should be used if you need to do a lookup or reference in your code. The display name should be used if you need to display text to a user. OrderedRichEnum Exactly like RichEnum but also has an index specified for each enum value. Also, iteration over an OrderedRichEnum will be sorted (ascending) by the enum value's index.
| GitHub <https://github.com/hearsaycorp/richenum>__
| PyPi <https://pypi.python.org/pypi/richenum/>__
.. code:: bash
$ pip install richenum
.. code:: python
>>> from richenum import enum
>>> MY_ENUM = enum(FOO=1, BAR=2)
>>> MY_ENUM.FOO
1
>>> MY_ENUM.BAR
2
.. code:: python
>>> from richenum import RichEnum, RichEnumValue
>>> class MyRichEnum(RichEnum):
... FOO = RichEnumValue(canonical_name="foo", display_name="Foo")
... BAR = RichEnumValue(canonical_name="bar", display_name="Bar")
...
>>> MyRichEnum.FOO
RichEnumValue - canonical_name: 'foo' display_name: 'Foo'
>>> MyRichEnum.from_canonical("foo")
RichEnumValue - canonical_name: 'foo' display_name: 'Foo'
.. code:: python
>>> from richenum import OrderedRichEnum, OrderedRichEnumValue
>>> class MyOrderedRichEnum(OrderedRichEnum):
... FOO = OrderedRichEnumValue(index=1, canonical_name="foo", display_name="Foo")
... BAR = OrderedRichEnumValue(index=2, canonical_name="bar", display_name="Bar")
...
>>> MyOrderedRichEnum.FOO
OrderedRichEnumValue - idx: 1 canonical_name: 'foo' display_name: 'Foo'
>>> MyOrderedRichEnum.from_canonical("foo")
OrderedRichEnumValue - idx: 1 canonical_name: 'foo' display_name: 'Foo'
>>> MyOrderedRichEnum.from_index(1)
OrderedRichEnumValue - idx: 1 canonical_name: 'foo' display_name: 'Foo'
django-richenum Makes RichEnum and OrderedRichEnum available in as model fields and form fields in Django.
| GitHub <https://github.com/hearsaycorp/django-richenum>__
| PyPi <https://pypi.python.org/pypi/django-richenum/>__
enum Starting with Python 3.4, there is a standard library for enumerations. This class has a similar API, but is not directly compatible with that class.
#. Fork the repo from GitHub <https://github.com/hearsaycorp/richenum>__.
#. Make your changes.
#. Add unittests for your changes.
#. Run pep8 <https://pypi.python.org/pypi/pep8>, pyflakes <https://pypi.python.org/pypi/pyflakes>, and pylint <https://pypi.python.org/pypi/pyflakes>_ to make sure your changes follow the Python style guide and doesn't have any errors.
#. Add yourself to the AUTHORS file (in alphabetical order).
#. Send a pull request from your fork to the main repo.
- Remove unavailable link for blog post from README.rst
- Fix README.rst
- Remove six
- Remove python 3.7 support
- Add python 3.9 and 3.10 support
- Remove tox.ini
- ``EnumLookupError`` class now inherits from built-in ``LookupError``.
- added simple ``LookupError`` members that are thrown when
``RichEnum.lookup`` is called for a nonexistent attr/val pair.
Users can choose to catch either the specific ``LookupError`` or
continue to catch ``EnumLookupError``.
- support for Python 3 and PyPy
- Better unicode handling in ``__str__``, ``__unicode__``, and
``__repr__`` magic methods.
- Stop throwing warnings.
- Suppress warnings from mismatched type comparisons when generated
in RichEnum.lookup.
- Raise warnings when comparing enum values to other types, but not
when checking membership or comparing to None.
- Initial public release.
Developed and maintained by Hearsay Social, Inc. <http://hearsaysocial.com>_.
| Adam DePue <http://github.com/adepue>_
| Aron radics <http://github.com/radaron>_
| Akshay Shah <http://github.com/akshayjshah>_
| Dale Hui <http://github.com/dhui>_
| Istvan Nemeth <http://github.com/archiezgg>_
| Robert MacCloy <http://github.com/rbm>_
| Sam Vilain <http://github.com/samv>_
| Wyatt Paul <http://github.com/wyguy444>_
FAQs
Enum library for python.
We found that richenum demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.
Security News
Research
Socket researchers found a malicious Maven package impersonating the legitimate ‘XZ for Java’ library, introducing a backdoor for remote code execution.