Serialising an Enum member to JSON

by

I know this is old but I feel this will help people. I just went through this exact problem and discovered if you’re using string enums, declaring your enums as a subclass of str works well for almost all situations:

import json
from enum import Enum

class LogLevel(str, Enum):
    DEBUG = 'DEBUG'
    INFO = 'INFO'

print(LogLevel.DEBUG)
print(json.dumps(LogLevel.DEBUG))
print(json.loads('"DEBUG"'))
print(LogLevel('DEBUG'))

Will output:

LogLevel.DEBUG
"DEBUG"
DEBUG
LogLevel.DEBUG

As you can see, loading the JSON outputs the string DEBUG but it is easily castable back into a LogLevel object. A good option if you don’t want to create a custom JSONEncoder.

More Related Contents:

  1. How to make a class JSON serializable
  2. How can I represent an ‘Enum’ in Python?
  3. How to get string objects instead of Unicode from JSON?
  4. Why Python 3.6.1 throws AttributeError: module ‘enum’ has no attribute ‘IntFlag’?
  5. Making object JSON serializable with regular encoder
  6. How to JSON serialize sets?
  7. Serializing class instance to JSON
  8. How I can I lazily read multiple JSON values from a file/stream in Python?
  9. Let JSON object accept bytes or let urlopen output strings
  10. is not JSON serializable
  11. Convert a python dict to a string and back
  12. django-rest-framework 3.0 create or update in nested serializer
  13. Trying to parse `request.body` from POST in Django [duplicate]
  14. Flask jsonify a list of objects
  15. Getting value of enum on string conversion
  16. Is it possible to define a class constant inside an Enum?
  17. pandas.io.json.json_normalize with very nested json
  18. OpenAI GPT-3 API error: “Cannot specify both model and engine”
  19. List of objects to JSON with Python
  20. Type annotations for Enum attribute
  21. How to extend Python Enum?
  22. String-based enum in Python
  23. TypeError: Object of type ‘bytes’ is not JSON serializable
  24. Serializing list to JSON [duplicate]
  25. json.decoder.JSONDecodeError: Extra data: line 2 column 1 (char 190) [duplicate]
  26. Json Encoder AND Decoder for complex numpy arrays
  27. A more pythonic way to define an enum with dynamic members
  28. Handle JSON Decode Error when nothing returned
  29. How to properly use the “choices” field option in Django
  30. What difference between pickle and _pickle in python 3?

Leave a Comment