CMD + K

aenum

Community

Advanced Enumerations (compatible with Python's stdlib Enum), NamedTuples, and NamedConstants

Installation

To install this package, run one of the following:

Conda
$conda install jpn::aenum

Usage Tracking

2.0.8
1 / 8 versions selected
Downloads (Last 6 months): 0

Description

Advanced Enumerations (compatible with Python's stdlib Enum), NamedTuples, and NamedConstants

aenum includes a Python stdlib Enum-compatible data type, as well as a metaclass-based NamedTuple implementation and a NamedConstant class.

An Enum is a set of symbolic names (members) bound to unique, constant values. Within an enumeration, the members can be compared by identity, and the enumeration itself can be iterated over. If using Python 3 there is built-in support for unique values, multiple values, auto-numbering, and suspension of aliasing (members with the same value are not identical), plus the ability to have values automatically bound to attributes.

A NamedTuple is a class-based, fixed-length tuple with a name for each possible position accessible using attribute-access notation as well as the standard index notation.

A NamedConstant is a class whose members cannot be rebound; it lacks all other Enum capabilities, however; consequently, it can have duplicate values.

Utility functions include:

  • skip: class that prevents attributes from being converted to a constant or enum member

  • module: inserts NamedConstant and Enum classes into sys.modules where it will appear to be a module whose top-level names cannot be rebound

  • extend_enum: add new members to enumerations after creation

  • enum: helper class for creating members with keywords

  • constant: helper class for creating constant members

About

Summary

Advanced Enumerations (compatible with Python's stdlib Enum), NamedTuples, and NamedConstants

Last Updated

Aug 16, 2017 at 03:03

License

BSD License

Total Downloads

67

Supported Platforms

macOS-64
win-64