StrEnum

StrEnum is a Python enum.Enum that inherits from str to complement enum.IntEnum in the standard library. Supports python 3.6+.

Installation

You can use pip to install.

pip install StrEnum

Usage

from enum import auto
from strenum import StrEnum


class HttpMethod(StrEnum):
    GET = auto()
    HEAD = auto()
    POST = auto()
    PUT = auto()
    DELETE = auto()
    CONNECT = auto()
    OPTIONS = auto()
    TRACE = auto()
    PATCH = auto()


print(f"An HTTP method: {HttpMethod.GET}")  # prints "An HTTP method: GET"

There are also case-folding versions available:

>>> from pprint import pprint
>>> from enum import auto
>>> from strenum import StrEnum, LowercaseStrEnum, UppercaseStrEnum
>>>
>>> class Regular(StrEnum):
...     Member = auto()
...
>>>
>>> class Lower(LowercaseStrEnum):
...     Member = auto()
...
>>>
>>> class Upper(UppercaseStrEnum):
...     Member = auto()
...
>>>
>>> pprint((Regular.Member, Lower.Member, Upper.Member))
( <Regular.Member: 'Member'>,
    <Lower.Member: 'member'>,
    <Upper.Member: 'MEMBER'>)

Why not enum34-custom's StrEnum?

Because it's not compatible with modern versions of python (see issue).

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please ensure tests pass before submitting a PR. This repository uses Black and Pylint for consistency. Both are run automatically as part of the test suite.

Running the tests

Tests can be run using make:

make test

This will create a virutal environment, install the module and its test dependencies and run the tests. Alternatively you can do the same thing manually:

python3 -m venv .venv
.venv/bin/pip install .[test]
.venv/bin/pytest

License

MIT

N.B. Starting with Python 3.10, enum.StrEnum is available in the standard library. This implementation is not a drop-in replacement for the standard library implementation. Sepcifically, the Python devs have decided to case fold name to lowercase by default when auto() is used which I think violates the principle of least surprise.