Skip to main content

User friendly implementation of Enum in Python

Project description

Build Status Coverage Status PyPI Status Python Version

User friendly implementation of documented Enum type for Python language.

Installation

$ pip install easy_enum

To install the latest version from master branch execute in shell following commands:

$ pip install -U https://github.com/molejar/pyEnum/archive/master.zip

In case of development, install pyEnum from sources:

$ git clone https://github.com/molejar/pyEnum.git
$ cd pyEnum
$ pip install -U -e .

You may run into a permissions issues running these commands. Here are a few options how to fix it:

  1. Run with sudo to install pyEnum and dependencies globally
  2. Specify the --user option to install locally into your home directory (export “~/.local/bin” into PATH variable if haven’t).
  3. Run the command in a virtualenv local to a specific project working set.

Usage

Example for Basic Enum (Enum):

from easy_enum import Enum

class TestEnum(Enum):

    # item with no description
    FIRST_ITEM  = 1

    # item with description
    SECOND_ITEM = (2, 'Description for second item')

    # item with description and custom string name
    THIRD_ITEM  = (3, 'third', 'Description for third item')

    # item with custom string name (the description must be specified as empty string)
    FOURTH_ITEM = (4, 'fourth', '')


# Usage
print(TestEnum.SECOND_ITEM)    # 2
print(TestEnum['FIRST_ITEM'])  # 1
print(TestEnum[1])             # 'FIRST_ITEM'
print(TestEnum[3])             # 'third'
print(TestEnum['third'])       # 3
print(len(TestEnum))           # 4
for name, value, desc in TestEnum:
    print('{} = {} ({})'.format(name, value, desc))

Example for Extended Enum (EEnum):

from easy_enum import EEnum as Enum

class TestEnum(Enum):

    # item with no description
    FIRST_ITEM  = 1

    # item with description
    SECOND_ITEM = (2, 'Description for second item')

    # item with description and custom string name
    THIRD_ITEM  = (3, 'third', 'Description for third item')

    # item with custom string name (the description must be specified as empty string)
    FOURTH_ITEM = (4, 'fourth', '')

# Usage of extended features
print(TestEnum.is_valid(1))       # True
print(TestEnum.is_valid('first')) # False
print(TestEnum.is_valid('third')) # True
print(TestEnum.desc(1))           # ''
print(TestEnum.desc(2))           # 'Description for second item'
print(TestEnum.desc('third'))     # 'Description for third item'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy_enum-0.1.0.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

easy_enum-0.1.0-py3-none-any.whl (8.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page