Typing stubs for enum34

1.1.8 · active · verified Mon Apr 13

types-enum34 is a PEP 561 type stub package providing static type information for the `enum34` library. The `enum34` library itself is a backport of Python 3.4's standard library `enum` module, enabling enumeration support for older Python versions (2.4-3.3). This stub package allows type-checking tools like MyPy, PyCharm, and Pytype to analyze code that uses `enum34`. The current version is 1.1.8, released in January 2022, and its development cadence follows contributions to the `typeshed` project.

Warnings

breaking Installing `enum34` (the runtime library for which `types-enum34` provides stubs) on Python 3.4 or newer environments can cause conflicts with the built-in `enum` module. This may lead to unexpected behavior, import issues, or break `pip` itself.
Fix: Do not install `enum34` on Python 3.4 or later. If it's already installed, uninstall it: `pip uninstall enum34`. Python 3.4+ includes `enum` in its standard library, making `enum34` redundant.
gotcha `types-enum34` is a stub package for static type checking. It does not provide the `enum` runtime functionality. You must install the `enum34` package separately (e.g., `pip install enum34`) for the code to run in Python environments older than 3.4.
Fix: Ensure `enum34` is installed alongside `types-enum34` if you are targeting Python versions where `enum` is not part of the standard library (i.e., Python < 3.4).
deprecated The `enum` module became a part of the Python standard library in Python 3.4. The `enum34` backport (and consequently `types-enum34`) is primarily relevant for maintaining compatibility with Python 2.x and earlier Python 3.x versions. New projects targeting Python 3.4+ should use the built-in `enum` module directly and typically do not require `enum34` or `types-enum34`.
Fix: For Python 3.4+, rely on the built-in `enum` module. If type checking is needed, mypy and other tools will automatically find stubs for the standard library module.
gotcha There have been past issues with type checkers like MyPy correctly identifying `types-enum34` as Python 2 compatible when using `--py2` flags, or issues with metadata declarations in `typeshed` affecting stub compatibility.
Fix: Ensure you are using recent versions of your type checker and `types-enum34`. If issues persist, refer to the `typeshed` GitHub repository for the latest status and workarounds.

Install

pip install types-enum34 Install types-enum34
pip install enum34 Install enum34 (runtime library)

Imports

Enum
```
from enum import Enum
```

Quickstart

This quickstart demonstrates how to define and use an enumeration, consistent with the `enum34` library's API (which `types-enum34` provides stubs for). The `types-enum34` package itself does not introduce new runtime functionality; it merely provides static type hints. This code is designed to work with the `enum34` runtime package. For Python versions 3.4 and above, the `enum` module is part of the standard library, rendering `enum34` (and thus `types-enum34`) largely obsolete for new projects.

from enum import Enum
from typing import TYPE_CHECKING

# This example demonstrates usage of enum34 (type-checked by types-enum34)
# Ensure 'enum34' is installed in your Python 2.x or pre-3.4 environment.
# For Python 3.4+, the 'enum' module is built-in.

class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

def get_color_name(color_enum: Color) -> str:
    return color_enum.name

def get_color_value(color_enum: Color) -> int:
    return color_enum.value

if __name__ == '__main__':
    my_color = Color.RED
    print(f"Selected color: {my_color}")
    print(f"Name: {get_color_name(my_color)}")
    print(f"Value: {get_color_value(my_color)}")

    # Example of type checking with mypy (assuming mypy is run externally)
    # if TYPE_CHECKING:
    #     reveal_type(my_color)
    #     # The following would ideally be flagged by a type checker if `enum34` was in use and `types-enum34` enabled
    #     # get_color_name('invalid_string') # type: ignore

view raw JSON →