Skip to content

Commit 16c80c1

Browse files
committed
Support from_enum description lambda
1 parent 34d03a7 commit 16c80c1

File tree

3 files changed

+67
-5
lines changed

3 files changed

+67
-5
lines changed

graphene/types/enum.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ def eq_enum(self, other):
2121

2222
class EnumOptions(BaseOptions):
2323
enum = None # type: Enum
24+
deprecation_reason = None
2425

2526

2627
class EnumMeta(SubclassWithMeta_Meta):
@@ -45,8 +46,9 @@ def __call__(cls, *args, **kwargs): # noqa: N805
4546
return super(EnumMeta, cls).__call__(*args, **kwargs)
4647
# return cls._meta.enum(*args, **kwargs)
4748

48-
def from_enum(cls, enum, description=None): # noqa: N805
49-
meta_class = type('Meta', (object,), {'enum': enum, 'description': description})
49+
def from_enum(cls, enum, description=None, deprecation_reason=None): # noqa: N805
50+
description = description or enum.__doc__
51+
meta_class = type('Meta', (object,), {'enum': enum, 'description': description, 'deprecation_reason': deprecation_reason})
5052
return type(meta_class.enum.__name__, (Enum,), {'Meta': meta_class})
5153

5254

@@ -56,8 +58,10 @@ class Enum(six.with_metaclass(EnumMeta, UnmountedType, BaseType)):
5658
def __init_subclass_with_meta__(cls, enum=None, **options):
5759
_meta = EnumOptions(cls)
5860
_meta.enum = enum or cls.__enum__
61+
_meta.deprecation_reason = options.pop('deprecation_reason', None)
5962
for key, value in _meta.enum.__members__.items():
6063
setattr(cls, key, value)
64+
6165
super(Enum, cls).__init_subclass_with_meta__(_meta=_meta, **options)
6266

6367
@classmethod

graphene/types/tests/test_enum.py

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
import six
2+
3+
from ..schema import Schema, ObjectType
14
from ..argument import Argument
25
from ..enum import Enum, PyEnum
36
from ..field import Field
@@ -66,6 +69,50 @@ def test_enum_from_builtin_enum():
6669
assert RGB.BLUE
6770

6871

72+
def test_enum_from_builtin_enum_accepts_lambda_description():
73+
def custom_description(value):
74+
if not value:
75+
return "StarWars Episodes"
76+
77+
return 'New Hope Episode' if value == Episode.NEWHOPE else 'Other'
78+
79+
PyEpisode = PyEnum('PyEpisode', 'NEWHOPE,EMPIRE,JEDI')
80+
Episode = Enum.from_enum(PyEpisode, description=custom_description)
81+
82+
class Query(ObjectType):
83+
foo = Episode()
84+
85+
schema = Schema(query=Query)
86+
87+
GraphQLPyEpisode = schema._type_map['PyEpisode'].values
88+
89+
assert schema._type_map['PyEpisode'].description == "StarWars Episodes"
90+
assert GraphQLPyEpisode[0].name == 'NEWHOPE' and GraphQLPyEpisode[0].description == 'New Hope Episode'
91+
assert GraphQLPyEpisode[1].name == 'EMPIRE' and GraphQLPyEpisode[1].description == 'Other'
92+
assert GraphQLPyEpisode[2].name == 'JEDI' and GraphQLPyEpisode[2].description == 'Other'
93+
94+
95+
def test_enum_from_python3_enum_uses_enum_doc():
96+
if not six.PY3:
97+
return
98+
99+
from enum import Enum as PyEnum
100+
101+
class Color(PyEnum):
102+
"""This is the description"""
103+
RED = 1
104+
GREEN = 2
105+
BLUE = 3
106+
107+
RGB = Enum.from_enum(Color)
108+
assert RGB._meta.enum == Color
109+
assert RGB._meta.description == "This is the description"
110+
assert RGB
111+
assert RGB.RED
112+
assert RGB.GREEN
113+
assert RGB.BLUE
114+
115+
69116
def test_enum_value_from_class():
70117
class RGB(Enum):
71118
RED = 1

graphene/types/typemap.py

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,16 +127,27 @@ def construct_scalar(self, map, type):
127127
def construct_enum(self, map, type):
128128
values = OrderedDict()
129129
for name, value in type._meta.enum.__members__.items():
130+
description = getattr(value, 'description', None)
131+
deprecation_reason = getattr(value, 'deprecation_reason', None)
132+
if not description and callable(type._meta.description):
133+
description = type._meta.description(value)
134+
135+
if not deprecation_reason and callable(type._meta.deprecation_reason):
136+
deprecation_reason = type._meta.deprecation_reason(value)
137+
130138
values[name] = GraphQLEnumValue(
131139
name=name,
132140
value=value.value,
133-
description=getattr(value, 'description', None),
134-
deprecation_reason=getattr(value, 'deprecation_reason', None))
141+
description=description,
142+
deprecation_reason=deprecation_reason)
143+
144+
type_description = type._meta.description(None) if callable(type._meta.description) else type._meta.description
145+
135146
return GrapheneEnumType(
136147
graphene_type=type,
137148
values=values,
138149
name=type._meta.name,
139-
description=type._meta.description, )
150+
description=type_description, )
140151

141152
def construct_objecttype(self, map, type):
142153
if type._meta.name in map:

0 commit comments

Comments
 (0)