Python Flask RestPlus Enum Type

Question

Am using python 3.4. I have created an enum type as shown below:

import enum
class EnumGender(enum.Enum):
    blank = ' '
    female = 'Female'
    male = 'Male'
    other = 'Other'

my question is how do i assign it to flask-restplus field as the only examples i can see are:

fields.String(description='The object type', enum=['A', 'B'])

What's your intent here? Are you looking to use the enum field for validation, just for added typing or some other reason? — Oluwafemi Sule, Jan 20 '18 at 20:21
For those in need of enums, consider choices=... https://github.com/noirbizarre/flask-restplus/issues/124 — Erick Stone, Jan 30 '20 at 17:25

score 10 · Accepted Answer · answered Feb 16 '18 at 16:02

10

You can assign the member names to it:

fields.String(description='The object type', enum=EnumGender._member_names_)

answered Feb 16 '18 at 16:02

Kobi Dadon

116
1
5

1

Is it possible to use a enum.IntEnum with fields.Integer? – hygorxaraujo Aug 24 '18 at 01:29
[Docs](https://docs.python.org/3/library/enum.html#iteration) tell me that there is no `Enum._member_names_` but there is `Enum.__members__` which is a view. So you'll have to do `fields.String(description='The object type', enum=EnumGender.__members__.items())`. A little verbose. – tutuca Jan 30 '19 at 19:13
For me __members__items() throws unserializable error, although _member_names_ is protected but it works. – smishra Mar 21 '19 at 13:22

score 4 · Answer 2 · answered Jul 03 '19 at 15:02

4

I have opted for this approach:

fields.String(attribute=lambda x: str(EnumGender(x.FieldContainingEnum).name))

(Source: How to get back name of the enum element in python?)

answered Jul 03 '19 at 15:02

peterrus

662
2
6
16

score 0 · Answer 3 · answered Nov 09 '19 at 02:27

0

Another possibility, Python 3.7.3 (circa Nov 2019):

fields.String(description="The object type",
              enum=[x.name for x in EnumGender])

answered Nov 09 '19 at 02:27

Joe Marley

129
4

score 0 · Answer 4 · answered May 25 '20 at 13:17

in my case having enum like this:

from enum import Enum


class SubscriptionEvent(Enum):
    on_success = "ON_SUCCESS"
    on_error = "ON_ERROR"

I needed definition in marshal like this:

subscription_action_serializer = api.model('SubscriptionAction', {
    'event': fields.String(enum=[x.value for x in SubscriptionEvent], attribute='event.value'),
})

I needed just accept and present as valid enum values "ON_SUCCESS", "ON_SUCCESS"

Python Flask RestPlus Enum Type

4 Answers4