h ,dZddlZdZGddeZy)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 Nc<t|Dcgc]}||fc}Scc}w)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 X/var/www/betterdocs.net/sherlock_api/venv/lib/python3.12/site-packages/stem/util/enum.py UppercaseEnumr.s!$ %1A% &&%s c:eZdZdZdZdZdZdZdZdZ dZ y ) rz Basic enumeration. c|ddlm}gg}}|D]}tjj |r |||}}n2t |t rt|dk(r|\}}ntd|z|j||j|t|||t ||_ t ||_ y)Nr)_to_camel_casezUnrecognized input: %s) stem.util.str_toolsr stemutil_is_str isinstancetuplelen ValueErrorappendsetattr_keys_values)selfrr keysvaluesentrykeyvals r__init__z Enum.__init__Hs2r&D    5 !./S eU #E aS1D899 kk# mmC dC tDJ=DLc,t|jS)zu Provides an ordered listing of the enumeration keys in this set. :returns: **list** with our enum keys )listr)rs rrz Enum.keys]s  r c8|jj|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)rvalues rindex_ofz Enum.index_offs <<  e $$r c||jvr+td|ddj|jd|jj|dzt |jz}|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: (options: , )rrjoinr$r)rr% next_indexs rnextz Enum.nextsi DLL PTPYPYZ^ZfZfPgh ii,,$$U+a/3t||3DDJ << ##r c||jvr+td|ddj|jd|jj|dz t |jz}|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+r,r-)rr% prev_indexs rpreviousz Enum.previousr1r c|t|vr t||Sdj|j}t d|d|)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: )varsgetattrr.rr)ritemrs r __getitem__zEnum.__getitem__sC tDz T4  YYtyy{ #d VZ\`a bbr c#6K|jD]}|yw)z? Provides an ordered listing of the enums in this set. N)r)rrs r__iter__z Enum.__iter__s  ksN) __name__ __module__ __qualname____doc__rrr&r0r4r:r<r rrrCs+!* %$"$"c"r r)r@ stem.utilrrobjectrrAr rrDs#%N'*i6ir