Module enum

source code

This module is designed to be the equivalent of the enum type in other languages. An enumeration object is created at run time, and contains named members that are the enumeration elements.

The enumeration is also a tuple of all of the values in it. You can iterate through the values, perform 'in' tests, slicing, etc. It also includes functions to lookup specific values by name, or names by value.

You can specify your own element values, or use the create factory method to create default Elements. These elements are unique system wide, and are ordered based on the order of the elements in the enumeration. They also are _repr_'d by the name of the element, which is convenient for testing, debugging, and generation text output.

Example Code:

>>>     # Using Element values
>>> Colors = Enumeration.create('red', 'green', 'blue')

>>> # Using explicitly specified values
>>>Borders = Enumeration.create(('SUNKEN', 1),
>>>                                                             ('RAISED', 32),
>>>                                                             ('FLAT', 2))

>>> x = Colors.red
>>> y = Colors.blue

>>> assert x < y
>>> assert x == Colors('red')
>>> assert Borders.FLAT == 2:
>>> assert 1 in Borders