Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

A simple alternative to Python 3 enums.

Project Description
Xenum: A simple alternative to Python 3 Enums.
==============================================

Xenum offers a simple alternative to Python 3 enums that's
especially useful for (de)serialization. When you would like
to model your enum values so that they survive jumps to and
from JSON, databases, and other sources cleanly as strings,
Xenum will allow you to do so extremely easily.

Installation
------------

Installation is simple. With python3-pip, do the following:

$ sudo pip install -e .

Or, to install the latest version available on PyPI:

$ sudo pip install xenum

Usage
-----
Just create a basic class with attributes and annotate it with the
``@xenum`` attribute. This will convert all of the class attributes
into Xenum instances and allow you to easily convert them to strings
via ``str(MyEnum.A)`` and from strings via ``MyEnum.by_name("MyEnum.A")``.

Example
-------
::

from xenum import xenum, ctor

@xenum
class Actions:
INSERT = ctor('insert')
UPDATE = ctor('update')
DELETE = ctor('delete')

def __init__(self, name):
self.name = name

assert Actions.INSERT == Actions.by_name('Actions.INSERT')
assert Actions.INSERT().name == 'insert'

Checkout ``test.py`` in the git repo for more usage examples.

Change Log
----------

Version 1.4: September 5th, 2016
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Add 'xenum.sref()' allowing enum values to be instances of the
@xenum annotated class, whos `*args` is prepended with the
Xenum instance itself for self-reference.

Version 1.3: September 4th, 2016
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Add 'xenum.ctor()' allowing enum values to be instances of the
@xenum annotated class.
- Made Xenum instances callable, returning the enum's internal value.

Version 1.2: September 4th, 2016
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Add 'values()' method to @xenum annotated classes for fetching
an ordered sequence of the Xenum entities created.

Version 1.1: August 31st, 2016
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- Made Xenum instances hashable, removed value() as a function.
Release History

Release History

This version
History Node

1.4

History Node

1.3

History Node

1.2

History Node

1.1

History Node

1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
xenum-1.4.tar.gz (4.3 kB) Copy SHA256 Checksum SHA256 Source Sep 6, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting