m4sk1n/calendar-social
1
0
Fork 0
forked from gergely/calendar-social
Code Issues Pull Requests Releases Wiki Activity

Document the EnumField form field type

Browse Source
This commit is contained in:
Gergely Polonkai 2018-07-16 13:33:25 +02:00
parent a763662cd6
commit 43a90a237f
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
calsocial/forms.py
View File

@ -174,6 +174,16 @@ class TimezoneField(SelectField):
class EnumField(SelectField): class EnumField(SelectField):
"""Field that allows selecting one value from an ``Enum`` class
:param enum_type: an ``Enum`` type
:type enum_type: type(Enum)
:param translations: translatable labels for enum values
:type translations: dict
:param args: passed verbatim to the constructor of `SelectField`
:param kwargs: passed verbatim to the constructor of `SelectField`
"""
def __init__(self, enum_type, translations, *args, **kwargs): def __init__(self, enum_type, translations, *args, **kwargs):
if not issubclass(enum_type, Enum): if not issubclass(enum_type, Enum):
raise TypeError('enum_type must be a subclass of Enum') raise TypeError('enum_type must be a subclass of Enum')