Skip to main content

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.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.

Download files

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

Source Distribution

xenum-1.3.tar.gz (4.1 kB view details)

Uploaded Source

File details

Details for the file xenum-1.3.tar.gz.

File metadata

  • Download URL: xenum-1.3.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for xenum-1.3.tar.gz
Algorithm Hash digest
SHA256 e643a083fbf9e01a32db723a20b8b024ad8a2c3aaa634033b5219ee90945552d
MD5 facd3a313cbca995035e989b08283c5a
BLAKE2b-256 d60af856dbb2b148765715c3de467021d700f04f16c0f1d87e2367afc63f5c79

See more details on using hashes here.

Release history Release notifications | RSS feed

1.4

1 file

This release

1.3 This release

1 file

1.2

1 file

1.1

1 file

1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page