>> from stem.util import enum >>> insects = enum.Enum('ANT', 'WASP', 'LADYBUG', 'FIREFLY') >>> insects.ANT 'Ant' >>> tuple(insects) ('Ant', 'Wasp', 'Ladybug', 'Firefly') ... or with overwritten string counterparts... :: >>> from stem.util import enum >>> pets = enum.Enum(('DOG', 'Skippy'), 'CAT', ('FISH', 'Nemo')) >>> pets.DOG 'Skippy' >>> pets.CAT 'Cat' **Module Overview:** :: UppercaseEnum - Provides an enum instance with capitalized values Enum - Provides a basic, ordered enumeration |- keys - string representation of our enum keys |- index_of - index of an enum value |- next - provides the enum after a given enum value |- previous - provides the enum before a given value |- __getitem__ - provides the value for an enum key +- __iter__ - iterator over our enum keys Nc@[UVs/sHoU4PM sn6$s snf)a Provides an :class:`~stem.util.enum.Enum` instance where the values are identical to the keys. Since the keys are uppercase by convention this means the values are too. For instance... :: >>> from stem.util import enum >>> runlevels = enum.UppercaseEnum('DEBUG', 'INFO', 'NOTICE', 'WARN', 'ERROR') >>> runlevels.DEBUG 'DEBUG' :param list args: enum keys to initialize with :returns: :class:`~stem.util.enum.Enum` instance with the given keys )Enum)argsvs H/home/james-whalen/.local/lib/python3.13/site-packages/stem/util/enum.py UppercaseEnumr.s#$ %1A% &&%s cB\rSrSrSrSrSrSrSrSr Sr S r S r g ) rCz Basic enumeration. cSSKJn //pCUHn[RR U5(a XR"U5pvO7[ U[ 5(a[U5S:XaUupgO[SU-5eURU5 URU5 [XU5 M [ U5Ul [ U5Ul g)Nr)_to_camel_casezUnrecognized input: %s) stem.util.str_toolsr stemutil_is_str isinstancetuplelen ValueErrorappendsetattr_keys_values)selfrr keysvaluesentrykeyvals r__init__ Enum.__init__Hs2r&   5 ! !./S eU # #E aS1D899 kk# mmC dtDJ=DLc,[UR5$)zi Provides an ordered listing of the enumeration keys in this set. :returns: **list** with our enum keys )listr)rs rr Enum.keys]s  r"c8URRU5$)z Provides the index of the given value in the collection. :param str value: entry to be looked up :returns: **int** index of the given entry :raises: **ValueError** if no such element exists )rindex)rvalues rindex_of Enum.index_offs <<  e $$r"cXR;a-[SU<SSRUR5<S35eURRU5S-[ UR5-nURU$)z Provides the next enumeration after the given value. :param str value: enumeration for which to get the next entry :returns: enum value following the given entry :raises: **ValueError** if no such element exists No such enumeration exists: (options: , )rrjoinr'r)rr( next_indexs rnext Enum.nextsg LL PTPYPYZ^ZfZfPgh ii,,$$U+a/3t||3DDJ << ##r"cXR;a-[SU<SSRUR5<S35eURRU5S- [ UR5-nURU$)z Provides the previous enumeration before the given value. :param str value: enumeration for which to get the previous entry :returns: enum value proceeding the given entry :raises: **ValueError** if no such element exists r,r-r.r/r0r1)rr( prev_indexs rprevious Enum.previousr6r"cU[U5;a [X5$SRUR55n[ SU<SU<35e)z Provides the values for the given key. :param str item: key to be looked up :returns: **str** with the value for the given key :raises: **ValueError** if the key doesn't exist r.'z4' isn't among our enumeration keys, which includes: )varsgetattrr2rr)ritemrs r __getitem__Enum.__getitem__sA tDz T  YYtyy{ #d VZ\`a bbr"c#:# URHnUv M g7f)z7 Provides an ordered listing of the enums in this set. N)r)rrs r__iter__ Enum.__iter__s  ks)rrN) __name__ __module__ __qualname____firstlineno____doc__r rr)r4r9r@rC__static_attributes__r"rrrCs+!* %$"$"c"r"r)rI stem.utilrrobjectrrKr"rrNs#%N'*i6ir"