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
– Oluwafemi Sule, Commented Jan 20, 2018 at 20:21
For those in need of enums, consider choices=... github.com/noirbizarre/flask-restplus/issues/124 — Erick Stone
– Erick Stone, Commented Jan 30, 2020 at 17:25

Kobi Dadon · Accepted Answer · 2018-02-16 16:02:58Z

10

You can assign the member names to it:

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

answered Feb 16, 2018 at 16:02

Kobi Dadon

1411 silver badge5 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Hygor Over a year ago

Is it possible to use a enum.IntEnum with fields.Integer?

tutuca Over a year ago

Docs 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.

smishra Over a year ago

For me _members__items() throws unserializable error, although _member_names is protected but it works.

peterrus · Accepted Answer · 2019-07-03 15:02:43Z

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 3, 2019 at 15:02

peterrus

6512 gold badges7 silver badges19 bronze badges

Comments

andilabs · Accepted Answer · 2020-05-25 13:17:32Z

1

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"

answered May 25, 2020 at 13:17

andilabs

23.5k14 gold badges126 silver badges159 bronze badges

Comments

Joe Marley · Accepted Answer · 2019-11-09 02:27:29Z

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 9, 2019 at 2:27

Joe Marley

3091 silver badge6 bronze badges

Collectives™ on Stack Overflow

Python Flask RestPlus Enum Type

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

3 Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related