Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-31 13:41:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Close issue20653: improve functional API docs; minor code changes

Browse source
This commit is contained in:
Ethan Furman 2014-03-03 12:42:52 -08:00
parent cd9028ca69
commit 9c45444727
2 changed files with 61 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

39
Lib/enum.py
View file

@ -115,14 +115,21 @@ def __new__(metacls, cls, bases, classdict):
# Reverse value->name map for hashable values.
enum_class._value2member_map_ = {}
# check for a supported pickle protocols, and if not present sabotage
# pickling, since it won't work anyway.
# if new class implements its own __reduce_ex__, do not sabotage
if classdict.get('__reduce_ex__') is None:
# If a custom type is mixed into the Enum, and it does not know how
# to pickle itself, pickle.dumps will succeed but pickle.loads will
# fail. Rather than have the error show up later and possibly far
# from the source, sabotage the pickle protocol for this class so
# that pickle.dumps also fails.
#
# However, if the new class implements its own __reduce_ex__, do not
# sabotage -- it's on them to make sure it works correctly. We use
# __reduce_ex__ instead of any of the others as it is preferred by
# pickle over __reduce__, and it handles all pickle protocols.
if '__reduce_ex__' not in classdict:
if member_type is not object:
methods = ('__getnewargs_ex__', '__getnewargs__',
'__reduce_ex__', '__reduce__')
if not any(map(member_type.__dict__.get, methods)):
if not any(m in member_type.__dict__ for m in methods):
_make_class_unpicklable(enum_class)
# instantiate them, checking for duplicates as we go
@ -193,14 +200,22 @@ def __call__(cls, value, names=None, *, module=None, qualname=None, type=None):
to an enumeration member (i.e. Color(3)) and for the functional API
(i.e. Color = Enum('Color', names='red green blue')).
When used for the functional API: `module`, if set, will be stored in
the new class' __module__ attribute; `qualname`, if set, will be stored
in the new class' __qualname__ attribute; `type`, if set, will be mixed
in as the first base class.
When used for the functional API:
Note: if `module` is not set this routine will attempt to discover the
calling module by walking the frame stack; if this is unsuccessful
the resulting class will not be pickleable.
`value` will be the name of the new class.
`names` should be either a string of white-space/comma delimited names
(values will start at 1), or an iterator/mapping of name, value pairs.
`module` should be set to the module this class is being created in;
if it is not set, an attempt to find that module will be made, but if
it fails the class will not be picklable.
`qualname` should be set to the actual location this class can be found
at in its module; by default it is set to the global scope. If this is
not correct, unpickling will fail in some circumstances.
`type`, if set, will be mixed in as the first base class.
"""
if names is None: # simple value lookup