Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add EnumString #1885

Closed
wants to merge 6 commits into from
Closed

Add EnumString #1885

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a9f3605
Add EnumString
orenc17 Oct 5, 2021
3d44717
Fix serialize/deserialize mixup
orenc17 Oct 5, 2021
9f52dd6
Fix Inheretence
orenc17 Oct 5, 2021
1313851
Fix Whitspace
orenc17 Oct 6, 2021
a65d058
Fix lint
orenc17 Oct 6, 2021
d986794
Add missing import
orenc17 Oct 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions src/marshmallow/fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import math
import typing
import warnings
import enum
from collections.abc import Mapping as _Mapping

from marshmallow import validate, utils, class_registry, types
Expand Down Expand Up @@ -65,6 +66,7 @@
"Int",
"Constant",
"Pluck",
"EnumString",
]

_T = typing.TypeVar("_T")
Expand Down Expand Up @@ -1989,6 +1991,24 @@ def _serialize(self, value, attr, obj, **kwargs):
return field._serialize(value, attr, obj, **kwargs)


class EnumString(String):
def __init__(self, enum_cls, **kwargs):
if not issubclass(enum_cls, enum.Enum):
raise ValueError("enum_cls must be a subclass of Enum")
super().__init__(**kwargs)
self.enum_cls = enum_cls

def _serialize(self, value, attr, obj, **kwargs):
if not isinstance(value, self.enum_cls):
raise self.make_error("invalid")
return value.name

def _deserialize(self, value, attr, data, **kwargs):
if value is None:
return None
return self.enum_cls[value]


# Aliases
URL = Url
Str = String
Expand Down