{|j> d dl Z d dlZd dlmZmZ d dlmZ d dl m
Z
g dZ dxZ xZ
xZxZZ G d de Z G d d e Zd
Zd Zd Zd
Zd Zd Zd Zd Zd Z dDdZ d Z G d d Z e Z G d d Z e Z G d d Z! G d d e Z" G d d Z# G d d e$ Z% G d! d"e& Z'e'Z( G d# d$e'% Z G d& d'e Z G d( d)e)e Z* G d* d+e+e Z,d, Z-e-Z.d- Z/ G d. d/e, Z0e0\ Z1Z2ZZ3 G d0 d1e e12 Z
G d3 d4e)ee
e32 Z4d5 Z5d6 Z6d7 Z7d8 Z8d9 Z9d: Z:dEd;Z;e fddd<d=Z< e d? Z=e=\ Z>Z?Z@ G d@ dA ZAdB ZBdDdd2dCZCe*e,e4fZy)F N)MappingProxyTypeDynamicClassAttribute)or_)reduce) EnumTypeEnumMetaEnumIntEnumStrEnumFlagIntFlagReprEnumautouniquepropertyverifymember nonmember FlagBoundarySTRICTCONFORMEJECTKEEPglobal_flag_reprglobal_enum_repr
global_str global_enum EnumCheck
CONTINUOUS NAMED_FLAGSUNIQUEpickle_by_global_namepickle_by_enum_namec e Zd ZdZd Zy)r zK
Protects item from becoming an Enum member during class creation.
c || _ y Nvalueselfr( s /usr/lib64/python3.12/enum.py__init__znonmember.__init__
N__name__
__module__ __qualname____doc__r, r. r+ r r r. r c e Zd ZdZd Zy)r zE
Forces item to become an Enum member during class creation.
c || _ y r& r' r) s r+ r, zmember.__init__# r- r. Nr/ r4 r. r+ r r r5 r. r c R t | d xs t | d xs t | d S )z?
Returns True if obj is a descriptor, False otherwise.
__get____set__
__delete__)hasattr)objs r+ _is_descriptorr> & s1
C #
' C #
' C &r. c v t | dkD xr* | dd | dd cxk( xr dk( nc xr | d dk7 xr | d dk7 S )z=
Returns True if a __dunder__ name, False otherwise.
N ___lennames r+
_is_dunderrJ 0 sT
IM
!HRS )T )
GsN
HO r. c v t | dkD xr* | d | d cxk( xr dk( nc xr | dd dk7 xr | dd dk7 S )z;
Returns True if a _sunder_ name, False otherwise.
rA r rD rB rF rH s r+
_is_sunderrN ; sV
IM
GtBx &3 &
1I
BK3 r. c t |t syt |dd }| dz t |dd z }d|z }||k( xs |j | S )NFr2 .r0 )
isinstancetypegetattrendswith)cls_namer= qualname s_pattern e_patterns r+ _is_internal_classrZ F sX c4 sNB/H3j"!==IiI y @H$5$5i$@@r. c d| d}t | }t | |kD r.|j | r |||dz dgk7 r|d dk7 s|d dk7 ryy)NrD rC rM rL rB TF)rG
startswith)rV rI patternpat_lens r+ _is_privater_ O s[ !$G'lG I (WWQY'C50bS DHOr. c ( | dk( ry| | dz
z } | dk( S )z<
True if only one bit set in num (should be an int)
r FrM r4 )nums r+ _is_single_bitrb ] s$ ax37NC !8Or. c t d }t | t r || d< d| d< yt | d| t | dd y)z]
Make the given obj un-picklable.
obj should be either a dictionary, or an Enum
c t d| z )Nz%r cannot be pickled) TypeErrorr* protos r+ _break_on_call_reducez6_make_class_unpicklable.._break_on_call_reducel s .566r.
__reduce_ex__z r1 N)rR dictsetattr)r= rh s r+ _make_class_unpicklablerl f s> 7#t 4O 'L_&;<\;/r. c # K | }t | t r | j } | dk rt d|z | r| | dz z }| | |z } | ry y w)Nr z %r is not a positive integerrM )rR r r(
ValueError)ra originalbs r+ _iter_bits_lsbrq u s\ H#t ii
Qw7(BCC
C4!8 q s AA
A
c * t t | S r& )listrq r' s r+ show_flag_valuesrt s u% &&r. c $ d| j z }| dk\ r*t j | |z j ddd }n t j | |dz
|z z }|dd }|dd }| t | |k r|d |z |z | d }|d |S )
z
Like built-in bin(), except negative values are represented in
twos-compliment, and the leading bit always indicates sign
(0=positive, 1=negative).
>>> bin(10)
'0b0 1010'
>>> bin(~10) # ~10 is -11
'0b1 0101'
rA r 10rM N rL )
bit_lengthbltnsbinreplacerG )ra max_bitsceilingssigndigitss r+ r| r| s C##%%G
ax IIcGm $ , ,S#q 9 IIsdgkW 44 5 Ra5D
qrUF v; !2h)F2XIJ?FF ##r. c | j d }d}t |d D ] \ }}|dk7 s n t | D ]
\ }}|d ||< dj | S )zM
Like textwrap.dedent. Rewritten because we cannot import textwrap.
r ry N)split enumeratejoin)textlinesblanksichjls r+ _dedentr sk
JJt E
F58$2
9 % % 1QR5a ! 99U r. c e Zd Zd Zy)
_not_givenc y)Nz r4 r* s r+ __repr__z_not_given.__repr__ s r. Nr0 r1 r2 r r4 r. r+ r r s r. r c e Zd Zd Zy)
_auto_nullc y)Nr r4 r s r+ r z_auto_null.__repr__ s r. Nr r4 r. r+ r r s r. r c e Zd ZdZefdZd Zy)r zP
Instances are replaced with an appropriate value in Enum class suites.
c || _ y r& r' r) s r+ r, z
auto.__init__ r- r. c d| j z S )Nzauto(%r)r' r s r+ r z
auto.__repr__ s DJJ&&r. N)r0 r1 r2 r3 r r, r r4 r. r+ r r s ( 'r. r c 6 e Zd ZdZdZdZdZddZd Zd Z d Z
y)r aI
This is a descriptor, used to define attributes that act differently
when accessed through an enum member and through an enum class.
Instance access is the same as property(), but access to an attribute
through the enum class will instead look in the class' _member_map_ for
a corresponding enum member.
Nc |2| j | j S t |d| j | j | j | S | j dk( r t | j | j S | j dk( r t |j | j S |j | j S # t $ r t |d| j d w xY w)Nz has no attribute attrdesc)
r AttributeErrorrI fget
_attr_typerT _cls_type_value_ _member_map_KeyError)r* instance
ownerclasss r+ r9 zproperty.__get__ s {{&{{"$4> J 99 99X& &
__
&4>>4995 5
__
&8++TYY7 7 **4995 5 0:DIIF
s 1C
%C/c | j | j || S t d| j d| j )N cannot set attribute )fsetr clsnamerI )r* r r( s r+ r: zproperty.__set__ s: 99 99Xu- - 7;||TYYO r. c | j | j | S t d| j d| j )Nr z> cannot delete attribute )fdelr r rI )r* r s r+ r; zproperty.__delete__ s8 99 99X& & :>,, R r. c 4 || _ |j | _ y r& )rI r0 r )r* r rI s r+ __set_name__zproperty.__set_name__ s !** r. r& ) r0 r1 r2 r3 r r r r9 r: r; r r4 r. r+ r r s, FJI 2+r. r c e Zd ZdZd Zd Zy)
_proto_memberzW
intermediate step for enum members between class execution and final creation
c || _ y r& r' r) s r+ r, z_proto_member.__init__ r- r. c t || | j }t |t s|f}n|}|j t u r|f}|j
s|j
| }n |j |g| }t |d s/|j t u r||_ n |j | |_ |j }||_
||_ |j | t! |j" |_ t& zt) |t& rjt |t* r5|xj, |z c_ t/ | r|xj0 |z c_ d|j, j3 z dz
|_ |j6 | }d}
d} d} |j@ dd D ]\ }
|
jB jE | }|!t |tF tH f r|}
|
} d} n tK | r|}
| xs d} | xs |
} Yd} |
} ^ |
rtG }||_& |jO || | d v rltQ |
d
d |_) tQ |
d d |_* tQ |
d d |_+ tQ |
d
d |_, tQ |
dd |_- tQ |
dd |_. | |_/ | |_0 tc ||| n
tc ||| ||j8 |< |j6 je || y# t $ r}t d }||_ |d}~ww xY w# t $ r? |j8 j; D ] \ }} | j |k( s| } n t< Y w xY w# t< $ r t& t) |t& s |j" j? | nLt& Ft) |t& r6t |t* r&t/ | r|j" j? | Y Yw xY w# t $ r |jf j? | Y yw xY w)zR
convert each quasi-member into an instance of the new enum class
r z/_value_ not set in __new__, unable to create itNrA rM enumr r )r r r r9 r r: r r; )4delattrr( rR tuple
_member_type_
_use_args_ _new_member_r< objectr Exceptionre __cause___name_ __objclass__r, rG _member_names_ _sort_order_r
issubclassint _flag_mask_rb _singles_mask_rz
_all_bits__value2member_map_r itemsr append__mro____dict__getr r r> r r rT r _getr _setr _delr r rk
setdefault_unhashable_values_)r*
enum_class member_namer( args enum_memberexcnew_excrI canonical_memberfound_descriptordescriptor_type
class_typebaser redirects r+ r z_proto_member.__set_name__ s
K(
%'9DD # #u ,8D$$$11*=K1*11*DtDK{I.''61&+ #"*B**B*BD*IK' ## ( #- d##&z'@'@#A
:t <%%&&%/&!%( --6-$%:+A+A*M*M*O$PST$TJ ! >
# ( ; ;E B 4
&&qr*D==$$[1D dX/D$EF'+$!%J&,O#D)'+$&5&?O!+!3tJ &,O!%J + zH )HO ! !*k : /1 '(8&$ G
'(8)T J
'(8&$ G
'(8)T J
'(8&$ G
'(8, M
"1H !+H J X 6 J [ 9/:
, 9
) ) 4 4UK Hy ! " ' M G ),G%!M "2
#.8.E.E.K.K.M*D*'//58&6 /N
#N
# > L%j$7 ))00=$":t4"5#.&u- ))00=! >z 9 * * 1 1% 8 9s[ K# 5L O! # L,L L8M M M MM BO O !$PPN)r0 r1 r2 r3 r, r r4 r. r+ r r s w9r. r c 2 e Zd ZdZ fdZ fdZd Z xZS ) _EnumDictz
Track enum member order and ensure member names are not reused.
EnumType will use the names found in self._member_names as the
enumeration member names.
c Z t | i | _ g | _ g | _ d| _ y )NF)superr,
_member_names _last_values_ignore _auto_called)r* __class__s r+ r, z_EnumDict.__init__ s-
!r. c @ t | j | r ddl}|j dt d t | j | rnt
| r|dvrt d|d |d k( rD| j r t d
t |t r |j n|}t | d | nH|d k( rBt |t r!|j d
d j! }n t# | }|| _ t' | t' | j( z }|rt d| t+ | r
|dk( rd}n|| j( v rt |d| | || j$ v rnt |t, r|j. }nit1 | rn\|| v rt |d| | t |t2 r |j. }d}d}t |t4 rd}|f}t |t6 rt9 d |D rg }t; | } |D ] }
t |
t4 r|d}|
j. t< k( r@| j? |dtA | j( | jB dd |
_ d| _ |
j. }
| jB jE |
|jE |
|r|d }n | | }d| j( |< |r| jB jE | tF | || y# t $ r | | }Y Mw xY w)z
Changes anything not dundered or not a descriptor.
If an enum member name is used twice, an error is raised; duplicate
values are not checked for.
Single underscore (sunder) names are reserved.
r NzzIn 3.13 classes created inside an enum will not become a member. Use the `member` decorator to keep the current behavior.rA
stacklevel)_order__generate_next_value__numeric_repr_ _missing__ignore_
_iter_member__iter_member_by_value__iter_member_by_def_z_sunder_ names, such as z", are reserved for future Enum user z4_generate_next_value_ must be defined before members_generate_next_valuer ,ry z+_ignore_ cannot specify already set names: __order__r z already defined as TFc 3 < K | ] }t |t y wr& )rR r ).0vs r+ z(_EnumDict.__setitem__.. s /SU
1d0CUs rM )%rZ _cls_namewarningswarnDeprecationWarningr_ rN rn r re rR staticmethod__func__rk strr} r rs r setr rJ r r( r> r r r anyrS r r rG r r r __setitem__) r* keyr( r _gnvalreadynon_auto_storesingle auto_valuedtr r s r+ r z_EnumDict.__setitem__ s dnne 4 MMO&
t~~s +
_
! " --$$#$Z[[)3E<)Hu~~e 4d;
" eS) !MM#c 2 8 8 :E KE $ e*s4+=+='>>$ & * _k!
D&&
&#tCy IJ J
DLL
y
)KKE
E
" d{ c49 MNNE6* !NF%& %'C/SU/S,S ! K A!!T*). 77j0&*&?&?$'C0B0B,CTEVEVWXEY'&AG 15D - GG ))003 &&q) 'NE0 !+ '+D s # !!((/
C'
% 0 !;0s L L L c |j D ]
}|| | |< |j D ]
\ }}|| |< y # t $ r |D ]
\ }}|| |< Y 8w xY wr& )keysr r )r* members more_membersrI r( s r+ updatez_EnumDict.update sn # $T]T
'
(--/KD% DJ 0 # & e "T
' #s > AA)r0 r1 r2 r3 r, r r
__classcell__r s @r+ r r x s "i(V r. r c . e Zd ZdZed Zddd fd
Zd Zefdddddd d
Z d Z
fd Z d
Z d Z
d Zd Zej" d Zd Zd Z fdZdddddd dZd ddddZed Zed Zed Zed Zed Z xZ S ) r z
Metaclass for Enum
c | j || t }||_ | j || \ }}|t |dd |d< |S )Nr ) _check_for_existing_members_r r _get_mixins_rT )metaclsclsbaseskwds enum_dict member_type
first_enums r+ __prepare__zEnumType.__prepare__ s` ,,S%8 K ! ")"6"6sE"B Z !18 72I- . r. NFboundary_simplec | |rt | | |||fi |S |j dg j d |d }|D ] }|j |d |j
} t
| ddhz }
|
r$t ddj d |
D z |j dd } |j d } | t | t ur t | } t |j }| | |d< | j || \ }
}| j ||
| \ }}}||d < ||d
< | D ] }|| }t! | ||< g |d < i |d < i |d
< g |d< |
|d< | j# || |d< |xs
t% |dd |d< d|d< d|d< d|d< d |d< t | | |||fi |}|j- |j. t0 t0 |v r{|
t2 u r t5 d d|vr |
j6 |_ |j6 |d< d|vr@|
j8 }|t2 j8 u r |
j: }||_ |j8 |d< dD ]O }||vst% || }t% || }t% t2 | }t% |
| }|||fv sCt= ||| Q t> >tA |t> r.d D ]) }||vst% t> | }t= ||| |||< + tB |r||_" tB j |_ | 0tG | tH r | jK dd jM } t> |d k7 st> MtA |t> s=tO |d tO |d tO |d tO |d tO |d nt> tA |t> ro|D cg c] }|jP } }| tS | k7 r|jT |_+ | r5| D cg c]* } | |jX vst[ || jP r| , } } | rc| D cg c]. } | |jX vs | |jX v r| |j\ v r| 0 } } | |j\ k7 rt5 d |j\ d | |S # t& $ r}t) |d r|` d }~ww xY wc c}w c c} w c c} w )!Nr mrorP z invalid enum member name(s) %sr c 3 2 K | ] }t | y wr& )repr)r ns r+ r z#EnumType.__new__..& s %D *+ 15I- . #*"6"6sE"B Z&-&8&8;
'#8 %, .!"* , !D dOE +E 2IdO !
') "#$& .!*, &'+- '(%0 /"$+$<$(>
%*4*?*? ,' )$,,V^^+ ) 1 1F%+
"'1'9'9 )$JD9$ %j$ 7 &z4 8 ' 5
#*;#= $4m#DDJk: K
:t <
y(")$"5KJk:&1IdO ,3
)!% J '3'!//#s399; #Jz4,H J - J
. J 0 1 J - J -
*Z">.89j199jK9f[ 11+5+J+J
( ")!(A J$;$;;~jYZmNcNc?d !( % $!8!88j 5 55!z?X?X:X $
*333 %44g?
i q+&K p :
s* R =R/7/R4.3R9 R,R''R,c y)z6
classes/types should always be True.
Tr4 r s r+ __bool__zEnumType.__bool__ s r. rM )modulerW rS startr c | j r!|t ur||f|z }| j | | S |t u r|t | d | j ||t u rdn|||||| S )ab
Either returns an existing member, or creates a new enum class.
This method is used both when an enum class is given a value to match
to an enumeration member (i.e. Color(3)) and for the functional API
(i.e. Color = Enum('Color', names='RED GREEN BLUE')).
The value lookup branch is chosen if the enum is final.
When used for the functional API:
`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 `start`), 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.
NzM has no members; specify `names=()` if you meant to create a new, empty, enum)
class_namenamesrL rW rS rM r )r r r4 re _create_) r r( rP rL rW rS rM r valuess r+ __call__zEnumType.__call__ s 6 J& /;;sE* * J 4<ehi
|| #z 1du !! r. c j t || ry | | y# t $ r || j v cY S w xY w)zReturn True if `value` is in `cls`.
`value` is in `cls` if:
1) `value` is a member of `cls`, or
2) `value` is the value of one of the `cls`'s members.
3) `value` is a pseudo-member (flags)
T)rR rn r r r( s r+ __contains__zEnumType.__contains__ s@ eS ! 4 J 4C 3 33 3 4s 22c v || j v rt | j d|d t | | y )Nz cannot delete member rQ )r r r0 r __delattr__)r r r s r+ rX zEnumType.__delattr__ s5 3## # #,,PT!UV V
D!r. c x t g d| j z }| j t j ur|j d | j t j ur|j d | j t u r t | S t t t | j |z S )N)
r rV r3 __getitem____iter____len__ __members__r1 r0 r2 r4 __init_subclass__)
r r r r r4 addr^ r r9 dir)r interestings r+ __dir__zEnumType.__dir__ s
$$ % 6>> 1 OOI & (@(@ @ OO / 0 &+& & #c#"3"3 45 CD Dr. c | j | S )z4
Return the member matching `name`.
r )r rI s r+ rZ zEnumType.__getitem__) s %%r. c . fd j D S )z5
Return members in definition order.
c 3 < K | ] }j | y wr& rd r rI r s r+ r z$EnumType.__iter__..3 s F3E4 &3E r rJ s `r+ r[ zEnumType.__iter__/ s G33E3EFFr. c , t | j S )z;
Return the number of members (no aliases)
)rG r rJ s r+ r\ zEnumType.__len__5 s 3%%&&r. c , t | j S )z
Returns a mapping of member name->value.
This mapping lists all enum members, including aliases. Note that this
is a read-only view of the internal mapping.
)r r rJ s r+ r] zEnumType.__members__; s 0 011r. c j t t | t rd| j z S d| j z S )Nz z )r r r0 rJ s r+ r zEnumType.__repr__E s/
3 5 - - - -r. c @ fdt j D S )z=
Return members in reverse definition order.
c 3 < K | ] }j | y wr& rd rg s r+ r z(EnumType.__reversed__..O s P3O4 &3Orh )reversedr rJ s `r+ __reversed__zEnumType.__reversed__K s Q8C value pairs.
Nr ry r r4 rA r0 r1 r2 r )r r r rR r r} r r rs r r r sys_getframemodulenamer _getframe f_globalsrn r rl r4 )r rO rP rL rW rS rM r r r rD r r: original_names last_valuescountrI r( itemr member_values r+ rQ zEnumType._create_^ s -- <dC[((U;
:''
E: eS !MM#s+113E eeT] +*U1Xs:S$)2EN K ( 8 t"88ue[YZ^\""5) dE]+ 9 =E D$$,0%+\ ,0) \%1Ik " >
003 > #I .&,Il # (0In %w
E9xXX "
]]1 - 7 7
CF&
H=
s6 E! ! F++"F
F+F%"F+$F%%F+*F+)r as_globalc r t j | j }|r
|j }n|}|j D cg c] \ }} || r||f } }} | j d | D
ci c] }
|
d |
d
} }
|| d< t
t f| } t | |xs t | } |r t | n@t j | j j j | j | ||< | S c c}}w # t
$ r | j d Y w xY wc c}
w )z[
Create a new Enum subclass that replaces a collection of global constants
c | d | d fS NrM r r4 r s r+ z$EnumType._convert_.. s !ad|r. r c | d S Nr r4 r s r+ r z$EnumType._convert_.. s qtr. r rM r1 )etyper )rv modulesr r sortre rS r _simple_enumr r r1 r r] )
r rI rL filtersourcer r module_globalsr( r r bodytmp_clss
r+ _convert_zEnumType._convert_ s/ V,55 __F#F $*<<>!#1KD%$< u
#1 ! - LL 3L 4 %,,Gq!ad
G, #\tfZ.@lx/?4@I KK ' 0 0 7 7 H "t
'! - LL^L , - -s D D 3D4 D10D1c |D ]A }|j D ]0 }t |t s|j s!t d|d| C y )Nr z> cannot extend )r rR r r re mclsrO r chainr s r+ r z%EnumType._check_for_existing_members_ sC E
dH-$2E2E# )4 1 & r. c |s t t fS |d }t |t s t d | j || xs t }||fS )z
Returns the type for creating enum members, and the first inherited
enum class.
bases: the tuple of bases that was given to __new__
rL zZnew enumerations should be created as `EnumName([mixin_type, ...] [data_type,] enum_type)`)r r rR r re _find_data_type_)r rO r r r s r+ r zEnumType._get_mixins_ s] 4< 2Y
*h/ K L
L++J>H& J&&r. c F |D ] }|j D ] }|t u r t |t r|j c c S d|j
v s;d|j
v r1d|j
v r#|j
d j r
t c c S |j
d c c S y )Nr __dataclass_fields____dataclass_params__)r r rR r r& r r# _dataclass_reprr s r+ r7 zEnumType._find_data_repr_ s E
6> h/ ,,, 4==0 3dmm C 6$-- G $
.D E J J .. #}}Z 88! & $ r. c t }t }|D ] }d }|j D ] }|j | |t u r t |t
r0|j t us@|j |j nd|j v sd|j v r|j |xs | |xs |} t | dkD rt d|d| |r|j S y )Nr4 r rM ztoo many data types for : ) r r r_ r rR r r r rG re r5 )r rO r
data_types
base_chainr candidater s r+ r zEnumType._find_data_type_ s U
U
E I
t$6> h/))7"t'9'9: $--/3IT]]3Z NN9#45 ) 1TI & z?Q
J WX X
>># #r. c ` |j dd }|duxr |du}|cdD ]N }||fD ]A }t ||d }|ddj t j t j hvs?|} n |N n t j }|"|t j t j fv rd} nd} ||| fS )a
Returns the __new__ to be used for creating the enum members.
classdict: the class dictionary given to __new__
member_type: the data type whose __new__ will be used by default
first_enum: enumeration to check for an overriding __new__
r4 N)r8 r4 FT)r rT r4 r r )
r r: r r r4 r> rA possibletargetr? s
r+ r6 zEnumType._find_new_
s -- 40 T)AgT.A ? 8!,j 9H $Xvt >,J!J HH(**r. r& ) r0 r1 r2 r3 classmethodr r4 rK r rS rV rX rb rZ r[ r\ r{ r r] r rp rr rQ r r r r7 r r6 r r s @r+ r r s =A% xt $. .tdY]efqu .`4 "E$& G ' ^^2 2. Q ) 48$TYZei 6Yp$dV[ $L ' '$ * 4 *+ *+r. r c e Zd ZdZed Zd Zd Zed Z ed Z
d Z d Z d Z
d
Zd Zd Zd
Zd Zed Zed Zy)r a
Create a collection of name/value pairs.
Example enumeration:
>>> class Color(Enum):
... RED = 1
... BLUE = 2
... GREEN = 3
Access them by:
- attribute access:
>>> Color.RED
- value lookup:
>>> Color(1)
- name lookup:
>>> Color['RED']
Enumerations can be iterated over, and know how many members they have:
>>> len(Color)
3
>>> list(Color)
[, , ]
Methods can be added to enumerations, and members can have their own
attributes -- see the documentation for details.
c | j ryy)Nz (*values)z\(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)ri rJ s r+
__signature__zEnum.__signature__a s qr. c t | | u r|S | j | S # t $ r Y nBt $ r7 | j j D ] }|j |k( s|c cY S Y nw xY w| j st d| z d }| j | }n# t $ r}|}d }Y d }~nd }~ww xY w t || r|d }d }S t 8t | t r(| j t u rt |t r|d }d }S t |d| j }|||| t d| j" d|d }t |t s||_ |# d }d }w xY w)Nz%r has no members defined is not a valid z error in z._missing_: returned z" instead of None or a valid member)rS r r re r rR r r r rR r r r' r r rn r2 r0 __context__)r r( r r resultr@ ve_excs r+ r4 z Enum.__new__h sx ;# L "))%0 0 " **113>>U*!M 4 " 7# => > C]]5)F CF &#& ( CF' $C)>%/Jvs4K CF $eSEUEU$VW>ck L[# "||V 5 C "#z2&,CO CFsQ A*4A* A*&A*)A*B B3%B..B37
E 9E AE E$c y r& r4 )r* r r s r+ r, z
Enum.__init__ s r. c |s|S |d }|j ||d k( r|dz S t # t $ rI ddl}|j dt d t | D ] } |dz c cY S # t $ r Y w xY w |cY S w xY w)z
Generate the next value when not given.
name: the name of the member
start: the initial start value or None
count: the number of existing members
last_values: the list of values assigned
rL rM r NzIn 3.13 the default `auto()`/`_generate_next_value_` will require all values to be sortable and support adding +1
and the value returned will be the largest value in the enum incremented by 1rx r )r re r r r ro )rI rM r| r{ lastr r s r+ r zEnum._generate_next_value_ s L r?D {2&ax
MMd&
k* q5L +
L
s7 !. . 3B "A+&B + A74B 6A77B ?B c y r& r4 rU s r+ r zEnum._missing_ s r. c | j j xs t }d| j j d| j d || j
dS )N)r r& r# r0 r r )r* v_reprs r+ r z
Enum.__repr__ s: ,,4 $ 7 7fT\\FZ[[r. c L | j j d| j S )NrQ )r r0 r r s r+ r+ z Enum.__str__ s ..114;;AAr. c t }| j j t ur t t j | }t | dg D ]+ }|d dk7 s || j vs|j | - | j j D ] }|j j D ]| \ }}|d dk( rt |t r>|j || j vr|j | K|j | ]|| j vsl|j | ~ t t g d |z }|S )zJ
Returns public methods and other interesting attributes.
r r rD )r r3 __eq____hash__r1 )r r r r rb rT r r_ r! r r rR r r discardr9 )r* ra rI r r= rP s r+ rb z Enum.__dir__ s$ e >> ' 'v 5 fnnT 23KD*b1DAw#~$d.?.?"?% 2 >>%%'C \\ / / 1 c7c> c8,xx+t4;L;L/L#- $++D1!2!22 OOD) 2 ( PQ r. c @ t j t | | S r& )r r* )r* format_specs r+ r* zEnum.__format__ s ~~c$i55r. c , t | j S r& )hashr r s r+ r z
Enum.__hash__ s DKK r. c 4 | j | j ffS r& )r r rf s r+ ri zEnum.__reduce_ex__ s ~~ ///r. c | S r& r4 )r* memos r+ __deepcopy__zEnum.__deepcopy__ r. c | S r& r4 r s r+ __copy__z
Enum.__copy__ r r. c | j S )z The name of the Enum member.)r r s r+ rI z Enum.name s {{r. c | j S )z The value of the Enum member.)r r s r+ r( z
Enum.value s ||r. N)r0 r1 r2 r3 r r r4 r, r r r r r+ rb r* r ri r r r rI r( r4 r. r+ r r 9 s %N r r 6p
! !F \B:6!0 r. r ) metaclassc e Zd ZdZy)r zS
Only changes the repr(), leaving str() and format() to the mixed-in type.
Nr0 r1 r2 r3 r4 r. r+ r r r. r c e Zd ZdZy)r
z8
Enum where members are also (and must be) ints
Nr r4 r. r+ r
r
r r. r
c & e Zd ZdZd Zed Zy)r z;
Enum where members are also (and must be) strings
c t | dkD rt d| t | dk( r$t |d t st |d d t | dk\ r$t |d t st d|d t | dk( r$t |d t st d|d z t | }t j | | }||_ |S ) z$values must already be of type `str`rx z too many arguments for str(): rM r z is not a stringrA z encoding must be a string, not z errors must be a string, not %r)rG re rR r r4 r )r rR r( r s r+ r4 zStrEnum.__new__" s v;?& KL L v;! fQi- q DEE v;! fQi- vay STT v;! fQi- AVAY OPPV S%(
r. c " | j S )zD
Return the lower-cased version of the member name.
)lower)rI rM r| r{ s r+ r z StrEnum._generate_next_value_7 s
zz|r. N)r0 r1 r2 r3 r4 r r r4 r. r+ r r s * r. r c | j S r& rH rf s r+ r" r" ? s 99r. c > t | j | j ffS r& )rT r r rf s r+ r# r# D s T^^T[[1 11r. c H e Zd ZdZ e Z e Z e Z e Zy)r a
control how out of range values are handled
"strict" -> error is raised [default for Flag]
"conform" -> extra bits are discarded
"eject" -> lose flag status
"keep" -> keep flag status and all bits [default for IntFlag]
N) r0 r1 r2 r3 r r r r r r4 r. r+ r r H s% VFfG FE 6Dr. r c e Zd ZdZeZed Zed Z e Z
ed Z ed Z d Z
d Zd Zd Zd
Zd Zd Zd
Zd Zd Zd ZeZeZeZy)r z
Support for flags
c |s||S dS t | } t | }d|dz z S # t $ r t d|z dw xY w)z
Generate the next value when not given.
name: the name of the member
start: the initial start value or None
count: the number of existing members
last_values: the last value assigned or None
NrM zinvalid flag value %rrA )max _high_bitr re )rI rM r| r{
last_valuehigh_bits r+ r zFlag._generate_next_value_^ sh ! -5 41 4%
L ,H XaZ L 3j @At K Ls ( Ac # K t || j z D ] }| j j | ! yw)za
Extract all members from the value in definition (i.e. increasing value) order.
N)rq r r r )r r( vals r+ r zFlag._iter_member_by_value_q s7
"%#//"9:C((,,S1 1 ;s <>c # Z K t | j | d E d{ y7 w)zI
Extract all members from the value in definition order.
c | j S r& )r )rF s r+ r z+Flag._iter_member_by_def_.. s annr. r N)r9 r rU s r+ r zFlag._iter_member_by_def_{ s+
**51, s !+)+c t |t st |d| j | j }| j
}| j }d}| |cxk r|k r n n|||z z r| j t u rRt |j |j }t | d|dt || dt || | j t u r||z }ni| j t u r|S | j t u r)|dk r>t |dz d|j z |z }nt | d | j |dk r
|}|dz |z }|| z }|| z }||z } |r<| j t ur*t | j d
|d |d t | d
| j t" u rt" j% | }
n | j j% | | }
t' |
d s||
_ | s|r=g } d} | j+ | D ]" }
| j- |
| |
j( z } $ |rv| |z }| j. j1 D ]T \ }}|| vs |j( s|j( |z |j( k( s5| j- | | |j( z } V || z }dj3 | D
cg c] }
|
j4 c}
|
_ | sd|
_ nU|r"| j t u rt | d| |r/|
xj4 d| j7 | z z
c_ nd|
_ | j8 j; ||
}
||
| j8 |< |
S c c}
w )z
Create a composite member containing all canonical members present in `value`.
If non-member values are present, result depends on `_boundary_` setting.
r Nz invalid value z
given z
allowed r rM rA z unknown flag boundary (z) --> unknown values z []r |z: no members with value z|%s) rR r rn r2 r r r r' r r rz r| r r r r0 r r r4 r< r r r r r r r r r r )r r( flag_mask singles_maskall_bits neg_valuer~ unknownaliasesr~
pseudo_memberr combined_valuerF r$ pms r+ r zFlag._missing_ s^ %% .3S5E5EF
OO )) >> I2(2Hy 01~~' u / / 193G3G3IJ E8(V 7* ) 5( 4'19
A0@0@0B,C D # $
!9>** ,,4 ;; !)6$,,+?@ @ %-dkk6$,,;OP Pr. c | j j }| j |d| j dS |d| j S )Nr )rQ )r r0 r r r* rV s r+ r+ z Flag.__str__ s9 >>** ;; ' 6 6 & 4 4r. c , t | j S r& )boolr r s r+ rK z
Flag.__bool__ s DLL!!r. c t || j r |j S | j t urt || j r|S t
S r& )rR r r r r NotImplemented)r* flags r+
_get_valuezFlag._get_value sB dDNN +<<
v
-*T4CUCU2VK r. c | j | }|t u rt S | |fD ]" }| j | t d| d | j }| j ||z S )N'z,' cannot be combined with other flags with |r r re r r r* r other_valuer r( s r+ r- z Flag.__or__ o ooe, . (! !%KDt$, !D6)U VWW ~~ek 122r. c | j | }|t u rt S | |fD ]" }| j | t d| d | j }| j ||z S )Nr z,' cannot be combined with other flags with &r r s r+ r. z Flag.__and__ r r. c | j | }|t u rt S | |fD ]" }| j | t d| d | j }| j ||z S )Nr z,' cannot be combined with other flags with ^r r s r+ r/ z Flag.__xor__$ r r. c X | j | t d| d | j s| j t t
fv r-| j
| j | _ | j S | j
| j | j z | _ | j S )Nr z' cannot be inverted) r re r( r' r r r r r r s r+ r3 zFlag.__invert__/ s ??4 (av%9 :; ; ?? "5$-/"&..$,, "? #'..1D1D }1T"U r. N)r0 r1 r2 r3 r# r r r r r r r r rV r[ r\ r r+ rK r r- r. r/ r3 r1 r0 r2 r4 r. r+ r r W s N! !$ 2 2 +M Z Z x=4 (Q5" 3 3 3 HGHr. r ru c e Zd ZdZy)r
z)
Support for integer-based Flags
Nr r4 r. r+ r
r
? r r. r
c ( | j dz
S )zJ
returns index of highest bit, or -1 if value is zero or negative
rM )rz r' s r+ r r E s !!r. c , g }| j j D ]2 \ }}||j k7 s|j ||j f 4 |r:dj |D cg c] \ }}|d| c}} }t d| d| | S c c}}w )zI
Class decorator for enumerations ensuring unique member values.
, -> zduplicate values found in r )r] r rI r r rn ) enumeration
duplicatesrI r alias
alias_detailss r+ r r K s J#//557 f 6;; tV[[ 1 2 8 AKL
ud+LN
m- . . Ms $B
c p j dj fdj D S )Nr c 3 ^ K | ]$ }| j r|d t | & yw)=N)r# rT )r kdcfr* s r+ r z"_dataclass_repr..\ s0 1v{{ '$* + s *-)r r r )r* r s `@r+ r r Z s2
#
#C 99 XXZ r. c t | j j j d d }|d| j S )z{
use module.enum_name instead of class.enum_name
the module is the last module in case of a multi-module name
rQ rL )r r1 r r )r* rL s r+ r r b s2 ^^
&
&
,
,S
1"
5F dkk **r. c | j j j d d }| j j }| j |d|d| j
dS t
| j
r|d| j S | j t j ur=dj | j j d D cg c] }|d| c} S g }| j j d D ]= }|d j r|j | (|j |d| ? dj | S c c}w )z{
use module.flag_name instead of class.flag_name
the module is the last module in case of a multi-module name
rQ rL r r r r )r r1 r r0 r r rb r' r r r rI isdigitr )r* rL rV rI r$ s r+ r r k s ^^
&
&
,
,S
1"
5F~~&&H {{ $h ==dll# $++.. l / //xxdiiooc>RS>RdFD1>RSTT""3'At||~ A vq 12 (
xx~ Ts
E
c | j (| j j }|d| j dS | j S )z2
use enum_name instead of class.enum_name
r r )r r r0 r r s r+ r r s6 {{>>**#T\\22{{r. c t | t r t | _ n t | _ t | t
r|r t | _ t j | j j j | j | S )z
decorator that makes the repr() of an enum member reference its module
instead of its class; also exports all members to the enum's module's
global namespace
)r r r r r r r r+ rv r r1 r r r] )r
update_strs r+ r r sY #t ' ' c8 $
KK ((//@ Jr. )r r? c fd}|S )a
Class decorator that converts a normal class into an :class:`Enum`. No
safety checks are done, and some advanced behavior (such as
:func:`__init_subclass__`) is not available. Enum creation can be faster
using :func:`simple_enum`.
>>> from enum import Enum, _simple_enum
>>> @_simple_enum(Enum)
... class Color:
... RED = auto()
... GREEN = auto()
... BLUE = auto()
>>> Color
c | j } j | j j d }|
|j }nj
j }i }i }|||d< ||d< |d< j x|d< }g x|d< }i x|d< }i x|d< } g |d < j
x|d
< }
j |d < t t rxs j |d < d |d
< d |d< d |d< d |d< t j |d< t j |d< t j |d< t j |d< t j |d< t j" |d< t j$ |d< | j j' D ]B \ } } | dv r t) | s"t+ || st- | s t/ | r| || < >| || < D | j j d d|d< t1 |f|d }
d D ]O } | |vst3 | }t3 |
| }t3 t4 | }t3 |
| }|||fv sCt7 |
| | Q g }t |
t rd x}}|j' D ]U \ } }t9 |t: r*t: j< t> u r || d tA | | }|| v r;| | }tC }||_" |jG |
| t7 |
| | ||| < r"t9 |tH s|f} ||
g| }|d }n ||
}|||_% | |_& |
|_' |jQ | tC }||_" |jG |
| t7 |
| | ||| < tA | |_) || |< tU | r|jW | ||z }n||z }|jW | X ||z |
_, ||
_- d ||z j] z d z
|
_/ |
D cg c] }|jJ }}|ta | k7 rs|
jb |
_2 n`|j' D ]L \ } }t9 |t: r7|j< t> u r || d tA | | |_ |j< }|| v r;| | }tC }||_" |jG |
| t7 |
| | ||| < r"t9 |tH s|f} ||
g| }|d }n ||
}|||_% | |_& |
|_' |jQ | tA | |_) tC }||_" |jG |
| t7 |
| | ||| < || |< |jW | |jW | O d|v r|
j |
_3 th j |
_ |
S c c}w )!Nr4 r8 r r r r r r r r r& r' r r r r( r- r/ r. r0 r2 r1 r3 )r __weakref__r3 zAn enumeration.Tr r, r rM rA )5r0 r r r r r r4 r r& r r r' r- r/ r. r0 r2 r1 r3 r rJ r_ rN r> rS rT r rk rR r r( r rG r r r r r r r r, r rb r r r rz r r9 r r r8 r ) r rV r4
new_memberattrsr gnvr< rs value2member_mapr rI r= r rB rC rD rE gnv_last_values single_bits
multi_bitsr( r r rF rG r r r? s r+
convert_classz#_simple_enum..convert_class s << ''H,,""9- ))J ,,44J %/D! " )^ %\.3.I.II
$%022
,..^ z8::
!"%5&(
"#.3.A.AA_ $ 1 1^ eT "!)!=U-=-=D "&D !%D %)D! "!%D ![[DN "llDO "llDO "llDO #}}D #}}D !% D ++-ID#22$ ;x#>*TBRVdehVi T
!d
. << I & . /DO (UIthPTU
JD4 %eT 2 &z4 8 ' 5
#*;#= $4m#DDJk: K j$ ''( (K* ${{} e eT*tzzZ/G a\):O LE ,, -e 4F 'zH&,HO ))*d;Jh7'-Jt$ )% 7%*IE!+J!?!? %a!+J!7 ).$(FM*4F'OOE* 'zH&,HO ))*d;Jh7'-Jt$*-l*;F'.4$U+%e,$++D1#u, "e+
#**51M -N &1:%=J "(3J %$%;z+A*M*M*O$PST$TJ !.89j199jK9f[ 11+5+J+J
( %{{} e eT* {{j0&)$3|3Do&V !KKE ,, -e 4F 'zH&,HO ))*d;Jh7'-Jt$ )% 7%*IE!+J!?!? %a!+J!7 ).$(FM*4F'OOE**-l*;F' 'zH&,HO ))*d;Jh7'-Jt$.4$U+ ''-#**51G -H (2(:(:J % !\\
Y :s Wr4 )r r r? r! s ``` r+ r r s Wp r. c e Zd ZdZdZdZdZy)r z8
various conditions to check an enumeration for
zno skipped integer valuesz0multi-flag aliases may not contain unnamed flagszone name per valueN)r0 r1 r2 r3 r r r! r4 r. r+ r r E s -JDK
!Fr. r c e Zd ZdZd Zd Zy)r zG
Check an enumeration for various constraints. (see EnumCheck)
c || _ y r& )checks)r* r% s r+ r, zverify.__init__T s r. c < | j }|j }t t |t rd}n t |t rd}n t d |D ] }|t u rg }|j j D ]2 \ }}||j k7 s|j ||j f 4 |s`dj |D cg c] \ } }| d| c}} }
t d|d|
|t u rt d |D } t | d k rt! | t# | }
} g }|dk( rCt% t' | d
z t' |
D ] }d |z | vs |j d |z n>|dk( r+t% | d
z |
D ] }|| vs|j | nt) d |z |set d |d
|ddj d |D d d |t* u s|j, }|D cg c] }|j. }}g }d}|j0 j D ]s \ }} ||v r | j. dk rt3 t5 | j. } | D cg c] }||vs| }}|sP|j | |t7 t8 | z }u |sYt | d
k( r d|d z } n ddj |d d d|d d} t; | rd|z }nd|z }t d|d| d
|d |S c c}} w c c}w c c}w )Nr r z4the 'verify' decorator only works with Enum and Flagr r zaliases found in r c 3 4 K | ] }|j y wr& r' )r r@ s r+ r z"verify.__call__..l s :kQWWks rA rM zverify: unknown type %rzinvalid ry z: missing values c 3 2 K | ] }t | y wr& )r )r rF s r+ r z"verify.__call__.. s ;TGqCFGr% r zalias %s is missingzaliases rL r z are missingz
value 0x%xzcombined values of 0x%xz
invalid Flag z/ [use enum.show_flag_values(value) for details]) r% r0 r r r re r! r] r rI r r rn r r rG minr ranger r r r r( r rs rq r _or_rb )r* r r% rV enum_typecheckr rI r r
r rR lowhighmissingr r< rF
member_values
missing_names
missing_valuer missedr( s r+ rS zverify.__call__V s6 ''
; = I
T
* I RS SE
$/$;$;$A$A$CLD&v{{*"))4*=> %D $(IIMW XZMUD5$ 7Z X%ZM$ (-&9 : :*$ :k ::v;? KVT & "9S>!#3Yt_ E a4v- #NN1a4 0 F &( "3q5$ / F? #NN1 - 0 $$= $IJJ$ %x;TG;T1U'W "s&$ % % +% * 9 9 2= >+Q+
> "
!
#.#;#;#A#A#CKD%|+ {{Q !."= >F)/ JA1M3IaF J %,,T2%f)==
$D !=)Q. 5
a8H H / !% -*< =}R?P!" &m4 ,} < 9M I$ ' 7 A H w Y: !? Ks L >L. L8LN)r0 r1 r2 r3 r, rS r4 r. r+ r r P s Mr. r c
\ g }| j |j k7 rq| j }t |j }|j }t |j }t t | j j t |j j z }t ||z D ] }|dv r ||v r||vr|j d| '||vr|j d| @|| } || }
t
| st | t j rp|dk( rj| j dd j dd } |
j dd j dd } | | k7 s|j |dd | d
d |
| |
k7 s|j |dd | d
d |
|j |D ]/ }
g }|
|vr|j d |
z n|
|vr|j d
|
z n| |
j }t |j }||
j }t |j }t ||z D ]n }|dv r||vr|j d|d|
$||vr|j d|d|
@|| } || }
| |
k7 sP|j |dd| d
d|
p |s |j |
ddj | 2 dD ]x }||v r||v r ||vri||vret | |d }t ||d }t |d r|j }|j }||k7 sX|j |dd |ddd | yz |r t! d d j | z y) a]
A function that can be used to test an enum created with :func:`_simple_enum`
against the version created by subclassing :class:`Enum`::
>>> from enum import Enum, _simple_enum, _test_simple_enum
>>> @_simple_enum(Enum)
... class Color:
... RED = auto()
... GREEN = auto()
... BLUE = auto()
>>> class CheckedColor(Enum):
... RED = auto()
... GREEN = auto()
... BLUE = auto()
>>> _test_simple_enum(CheckedColor, Color)
If differences are found, a :exc:`TypeError` is raised.
)r1 r r r3 z
missing key: z
extra key: r3 ry rP z :
z checked -> z
z simple -> z#missing member from simple enum: %rz extra member in simple enum: %r)r1 r r( z missing key z not in the simple enum member z
extra key z in simple enum member zchecked member -> zsimple member -> z member mismatch:
z
)r+ r ri r* __getnewargs_ex____getnewargs__ri
__reduce__Nr z: 30z
simple -> zenum mismatch:
%sz
)r rs r r r r callablerR r{ r r} r r rT r< r re ) checked_enum simple_enumfailed checked_dict checked_keys simple_dict simple_keysr< r
checked_value simple_valuecompressed_checked_valuecompressed_simple_valuerI
failed_memberchecked_member_dictchecked_member_keyssimple_member_dictsimple_member_keysrA checked_method
simple_methods r+ _test_simple_enumrO s & F 4 44#,, L - - /0 !** ;++-. \..3356{//44678 |k12CUU $K'
3 9:L(
3 9: ,S 1
*3 / M*j .W )#/# 7 3@
D M;&
Cd JK\)
?$ FG&24&8&A&A#&*+>+C+C+E&F#%0%6%?%?"%)*<*A*A*C%D" 25G GHC JJ $66%,,begk-lm $77%,,X[]a-bc(;C(@
'9#'> (L8 ) 0 0$'>K$N>J$M2& ' I"
joom < ; !@F $<)?{*v\/I!( vt!D ' VT B
>:6%3%<%# /0 /',,v2FFGG r. c Z t j | j }|r
|j }n|}|j D cg c] \ }} || r||f }}} |j d | |||xs t } | S c c}}w # t
$ r |j d Y :w xY w)zS
Create a new Enum subclass that replaces a collection of global constants
c | d | d fS r r4 r s r+ r z _old_convert_..5 s AaD!A$.8 s 1Q4r. )rL r )rv r r r r re r )
r rI rL r r r r r( r r s
r+
_old_convert_rS s [[(11N
&||~ - ed| 5M - ) / 0 gfx7G4
HC J ) ()s B B B*)B*r& )F)Drv builtinsr{ typesr r operatorr r, functoolsr __all__r r r
_stdlib_enumsr r r r r> rJ rN rZ r_ rb rl rq rt r| r r r r r r rj r rS r r r r
r r r" _reduce_ex_by_global_namer# r r r r r
r r r r r r r r r r r r! r rO rS r4 r. r+ r[ s
9
26 5 5t 5e 5mh V A
0
'$0 \
\
' '6+$ 6+r9 9DA A Hy+t y+t U X U pt c8 c8 D 2 2 7 , e4& ePc8TD "
+ .
h hT g" " " #,
KS SjwHr < ')
r.