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

@xenum
class Colors:
  RED = 1
  GREEN = 2
  BLUE = 3

# convert to a string
str_value = str(Colors.RED)
# convert from a string
enum_value = Colors.by_name(str_value)

if Colors.RED == enum_value:
  print('We did it!')

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

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.0.tar.gz (3.7 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for xenum-1.0.tar.gz
Algorithm Hash digest
SHA256 b8892aa37d0d7f05ab4b2327911098b9a0deb5b98ce9860c7dba227c0fe99bda
MD5 cb787f337a143c710d760816ce634c0b
BLAKE2b-256 e7a5818ee7a09d51ebb2c87c0d82bba04d17879a25c72de8652e18b276954a16

See more details on using hashes here.

Release history Release notifications | RSS feed

1.4

1 file

1.3

1 file

1.2

1 file

1.1

1 file

This release

1.0 This release

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