o u] @s(dZddlZddZGdddeZdS)a Basic enumeration, providing ordered types for collections. These can be constructed as simple type listings... :: >>> 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 NcGstdd|DS)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 cSsg|]}||fqSr).0vrr0/usr/lib/python3/dist-packages/stem/util/enum.py @sz!UppercaseEnum..)Enum)argsrrr UppercaseEnum.sr c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ dS)rz Basic enumeration. cGsddlm}gg}}|D]6}tj|r|||}}nt|tr-t|dkr-|\}}ntd|| || |t |||q t||_ t||_ dS)Nr)_to_camel_casezUnrecognized input: %s) Zstem.util.str_toolsr stemutilZ_is_str isinstancetuplelen ValueErrorappendsetattr_keys_values)selfrr keysvaluesentrykeyvalrrr__init__Hs        z Enum.__init__cCs t|jS)zu Provides an ordered listing of the enumeration keys in this set. :returns: **list** with our enum keys )listr)rrrrr]s z Enum.keyscCs |j|S)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)rvaluerrrindex_offs z Enum.index_ofcCsF||jvrtd|d|jf|j|dt|j}|j|S)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: %s (options: %s), rrjoinrr)rrZ next_indexrrrnexts  z Enum.nextcCsF||jvrtd|d|jf|j|dt|j}|j|S)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$)rrZ prev_indexrrrpreviousr'z Enum.previouscCs4|t|vr t||Sd|}td||f)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"z9'%s' isn't among our enumeration keys, which includes: %s)varsgetattrr%rr)ritemrrrr __getitem__s zEnum.__getitem__ccs|jD]}|VqdS)z? Provides an ordered listing of the enums in this set. N)r)rrrrr__iter__s z Enum.__iter__N) __name__ __module__ __qualname____doc__rrr r&r(r,r-rrrrrCs   r)r1Z stem.utilr r objectrrrrrs'