| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712 |
- import copy
- import enum
- import doctest
- import inspect
- import os
- import pydoc
- import sys
- import unittest
- import threading
- import typing
- import builtins as bltns
- from collections import OrderedDict
- from datetime import date
- from enum import Enum, IntEnum, StrEnum, EnumType, Flag, IntFlag, unique, auto
- from enum import STRICT, CONFORM, EJECT, KEEP, _simple_enum, _test_simple_enum
- from enum import verify, UNIQUE, CONTINUOUS, NAMED_FLAGS, ReprEnum
- from enum import member, nonmember, _iter_bits_lsb
- from io import StringIO
- from pickle import dumps, loads, PicklingError, HIGHEST_PROTOCOL
- from test import support
- from test.support import ALWAYS_EQ
- from test.support import threading_helper
- from textwrap import dedent
- from datetime import timedelta
- python_version = sys.version_info[:2]
- def load_tests(loader, tests, ignore):
- tests.addTests(doctest.DocTestSuite(enum))
- if os.path.exists('Doc/library/enum.rst'):
- tests.addTests(doctest.DocFileSuite(
- '../../Doc/library/enum.rst',
- optionflags=doctest.ELLIPSIS|doctest.NORMALIZE_WHITESPACE,
- ))
- return tests
- MODULE = __name__
- SHORT_MODULE = MODULE.split('.')[-1]
- # for pickle tests
- try:
- class Stooges(Enum):
- LARRY = 1
- CURLY = 2
- MOE = 3
- except Exception as exc:
- Stooges = exc
- try:
- class IntStooges(int, Enum):
- LARRY = 1
- CURLY = 2
- MOE = 3
- except Exception as exc:
- IntStooges = exc
- try:
- class FloatStooges(float, Enum):
- LARRY = 1.39
- CURLY = 2.72
- MOE = 3.142596
- except Exception as exc:
- FloatStooges = exc
- try:
- class FlagStooges(Flag):
- LARRY = 1
- CURLY = 2
- MOE = 4
- except Exception as exc:
- FlagStooges = exc
- class FlagStoogesWithZero(Flag):
- NOFLAG = 0
- LARRY = 1
- CURLY = 2
- MOE = 4
- class IntFlagStooges(IntFlag):
- LARRY = 1
- CURLY = 2
- MOE = 4
- class IntFlagStoogesWithZero(IntFlag):
- NOFLAG = 0
- LARRY = 1
- CURLY = 2
- MOE = 4
- # for pickle test and subclass tests
- class Name(StrEnum):
- BDFL = 'Guido van Rossum'
- FLUFL = 'Barry Warsaw'
- try:
- Question = Enum('Question', 'who what when where why', module=__name__)
- except Exception as exc:
- Question = exc
- try:
- Answer = Enum('Answer', 'him this then there because')
- except Exception as exc:
- Answer = exc
- try:
- Theory = Enum('Theory', 'rule law supposition', qualname='spanish_inquisition')
- except Exception as exc:
- Theory = exc
- # for doctests
- try:
- class Fruit(Enum):
- TOMATO = 1
- BANANA = 2
- CHERRY = 3
- except Exception:
- pass
- def test_pickle_dump_load(assertion, source, target=None):
- if target is None:
- target = source
- for protocol in range(HIGHEST_PROTOCOL + 1):
- assertion(loads(dumps(source, protocol=protocol)), target)
- def test_pickle_exception(assertion, exception, obj):
- for protocol in range(HIGHEST_PROTOCOL + 1):
- with assertion(exception):
- dumps(obj, protocol=protocol)
- class TestHelpers(unittest.TestCase):
- # _is_descriptor, _is_sunder, _is_dunder
- sunder_names = '_bad_', '_good_', '_what_ho_'
- dunder_names = '__mal__', '__bien__', '__que_que__'
- private_names = '_MyEnum__private', '_MyEnum__still_private'
- private_and_sunder_names = '_MyEnum__private_', '_MyEnum__also_private_'
- random_names = 'okay', '_semi_private', '_weird__', '_MyEnum__'
- def test_is_descriptor(self):
- class foo:
- pass
- for attr in ('__get__','__set__','__delete__'):
- obj = foo()
- self.assertFalse(enum._is_descriptor(obj))
- setattr(obj, attr, 1)
- self.assertTrue(enum._is_descriptor(obj))
- def test_sunder(self):
- for name in self.sunder_names + self.private_and_sunder_names:
- self.assertTrue(enum._is_sunder(name), '%r is a not sunder name?' % name)
- for name in self.dunder_names + self.private_names + self.random_names:
- self.assertFalse(enum._is_sunder(name), '%r is a sunder name?' % name)
- for s in ('_a_', '_aa_'):
- self.assertTrue(enum._is_sunder(s))
- for s in ('a', 'a_', '_a', '__a', 'a__', '__a__', '_a__', '__a_', '_',
- '__', '___', '____', '_____',):
- self.assertFalse(enum._is_sunder(s))
- def test_dunder(self):
- for name in self.dunder_names:
- self.assertTrue(enum._is_dunder(name), '%r is a not dunder name?' % name)
- for name in self.sunder_names + self.private_names + self.private_and_sunder_names + self.random_names:
- self.assertFalse(enum._is_dunder(name), '%r is a dunder name?' % name)
- for s in ('__a__', '__aa__'):
- self.assertTrue(enum._is_dunder(s))
- for s in ('a', 'a_', '_a', '__a', 'a__', '_a_', '_a__', '__a_', '_',
- '__', '___', '____', '_____',):
- self.assertFalse(enum._is_dunder(s))
- def test_is_private(self):
- for name in self.private_names + self.private_and_sunder_names:
- self.assertTrue(enum._is_private('MyEnum', name), '%r is a not private name?')
- for name in self.sunder_names + self.dunder_names + self.random_names:
- self.assertFalse(enum._is_private('MyEnum', name), '%r is a private name?')
- def test_iter_bits_lsb(self):
- self.assertEqual(list(_iter_bits_lsb(7)), [1, 2, 4])
- self.assertRaisesRegex(ValueError, '-8 is not a positive integer', list, _iter_bits_lsb(-8))
- # for subclassing tests
- class classproperty:
- def __init__(self, fget=None, fset=None, fdel=None, doc=None):
- self.fget = fget
- self.fset = fset
- self.fdel = fdel
- if doc is None and fget is not None:
- doc = fget.__doc__
- self.__doc__ = doc
- def __get__(self, instance, ownerclass):
- return self.fget(ownerclass)
- # for global repr tests
- @enum.global_enum
- class HeadlightsK(IntFlag, boundary=enum.KEEP):
- OFF_K = 0
- LOW_BEAM_K = auto()
- HIGH_BEAM_K = auto()
- FOG_K = auto()
- @enum.global_enum
- class HeadlightsC(IntFlag, boundary=enum.CONFORM):
- OFF_C = 0
- LOW_BEAM_C = auto()
- HIGH_BEAM_C = auto()
- FOG_C = auto()
- @enum.global_enum
- class NoName(Flag):
- ONE = 1
- TWO = 2
- # tests
- class _EnumTests:
- """
- Test for behavior that is the same across the different types of enumerations.
- """
- values = None
- def setUp(self):
- class BaseEnum(self.enum_type):
- @enum.property
- def first(self):
- return '%s is first!' % self.name
- class MainEnum(BaseEnum):
- first = auto()
- second = auto()
- third = auto()
- if issubclass(self.enum_type, Flag):
- dupe = 3
- else:
- dupe = third
- self.MainEnum = MainEnum
- #
- class NewStrEnum(self.enum_type):
- def __str__(self):
- return self.name.upper()
- first = auto()
- self.NewStrEnum = NewStrEnum
- #
- class NewFormatEnum(self.enum_type):
- def __format__(self, spec):
- return self.name.upper()
- first = auto()
- self.NewFormatEnum = NewFormatEnum
- #
- class NewStrFormatEnum(self.enum_type):
- def __str__(self):
- return self.name.title()
- def __format__(self, spec):
- return ''.join(reversed(self.name))
- first = auto()
- self.NewStrFormatEnum = NewStrFormatEnum
- #
- class NewBaseEnum(self.enum_type):
- def __str__(self):
- return self.name.title()
- def __format__(self, spec):
- return ''.join(reversed(self.name))
- class NewSubEnum(NewBaseEnum):
- first = auto()
- self.NewSubEnum = NewSubEnum
- #
- self.is_flag = False
- self.names = ['first', 'second', 'third']
- if issubclass(MainEnum, StrEnum):
- self.values = self.names
- elif MainEnum._member_type_ is str:
- self.values = ['1', '2', '3']
- elif issubclass(self.enum_type, Flag):
- self.values = [1, 2, 4]
- self.is_flag = True
- self.dupe2 = MainEnum(5)
- else:
- self.values = self.values or [1, 2, 3]
- #
- if not getattr(self, 'source_values', False):
- self.source_values = self.values
- def assertFormatIsValue(self, spec, member):
- self.assertEqual(spec.format(member), spec.format(member.value))
- def assertFormatIsStr(self, spec, member):
- self.assertEqual(spec.format(member), spec.format(str(member)))
- def test_attribute_deletion(self):
- class Season(self.enum_type):
- SPRING = auto()
- SUMMER = auto()
- AUTUMN = auto()
- #
- def spam(cls):
- pass
- #
- self.assertTrue(hasattr(Season, 'spam'))
- del Season.spam
- self.assertFalse(hasattr(Season, 'spam'))
- #
- with self.assertRaises(AttributeError):
- del Season.SPRING
- with self.assertRaises(AttributeError):
- del Season.DRY
- with self.assertRaises(AttributeError):
- del Season.SPRING.name
- def test_basics(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(repr(TE), "<flag 'MainEnum'>")
- self.assertEqual(str(TE), "<flag 'MainEnum'>")
- self.assertEqual(format(TE), "<flag 'MainEnum'>")
- self.assertTrue(TE(5) is self.dupe2)
- else:
- self.assertEqual(repr(TE), "<enum 'MainEnum'>")
- self.assertEqual(str(TE), "<enum 'MainEnum'>")
- self.assertEqual(format(TE), "<enum 'MainEnum'>")
- self.assertEqual(list(TE), [TE.first, TE.second, TE.third])
- self.assertEqual(
- [m.name for m in TE],
- self.names,
- )
- self.assertEqual(
- [m.value for m in TE],
- self.values,
- )
- self.assertEqual(
- [m.first for m in TE],
- ['first is first!', 'second is first!', 'third is first!']
- )
- for member, name in zip(TE, self.names, strict=True):
- self.assertIs(TE[name], member)
- for member, value in zip(TE, self.values, strict=True):
- self.assertIs(TE(value), member)
- if issubclass(TE, StrEnum):
- self.assertTrue(TE.dupe is TE('third') is TE['dupe'])
- elif TE._member_type_ is str:
- self.assertTrue(TE.dupe is TE('3') is TE['dupe'])
- elif issubclass(TE, Flag):
- self.assertTrue(TE.dupe is TE(3) is TE['dupe'])
- else:
- self.assertTrue(TE.dupe is TE(self.values[2]) is TE['dupe'])
- def test_bool_is_true(self):
- class Empty(self.enum_type):
- pass
- self.assertTrue(Empty)
- #
- self.assertTrue(self.MainEnum)
- for member in self.MainEnum:
- self.assertTrue(member)
- def test_changing_member_fails(self):
- MainEnum = self.MainEnum
- with self.assertRaises(AttributeError):
- self.MainEnum.second = 'really first'
- @unittest.skipIf(
- python_version >= (3, 12),
- '__contains__ now returns True/False for all inputs',
- )
- def test_contains_er(self):
- MainEnum = self.MainEnum
- self.assertIn(MainEnum.third, MainEnum)
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- self.source_values[1] in MainEnum
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 'first' in MainEnum
- val = MainEnum.dupe
- self.assertIn(val, MainEnum)
- #
- class OtherEnum(Enum):
- one = auto()
- two = auto()
- self.assertNotIn(OtherEnum.two, MainEnum)
- @unittest.skipIf(
- python_version < (3, 12),
- '__contains__ works only with enum memmbers before 3.12',
- )
- def test_contains_tf(self):
- MainEnum = self.MainEnum
- self.assertIn(MainEnum.first, MainEnum)
- self.assertTrue(self.source_values[0] in MainEnum)
- self.assertFalse('first' in MainEnum)
- val = MainEnum.dupe
- self.assertIn(val, MainEnum)
- #
- class OtherEnum(Enum):
- one = auto()
- two = auto()
- self.assertNotIn(OtherEnum.two, MainEnum)
- def test_dir_on_class(self):
- TE = self.MainEnum
- self.assertEqual(set(dir(TE)), set(enum_dir(TE)))
- def test_dir_on_item(self):
- TE = self.MainEnum
- self.assertEqual(set(dir(TE.first)), set(member_dir(TE.first)))
- def test_dir_with_added_behavior(self):
- class Test(self.enum_type):
- this = auto()
- these = auto()
- def wowser(self):
- return ("Wowser! I'm %s!" % self.name)
- self.assertTrue('wowser' not in dir(Test))
- self.assertTrue('wowser' in dir(Test.this))
- def test_dir_on_sub_with_behavior_on_super(self):
- # see issue22506
- class SuperEnum(self.enum_type):
- def invisible(self):
- return "did you see me?"
- class SubEnum(SuperEnum):
- sample = auto()
- self.assertTrue('invisible' not in dir(SubEnum))
- self.assertTrue('invisible' in dir(SubEnum.sample))
- def test_dir_on_sub_with_behavior_including_instance_dict_on_super(self):
- # see issue40084
- class SuperEnum(self.enum_type):
- def __new__(cls, *value, **kwds):
- new = self.enum_type._member_type_.__new__
- if self.enum_type._member_type_ is object:
- obj = new(cls)
- else:
- if isinstance(value[0], tuple):
- create_value ,= value[0]
- else:
- create_value = value
- obj = new(cls, *create_value)
- obj._value_ = value[0] if len(value) == 1 else value
- obj.description = 'test description'
- return obj
- class SubEnum(SuperEnum):
- sample = self.source_values[1]
- self.assertTrue('description' not in dir(SubEnum))
- self.assertTrue('description' in dir(SubEnum.sample), dir(SubEnum.sample))
- def test_enum_in_enum_out(self):
- Main = self.MainEnum
- self.assertIs(Main(Main.first), Main.first)
- def test_hash(self):
- MainEnum = self.MainEnum
- mapping = {}
- mapping[MainEnum.first] = '1225'
- mapping[MainEnum.second] = '0315'
- mapping[MainEnum.third] = '0704'
- self.assertEqual(mapping[MainEnum.second], '0315')
- def test_invalid_names(self):
- with self.assertRaises(ValueError):
- class Wrong(self.enum_type):
- mro = 9
- with self.assertRaises(ValueError):
- class Wrong(self.enum_type):
- _create_= 11
- with self.assertRaises(ValueError):
- class Wrong(self.enum_type):
- _get_mixins_ = 9
- with self.assertRaises(ValueError):
- class Wrong(self.enum_type):
- _find_new_ = 1
- with self.assertRaises(ValueError):
- class Wrong(self.enum_type):
- _any_name_ = 9
- def test_object_str_override(self):
- "check that setting __str__ to object's is not reset to Enum's"
- class Generic(self.enum_type):
- item = self.source_values[2]
- def __repr__(self):
- return "%s.test" % (self._name_, )
- __str__ = object.__str__
- self.assertEqual(str(Generic.item), 'item.test')
- def test_overridden_str(self):
- NS = self.NewStrEnum
- self.assertEqual(str(NS.first), NS.first.name.upper())
- self.assertEqual(format(NS.first), NS.first.name.upper())
- def test_overridden_str_format(self):
- NSF = self.NewStrFormatEnum
- self.assertEqual(str(NSF.first), NSF.first.name.title())
- self.assertEqual(format(NSF.first), ''.join(reversed(NSF.first.name)))
- def test_overridden_str_format_inherited(self):
- NSE = self.NewSubEnum
- self.assertEqual(str(NSE.first), NSE.first.name.title())
- self.assertEqual(format(NSE.first), ''.join(reversed(NSE.first.name)))
- def test_programmatic_function_string(self):
- MinorEnum = self.enum_type('MinorEnum', 'june july august')
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- values = self.values
- if self.enum_type is StrEnum:
- values = ['june','july','august']
- for month, av in zip('june july august'.split(), values):
- e = MinorEnum[month]
- self.assertEqual(e.value, av, list(MinorEnum))
- self.assertEqual(e.name, month)
- if MinorEnum._member_type_ is not object and issubclass(MinorEnum, MinorEnum._member_type_):
- self.assertEqual(e, av)
- else:
- self.assertNotEqual(e, av)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- self.assertIs(e, MinorEnum(av))
- def test_programmatic_function_string_list(self):
- MinorEnum = self.enum_type('MinorEnum', ['june', 'july', 'august'])
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- values = self.values
- if self.enum_type is StrEnum:
- values = ['june','july','august']
- for month, av in zip('june july august'.split(), values):
- e = MinorEnum[month]
- self.assertEqual(e.value, av)
- self.assertEqual(e.name, month)
- if MinorEnum._member_type_ is not object and issubclass(MinorEnum, MinorEnum._member_type_):
- self.assertEqual(e, av)
- else:
- self.assertNotEqual(e, av)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- self.assertIs(e, MinorEnum(av))
- def test_programmatic_function_iterable(self):
- MinorEnum = self.enum_type(
- 'MinorEnum',
- (('june', self.source_values[0]), ('july', self.source_values[1]), ('august', self.source_values[2]))
- )
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for month, av in zip('june july august'.split(), self.values):
- e = MinorEnum[month]
- self.assertEqual(e.value, av)
- self.assertEqual(e.name, month)
- if MinorEnum._member_type_ is not object and issubclass(MinorEnum, MinorEnum._member_type_):
- self.assertEqual(e, av)
- else:
- self.assertNotEqual(e, av)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- self.assertIs(e, MinorEnum(av))
- def test_programmatic_function_from_dict(self):
- MinorEnum = self.enum_type(
- 'MinorEnum',
- OrderedDict((('june', self.source_values[0]), ('july', self.source_values[1]), ('august', self.source_values[2])))
- )
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for month, av in zip('june july august'.split(), self.values):
- e = MinorEnum[month]
- if MinorEnum._member_type_ is not object and issubclass(MinorEnum, MinorEnum._member_type_):
- self.assertEqual(e, av)
- else:
- self.assertNotEqual(e, av)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- self.assertIs(e, MinorEnum(av))
- def test_repr(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(repr(TE(0)), "<MainEnum: 0>")
- self.assertEqual(repr(TE.dupe), "<MainEnum.dupe: 3>")
- self.assertEqual(repr(self.dupe2), "<MainEnum.first|third: 5>")
- elif issubclass(TE, StrEnum):
- self.assertEqual(repr(TE.dupe), "<MainEnum.third: 'third'>")
- else:
- self.assertEqual(repr(TE.dupe), "<MainEnum.third: %r>" % (self.values[2], ), TE._value_repr_)
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(repr(member), "<MainEnum.%s: %r>" % (member.name, member.value))
- def test_repr_override(self):
- class Generic(self.enum_type):
- first = auto()
- second = auto()
- third = auto()
- def __repr__(self):
- return "don't you just love shades of %s?" % self.name
- self.assertEqual(
- repr(Generic.third),
- "don't you just love shades of third?",
- )
- def test_inherited_repr(self):
- class MyEnum(self.enum_type):
- def __repr__(self):
- return "My name is %s." % self.name
- class MySubEnum(MyEnum):
- this = auto()
- that = auto()
- theother = auto()
- self.assertEqual(repr(MySubEnum.that), "My name is that.")
- def test_reversed_iteration_order(self):
- self.assertEqual(
- list(reversed(self.MainEnum)),
- [self.MainEnum.third, self.MainEnum.second, self.MainEnum.first],
- )
- class _PlainOutputTests:
- def test_str(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(str(TE(0)), "MainEnum(0)")
- self.assertEqual(str(TE.dupe), "MainEnum.dupe")
- self.assertEqual(str(self.dupe2), "MainEnum.first|third")
- else:
- self.assertEqual(str(TE.dupe), "MainEnum.third")
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(str(member), "MainEnum.%s" % (member.name, ))
- def test_format(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(format(TE.dupe), "MainEnum.dupe")
- self.assertEqual(format(self.dupe2), "MainEnum.first|third")
- else:
- self.assertEqual(format(TE.dupe), "MainEnum.third")
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(format(member), "MainEnum.%s" % (member.name, ))
- def test_overridden_format(self):
- NF = self.NewFormatEnum
- self.assertEqual(str(NF.first), "NewFormatEnum.first", '%s %r' % (NF.__str__, NF.first))
- self.assertEqual(format(NF.first), "FIRST")
- def test_format_specs(self):
- TE = self.MainEnum
- self.assertFormatIsStr('{}', TE.second)
- self.assertFormatIsStr('{:}', TE.second)
- self.assertFormatIsStr('{:20}', TE.second)
- self.assertFormatIsStr('{:^20}', TE.second)
- self.assertFormatIsStr('{:>20}', TE.second)
- self.assertFormatIsStr('{:<20}', TE.second)
- self.assertFormatIsStr('{:5.2}', TE.second)
- class _MixedOutputTests:
- def test_str(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(str(TE.dupe), "MainEnum.dupe")
- self.assertEqual(str(self.dupe2), "MainEnum.first|third")
- else:
- self.assertEqual(str(TE.dupe), "MainEnum.third")
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(str(member), "MainEnum.%s" % (member.name, ))
- def test_format(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(format(TE.dupe), "MainEnum.dupe")
- self.assertEqual(format(self.dupe2), "MainEnum.first|third")
- else:
- self.assertEqual(format(TE.dupe), "MainEnum.third")
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(format(member), "MainEnum.%s" % (member.name, ))
- def test_overridden_format(self):
- NF = self.NewFormatEnum
- self.assertEqual(str(NF.first), "NewFormatEnum.first")
- self.assertEqual(format(NF.first), "FIRST")
- def test_format_specs(self):
- TE = self.MainEnum
- self.assertFormatIsStr('{}', TE.first)
- self.assertFormatIsStr('{:}', TE.first)
- self.assertFormatIsStr('{:20}', TE.first)
- self.assertFormatIsStr('{:^20}', TE.first)
- self.assertFormatIsStr('{:>20}', TE.first)
- self.assertFormatIsStr('{:<20}', TE.first)
- self.assertFormatIsStr('{:5.2}', TE.first)
- class _MinimalOutputTests:
- def test_str(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(str(TE.dupe), "3")
- self.assertEqual(str(self.dupe2), "5")
- else:
- self.assertEqual(str(TE.dupe), str(self.values[2]))
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(str(member), str(value))
- def test_format(self):
- TE = self.MainEnum
- if self.is_flag:
- self.assertEqual(format(TE.dupe), "3")
- self.assertEqual(format(self.dupe2), "5")
- else:
- self.assertEqual(format(TE.dupe), format(self.values[2]))
- for name, value, member in zip(self.names, self.values, TE, strict=True):
- self.assertEqual(format(member), format(value))
- def test_overridden_format(self):
- NF = self.NewFormatEnum
- self.assertEqual(str(NF.first), str(self.values[0]))
- self.assertEqual(format(NF.first), "FIRST")
- def test_format_specs(self):
- TE = self.MainEnum
- self.assertFormatIsValue('{}', TE.third)
- self.assertFormatIsValue('{:}', TE.third)
- self.assertFormatIsValue('{:20}', TE.third)
- self.assertFormatIsValue('{:^20}', TE.third)
- self.assertFormatIsValue('{:>20}', TE.third)
- self.assertFormatIsValue('{:<20}', TE.third)
- if TE._member_type_ is float:
- self.assertFormatIsValue('{:n}', TE.third)
- self.assertFormatIsValue('{:5.2}', TE.third)
- self.assertFormatIsValue('{:f}', TE.third)
- def test_copy(self):
- TE = self.MainEnum
- copied = copy.copy(TE)
- self.assertEqual(copied, TE)
- deep = copy.deepcopy(TE)
- self.assertEqual(deep, TE)
- class _FlagTests:
- def test_default_missing_with_wrong_type_value(self):
- with self.assertRaisesRegex(
- ValueError,
- "'RED' is not a valid ",
- ) as ctx:
- self.MainEnum('RED')
- self.assertIs(ctx.exception.__context__, None)
- class TestPlainEnum(_EnumTests, _PlainOutputTests, unittest.TestCase):
- enum_type = Enum
- class TestPlainFlag(_EnumTests, _PlainOutputTests, _FlagTests, unittest.TestCase):
- enum_type = Flag
- class TestIntEnum(_EnumTests, _MinimalOutputTests, unittest.TestCase):
- enum_type = IntEnum
- class TestStrEnum(_EnumTests, _MinimalOutputTests, unittest.TestCase):
- enum_type = StrEnum
- class TestIntFlag(_EnumTests, _MinimalOutputTests, _FlagTests, unittest.TestCase):
- enum_type = IntFlag
- class TestMixedInt(_EnumTests, _MixedOutputTests, unittest.TestCase):
- class enum_type(int, Enum): pass
- class TestMixedStr(_EnumTests, _MixedOutputTests, unittest.TestCase):
- class enum_type(str, Enum): pass
- class TestMixedIntFlag(_EnumTests, _MixedOutputTests, _FlagTests, unittest.TestCase):
- class enum_type(int, Flag): pass
- class TestMixedDate(_EnumTests, _MixedOutputTests, unittest.TestCase):
- values = [date(2021, 12, 25), date(2020, 3, 15), date(2019, 11, 27)]
- source_values = [(2021, 12, 25), (2020, 3, 15), (2019, 11, 27)]
- class enum_type(date, Enum):
- def _generate_next_value_(name, start, count, last_values):
- values = [(2021, 12, 25), (2020, 3, 15), (2019, 11, 27)]
- return values[count]
- class TestMinimalDate(_EnumTests, _MinimalOutputTests, unittest.TestCase):
- values = [date(2023, 12, 1), date(2016, 2, 29), date(2009, 1, 1)]
- source_values = [(2023, 12, 1), (2016, 2, 29), (2009, 1, 1)]
- class enum_type(date, ReprEnum):
- def _generate_next_value_(name, start, count, last_values):
- values = [(2023, 12, 1), (2016, 2, 29), (2009, 1, 1)]
- return values[count]
- class TestMixedFloat(_EnumTests, _MixedOutputTests, unittest.TestCase):
- values = [1.1, 2.2, 3.3]
- class enum_type(float, Enum):
- def _generate_next_value_(name, start, count, last_values):
- values = [1.1, 2.2, 3.3]
- return values[count]
- class TestMinimalFloat(_EnumTests, _MinimalOutputTests, unittest.TestCase):
- values = [4.4, 5.5, 6.6]
- class enum_type(float, ReprEnum):
- def _generate_next_value_(name, start, count, last_values):
- values = [4.4, 5.5, 6.6]
- return values[count]
- class TestSpecial(unittest.TestCase):
- """
- various operations that are not attributable to every possible enum
- """
- def setUp(self):
- class Season(Enum):
- SPRING = 1
- SUMMER = 2
- AUTUMN = 3
- WINTER = 4
- self.Season = Season
- #
- class Grades(IntEnum):
- A = 5
- B = 4
- C = 3
- D = 2
- F = 0
- self.Grades = Grades
- #
- class Directional(str, Enum):
- EAST = 'east'
- WEST = 'west'
- NORTH = 'north'
- SOUTH = 'south'
- self.Directional = Directional
- #
- from datetime import date
- class Holiday(date, Enum):
- NEW_YEAR = 2013, 1, 1
- IDES_OF_MARCH = 2013, 3, 15
- self.Holiday = Holiday
- def test_bool(self):
- # plain Enum members are always True
- class Logic(Enum):
- true = True
- false = False
- self.assertTrue(Logic.true)
- self.assertTrue(Logic.false)
- # unless overridden
- class RealLogic(Enum):
- true = True
- false = False
- def __bool__(self):
- return bool(self._value_)
- self.assertTrue(RealLogic.true)
- self.assertFalse(RealLogic.false)
- # mixed Enums depend on mixed-in type
- class IntLogic(int, Enum):
- true = 1
- false = 0
- self.assertTrue(IntLogic.true)
- self.assertFalse(IntLogic.false)
- def test_comparisons(self):
- Season = self.Season
- with self.assertRaises(TypeError):
- Season.SPRING < Season.WINTER
- with self.assertRaises(TypeError):
- Season.SPRING > 4
- #
- self.assertNotEqual(Season.SPRING, 1)
- #
- class Part(Enum):
- SPRING = 1
- CLIP = 2
- BARREL = 3
- #
- self.assertNotEqual(Season.SPRING, Part.SPRING)
- with self.assertRaises(TypeError):
- Season.SPRING < Part.CLIP
- @unittest.skip('to-do list')
- def test_dir_with_custom_dunders(self):
- class PlainEnum(Enum):
- pass
- cls_dir = dir(PlainEnum)
- self.assertNotIn('__repr__', cls_dir)
- self.assertNotIn('__str__', cls_dir)
- self.assertNotIn('__format__', cls_dir)
- self.assertNotIn('__init__', cls_dir)
- #
- class MyEnum(Enum):
- def __repr__(self):
- return object.__repr__(self)
- def __str__(self):
- return object.__repr__(self)
- def __format__(self):
- return object.__repr__(self)
- def __init__(self):
- pass
- cls_dir = dir(MyEnum)
- self.assertIn('__repr__', cls_dir)
- self.assertIn('__str__', cls_dir)
- self.assertIn('__format__', cls_dir)
- self.assertIn('__init__', cls_dir)
- def test_duplicate_name_error(self):
- with self.assertRaises(TypeError):
- class Color(Enum):
- red = 1
- green = 2
- blue = 3
- red = 4
- #
- with self.assertRaises(TypeError):
- class Color(Enum):
- red = 1
- green = 2
- blue = 3
- def red(self):
- return 'red'
- #
- with self.assertRaises(TypeError):
- class Color(Enum):
- @enum.property
- def red(self):
- return 'redder'
- red = 1
- green = 2
- blue = 3
- def test_enum_function_with_qualname(self):
- if isinstance(Theory, Exception):
- raise Theory
- self.assertEqual(Theory.__qualname__, 'spanish_inquisition')
- def test_enum_of_types(self):
- """Support using Enum to refer to types deliberately."""
- class MyTypes(Enum):
- i = int
- f = float
- s = str
- self.assertEqual(MyTypes.i.value, int)
- self.assertEqual(MyTypes.f.value, float)
- self.assertEqual(MyTypes.s.value, str)
- class Foo:
- pass
- class Bar:
- pass
- class MyTypes2(Enum):
- a = Foo
- b = Bar
- self.assertEqual(MyTypes2.a.value, Foo)
- self.assertEqual(MyTypes2.b.value, Bar)
- class SpamEnumNotInner:
- pass
- class SpamEnum(Enum):
- spam = SpamEnumNotInner
- self.assertEqual(SpamEnum.spam.value, SpamEnumNotInner)
- def test_enum_of_generic_aliases(self):
- class E(Enum):
- a = typing.List[int]
- b = list[int]
- self.assertEqual(E.a.value, typing.List[int])
- self.assertEqual(E.b.value, list[int])
- self.assertEqual(repr(E.a), '<E.a: typing.List[int]>')
- self.assertEqual(repr(E.b), '<E.b: list[int]>')
- @unittest.skipIf(
- python_version >= (3, 13),
- 'inner classes are not members',
- )
- def test_nested_classes_in_enum_are_members(self):
- """
- Check for warnings pre-3.13
- """
- with self.assertWarnsRegex(DeprecationWarning, 'will not become a member'):
- class Outer(Enum):
- a = 1
- b = 2
- class Inner(Enum):
- foo = 10
- bar = 11
- self.assertTrue(isinstance(Outer.Inner, Outer))
- self.assertEqual(Outer.a.value, 1)
- self.assertEqual(Outer.Inner.value.foo.value, 10)
- self.assertEqual(
- list(Outer.Inner.value),
- [Outer.Inner.value.foo, Outer.Inner.value.bar],
- )
- self.assertEqual(
- list(Outer),
- [Outer.a, Outer.b, Outer.Inner],
- )
- @unittest.skipIf(
- python_version < (3, 13),
- 'inner classes are still members',
- )
- def test_nested_classes_in_enum_are_not_members(self):
- """Support locally-defined nested classes."""
- class Outer(Enum):
- a = 1
- b = 2
- class Inner(Enum):
- foo = 10
- bar = 11
- self.assertTrue(isinstance(Outer.Inner, type))
- self.assertEqual(Outer.a.value, 1)
- self.assertEqual(Outer.Inner.foo.value, 10)
- self.assertEqual(
- list(Outer.Inner),
- [Outer.Inner.foo, Outer.Inner.bar],
- )
- self.assertEqual(
- list(Outer),
- [Outer.a, Outer.b],
- )
- def test_nested_classes_in_enum_with_nonmember(self):
- class Outer(Enum):
- a = 1
- b = 2
- @nonmember
- class Inner(Enum):
- foo = 10
- bar = 11
- self.assertTrue(isinstance(Outer.Inner, type))
- self.assertEqual(Outer.a.value, 1)
- self.assertEqual(Outer.Inner.foo.value, 10)
- self.assertEqual(
- list(Outer.Inner),
- [Outer.Inner.foo, Outer.Inner.bar],
- )
- self.assertEqual(
- list(Outer),
- [Outer.a, Outer.b],
- )
- def test_enum_of_types_with_nonmember(self):
- """Support using Enum to refer to types deliberately."""
- class MyTypes(Enum):
- i = int
- f = nonmember(float)
- s = str
- self.assertEqual(MyTypes.i.value, int)
- self.assertTrue(MyTypes.f is float)
- self.assertEqual(MyTypes.s.value, str)
- class Foo:
- pass
- class Bar:
- pass
- class MyTypes2(Enum):
- a = Foo
- b = nonmember(Bar)
- self.assertEqual(MyTypes2.a.value, Foo)
- self.assertTrue(MyTypes2.b is Bar)
- class SpamEnumIsInner:
- pass
- class SpamEnum(Enum):
- spam = nonmember(SpamEnumIsInner)
- self.assertTrue(SpamEnum.spam is SpamEnumIsInner)
- def test_nested_classes_in_enum_with_member(self):
- """Support locally-defined nested classes."""
- class Outer(Enum):
- a = 1
- b = 2
- @member
- class Inner(Enum):
- foo = 10
- bar = 11
- self.assertTrue(isinstance(Outer.Inner, Outer))
- self.assertEqual(Outer.a.value, 1)
- self.assertEqual(Outer.Inner.value.foo.value, 10)
- self.assertEqual(
- list(Outer.Inner.value),
- [Outer.Inner.value.foo, Outer.Inner.value.bar],
- )
- self.assertEqual(
- list(Outer),
- [Outer.a, Outer.b, Outer.Inner],
- )
- def test_enum_with_value_name(self):
- class Huh(Enum):
- name = 1
- value = 2
- self.assertEqual(list(Huh), [Huh.name, Huh.value])
- self.assertIs(type(Huh.name), Huh)
- self.assertEqual(Huh.name.name, 'name')
- self.assertEqual(Huh.name.value, 1)
- def test_inherited_data_type(self):
- class HexInt(int):
- __qualname__ = 'HexInt'
- def __repr__(self):
- return hex(self)
- class MyEnum(HexInt, enum.Enum):
- __qualname__ = 'MyEnum'
- A = 1
- B = 2
- C = 3
- self.assertEqual(repr(MyEnum.A), '<MyEnum.A: 0x1>')
- globals()['HexInt'] = HexInt
- globals()['MyEnum'] = MyEnum
- test_pickle_dump_load(self.assertIs, MyEnum.A)
- test_pickle_dump_load(self.assertIs, MyEnum)
- #
- class SillyInt(HexInt):
- __qualname__ = 'SillyInt'
- pass
- class MyOtherEnum(SillyInt, enum.Enum):
- __qualname__ = 'MyOtherEnum'
- D = 4
- E = 5
- F = 6
- self.assertIs(MyOtherEnum._member_type_, SillyInt)
- globals()['SillyInt'] = SillyInt
- globals()['MyOtherEnum'] = MyOtherEnum
- test_pickle_dump_load(self.assertIs, MyOtherEnum.E)
- test_pickle_dump_load(self.assertIs, MyOtherEnum)
- #
- # This did not work in 3.10, but does now with pickling by name
- class UnBrokenInt(int):
- __qualname__ = 'UnBrokenInt'
- def __new__(cls, value):
- return int.__new__(cls, value)
- class MyUnBrokenEnum(UnBrokenInt, Enum):
- __qualname__ = 'MyUnBrokenEnum'
- G = 7
- H = 8
- I = 9
- self.assertIs(MyUnBrokenEnum._member_type_, UnBrokenInt)
- self.assertIs(MyUnBrokenEnum(7), MyUnBrokenEnum.G)
- globals()['UnBrokenInt'] = UnBrokenInt
- globals()['MyUnBrokenEnum'] = MyUnBrokenEnum
- test_pickle_dump_load(self.assertIs, MyUnBrokenEnum.I)
- test_pickle_dump_load(self.assertIs, MyUnBrokenEnum)
- def test_floatenum_fromhex(self):
- h = float.hex(FloatStooges.MOE.value)
- self.assertIs(FloatStooges.fromhex(h), FloatStooges.MOE)
- h = float.hex(FloatStooges.MOE.value + 0.01)
- with self.assertRaises(ValueError):
- FloatStooges.fromhex(h)
- def test_programmatic_function_type(self):
- MinorEnum = Enum('MinorEnum', 'june july august', type=int)
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 1):
- e = MinorEnum(i)
- self.assertEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_programmatic_function_string_with_start(self):
- MinorEnum = Enum('MinorEnum', 'june july august', start=10)
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 10):
- e = MinorEnum(i)
- self.assertEqual(int(e.value), i)
- self.assertNotEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_programmatic_function_type_with_start(self):
- MinorEnum = Enum('MinorEnum', 'june july august', type=int, start=30)
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 30):
- e = MinorEnum(i)
- self.assertEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_programmatic_function_string_list_with_start(self):
- MinorEnum = Enum('MinorEnum', ['june', 'july', 'august'], start=20)
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 20):
- e = MinorEnum(i)
- self.assertEqual(int(e.value), i)
- self.assertNotEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_programmatic_function_type_from_subclass(self):
- MinorEnum = IntEnum('MinorEnum', 'june july august')
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 1):
- e = MinorEnum(i)
- self.assertEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_programmatic_function_type_from_subclass_with_start(self):
- MinorEnum = IntEnum('MinorEnum', 'june july august', start=40)
- lst = list(MinorEnum)
- self.assertEqual(len(lst), len(MinorEnum))
- self.assertEqual(len(MinorEnum), 3, MinorEnum)
- self.assertEqual(
- [MinorEnum.june, MinorEnum.july, MinorEnum.august],
- lst,
- )
- for i, month in enumerate('june july august'.split(), 40):
- e = MinorEnum(i)
- self.assertEqual(e, i)
- self.assertEqual(e.name, month)
- self.assertIn(e, MinorEnum)
- self.assertIs(type(e), MinorEnum)
- def test_intenum_from_bytes(self):
- self.assertIs(IntStooges.from_bytes(b'\x00\x03', 'big'), IntStooges.MOE)
- with self.assertRaises(ValueError):
- IntStooges.from_bytes(b'\x00\x05', 'big')
- def test_reserved_sunder_error(self):
- with self.assertRaisesRegex(
- ValueError,
- '_sunder_ names, such as ._bad_., are reserved',
- ):
- class Bad(Enum):
- _bad_ = 1
- def test_too_many_data_types(self):
- with self.assertRaisesRegex(TypeError, 'too many data types'):
- class Huh(str, int, Enum):
- One = 1
- class MyStr(str):
- def hello(self):
- return 'hello, %s' % self
- class MyInt(int):
- def repr(self):
- return hex(self)
- with self.assertRaisesRegex(TypeError, 'too many data types'):
- class Huh(MyStr, MyInt, Enum):
- One = 1
- def test_pickle_enum(self):
- if isinstance(Stooges, Exception):
- raise Stooges
- test_pickle_dump_load(self.assertIs, Stooges.CURLY)
- test_pickle_dump_load(self.assertIs, Stooges)
- def test_pickle_int(self):
- if isinstance(IntStooges, Exception):
- raise IntStooges
- test_pickle_dump_load(self.assertIs, IntStooges.CURLY)
- test_pickle_dump_load(self.assertIs, IntStooges)
- def test_pickle_float(self):
- if isinstance(FloatStooges, Exception):
- raise FloatStooges
- test_pickle_dump_load(self.assertIs, FloatStooges.CURLY)
- test_pickle_dump_load(self.assertIs, FloatStooges)
- def test_pickle_enum_function(self):
- if isinstance(Answer, Exception):
- raise Answer
- test_pickle_dump_load(self.assertIs, Answer.him)
- test_pickle_dump_load(self.assertIs, Answer)
- def test_pickle_enum_function_with_module(self):
- if isinstance(Question, Exception):
- raise Question
- test_pickle_dump_load(self.assertIs, Question.who)
- test_pickle_dump_load(self.assertIs, Question)
- def test_pickle_nested_class(self):
- # would normally just have this directly in the class namespace
- class NestedEnum(Enum):
- twigs = 'common'
- shiny = 'rare'
- self.__class__.NestedEnum = NestedEnum
- self.NestedEnum.__qualname__ = '%s.NestedEnum' % self.__class__.__name__
- test_pickle_dump_load(self.assertIs, self.NestedEnum.twigs)
- def test_pickle_by_name(self):
- class ReplaceGlobalInt(IntEnum):
- ONE = 1
- TWO = 2
- ReplaceGlobalInt.__reduce_ex__ = enum._reduce_ex_by_global_name
- for proto in range(HIGHEST_PROTOCOL):
- self.assertEqual(ReplaceGlobalInt.TWO.__reduce_ex__(proto), 'TWO')
- def test_pickle_explodes(self):
- BadPickle = Enum(
- 'BadPickle', 'dill sweet bread-n-butter', module=__name__)
- globals()['BadPickle'] = BadPickle
- # now break BadPickle to test exception raising
- enum._make_class_unpicklable(BadPickle)
- test_pickle_exception(self.assertRaises, TypeError, BadPickle.dill)
- test_pickle_exception(self.assertRaises, PicklingError, BadPickle)
- def test_string_enum(self):
- class SkillLevel(str, Enum):
- master = 'what is the sound of one hand clapping?'
- journeyman = 'why did the chicken cross the road?'
- apprentice = 'knock, knock!'
- self.assertEqual(SkillLevel.apprentice, 'knock, knock!')
- def test_getattr_getitem(self):
- class Period(Enum):
- morning = 1
- noon = 2
- evening = 3
- night = 4
- self.assertIs(Period(2), Period.noon)
- self.assertIs(getattr(Period, 'night'), Period.night)
- self.assertIs(Period['morning'], Period.morning)
- def test_getattr_dunder(self):
- Season = self.Season
- self.assertTrue(getattr(Season, '__eq__'))
- def test_iteration_order(self):
- class Season(Enum):
- SUMMER = 2
- WINTER = 4
- AUTUMN = 3
- SPRING = 1
- self.assertEqual(
- list(Season),
- [Season.SUMMER, Season.WINTER, Season.AUTUMN, Season.SPRING],
- )
- def test_subclassing(self):
- if isinstance(Name, Exception):
- raise Name
- self.assertEqual(Name.BDFL, 'Guido van Rossum')
- self.assertTrue(Name.BDFL, Name('Guido van Rossum'))
- self.assertIs(Name.BDFL, getattr(Name, 'BDFL'))
- test_pickle_dump_load(self.assertIs, Name.BDFL)
- def test_extending(self):
- class Color(Enum):
- red = 1
- green = 2
- blue = 3
- #
- with self.assertRaises(TypeError):
- class MoreColor(Color):
- cyan = 4
- magenta = 5
- yellow = 6
- #
- with self.assertRaisesRegex(TypeError, "<enum .EvenMoreColor.> cannot extend <enum .Color.>"):
- class EvenMoreColor(Color, IntEnum):
- chartruese = 7
- #
- with self.assertRaisesRegex(TypeError, "<enum .Foo.> cannot extend <enum .Color.>"):
- Color('Foo', ('pink', 'black'))
- def test_exclude_methods(self):
- class whatever(Enum):
- this = 'that'
- these = 'those'
- def really(self):
- return 'no, not %s' % self.value
- self.assertIsNot(type(whatever.really), whatever)
- self.assertEqual(whatever.this.really(), 'no, not that')
- def test_wrong_inheritance_order(self):
- with self.assertRaises(TypeError):
- class Wrong(Enum, str):
- NotHere = 'error before this point'
- def test_intenum_transitivity(self):
- class number(IntEnum):
- one = 1
- two = 2
- three = 3
- class numero(IntEnum):
- uno = 1
- dos = 2
- tres = 3
- self.assertEqual(number.one, numero.uno)
- self.assertEqual(number.two, numero.dos)
- self.assertEqual(number.three, numero.tres)
- def test_wrong_enum_in_call(self):
- class Monochrome(Enum):
- black = 0
- white = 1
- class Gender(Enum):
- male = 0
- female = 1
- self.assertRaises(ValueError, Monochrome, Gender.male)
- def test_wrong_enum_in_mixed_call(self):
- class Monochrome(IntEnum):
- black = 0
- white = 1
- class Gender(Enum):
- male = 0
- female = 1
- self.assertRaises(ValueError, Monochrome, Gender.male)
- def test_mixed_enum_in_call_1(self):
- class Monochrome(IntEnum):
- black = 0
- white = 1
- class Gender(IntEnum):
- male = 0
- female = 1
- self.assertIs(Monochrome(Gender.female), Monochrome.white)
- def test_mixed_enum_in_call_2(self):
- class Monochrome(Enum):
- black = 0
- white = 1
- class Gender(IntEnum):
- male = 0
- female = 1
- self.assertIs(Monochrome(Gender.male), Monochrome.black)
- def test_flufl_enum(self):
- class Fluflnum(Enum):
- def __int__(self):
- return int(self.value)
- class MailManOptions(Fluflnum):
- option1 = 1
- option2 = 2
- option3 = 3
- self.assertEqual(int(MailManOptions.option1), 1)
- def test_introspection(self):
- class Number(IntEnum):
- one = 100
- two = 200
- self.assertIs(Number.one._member_type_, int)
- self.assertIs(Number._member_type_, int)
- class String(str, Enum):
- yarn = 'soft'
- rope = 'rough'
- wire = 'hard'
- self.assertIs(String.yarn._member_type_, str)
- self.assertIs(String._member_type_, str)
- class Plain(Enum):
- vanilla = 'white'
- one = 1
- self.assertIs(Plain.vanilla._member_type_, object)
- self.assertIs(Plain._member_type_, object)
- def test_no_such_enum_member(self):
- class Color(Enum):
- red = 1
- green = 2
- blue = 3
- with self.assertRaises(ValueError):
- Color(4)
- with self.assertRaises(KeyError):
- Color['chartreuse']
- # tests that need to be evalualted for moving
- def test_multiple_mixin_mro(self):
- class auto_enum(type(Enum)):
- def __new__(metacls, cls, bases, classdict):
- temp = type(classdict)()
- temp._cls_name = cls
- names = set(classdict._member_names)
- i = 0
- for k in classdict._member_names:
- v = classdict[k]
- if v is Ellipsis:
- v = i
- else:
- i = v
- i += 1
- temp[k] = v
- for k, v in classdict.items():
- if k not in names:
- temp[k] = v
- return super(auto_enum, metacls).__new__(
- metacls, cls, bases, temp)
- class AutoNumberedEnum(Enum, metaclass=auto_enum):
- pass
- class AutoIntEnum(IntEnum, metaclass=auto_enum):
- pass
- class TestAutoNumber(AutoNumberedEnum):
- a = ...
- b = 3
- c = ...
- class TestAutoInt(AutoIntEnum):
- a = ...
- b = 3
- c = ...
- def test_subclasses_with_getnewargs(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt' # needed for pickle protocol 4
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- def __getnewargs__(self):
- return self._args
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp,
- )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI' # needed for pickle protocol 4
- x = ('the-x', 1)
- y = ('the-y', 2)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- test_pickle_dump_load(self.assertEqual, NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_subclasses_with_getnewargs_ex(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt' # needed for pickle protocol 4
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- def __getnewargs_ex__(self):
- return self._args, {}
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp,
- )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI' # needed for pickle protocol 4
- x = ('the-x', 1)
- y = ('the-y', 2)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- test_pickle_dump_load(self.assertEqual, NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_subclasses_with_reduce(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt' # needed for pickle protocol 4
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- def __reduce__(self):
- return self.__class__, self._args
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp,
- )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI' # needed for pickle protocol 4
- x = ('the-x', 1)
- y = ('the-y', 2)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- test_pickle_dump_load(self.assertEqual, NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_subclasses_with_reduce_ex(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt' # needed for pickle protocol 4
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- def __reduce_ex__(self, proto):
- return self.__class__, self._args
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp,
- )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI' # needed for pickle protocol 4
- x = ('the-x', 1)
- y = ('the-y', 2)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- test_pickle_dump_load(self.assertEqual, NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_subclasses_without_direct_pickle_support(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt'
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI'
- x = ('the-x', 1)
- y = ('the-y', 2)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_subclasses_with_direct_pickle_support(self):
- class NamedInt(int):
- __qualname__ = 'NamedInt'
- def __new__(cls, *args):
- _args = args
- name, *args = args
- if len(args) == 0:
- raise TypeError("name and value must be specified")
- self = int.__new__(cls, *args)
- self._intname = name
- self._args = _args
- return self
- @bltns.property
- def __name__(self):
- return self._intname
- def __repr__(self):
- # repr() is updated to include the name and type info
- return "{}({!r}, {})".format(
- type(self).__name__,
- self.__name__,
- int.__repr__(self),
- )
- def __str__(self):
- # str() is unchanged, even if it relies on the repr() fallback
- base = int
- base_str = base.__str__
- if base_str.__objclass__ is object:
- return base.__repr__(self)
- return base_str(self)
- # for simplicity, we only define one operator that
- # propagates expressions
- def __add__(self, other):
- temp = int(self) + int( other)
- if isinstance(self, NamedInt) and isinstance(other, NamedInt):
- return NamedInt(
- '({0} + {1})'.format(self.__name__, other.__name__),
- temp,
- )
- else:
- return temp
- class NEI(NamedInt, Enum):
- __qualname__ = 'NEI'
- x = ('the-x', 1)
- y = ('the-y', 2)
- def __reduce_ex__(self, proto):
- return getattr, (self.__class__, self._name_)
- self.assertIs(NEI.__new__, Enum.__new__)
- self.assertEqual(repr(NEI.x + NEI.y), "NamedInt('(the-x + the-y)', 3)")
- globals()['NamedInt'] = NamedInt
- globals()['NEI'] = NEI
- NI5 = NamedInt('test', 5)
- self.assertEqual(NI5, 5)
- self.assertEqual(NEI.y.value, 2)
- test_pickle_dump_load(self.assertIs, NEI.y)
- test_pickle_dump_load(self.assertIs, NEI)
- def test_tuple_subclass(self):
- class SomeTuple(tuple, Enum):
- __qualname__ = 'SomeTuple' # needed for pickle protocol 4
- first = (1, 'for the money')
- second = (2, 'for the show')
- third = (3, 'for the music')
- self.assertIs(type(SomeTuple.first), SomeTuple)
- self.assertIsInstance(SomeTuple.second, tuple)
- self.assertEqual(SomeTuple.third, (3, 'for the music'))
- globals()['SomeTuple'] = SomeTuple
- test_pickle_dump_load(self.assertIs, SomeTuple.first)
- def test_duplicate_values_give_unique_enum_items(self):
- class AutoNumber(Enum):
- first = ()
- second = ()
- third = ()
- def __new__(cls):
- value = len(cls.__members__) + 1
- obj = object.__new__(cls)
- obj._value_ = value
- return obj
- def __int__(self):
- return int(self._value_)
- self.assertEqual(
- list(AutoNumber),
- [AutoNumber.first, AutoNumber.second, AutoNumber.third],
- )
- self.assertEqual(int(AutoNumber.second), 2)
- self.assertEqual(AutoNumber.third.value, 3)
- self.assertIs(AutoNumber(1), AutoNumber.first)
- def test_inherited_new_from_enhanced_enum(self):
- class AutoNumber(Enum):
- def __new__(cls):
- value = len(cls.__members__) + 1
- obj = object.__new__(cls)
- obj._value_ = value
- return obj
- def __int__(self):
- return int(self._value_)
- class Color(AutoNumber):
- red = ()
- green = ()
- blue = ()
- self.assertEqual(list(Color), [Color.red, Color.green, Color.blue])
- self.assertEqual(list(map(int, Color)), [1, 2, 3])
- def test_inherited_new_from_mixed_enum(self):
- class AutoNumber(IntEnum):
- def __new__(cls):
- value = len(cls.__members__) + 1
- obj = int.__new__(cls, value)
- obj._value_ = value
- return obj
- class Color(AutoNumber):
- red = ()
- green = ()
- blue = ()
- self.assertEqual(list(Color), [Color.red, Color.green, Color.blue])
- self.assertEqual(list(map(int, Color)), [1, 2, 3])
- def test_equality(self):
- class OrdinaryEnum(Enum):
- a = 1
- self.assertEqual(ALWAYS_EQ, OrdinaryEnum.a)
- self.assertEqual(OrdinaryEnum.a, ALWAYS_EQ)
- def test_ordered_mixin(self):
- class OrderedEnum(Enum):
- def __ge__(self, other):
- if self.__class__ is other.__class__:
- return self._value_ >= other._value_
- return NotImplemented
- def __gt__(self, other):
- if self.__class__ is other.__class__:
- return self._value_ > other._value_
- return NotImplemented
- def __le__(self, other):
- if self.__class__ is other.__class__:
- return self._value_ <= other._value_
- return NotImplemented
- def __lt__(self, other):
- if self.__class__ is other.__class__:
- return self._value_ < other._value_
- return NotImplemented
- class Grade(OrderedEnum):
- A = 5
- B = 4
- C = 3
- D = 2
- F = 1
- self.assertGreater(Grade.A, Grade.B)
- self.assertLessEqual(Grade.F, Grade.C)
- self.assertLess(Grade.D, Grade.A)
- self.assertGreaterEqual(Grade.B, Grade.B)
- self.assertEqual(Grade.B, Grade.B)
- self.assertNotEqual(Grade.C, Grade.D)
- def test_extending2(self):
- class Shade(Enum):
- def shade(self):
- print(self.name)
- class Color(Shade):
- red = 1
- green = 2
- blue = 3
- with self.assertRaises(TypeError):
- class MoreColor(Color):
- cyan = 4
- magenta = 5
- yellow = 6
- def test_extending3(self):
- class Shade(Enum):
- def shade(self):
- return self.name
- class Color(Shade):
- def hex(self):
- return '%s hexlified!' % self.value
- class MoreColor(Color):
- cyan = 4
- magenta = 5
- yellow = 6
- self.assertEqual(MoreColor.magenta.hex(), '5 hexlified!')
- def test_subclass_duplicate_name(self):
- class Base(Enum):
- def test(self):
- pass
- class Test(Base):
- test = 1
- self.assertIs(type(Test.test), Test)
- def test_subclass_duplicate_name_dynamic(self):
- from types import DynamicClassAttribute
- class Base(Enum):
- @DynamicClassAttribute
- def test(self):
- return 'dynamic'
- class Test(Base):
- test = 1
- self.assertEqual(Test.test.test, 'dynamic')
- self.assertEqual(Test.test.value, 1)
- class Base2(Enum):
- @enum.property
- def flash(self):
- return 'flashy dynamic'
- class Test(Base2):
- flash = 1
- self.assertEqual(Test.flash.flash, 'flashy dynamic')
- self.assertEqual(Test.flash.value, 1)
- def test_no_duplicates(self):
- class UniqueEnum(Enum):
- def __init__(self, *args):
- cls = self.__class__
- if any(self.value == e.value for e in cls):
- a = self.name
- e = cls(self.value).name
- raise ValueError(
- "aliases not allowed in UniqueEnum: %r --> %r"
- % (a, e)
- )
- class Color(UniqueEnum):
- red = 1
- green = 2
- blue = 3
- with self.assertRaises(ValueError):
- class Color(UniqueEnum):
- red = 1
- green = 2
- blue = 3
- grene = 2
- def test_init(self):
- class Planet(Enum):
- MERCURY = (3.303e+23, 2.4397e6)
- VENUS = (4.869e+24, 6.0518e6)
- EARTH = (5.976e+24, 6.37814e6)
- MARS = (6.421e+23, 3.3972e6)
- JUPITER = (1.9e+27, 7.1492e7)
- SATURN = (5.688e+26, 6.0268e7)
- URANUS = (8.686e+25, 2.5559e7)
- NEPTUNE = (1.024e+26, 2.4746e7)
- def __init__(self, mass, radius):
- self.mass = mass # in kilograms
- self.radius = radius # in meters
- @enum.property
- def surface_gravity(self):
- # universal gravitational constant (m3 kg-1 s-2)
- G = 6.67300E-11
- return G * self.mass / (self.radius * self.radius)
- self.assertEqual(round(Planet.EARTH.surface_gravity, 2), 9.80)
- self.assertEqual(Planet.EARTH.value, (5.976e+24, 6.37814e6))
- def test_ignore(self):
- class Period(timedelta, Enum):
- '''
- different lengths of time
- '''
- def __new__(cls, value, period):
- obj = timedelta.__new__(cls, value)
- obj._value_ = value
- obj.period = period
- return obj
- _ignore_ = 'Period i'
- Period = vars()
- for i in range(13):
- Period['month_%d' % i] = i*30, 'month'
- for i in range(53):
- Period['week_%d' % i] = i*7, 'week'
- for i in range(32):
- Period['day_%d' % i] = i, 'day'
- OneDay = day_1
- OneWeek = week_1
- OneMonth = month_1
- self.assertFalse(hasattr(Period, '_ignore_'))
- self.assertFalse(hasattr(Period, 'Period'))
- self.assertFalse(hasattr(Period, 'i'))
- self.assertTrue(isinstance(Period.day_1, timedelta))
- self.assertTrue(Period.month_1 is Period.day_30)
- self.assertTrue(Period.week_4 is Period.day_28)
- def test_nonhash_value(self):
- class AutoNumberInAList(Enum):
- def __new__(cls):
- value = [len(cls.__members__) + 1]
- obj = object.__new__(cls)
- obj._value_ = value
- return obj
- class ColorInAList(AutoNumberInAList):
- red = ()
- green = ()
- blue = ()
- self.assertEqual(list(ColorInAList), [ColorInAList.red, ColorInAList.green, ColorInAList.blue])
- for enum, value in zip(ColorInAList, range(3)):
- value += 1
- self.assertEqual(enum.value, [value])
- self.assertIs(ColorInAList([value]), enum)
- def test_conflicting_types_resolved_in_new(self):
- class LabelledIntEnum(int, Enum):
- def __new__(cls, *args):
- value, label = args
- obj = int.__new__(cls, value)
- obj.label = label
- obj._value_ = value
- return obj
- class LabelledList(LabelledIntEnum):
- unprocessed = (1, "Unprocessed")
- payment_complete = (2, "Payment Complete")
- self.assertEqual(list(LabelledList), [LabelledList.unprocessed, LabelledList.payment_complete])
- self.assertEqual(LabelledList.unprocessed, 1)
- self.assertEqual(LabelledList(1), LabelledList.unprocessed)
- def test_default_missing_no_chained_exception(self):
- class Color(Enum):
- RED = 1
- GREEN = 2
- BLUE = 3
- try:
- Color(7)
- except ValueError as exc:
- self.assertTrue(exc.__context__ is None)
- else:
- raise Exception('Exception not raised.')
- def test_missing_override(self):
- class Color(Enum):
- red = 1
- green = 2
- blue = 3
- @classmethod
- def _missing_(cls, item):
- if item == 'three':
- return cls.blue
- elif item == 'bad return':
- # trigger internal error
- return 5
- elif item == 'error out':
- raise ZeroDivisionError
- else:
- # trigger not found
- return None
- self.assertIs(Color('three'), Color.blue)
- try:
- Color(7)
- except ValueError as exc:
- self.assertTrue(exc.__context__ is None)
- else:
- raise Exception('Exception not raised.')
- try:
- Color('bad return')
- except TypeError as exc:
- self.assertTrue(isinstance(exc.__context__, ValueError))
- else:
- raise Exception('Exception not raised.')
- try:
- Color('error out')
- except ZeroDivisionError as exc:
- self.assertTrue(isinstance(exc.__context__, ValueError))
- else:
- raise Exception('Exception not raised.')
- def test_missing_exceptions_reset(self):
- import gc
- import weakref
- #
- class TestEnum(enum.Enum):
- VAL1 = 'val1'
- VAL2 = 'val2'
- #
- class Class1:
- def __init__(self):
- # Gracefully handle an exception of our own making
- try:
- raise ValueError()
- except ValueError:
- pass
- #
- class Class2:
- def __init__(self):
- # Gracefully handle an exception of Enum's making
- try:
- TestEnum('invalid_value')
- except ValueError:
- pass
- # No strong refs here so these are free to die.
- class_1_ref = weakref.ref(Class1())
- class_2_ref = weakref.ref(Class2())
- #
- # The exception raised by Enum used to create a reference loop and thus
- # Class2 instances would stick around until the next garbage collection
- # cycle, unlike Class1. Verify Class2 no longer does this.
- gc.collect() # For PyPy or other GCs.
- self.assertIs(class_1_ref(), None)
- self.assertIs(class_2_ref(), None)
- def test_multiple_mixin(self):
- class MaxMixin:
- @classproperty
- def MAX(cls):
- max = len(cls)
- cls.MAX = max
- return max
- class StrMixin:
- def __str__(self):
- return self._name_.lower()
- class SomeEnum(Enum):
- def behavior(self):
- return 'booyah'
- class AnotherEnum(Enum):
- def behavior(self):
- return 'nuhuh!'
- def social(self):
- return "what's up?"
- class Color(MaxMixin, Enum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 3)
- self.assertEqual(Color.MAX, 3)
- self.assertEqual(str(Color.BLUE), 'Color.BLUE')
- class Color(MaxMixin, StrMixin, Enum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 3)
- self.assertEqual(Color.MAX, 3)
- self.assertEqual(str(Color.BLUE), 'blue')
- class Color(StrMixin, MaxMixin, Enum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 3)
- self.assertEqual(Color.MAX, 3)
- self.assertEqual(str(Color.BLUE), 'blue')
- class CoolColor(StrMixin, SomeEnum, Enum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(CoolColor.RED.value, 1)
- self.assertEqual(CoolColor.GREEN.value, 2)
- self.assertEqual(CoolColor.BLUE.value, 3)
- self.assertEqual(str(CoolColor.BLUE), 'blue')
- self.assertEqual(CoolColor.RED.behavior(), 'booyah')
- class CoolerColor(StrMixin, AnotherEnum, Enum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(CoolerColor.RED.value, 1)
- self.assertEqual(CoolerColor.GREEN.value, 2)
- self.assertEqual(CoolerColor.BLUE.value, 3)
- self.assertEqual(str(CoolerColor.BLUE), 'blue')
- self.assertEqual(CoolerColor.RED.behavior(), 'nuhuh!')
- self.assertEqual(CoolerColor.RED.social(), "what's up?")
- class CoolestColor(StrMixin, SomeEnum, AnotherEnum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(CoolestColor.RED.value, 1)
- self.assertEqual(CoolestColor.GREEN.value, 2)
- self.assertEqual(CoolestColor.BLUE.value, 3)
- self.assertEqual(str(CoolestColor.BLUE), 'blue')
- self.assertEqual(CoolestColor.RED.behavior(), 'booyah')
- self.assertEqual(CoolestColor.RED.social(), "what's up?")
- class ConfusedColor(StrMixin, AnotherEnum, SomeEnum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(ConfusedColor.RED.value, 1)
- self.assertEqual(ConfusedColor.GREEN.value, 2)
- self.assertEqual(ConfusedColor.BLUE.value, 3)
- self.assertEqual(str(ConfusedColor.BLUE), 'blue')
- self.assertEqual(ConfusedColor.RED.behavior(), 'nuhuh!')
- self.assertEqual(ConfusedColor.RED.social(), "what's up?")
- class ReformedColor(StrMixin, IntEnum, SomeEnum, AnotherEnum):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__ # needed as of 3.11
- self.assertEqual(ReformedColor.RED.value, 1)
- self.assertEqual(ReformedColor.GREEN.value, 2)
- self.assertEqual(ReformedColor.BLUE.value, 3)
- self.assertEqual(str(ReformedColor.BLUE), 'blue')
- self.assertEqual(ReformedColor.RED.behavior(), 'booyah')
- self.assertEqual(ConfusedColor.RED.social(), "what's up?")
- self.assertTrue(issubclass(ReformedColor, int))
- def test_multiple_inherited_mixin(self):
- @unique
- class Decision1(StrEnum):
- REVERT = "REVERT"
- REVERT_ALL = "REVERT_ALL"
- RETRY = "RETRY"
- class MyEnum(StrEnum):
- pass
- @unique
- class Decision2(MyEnum):
- REVERT = "REVERT"
- REVERT_ALL = "REVERT_ALL"
- RETRY = "RETRY"
- def test_multiple_mixin_inherited(self):
- class MyInt(int):
- def __new__(cls, value):
- return super().__new__(cls, value)
- class HexMixin:
- def __repr__(self):
- return hex(self)
- class MyIntEnum(HexMixin, MyInt, enum.Enum):
- __repr__ = HexMixin.__repr__
- class Foo(MyIntEnum):
- TEST = 1
- self.assertTrue(isinstance(Foo.TEST, MyInt))
- self.assertEqual(Foo._member_type_, MyInt)
- self.assertEqual(repr(Foo.TEST), "0x1")
- class Fee(MyIntEnum):
- TEST = 1
- def __new__(cls, value):
- value += 1
- member = int.__new__(cls, value)
- member._value_ = value
- return member
- self.assertEqual(Fee.TEST, 2)
- def test_multiple_mixin_with_common_data_type(self):
- class CaseInsensitiveStrEnum(str, Enum):
- @classmethod
- def _missing_(cls, value):
- for member in cls._member_map_.values():
- if member._value_.lower() == value.lower():
- return member
- return super()._missing_(value)
- #
- class LenientStrEnum(str, Enum):
- def __init__(self, *args):
- self._valid = True
- @classmethod
- def _missing_(cls, value):
- unknown = cls._member_type_.__new__(cls, value)
- unknown._valid = False
- unknown._name_ = value.upper()
- unknown._value_ = value
- cls._member_map_[value] = unknown
- return unknown
- @enum.property
- def valid(self):
- return self._valid
- #
- class JobStatus(CaseInsensitiveStrEnum, LenientStrEnum):
- ACTIVE = "active"
- PENDING = "pending"
- TERMINATED = "terminated"
- #
- JS = JobStatus
- self.assertEqual(list(JobStatus), [JS.ACTIVE, JS.PENDING, JS.TERMINATED])
- self.assertEqual(JS.ACTIVE, 'active')
- self.assertEqual(JS.ACTIVE.value, 'active')
- self.assertIs(JS('Active'), JS.ACTIVE)
- self.assertTrue(JS.ACTIVE.valid)
- missing = JS('missing')
- self.assertEqual(list(JobStatus), [JS.ACTIVE, JS.PENDING, JS.TERMINATED])
- self.assertEqual(JS.ACTIVE, 'active')
- self.assertEqual(JS.ACTIVE.value, 'active')
- self.assertIs(JS('Active'), JS.ACTIVE)
- self.assertTrue(JS.ACTIVE.valid)
- self.assertTrue(isinstance(missing, JS))
- self.assertFalse(missing.valid)
- def test_empty_globals(self):
- # bpo-35717: sys._getframe(2).f_globals['__name__'] fails with KeyError
- # when using compile and exec because f_globals is empty
- code = "from enum import Enum; Enum('Animal', 'ANT BEE CAT DOG')"
- code = compile(code, "<string>", "exec")
- global_ns = {}
- local_ls = {}
- exec(code, global_ns, local_ls)
- def test_strenum(self):
- class GoodStrEnum(StrEnum):
- one = '1'
- two = '2'
- three = b'3', 'ascii'
- four = b'4', 'latin1', 'strict'
- self.assertEqual(GoodStrEnum.one, '1')
- self.assertEqual(str(GoodStrEnum.one), '1')
- self.assertEqual('{}'.format(GoodStrEnum.one), '1')
- self.assertEqual(GoodStrEnum.one, str(GoodStrEnum.one))
- self.assertEqual(GoodStrEnum.one, '{}'.format(GoodStrEnum.one))
- self.assertEqual(repr(GoodStrEnum.one), "<GoodStrEnum.one: '1'>")
- #
- class DumbMixin:
- def __str__(self):
- return "don't do this"
- class DumbStrEnum(DumbMixin, StrEnum):
- five = '5'
- six = '6'
- seven = '7'
- __str__ = DumbMixin.__str__ # needed as of 3.11
- self.assertEqual(DumbStrEnum.seven, '7')
- self.assertEqual(str(DumbStrEnum.seven), "don't do this")
- #
- class EnumMixin(Enum):
- def hello(self):
- print('hello from %s' % (self, ))
- class HelloEnum(EnumMixin, StrEnum):
- eight = '8'
- self.assertEqual(HelloEnum.eight, '8')
- self.assertEqual(HelloEnum.eight, str(HelloEnum.eight))
- #
- class GoodbyeMixin:
- def goodbye(self):
- print('%s wishes you a fond farewell')
- class GoodbyeEnum(GoodbyeMixin, EnumMixin, StrEnum):
- nine = '9'
- self.assertEqual(GoodbyeEnum.nine, '9')
- self.assertEqual(GoodbyeEnum.nine, str(GoodbyeEnum.nine))
- #
- with self.assertRaisesRegex(TypeError, '1 is not a string'):
- class FirstFailedStrEnum(StrEnum):
- one = 1
- two = '2'
- with self.assertRaisesRegex(TypeError, "2 is not a string"):
- class SecondFailedStrEnum(StrEnum):
- one = '1'
- two = 2,
- three = '3'
- with self.assertRaisesRegex(TypeError, '2 is not a string'):
- class ThirdFailedStrEnum(StrEnum):
- one = '1'
- two = 2
- with self.assertRaisesRegex(TypeError, 'encoding must be a string, not %r' % (sys.getdefaultencoding, )):
- class ThirdFailedStrEnum(StrEnum):
- one = '1'
- two = b'2', sys.getdefaultencoding
- with self.assertRaisesRegex(TypeError, 'errors must be a string, not 9'):
- class ThirdFailedStrEnum(StrEnum):
- one = '1'
- two = b'2', 'ascii', 9
- def test_custom_strenum(self):
- class CustomStrEnum(str, Enum):
- pass
- class OkayEnum(CustomStrEnum):
- one = '1'
- two = '2'
- three = b'3', 'ascii'
- four = b'4', 'latin1', 'strict'
- self.assertEqual(OkayEnum.one, '1')
- self.assertEqual(str(OkayEnum.one), 'OkayEnum.one')
- self.assertEqual('{}'.format(OkayEnum.one), 'OkayEnum.one')
- self.assertEqual(repr(OkayEnum.one), "<OkayEnum.one: '1'>")
- #
- class DumbMixin:
- def __str__(self):
- return "don't do this"
- class DumbStrEnum(DumbMixin, CustomStrEnum):
- five = '5'
- six = '6'
- seven = '7'
- __str__ = DumbMixin.__str__ # needed as of 3.11
- self.assertEqual(DumbStrEnum.seven, '7')
- self.assertEqual(str(DumbStrEnum.seven), "don't do this")
- #
- class EnumMixin(Enum):
- def hello(self):
- print('hello from %s' % (self, ))
- class HelloEnum(EnumMixin, CustomStrEnum):
- eight = '8'
- self.assertEqual(HelloEnum.eight, '8')
- self.assertEqual(str(HelloEnum.eight), 'HelloEnum.eight')
- #
- class GoodbyeMixin:
- def goodbye(self):
- print('%s wishes you a fond farewell')
- class GoodbyeEnum(GoodbyeMixin, EnumMixin, CustomStrEnum):
- nine = '9'
- self.assertEqual(GoodbyeEnum.nine, '9')
- self.assertEqual(str(GoodbyeEnum.nine), 'GoodbyeEnum.nine')
- #
- class FirstFailedStrEnum(CustomStrEnum):
- one = 1 # this will become '1'
- two = '2'
- class SecondFailedStrEnum(CustomStrEnum):
- one = '1'
- two = 2, # this will become '2'
- three = '3'
- class ThirdFailedStrEnum(CustomStrEnum):
- one = '1'
- two = 2 # this will become '2'
- with self.assertRaisesRegex(TypeError, '.encoding. must be str, not '):
- class ThirdFailedStrEnum(CustomStrEnum):
- one = '1'
- two = b'2', sys.getdefaultencoding
- with self.assertRaisesRegex(TypeError, '.errors. must be str, not '):
- class ThirdFailedStrEnum(CustomStrEnum):
- one = '1'
- two = b'2', 'ascii', 9
- def test_missing_value_error(self):
- with self.assertRaisesRegex(TypeError, "_value_ not set in __new__"):
- class Combined(str, Enum):
- #
- def __new__(cls, value, sequence):
- enum = str.__new__(cls, value)
- if '(' in value:
- fis_name, segment = value.split('(', 1)
- segment = segment.strip(' )')
- else:
- fis_name = value
- segment = None
- enum.fis_name = fis_name
- enum.segment = segment
- enum.sequence = sequence
- return enum
- #
- def __repr__(self):
- return "<%s.%s>" % (self.__class__.__name__, self._name_)
- #
- key_type = 'An$(1,2)', 0
- company_id = 'An$(3,2)', 1
- code = 'An$(5,1)', 2
- description = 'Bn$', 3
- def test_private_variable_is_normal_attribute(self):
- class Private(Enum):
- __corporal = 'Radar'
- __major_ = 'Hoolihan'
- self.assertEqual(Private._Private__corporal, 'Radar')
- self.assertEqual(Private._Private__major_, 'Hoolihan')
- @unittest.skip("Accessing all values retained for performance reasons, see GH-93910")
- def test_exception_for_member_from_member_access(self):
- with self.assertRaisesRegex(AttributeError, "<enum .Di.> member has no attribute .NO."):
- class Di(Enum):
- YES = 1
- NO = 0
- nope = Di.YES.NO
- def test_dynamic_members_with_static_methods(self):
- #
- foo_defines = {'FOO_CAT': 'aloof', 'BAR_DOG': 'friendly', 'FOO_HORSE': 'big'}
- class Foo(Enum):
- vars().update({
- k: v
- for k, v in foo_defines.items()
- if k.startswith('FOO_')
- })
- def upper(self):
- return self.value.upper()
- self.assertEqual(list(Foo), [Foo.FOO_CAT, Foo.FOO_HORSE])
- self.assertEqual(Foo.FOO_CAT.value, 'aloof')
- self.assertEqual(Foo.FOO_HORSE.upper(), 'BIG')
- #
- with self.assertRaisesRegex(TypeError, "'FOO_CAT' already defined as 'aloof'"):
- class FooBar(Enum):
- vars().update({
- k: v
- for k, v in foo_defines.items()
- if k.startswith('FOO_')
- },
- **{'FOO_CAT': 'small'},
- )
- def upper(self):
- return self.value.upper()
- def test_repr_with_dataclass(self):
- "ensure dataclass-mixin has correct repr()"
- from dataclasses import dataclass
- @dataclass
- class Foo:
- __qualname__ = 'Foo'
- a: int
- class Entries(Foo, Enum):
- ENTRY1 = 1
- self.assertTrue(isinstance(Entries.ENTRY1, Foo))
- self.assertTrue(Entries._member_type_ is Foo, Entries._member_type_)
- self.assertTrue(Entries.ENTRY1.value == Foo(1), Entries.ENTRY1.value)
- self.assertEqual(repr(Entries.ENTRY1), '<Entries.ENTRY1: Foo(a=1)>')
- def test_repr_with_init_data_type_mixin(self):
- # non-data_type is a mixin that doesn't define __new__
- class Foo:
- def __init__(self, a):
- self.a = a
- def __repr__(self):
- return f'Foo(a={self.a!r})'
- class Entries(Foo, Enum):
- ENTRY1 = 1
- #
- self.assertEqual(repr(Entries.ENTRY1), '<Entries.ENTRY1: Foo(a=1)>')
- def test_repr_and_str_with_non_data_type_mixin(self):
- # non-data_type is a mixin that doesn't define __new__
- class Foo:
- def __repr__(self):
- return 'Foo'
- def __str__(self):
- return 'ooF'
- class Entries(Foo, Enum):
- ENTRY1 = 1
- #
- self.assertEqual(repr(Entries.ENTRY1), 'Foo')
- self.assertEqual(str(Entries.ENTRY1), 'ooF')
- def test_value_backup_assign(self):
- # check that enum will add missing values when custom __new__ does not
- class Some(Enum):
- def __new__(cls, val):
- return object.__new__(cls)
- x = 1
- y = 2
- self.assertEqual(Some.x.value, 1)
- self.assertEqual(Some.y.value, 2)
- def test_custom_flag_bitwise(self):
- class MyIntFlag(int, Flag):
- ONE = 1
- TWO = 2
- FOUR = 4
- self.assertTrue(isinstance(MyIntFlag.ONE | MyIntFlag.TWO, MyIntFlag), MyIntFlag.ONE | MyIntFlag.TWO)
- self.assertTrue(isinstance(MyIntFlag.ONE | 2, MyIntFlag))
- def test_int_flags_copy(self):
- class MyIntFlag(IntFlag):
- ONE = 1
- TWO = 2
- FOUR = 4
- flags = MyIntFlag.ONE | MyIntFlag.TWO
- copied = copy.copy(flags)
- deep = copy.deepcopy(flags)
- self.assertEqual(copied, flags)
- self.assertEqual(deep, flags)
- flags = MyIntFlag.ONE | MyIntFlag.TWO | 8
- copied = copy.copy(flags)
- deep = copy.deepcopy(flags)
- self.assertEqual(copied, flags)
- self.assertEqual(deep, flags)
- self.assertEqual(copied.value, 1 | 2 | 8)
- def test_namedtuple_as_value(self):
- from collections import namedtuple
- TTuple = namedtuple('TTuple', 'id a blist')
- class NTEnum(Enum):
- NONE = TTuple(0, 0, [])
- A = TTuple(1, 2, [4])
- B = TTuple(2, 4, [0, 1, 2])
- self.assertEqual(repr(NTEnum.NONE), "<NTEnum.NONE: TTuple(id=0, a=0, blist=[])>")
- self.assertEqual(NTEnum.NONE.value, TTuple(id=0, a=0, blist=[]))
- self.assertEqual(
- [x.value for x in NTEnum],
- [TTuple(id=0, a=0, blist=[]), TTuple(id=1, a=2, blist=[4]), TTuple(id=2, a=4, blist=[0, 1, 2])],
- )
- def test_flag_with_custom_new(self):
- class FlagFromChar(IntFlag):
- def __new__(cls, c):
- value = 1 << c
- self = int.__new__(cls, value)
- self._value_ = value
- return self
- #
- a = ord('a')
- #
- self.assertEqual(FlagFromChar.a, 158456325028528675187087900672)
- self.assertEqual(FlagFromChar.a|1, 158456325028528675187087900673)
- #
- #
- class FlagFromChar(Flag):
- def __new__(cls, c):
- value = 1 << c
- self = object.__new__(cls)
- self._value_ = value
- return self
- #
- a = ord('a')
- z = 1
- #
- self.assertEqual(FlagFromChar.a.value, 158456325028528675187087900672)
- self.assertEqual((FlagFromChar.a|FlagFromChar.z).value, 158456325028528675187087900674)
- #
- #
- class FlagFromChar(int, Flag, boundary=KEEP):
- def __new__(cls, c):
- value = 1 << c
- self = int.__new__(cls, value)
- self._value_ = value
- return self
- #
- a = ord('a')
- #
- self.assertEqual(FlagFromChar.a, 158456325028528675187087900672)
- self.assertEqual(FlagFromChar.a|1, 158456325028528675187087900673)
- class TestOrder(unittest.TestCase):
- "test usage of the `_order_` attribute"
- def test_same_members(self):
- class Color(Enum):
- _order_ = 'red green blue'
- red = 1
- green = 2
- blue = 3
- def test_same_members_with_aliases(self):
- class Color(Enum):
- _order_ = 'red green blue'
- red = 1
- green = 2
- blue = 3
- verde = green
- def test_same_members_wrong_order(self):
- with self.assertRaisesRegex(TypeError, 'member order does not match _order_'):
- class Color(Enum):
- _order_ = 'red green blue'
- red = 1
- blue = 3
- green = 2
- def test_order_has_extra_members(self):
- with self.assertRaisesRegex(TypeError, 'member order does not match _order_'):
- class Color(Enum):
- _order_ = 'red green blue purple'
- red = 1
- green = 2
- blue = 3
- def test_order_has_extra_members_with_aliases(self):
- with self.assertRaisesRegex(TypeError, 'member order does not match _order_'):
- class Color(Enum):
- _order_ = 'red green blue purple'
- red = 1
- green = 2
- blue = 3
- verde = green
- def test_enum_has_extra_members(self):
- with self.assertRaisesRegex(TypeError, 'member order does not match _order_'):
- class Color(Enum):
- _order_ = 'red green blue'
- red = 1
- green = 2
- blue = 3
- purple = 4
- def test_enum_has_extra_members_with_aliases(self):
- with self.assertRaisesRegex(TypeError, 'member order does not match _order_'):
- class Color(Enum):
- _order_ = 'red green blue'
- red = 1
- green = 2
- blue = 3
- purple = 4
- verde = green
- class OldTestFlag(unittest.TestCase):
- """Tests of the Flags."""
- class Perm(Flag):
- R, W, X = 4, 2, 1
- class Open(Flag):
- RO = 0
- WO = 1
- RW = 2
- AC = 3
- CE = 1<<19
- class Color(Flag):
- BLACK = 0
- RED = 1
- ROJO = 1
- GREEN = 2
- BLUE = 4
- PURPLE = RED|BLUE
- WHITE = RED|GREEN|BLUE
- BLANCO = RED|GREEN|BLUE
- def test_or(self):
- Perm = self.Perm
- for i in Perm:
- for j in Perm:
- self.assertEqual((i | j), Perm(i.value | j.value))
- self.assertEqual((i | j).value, i.value | j.value)
- self.assertIs(type(i | j), Perm)
- for i in Perm:
- self.assertIs(i | i, i)
- Open = self.Open
- self.assertIs(Open.RO | Open.CE, Open.CE)
- def test_and(self):
- Perm = self.Perm
- RW = Perm.R | Perm.W
- RX = Perm.R | Perm.X
- WX = Perm.W | Perm.X
- RWX = Perm.R | Perm.W | Perm.X
- values = list(Perm) + [RW, RX, WX, RWX, Perm(0)]
- for i in values:
- for j in values:
- self.assertEqual((i & j).value, i.value & j.value)
- self.assertIs(type(i & j), Perm)
- for i in Perm:
- self.assertIs(i & i, i)
- self.assertIs(i & RWX, i)
- self.assertIs(RWX & i, i)
- Open = self.Open
- self.assertIs(Open.RO & Open.CE, Open.RO)
- def test_xor(self):
- Perm = self.Perm
- for i in Perm:
- for j in Perm:
- self.assertEqual((i ^ j).value, i.value ^ j.value)
- self.assertIs(type(i ^ j), Perm)
- for i in Perm:
- self.assertIs(i ^ Perm(0), i)
- self.assertIs(Perm(0) ^ i, i)
- Open = self.Open
- self.assertIs(Open.RO ^ Open.CE, Open.CE)
- self.assertIs(Open.CE ^ Open.CE, Open.RO)
- def test_invert(self):
- Perm = self.Perm
- RW = Perm.R | Perm.W
- RX = Perm.R | Perm.X
- WX = Perm.W | Perm.X
- RWX = Perm.R | Perm.W | Perm.X
- values = list(Perm) + [RW, RX, WX, RWX, Perm(0)]
- for i in values:
- self.assertIs(type(~i), Perm)
- self.assertEqual(~~i, i)
- for i in Perm:
- self.assertIs(~~i, i)
- Open = self.Open
- self.assertIs(Open.WO & ~Open.WO, Open.RO)
- self.assertIs((Open.WO|Open.CE) & ~Open.WO, Open.CE)
- def test_bool(self):
- Perm = self.Perm
- for f in Perm:
- self.assertTrue(f)
- Open = self.Open
- for f in Open:
- self.assertEqual(bool(f.value), bool(f))
- def test_boundary(self):
- self.assertIs(enum.Flag._boundary_, CONFORM)
- class Iron(Flag, boundary=STRICT):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Iron._boundary_, STRICT)
- #
- class Water(Flag, boundary=CONFORM):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Water._boundary_, CONFORM)
- #
- class Space(Flag, boundary=EJECT):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Space._boundary_, EJECT)
- #
- class Bizarre(Flag, boundary=KEEP):
- b = 3
- c = 4
- d = 6
- #
- self.assertRaisesRegex(ValueError, 'invalid value 7', Iron, 7)
- #
- self.assertIs(Water(7), Water.ONE|Water.TWO)
- self.assertIs(Water(~9), Water.TWO)
- #
- self.assertEqual(Space(7), 7)
- self.assertTrue(type(Space(7)) is int)
- #
- self.assertEqual(list(Bizarre), [Bizarre.c])
- self.assertIs(Bizarre(3), Bizarre.b)
- self.assertIs(Bizarre(6), Bizarre.d)
- def test_iter(self):
- Color = self.Color
- Open = self.Open
- self.assertEqual(list(Color), [Color.RED, Color.GREEN, Color.BLUE])
- self.assertEqual(list(Open), [Open.WO, Open.RW, Open.CE])
- def test_programatic_function_string(self):
- Perm = Flag('Perm', 'R W X')
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_string_with_start(self):
- Perm = Flag('Perm', 'R W X', start=8)
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 8<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_string_list(self):
- Perm = Flag('Perm', ['R', 'W', 'X'])
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_iterable(self):
- Perm = Flag('Perm', (('R', 2), ('W', 8), ('X', 32)))
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<(2*i+1)
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_from_dict(self):
- Perm = Flag('Perm', OrderedDict((('R', 2), ('W', 8), ('X', 32))))
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<(2*i+1)
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_pickle(self):
- if isinstance(FlagStooges, Exception):
- raise FlagStooges
- test_pickle_dump_load(self.assertIs, FlagStooges.CURLY)
- test_pickle_dump_load(self.assertEqual,
- FlagStooges.CURLY|FlagStooges.MOE)
- test_pickle_dump_load(self.assertEqual,
- FlagStooges.CURLY&~FlagStooges.CURLY)
- test_pickle_dump_load(self.assertIs, FlagStooges)
- test_pickle_dump_load(self.assertIs, FlagStoogesWithZero.CURLY)
- test_pickle_dump_load(self.assertEqual,
- FlagStoogesWithZero.CURLY|FlagStoogesWithZero.MOE)
- test_pickle_dump_load(self.assertIs, FlagStoogesWithZero.NOFLAG)
- test_pickle_dump_load(self.assertIs, IntFlagStooges.CURLY)
- test_pickle_dump_load(self.assertEqual,
- IntFlagStooges.CURLY|IntFlagStooges.MOE)
- test_pickle_dump_load(self.assertEqual,
- IntFlagStooges.CURLY|IntFlagStooges.MOE|0x30)
- test_pickle_dump_load(self.assertEqual, IntFlagStooges(0))
- test_pickle_dump_load(self.assertEqual, IntFlagStooges(0x30))
- test_pickle_dump_load(self.assertIs, IntFlagStooges)
- test_pickle_dump_load(self.assertIs, IntFlagStoogesWithZero.CURLY)
- test_pickle_dump_load(self.assertEqual,
- IntFlagStoogesWithZero.CURLY|IntFlagStoogesWithZero.MOE)
- test_pickle_dump_load(self.assertIs, IntFlagStoogesWithZero.NOFLAG)
- @unittest.skipIf(
- python_version >= (3, 12),
- '__contains__ now returns True/False for all inputs',
- )
- def test_contains_er(self):
- Open = self.Open
- Color = self.Color
- self.assertFalse(Color.BLACK in Open)
- self.assertFalse(Open.RO in Color)
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 'BLACK' in Color
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 'RO' in Open
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 1 in Color
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 1 in Open
- @unittest.skipIf(
- python_version < (3, 12),
- '__contains__ only works with enum memmbers before 3.12',
- )
- def test_contains_tf(self):
- Open = self.Open
- Color = self.Color
- self.assertFalse(Color.BLACK in Open)
- self.assertFalse(Open.RO in Color)
- self.assertFalse('BLACK' in Color)
- self.assertFalse('RO' in Open)
- self.assertTrue(1 in Color)
- self.assertTrue(1 in Open)
- def test_member_contains(self):
- Perm = self.Perm
- R, W, X = Perm
- RW = R | W
- RX = R | X
- WX = W | X
- RWX = R | W | X
- self.assertTrue(R in RW)
- self.assertTrue(R in RX)
- self.assertTrue(R in RWX)
- self.assertTrue(W in RW)
- self.assertTrue(W in WX)
- self.assertTrue(W in RWX)
- self.assertTrue(X in RX)
- self.assertTrue(X in WX)
- self.assertTrue(X in RWX)
- self.assertFalse(R in WX)
- self.assertFalse(W in RX)
- self.assertFalse(X in RW)
- def test_member_iter(self):
- Color = self.Color
- self.assertEqual(list(Color.BLACK), [])
- self.assertEqual(list(Color.PURPLE), [Color.RED, Color.BLUE])
- self.assertEqual(list(Color.BLUE), [Color.BLUE])
- self.assertEqual(list(Color.GREEN), [Color.GREEN])
- self.assertEqual(list(Color.WHITE), [Color.RED, Color.GREEN, Color.BLUE])
- self.assertEqual(list(Color.WHITE), [Color.RED, Color.GREEN, Color.BLUE])
- def test_member_length(self):
- self.assertEqual(self.Color.__len__(self.Color.BLACK), 0)
- self.assertEqual(self.Color.__len__(self.Color.GREEN), 1)
- self.assertEqual(self.Color.__len__(self.Color.PURPLE), 2)
- self.assertEqual(self.Color.__len__(self.Color.BLANCO), 3)
- def test_number_reset_and_order_cleanup(self):
- class Confused(Flag):
- _order_ = 'ONE TWO FOUR DOS EIGHT SIXTEEN'
- ONE = auto()
- TWO = auto()
- FOUR = auto()
- DOS = 2
- EIGHT = auto()
- SIXTEEN = auto()
- self.assertEqual(
- list(Confused),
- [Confused.ONE, Confused.TWO, Confused.FOUR, Confused.EIGHT, Confused.SIXTEEN])
- self.assertIs(Confused.TWO, Confused.DOS)
- self.assertEqual(Confused.DOS._value_, 2)
- self.assertEqual(Confused.EIGHT._value_, 8)
- self.assertEqual(Confused.SIXTEEN._value_, 16)
- def test_aliases(self):
- Color = self.Color
- self.assertEqual(Color(1).name, 'RED')
- self.assertEqual(Color['ROJO'].name, 'RED')
- self.assertEqual(Color(7).name, 'WHITE')
- self.assertEqual(Color['BLANCO'].name, 'WHITE')
- self.assertIs(Color.BLANCO, Color.WHITE)
- Open = self.Open
- self.assertIs(Open['AC'], Open.AC)
- def test_auto_number(self):
- class Color(Flag):
- red = auto()
- blue = auto()
- green = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
- self.assertEqual(Color.red.value, 1)
- self.assertEqual(Color.blue.value, 2)
- self.assertEqual(Color.green.value, 4)
- def test_auto_number_garbage(self):
- with self.assertRaisesRegex(TypeError, 'invalid flag value .not an int.'):
- class Color(Flag):
- red = 'not an int'
- blue = auto()
- def test_duplicate_auto(self):
- class Dupes(Enum):
- first = primero = auto()
- second = auto()
- third = auto()
- self.assertEqual([Dupes.first, Dupes.second, Dupes.third], list(Dupes))
- def test_multiple_mixin(self):
- class AllMixin:
- @classproperty
- def ALL(cls):
- members = list(cls)
- all_value = None
- if members:
- all_value = members[0]
- for member in members[1:]:
- all_value |= member
- cls.ALL = all_value
- return all_value
- class StrMixin:
- def __str__(self):
- return self._name_.lower()
- class Color(AllMixin, Flag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), 'Color.BLUE')
- class Color(AllMixin, StrMixin, Flag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), 'blue')
- class Color(StrMixin, AllMixin, Flag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), 'blue')
- @threading_helper.reap_threads
- @threading_helper.requires_working_threading()
- def test_unique_composite(self):
- # override __eq__ to be identity only
- class TestFlag(Flag):
- one = auto()
- two = auto()
- three = auto()
- four = auto()
- five = auto()
- six = auto()
- seven = auto()
- eight = auto()
- def __eq__(self, other):
- return self is other
- def __hash__(self):
- return hash(self._value_)
- # have multiple threads competing to complete the composite members
- seen = set()
- failed = False
- def cycle_enum():
- nonlocal failed
- try:
- for i in range(256):
- seen.add(TestFlag(i))
- except Exception:
- failed = True
- threads = [
- threading.Thread(target=cycle_enum)
- for _ in range(8)
- ]
- with threading_helper.start_threads(threads):
- pass
- # check that only 248 members were created
- self.assertFalse(
- failed,
- 'at least one thread failed while creating composite members')
- self.assertEqual(256, len(seen), 'too many composite members created')
- def test_init_subclass(self):
- class MyEnum(Flag):
- def __init_subclass__(cls, **kwds):
- super().__init_subclass__(**kwds)
- self.assertFalse(cls.__dict__.get('_test', False))
- cls._test1 = 'MyEnum'
- #
- class TheirEnum(MyEnum):
- def __init_subclass__(cls, **kwds):
- super(TheirEnum, cls).__init_subclass__(**kwds)
- cls._test2 = 'TheirEnum'
- class WhoseEnum(TheirEnum):
- def __init_subclass__(cls, **kwds):
- pass
- class NoEnum(WhoseEnum):
- ONE = 1
- self.assertEqual(TheirEnum.__dict__['_test1'], 'MyEnum')
- self.assertEqual(WhoseEnum.__dict__['_test1'], 'MyEnum')
- self.assertEqual(WhoseEnum.__dict__['_test2'], 'TheirEnum')
- self.assertFalse(NoEnum.__dict__.get('_test1', False))
- self.assertFalse(NoEnum.__dict__.get('_test2', False))
- #
- class OurEnum(MyEnum):
- def __init_subclass__(cls, **kwds):
- cls._test2 = 'OurEnum'
- class WhereEnum(OurEnum):
- def __init_subclass__(cls, **kwds):
- pass
- class NeverEnum(WhereEnum):
- ONE = 1
- self.assertEqual(OurEnum.__dict__['_test1'], 'MyEnum')
- self.assertFalse(WhereEnum.__dict__.get('_test1', False))
- self.assertEqual(WhereEnum.__dict__['_test2'], 'OurEnum')
- self.assertFalse(NeverEnum.__dict__.get('_test1', False))
- self.assertFalse(NeverEnum.__dict__.get('_test2', False))
- class OldTestIntFlag(unittest.TestCase):
- """Tests of the IntFlags."""
- class Perm(IntFlag):
- R = 1 << 2
- W = 1 << 1
- X = 1 << 0
- class Open(IntFlag):
- RO = 0
- WO = 1
- RW = 2
- AC = 3
- CE = 1<<19
- class Color(IntFlag):
- BLACK = 0
- RED = 1
- ROJO = 1
- GREEN = 2
- BLUE = 4
- PURPLE = RED|BLUE
- WHITE = RED|GREEN|BLUE
- BLANCO = RED|GREEN|BLUE
- class Skip(IntFlag):
- FIRST = 1
- SECOND = 2
- EIGHTH = 8
- def test_type(self):
- Perm = self.Perm
- self.assertTrue(Perm._member_type_ is int)
- Open = self.Open
- for f in Perm:
- self.assertTrue(isinstance(f, Perm))
- self.assertEqual(f, f.value)
- self.assertTrue(isinstance(Perm.W | Perm.X, Perm))
- self.assertEqual(Perm.W | Perm.X, 3)
- for f in Open:
- self.assertTrue(isinstance(f, Open))
- self.assertEqual(f, f.value)
- self.assertTrue(isinstance(Open.WO | Open.RW, Open))
- self.assertEqual(Open.WO | Open.RW, 3)
- def test_global_repr_keep(self):
- self.assertEqual(
- repr(HeadlightsK(0)),
- '%s.OFF_K' % SHORT_MODULE,
- )
- self.assertEqual(
- repr(HeadlightsK(2**0 + 2**2 + 2**3)),
- '%(m)s.LOW_BEAM_K|%(m)s.FOG_K|8' % {'m': SHORT_MODULE},
- )
- self.assertEqual(
- repr(HeadlightsK(2**3)),
- '%(m)s.HeadlightsK(8)' % {'m': SHORT_MODULE},
- )
- def test_global_repr_conform1(self):
- self.assertEqual(
- repr(HeadlightsC(0)),
- '%s.OFF_C' % SHORT_MODULE,
- )
- self.assertEqual(
- repr(HeadlightsC(2**0 + 2**2 + 2**3)),
- '%(m)s.LOW_BEAM_C|%(m)s.FOG_C' % {'m': SHORT_MODULE},
- )
- self.assertEqual(
- repr(HeadlightsC(2**3)),
- '%(m)s.OFF_C' % {'m': SHORT_MODULE},
- )
- def test_global_enum_str(self):
- self.assertEqual(str(NoName.ONE & NoName.TWO), 'NoName(0)')
- self.assertEqual(str(NoName(0)), 'NoName(0)')
- def test_format(self):
- Perm = self.Perm
- self.assertEqual(format(Perm.R, ''), '4')
- self.assertEqual(format(Perm.R | Perm.X, ''), '5')
- #
- class NewPerm(IntFlag):
- R = 1 << 2
- W = 1 << 1
- X = 1 << 0
- def __str__(self):
- return self._name_
- self.assertEqual(format(NewPerm.R, ''), 'R')
- self.assertEqual(format(NewPerm.R | Perm.X, ''), 'R|X')
- def test_or(self):
- Perm = self.Perm
- for i in Perm:
- for j in Perm:
- self.assertEqual(i | j, i.value | j.value)
- self.assertEqual((i | j).value, i.value | j.value)
- self.assertIs(type(i | j), Perm)
- for j in range(8):
- self.assertEqual(i | j, i.value | j)
- self.assertEqual((i | j).value, i.value | j)
- self.assertIs(type(i | j), Perm)
- self.assertEqual(j | i, j | i.value)
- self.assertEqual((j | i).value, j | i.value)
- self.assertIs(type(j | i), Perm)
- for i in Perm:
- self.assertIs(i | i, i)
- self.assertIs(i | 0, i)
- self.assertIs(0 | i, i)
- Open = self.Open
- self.assertIs(Open.RO | Open.CE, Open.CE)
- def test_and(self):
- Perm = self.Perm
- RW = Perm.R | Perm.W
- RX = Perm.R | Perm.X
- WX = Perm.W | Perm.X
- RWX = Perm.R | Perm.W | Perm.X
- values = list(Perm) + [RW, RX, WX, RWX, Perm(0)]
- for i in values:
- for j in values:
- self.assertEqual(i & j, i.value & j.value, 'i is %r, j is %r' % (i, j))
- self.assertEqual((i & j).value, i.value & j.value, 'i is %r, j is %r' % (i, j))
- self.assertIs(type(i & j), Perm, 'i is %r, j is %r' % (i, j))
- for j in range(8):
- self.assertEqual(i & j, i.value & j)
- self.assertEqual((i & j).value, i.value & j)
- self.assertIs(type(i & j), Perm)
- self.assertEqual(j & i, j & i.value)
- self.assertEqual((j & i).value, j & i.value)
- self.assertIs(type(j & i), Perm)
- for i in Perm:
- self.assertIs(i & i, i)
- self.assertIs(i & 7, i)
- self.assertIs(7 & i, i)
- Open = self.Open
- self.assertIs(Open.RO & Open.CE, Open.RO)
- def test_xor(self):
- Perm = self.Perm
- for i in Perm:
- for j in Perm:
- self.assertEqual(i ^ j, i.value ^ j.value)
- self.assertEqual((i ^ j).value, i.value ^ j.value)
- self.assertIs(type(i ^ j), Perm)
- for j in range(8):
- self.assertEqual(i ^ j, i.value ^ j)
- self.assertEqual((i ^ j).value, i.value ^ j)
- self.assertIs(type(i ^ j), Perm)
- self.assertEqual(j ^ i, j ^ i.value)
- self.assertEqual((j ^ i).value, j ^ i.value)
- self.assertIs(type(j ^ i), Perm)
- for i in Perm:
- self.assertIs(i ^ 0, i)
- self.assertIs(0 ^ i, i)
- Open = self.Open
- self.assertIs(Open.RO ^ Open.CE, Open.CE)
- self.assertIs(Open.CE ^ Open.CE, Open.RO)
- def test_invert(self):
- Perm = self.Perm
- RW = Perm.R | Perm.W
- RX = Perm.R | Perm.X
- WX = Perm.W | Perm.X
- RWX = Perm.R | Perm.W | Perm.X
- values = list(Perm) + [RW, RX, WX, RWX, Perm(0)]
- for i in values:
- self.assertEqual(~i, (~i).value)
- self.assertIs(type(~i), Perm)
- self.assertEqual(~~i, i)
- for i in Perm:
- self.assertIs(~~i, i)
- Open = self.Open
- self.assertIs(Open.WO & ~Open.WO, Open.RO)
- self.assertIs((Open.WO|Open.CE) & ~Open.WO, Open.CE)
- def test_boundary(self):
- self.assertIs(enum.IntFlag._boundary_, KEEP)
- class Simple(IntFlag, boundary=KEEP):
- SINGLE = 1
- #
- class Iron(IntFlag, boundary=STRICT):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Iron._boundary_, STRICT)
- #
- class Water(IntFlag, boundary=CONFORM):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Water._boundary_, CONFORM)
- #
- class Space(IntFlag, boundary=EJECT):
- ONE = 1
- TWO = 2
- EIGHT = 8
- self.assertIs(Space._boundary_, EJECT)
- #
- class Bizarre(IntFlag, boundary=KEEP):
- b = 3
- c = 4
- d = 6
- #
- self.assertRaisesRegex(ValueError, 'invalid value 5', Iron, 5)
- #
- self.assertIs(Water(7), Water.ONE|Water.TWO)
- self.assertIs(Water(~9), Water.TWO)
- #
- self.assertEqual(Space(7), 7)
- self.assertTrue(type(Space(7)) is int)
- #
- self.assertEqual(list(Bizarre), [Bizarre.c])
- self.assertIs(Bizarre(3), Bizarre.b)
- self.assertIs(Bizarre(6), Bizarre.d)
- #
- simple = Simple.SINGLE | Iron.TWO
- self.assertEqual(simple, 3)
- self.assertIsInstance(simple, Simple)
- self.assertEqual(repr(simple), '<Simple.SINGLE|<Iron.TWO: 2>: 3>')
- self.assertEqual(str(simple), '3')
- def test_iter(self):
- Color = self.Color
- Open = self.Open
- self.assertEqual(list(Color), [Color.RED, Color.GREEN, Color.BLUE])
- self.assertEqual(list(Open), [Open.WO, Open.RW, Open.CE])
- def test_programatic_function_string(self):
- Perm = IntFlag('Perm', 'R W X')
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e, v)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_string_with_start(self):
- Perm = IntFlag('Perm', 'R W X', start=8)
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 8<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e, v)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_string_list(self):
- Perm = IntFlag('Perm', ['R', 'W', 'X'])
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<i
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e, v)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_iterable(self):
- Perm = IntFlag('Perm', (('R', 2), ('W', 8), ('X', 32)))
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<(2*i+1)
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e, v)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_from_dict(self):
- Perm = IntFlag('Perm', OrderedDict((('R', 2), ('W', 8), ('X', 32))))
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 3, Perm)
- self.assertEqual(lst, [Perm.R, Perm.W, Perm.X])
- for i, n in enumerate('R W X'.split()):
- v = 1<<(2*i+1)
- e = Perm(v)
- self.assertEqual(e.value, v)
- self.assertEqual(type(e.value), int)
- self.assertEqual(e, v)
- self.assertEqual(e.name, n)
- self.assertIn(e, Perm)
- self.assertIs(type(e), Perm)
- def test_programatic_function_from_empty_list(self):
- Perm = enum.IntFlag('Perm', [])
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 0, Perm)
- Thing = enum.Enum('Thing', [])
- lst = list(Thing)
- self.assertEqual(len(lst), len(Thing))
- self.assertEqual(len(Thing), 0, Thing)
- def test_programatic_function_from_empty_tuple(self):
- Perm = enum.IntFlag('Perm', ())
- lst = list(Perm)
- self.assertEqual(len(lst), len(Perm))
- self.assertEqual(len(Perm), 0, Perm)
- Thing = enum.Enum('Thing', ())
- self.assertEqual(len(lst), len(Thing))
- self.assertEqual(len(Thing), 0, Thing)
- @unittest.skipIf(
- python_version >= (3, 12),
- '__contains__ now returns True/False for all inputs',
- )
- def test_contains_er(self):
- Open = self.Open
- Color = self.Color
- self.assertTrue(Color.GREEN in Color)
- self.assertTrue(Open.RW in Open)
- self.assertFalse(Color.GREEN in Open)
- self.assertFalse(Open.RW in Color)
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 'GREEN' in Color
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 'RW' in Open
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 2 in Color
- with self.assertRaises(TypeError):
- with self.assertWarns(DeprecationWarning):
- 2 in Open
- @unittest.skipIf(
- python_version < (3, 12),
- '__contains__ only works with enum memmbers before 3.12',
- )
- def test_contains_tf(self):
- Open = self.Open
- Color = self.Color
- self.assertTrue(Color.GREEN in Color)
- self.assertTrue(Open.RW in Open)
- self.assertTrue(Color.GREEN in Open)
- self.assertTrue(Open.RW in Color)
- self.assertFalse('GREEN' in Color)
- self.assertFalse('RW' in Open)
- self.assertTrue(2 in Color)
- self.assertTrue(2 in Open)
- def test_member_contains(self):
- Perm = self.Perm
- R, W, X = Perm
- RW = R | W
- RX = R | X
- WX = W | X
- RWX = R | W | X
- self.assertTrue(R in RW)
- self.assertTrue(R in RX)
- self.assertTrue(R in RWX)
- self.assertTrue(W in RW)
- self.assertTrue(W in WX)
- self.assertTrue(W in RWX)
- self.assertTrue(X in RX)
- self.assertTrue(X in WX)
- self.assertTrue(X in RWX)
- self.assertFalse(R in WX)
- self.assertFalse(W in RX)
- self.assertFalse(X in RW)
- with self.assertRaises(TypeError):
- self.assertFalse('test' in RW)
- def test_member_iter(self):
- Color = self.Color
- self.assertEqual(list(Color.BLACK), [])
- self.assertEqual(list(Color.PURPLE), [Color.RED, Color.BLUE])
- self.assertEqual(list(Color.BLUE), [Color.BLUE])
- self.assertEqual(list(Color.GREEN), [Color.GREEN])
- self.assertEqual(list(Color.WHITE), [Color.RED, Color.GREEN, Color.BLUE])
- def test_member_length(self):
- self.assertEqual(self.Color.__len__(self.Color.BLACK), 0)
- self.assertEqual(self.Color.__len__(self.Color.GREEN), 1)
- self.assertEqual(self.Color.__len__(self.Color.PURPLE), 2)
- self.assertEqual(self.Color.__len__(self.Color.BLANCO), 3)
- def test_aliases(self):
- Color = self.Color
- self.assertEqual(Color(1).name, 'RED')
- self.assertEqual(Color['ROJO'].name, 'RED')
- self.assertEqual(Color(7).name, 'WHITE')
- self.assertEqual(Color['BLANCO'].name, 'WHITE')
- self.assertIs(Color.BLANCO, Color.WHITE)
- Open = self.Open
- self.assertIs(Open['AC'], Open.AC)
- def test_bool(self):
- Perm = self.Perm
- for f in Perm:
- self.assertTrue(f)
- Open = self.Open
- for f in Open:
- self.assertEqual(bool(f.value), bool(f))
- def test_multiple_mixin(self):
- class AllMixin:
- @classproperty
- def ALL(cls):
- members = list(cls)
- all_value = None
- if members:
- all_value = members[0]
- for member in members[1:]:
- all_value |= member
- cls.ALL = all_value
- return all_value
- class StrMixin:
- def __str__(self):
- return self._name_.lower()
- class Color(AllMixin, IntFlag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), '4')
- class Color(AllMixin, StrMixin, IntFlag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), 'blue')
- class Color(StrMixin, AllMixin, IntFlag):
- RED = auto()
- GREEN = auto()
- BLUE = auto()
- __str__ = StrMixin.__str__
- self.assertEqual(Color.RED.value, 1)
- self.assertEqual(Color.GREEN.value, 2)
- self.assertEqual(Color.BLUE.value, 4)
- self.assertEqual(Color.ALL.value, 7)
- self.assertEqual(str(Color.BLUE), 'blue')
- @threading_helper.reap_threads
- @threading_helper.requires_working_threading()
- def test_unique_composite(self):
- # override __eq__ to be identity only
- class TestFlag(IntFlag):
- one = auto()
- two = auto()
- three = auto()
- four = auto()
- five = auto()
- six = auto()
- seven = auto()
- eight = auto()
- def __eq__(self, other):
- return self is other
- def __hash__(self):
- return hash(self._value_)
- # have multiple threads competing to complete the composite members
- seen = set()
- failed = False
- def cycle_enum():
- nonlocal failed
- try:
- for i in range(256):
- seen.add(TestFlag(i))
- except Exception:
- failed = True
- threads = [
- threading.Thread(target=cycle_enum)
- for _ in range(8)
- ]
- with threading_helper.start_threads(threads):
- pass
- # check that only 248 members were created
- self.assertFalse(
- failed,
- 'at least one thread failed while creating composite members')
- self.assertEqual(256, len(seen), 'too many composite members created')
- class TestEmptyAndNonLatinStrings(unittest.TestCase):
- def test_empty_string(self):
- with self.assertRaises(ValueError):
- empty_abc = Enum('empty_abc', ('', 'B', 'C'))
- def test_non_latin_character_string(self):
- greek_abc = Enum('greek_abc', ('\u03B1', 'B', 'C'))
- item = getattr(greek_abc, '\u03B1')
- self.assertEqual(item.value, 1)
- def test_non_latin_number_string(self):
- hebrew_123 = Enum('hebrew_123', ('\u05D0', '2', '3'))
- item = getattr(hebrew_123, '\u05D0')
- self.assertEqual(item.value, 1)
- class TestUnique(unittest.TestCase):
- def test_unique_clean(self):
- @unique
- class Clean(Enum):
- one = 1
- two = 'dos'
- tres = 4.0
- #
- @unique
- class Cleaner(IntEnum):
- single = 1
- double = 2
- triple = 3
- def test_unique_dirty(self):
- with self.assertRaisesRegex(ValueError, 'tres.*one'):
- @unique
- class Dirty(Enum):
- one = 1
- two = 'dos'
- tres = 1
- with self.assertRaisesRegex(
- ValueError,
- 'double.*single.*turkey.*triple',
- ):
- @unique
- class Dirtier(IntEnum):
- single = 1
- double = 1
- triple = 3
- turkey = 3
- def test_unique_with_name(self):
- @verify(UNIQUE)
- class Silly(Enum):
- one = 1
- two = 'dos'
- name = 3
- #
- @verify(UNIQUE)
- class Sillier(IntEnum):
- single = 1
- name = 2
- triple = 3
- value = 4
- class TestVerify(unittest.TestCase):
- def test_continuous(self):
- @verify(CONTINUOUS)
- class Auto(Enum):
- FIRST = auto()
- SECOND = auto()
- THIRD = auto()
- FORTH = auto()
- #
- @verify(CONTINUOUS)
- class Manual(Enum):
- FIRST = 3
- SECOND = 4
- THIRD = 5
- FORTH = 6
- #
- with self.assertRaisesRegex(ValueError, 'invalid enum .Missing.: missing values 5, 6, 7, 8, 9, 10, 12'):
- @verify(CONTINUOUS)
- class Missing(Enum):
- FIRST = 3
- SECOND = 4
- THIRD = 11
- FORTH = 13
- #
- with self.assertRaisesRegex(ValueError, 'invalid flag .Incomplete.: missing values 32'):
- @verify(CONTINUOUS)
- class Incomplete(Flag):
- FIRST = 4
- SECOND = 8
- THIRD = 16
- FORTH = 64
- #
- with self.assertRaisesRegex(ValueError, 'invalid flag .StillIncomplete.: missing values 16'):
- @verify(CONTINUOUS)
- class StillIncomplete(Flag):
- FIRST = 4
- SECOND = 8
- THIRD = 11
- FORTH = 32
- def test_composite(self):
- class Bizarre(Flag):
- b = 3
- c = 4
- d = 6
- self.assertEqual(list(Bizarre), [Bizarre.c])
- self.assertEqual(Bizarre.b.value, 3)
- self.assertEqual(Bizarre.c.value, 4)
- self.assertEqual(Bizarre.d.value, 6)
- with self.assertRaisesRegex(
- ValueError,
- "invalid Flag 'Bizarre': aliases b and d are missing combined values of 0x3 .use enum.show_flag_values.value. for details.",
- ):
- @verify(NAMED_FLAGS)
- class Bizarre(Flag):
- b = 3
- c = 4
- d = 6
- #
- self.assertEqual(enum.show_flag_values(3), [1, 2])
- class Bizarre(IntFlag):
- b = 3
- c = 4
- d = 6
- self.assertEqual(list(Bizarre), [Bizarre.c])
- self.assertEqual(Bizarre.b.value, 3)
- self.assertEqual(Bizarre.c.value, 4)
- self.assertEqual(Bizarre.d.value, 6)
- with self.assertRaisesRegex(
- ValueError,
- "invalid Flag 'Bizarre': alias d is missing value 0x2 .use enum.show_flag_values.value. for details.",
- ):
- @verify(NAMED_FLAGS)
- class Bizarre(IntFlag):
- c = 4
- d = 6
- self.assertEqual(enum.show_flag_values(2), [2])
- def test_unique_clean(self):
- @verify(UNIQUE)
- class Clean(Enum):
- one = 1
- two = 'dos'
- tres = 4.0
- #
- @verify(UNIQUE)
- class Cleaner(IntEnum):
- single = 1
- double = 2
- triple = 3
- def test_unique_dirty(self):
- with self.assertRaisesRegex(ValueError, 'tres.*one'):
- @verify(UNIQUE)
- class Dirty(Enum):
- one = 1
- two = 'dos'
- tres = 1
- with self.assertRaisesRegex(
- ValueError,
- 'double.*single.*turkey.*triple',
- ):
- @verify(UNIQUE)
- class Dirtier(IntEnum):
- single = 1
- double = 1
- triple = 3
- turkey = 3
- def test_unique_with_name(self):
- @verify(UNIQUE)
- class Silly(Enum):
- one = 1
- two = 'dos'
- name = 3
- #
- @verify(UNIQUE)
- class Sillier(IntEnum):
- single = 1
- name = 2
- triple = 3
- value = 4
- def test_negative_alias(self):
- @verify(NAMED_FLAGS)
- class Color(Flag):
- RED = 1
- GREEN = 2
- BLUE = 4
- WHITE = -1
- # no error means success
- class TestInternals(unittest.TestCase):
- sunder_names = '_bad_', '_good_', '_what_ho_'
- dunder_names = '__mal__', '__bien__', '__que_que__'
- private_names = '_MyEnum__private', '_MyEnum__still_private'
- private_and_sunder_names = '_MyEnum__private_', '_MyEnum__also_private_'
- random_names = 'okay', '_semi_private', '_weird__', '_MyEnum__'
- def test_sunder(self):
- for name in self.sunder_names + self.private_and_sunder_names:
- self.assertTrue(enum._is_sunder(name), '%r is a not sunder name?' % name)
- for name in self.dunder_names + self.private_names + self.random_names:
- self.assertFalse(enum._is_sunder(name), '%r is a sunder name?' % name)
- def test_dunder(self):
- for name in self.dunder_names:
- self.assertTrue(enum._is_dunder(name), '%r is a not dunder name?' % name)
- for name in self.sunder_names + self.private_names + self.private_and_sunder_names + self.random_names:
- self.assertFalse(enum._is_dunder(name), '%r is a dunder name?' % name)
- def test_is_private(self):
- for name in self.private_names + self.private_and_sunder_names:
- self.assertTrue(enum._is_private('MyEnum', name), '%r is a not private name?')
- for name in self.sunder_names + self.dunder_names + self.random_names:
- self.assertFalse(enum._is_private('MyEnum', name), '%r is a private name?')
- def test_auto_number(self):
- class Color(Enum):
- red = auto()
- blue = auto()
- green = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
- self.assertEqual(Color.red.value, 1)
- self.assertEqual(Color.blue.value, 2)
- self.assertEqual(Color.green.value, 3)
- def test_auto_name(self):
- class Color(Enum):
- def _generate_next_value_(name, start, count, last):
- return name
- red = auto()
- blue = auto()
- green = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
- self.assertEqual(Color.red.value, 'red')
- self.assertEqual(Color.blue.value, 'blue')
- self.assertEqual(Color.green.value, 'green')
- def test_auto_name_inherit(self):
- class AutoNameEnum(Enum):
- def _generate_next_value_(name, start, count, last):
- return name
- class Color(AutoNameEnum):
- red = auto()
- blue = auto()
- green = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
- self.assertEqual(Color.red.value, 'red')
- self.assertEqual(Color.blue.value, 'blue')
- self.assertEqual(Color.green.value, 'green')
- @unittest.skipIf(
- python_version >= (3, 13),
- 'mixed types with auto() no longer supported',
- )
- def test_auto_garbage_ok(self):
- with self.assertWarnsRegex(DeprecationWarning, 'will require all values to be sortable'):
- class Color(Enum):
- red = 'red'
- blue = auto()
- self.assertEqual(Color.blue.value, 1)
- @unittest.skipIf(
- python_version >= (3, 13),
- 'mixed types with auto() no longer supported',
- )
- def test_auto_garbage_corrected_ok(self):
- with self.assertWarnsRegex(DeprecationWarning, 'will require all values to be sortable'):
- class Color(Enum):
- red = 'red'
- blue = 2
- green = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue, Color.green])
- self.assertEqual(Color.red.value, 'red')
- self.assertEqual(Color.blue.value, 2)
- self.assertEqual(Color.green.value, 3)
- @unittest.skipIf(
- python_version < (3, 13),
- 'mixed types with auto() will raise in 3.13',
- )
- def test_auto_garbage_fail(self):
- with self.assertRaisesRegex(TypeError, 'will require all values to be sortable'):
- class Color(Enum):
- red = 'red'
- blue = auto()
- @unittest.skipIf(
- python_version < (3, 13),
- 'mixed types with auto() will raise in 3.13',
- )
- def test_auto_garbage_corrected_fail(self):
- with self.assertRaisesRegex(TypeError, 'will require all values to be sortable'):
- class Color(Enum):
- red = 'red'
- blue = 2
- green = auto()
- def test_auto_order(self):
- with self.assertRaises(TypeError):
- class Color(Enum):
- red = auto()
- green = auto()
- blue = auto()
- def _generate_next_value_(name, start, count, last):
- return name
- def test_auto_order_wierd(self):
- weird_auto = auto()
- weird_auto.value = 'pathological case'
- class Color(Enum):
- red = weird_auto
- def _generate_next_value_(name, start, count, last):
- return name
- blue = auto()
- self.assertEqual(list(Color), [Color.red, Color.blue])
- self.assertEqual(Color.red.value, 'pathological case')
- self.assertEqual(Color.blue.value, 'blue')
- @unittest.skipIf(
- python_version < (3, 13),
- 'auto() will return highest value + 1 in 3.13',
- )
- def test_auto_with_aliases(self):
- class Color(Enum):
- red = auto()
- blue = auto()
- oxford = blue
- crimson = red
- green = auto()
- self.assertIs(Color.crimson, Color.red)
- self.assertIs(Color.oxford, Color.blue)
- self.assertIsNot(Color.green, Color.red)
- self.assertIsNot(Color.green, Color.blue)
- def test_duplicate_auto(self):
- class Dupes(Enum):
- first = primero = auto()
- second = auto()
- third = auto()
- self.assertEqual([Dupes.first, Dupes.second, Dupes.third], list(Dupes))
- def test_multiple_auto_on_line(self):
- class Huh(Enum):
- ONE = auto()
- TWO = auto(), auto()
- THREE = auto(), auto(), auto()
- self.assertEqual(Huh.ONE.value, 1)
- self.assertEqual(Huh.TWO.value, (2, 3))
- self.assertEqual(Huh.THREE.value, (4, 5, 6))
- #
- class Hah(Enum):
- def __new__(cls, value, abbr=None):
- member = object.__new__(cls)
- member._value_ = value
- member.abbr = abbr or value[:3].lower()
- return member
- def _generate_next_value_(name, start, count, last):
- return name
- #
- MONDAY = auto()
- TUESDAY = auto()
- WEDNESDAY = auto(), 'WED'
- THURSDAY = auto(), 'Thu'
- FRIDAY = auto()
- self.assertEqual(Hah.MONDAY.value, 'MONDAY')
- self.assertEqual(Hah.MONDAY.abbr, 'mon')
- self.assertEqual(Hah.TUESDAY.value, 'TUESDAY')
- self.assertEqual(Hah.TUESDAY.abbr, 'tue')
- self.assertEqual(Hah.WEDNESDAY.value, 'WEDNESDAY')
- self.assertEqual(Hah.WEDNESDAY.abbr, 'WED')
- self.assertEqual(Hah.THURSDAY.value, 'THURSDAY')
- self.assertEqual(Hah.THURSDAY.abbr, 'Thu')
- self.assertEqual(Hah.FRIDAY.value, 'FRIDAY')
- self.assertEqual(Hah.FRIDAY.abbr, 'fri')
- #
- class Huh(Enum):
- def _generate_next_value_(name, start, count, last):
- return count+1
- ONE = auto()
- TWO = auto(), auto()
- THREE = auto(), auto(), auto()
- self.assertEqual(Huh.ONE.value, 1)
- self.assertEqual(Huh.TWO.value, (2, 2))
- self.assertEqual(Huh.THREE.value, (3, 3, 3))
- class TestEnumTypeSubclassing(unittest.TestCase):
- pass
- expected_help_output_with_docs = """\
- Help on class Color in module %s:
- class Color(enum.Enum)
- | Color(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)
- |\x20\x20
- | Method resolution order:
- | Color
- | enum.Enum
- | builtins.object
- |\x20\x20
- | Data and other attributes defined here:
- |\x20\x20
- | CYAN = <Color.CYAN: 1>
- |\x20\x20
- | MAGENTA = <Color.MAGENTA: 2>
- |\x20\x20
- | YELLOW = <Color.YELLOW: 3>
- |\x20\x20
- | ----------------------------------------------------------------------
- | Data descriptors inherited from enum.Enum:
- |\x20\x20
- | name
- | The name of the Enum member.
- |\x20\x20
- | value
- | The value of the Enum member.
- |\x20\x20
- | ----------------------------------------------------------------------
- | Methods inherited from enum.EnumType:
- |\x20\x20
- | __contains__(member) from enum.EnumType
- | Return True if member is a member of this enum
- | raises TypeError if member is not an enum member
- |\x20\x20\x20\x20\x20\x20
- | note: in 3.12 TypeError will no longer be raised, and True will also be
- | returned if member is the value of a member in this enum
- |\x20\x20
- | __getitem__(name) from enum.EnumType
- | Return the member matching `name`.
- |\x20\x20
- | __iter__() from enum.EnumType
- | Return members in definition order.
- |\x20\x20
- | __len__() from enum.EnumType
- | Return the number of members (no aliases)
- |\x20\x20
- | ----------------------------------------------------------------------
- | Readonly properties inherited from enum.EnumType:
- |\x20\x20
- | __members__
- | Returns a mapping of member name->value.
- |\x20\x20\x20\x20\x20\x20
- | This mapping lists all enum members, including aliases. Note that this
- | is a read-only view of the internal mapping."""
- expected_help_output_without_docs = """\
- Help on class Color in module %s:
- class Color(enum.Enum)
- | Color(value, names=None, *, module=None, qualname=None, type=None, start=1)
- |\x20\x20
- | Method resolution order:
- | Color
- | enum.Enum
- | builtins.object
- |\x20\x20
- | Data and other attributes defined here:
- |\x20\x20
- | YELLOW = <Color.YELLOW: 3>
- |\x20\x20
- | MAGENTA = <Color.MAGENTA: 2>
- |\x20\x20
- | CYAN = <Color.CYAN: 1>
- |\x20\x20
- | ----------------------------------------------------------------------
- | Data descriptors inherited from enum.Enum:
- |\x20\x20
- | name
- |\x20\x20
- | value
- |\x20\x20
- | ----------------------------------------------------------------------
- | Data descriptors inherited from enum.EnumType:
- |\x20\x20
- | __members__"""
- class TestStdLib(unittest.TestCase):
- maxDiff = None
- class Color(Enum):
- CYAN = 1
- MAGENTA = 2
- YELLOW = 3
- def test_pydoc(self):
- # indirectly test __objclass__
- if StrEnum.__doc__ is None:
- expected_text = expected_help_output_without_docs % __name__
- else:
- expected_text = expected_help_output_with_docs % __name__
- output = StringIO()
- helper = pydoc.Helper(output=output)
- helper(self.Color)
- result = output.getvalue().strip()
- self.assertEqual(result, expected_text, result)
- def test_inspect_getmembers(self):
- values = dict((
- ('__class__', EnumType),
- ('__doc__', '...'),
- ('__members__', self.Color.__members__),
- ('__module__', __name__),
- ('YELLOW', self.Color.YELLOW),
- ('MAGENTA', self.Color.MAGENTA),
- ('CYAN', self.Color.CYAN),
- ('name', Enum.__dict__['name']),
- ('value', Enum.__dict__['value']),
- ('__len__', self.Color.__len__),
- ('__contains__', self.Color.__contains__),
- ('__name__', 'Color'),
- ('__getitem__', self.Color.__getitem__),
- ('__qualname__', 'TestStdLib.Color'),
- ('__init_subclass__', getattr(self.Color, '__init_subclass__')),
- ('__iter__', self.Color.__iter__),
- ))
- result = dict(inspect.getmembers(self.Color))
- self.assertEqual(set(values.keys()), set(result.keys()))
- failed = False
- for k in values.keys():
- if k == '__doc__':
- # __doc__ is huge, not comparing
- continue
- if result[k] != values[k]:
- print()
- print('\n%s\n key: %s\n result: %s\nexpected: %s\n%s\n' %
- ('=' * 75, k, result[k], values[k], '=' * 75), sep='')
- failed = True
- if failed:
- self.fail("result does not equal expected, see print above")
- def test_inspect_classify_class_attrs(self):
- # indirectly test __objclass__
- from inspect import Attribute
- values = [
- Attribute(name='__class__', kind='data',
- defining_class=object, object=EnumType),
- Attribute(name='__contains__', kind='method',
- defining_class=EnumType, object=self.Color.__contains__),
- Attribute(name='__doc__', kind='data',
- defining_class=self.Color, object='...'),
- Attribute(name='__getitem__', kind='method',
- defining_class=EnumType, object=self.Color.__getitem__),
- Attribute(name='__iter__', kind='method',
- defining_class=EnumType, object=self.Color.__iter__),
- Attribute(name='__init_subclass__', kind='class method',
- defining_class=object, object=getattr(self.Color, '__init_subclass__')),
- Attribute(name='__len__', kind='method',
- defining_class=EnumType, object=self.Color.__len__),
- Attribute(name='__members__', kind='property',
- defining_class=EnumType, object=EnumType.__members__),
- Attribute(name='__module__', kind='data',
- defining_class=self.Color, object=__name__),
- Attribute(name='__name__', kind='data',
- defining_class=self.Color, object='Color'),
- Attribute(name='__qualname__', kind='data',
- defining_class=self.Color, object='TestStdLib.Color'),
- Attribute(name='YELLOW', kind='data',
- defining_class=self.Color, object=self.Color.YELLOW),
- Attribute(name='MAGENTA', kind='data',
- defining_class=self.Color, object=self.Color.MAGENTA),
- Attribute(name='CYAN', kind='data',
- defining_class=self.Color, object=self.Color.CYAN),
- Attribute(name='name', kind='data',
- defining_class=Enum, object=Enum.__dict__['name']),
- Attribute(name='value', kind='data',
- defining_class=Enum, object=Enum.__dict__['value']),
- ]
- for v in values:
- try:
- v.name
- except AttributeError:
- print(v)
- values.sort(key=lambda item: item.name)
- result = list(inspect.classify_class_attrs(self.Color))
- result.sort(key=lambda item: item.name)
- self.assertEqual(
- len(values), len(result),
- "%s != %s" % ([a.name for a in values], [a.name for a in result])
- )
- failed = False
- for v, r in zip(values, result):
- if r.name in ('__init_subclass__', '__doc__'):
- # not sure how to make the __init_subclass_ Attributes match
- # so as long as there is one, call it good
- # __doc__ is too big to check exactly, so treat the same as __init_subclass__
- for name in ('name','kind','defining_class'):
- if getattr(v, name) != getattr(r, name):
- print('\n%s\n%s\n%s\n%s\n' % ('=' * 75, r, v, '=' * 75), sep='')
- failed = True
- elif r != v:
- print('\n%s\n%s\n%s\n%s\n' % ('=' * 75, r, v, '=' * 75), sep='')
- failed = True
- if failed:
- self.fail("result does not equal expected, see print above")
- def test_test_simple_enum(self):
- @_simple_enum(Enum)
- class SimpleColor:
- CYAN = 1
- MAGENTA = 2
- YELLOW = 3
- @bltns.property
- def zeroth(self):
- return 'zeroed %s' % self.name
- class CheckedColor(Enum):
- CYAN = 1
- MAGENTA = 2
- YELLOW = 3
- @bltns.property
- def zeroth(self):
- return 'zeroed %s' % self.name
- self.assertTrue(_test_simple_enum(CheckedColor, SimpleColor) is None)
- SimpleColor.MAGENTA._value_ = 9
- self.assertRaisesRegex(
- TypeError, "enum mismatch",
- _test_simple_enum, CheckedColor, SimpleColor,
- )
- class CheckedMissing(IntFlag, boundary=KEEP):
- SIXTY_FOUR = 64
- ONE_TWENTY_EIGHT = 128
- TWENTY_FORTY_EIGHT = 2048
- ALL = 2048 + 128 + 64 + 12
- CM = CheckedMissing
- self.assertEqual(list(CheckedMissing), [CM.SIXTY_FOUR, CM.ONE_TWENTY_EIGHT, CM.TWENTY_FORTY_EIGHT])
- #
- @_simple_enum(IntFlag, boundary=KEEP)
- class Missing:
- SIXTY_FOUR = 64
- ONE_TWENTY_EIGHT = 128
- TWENTY_FORTY_EIGHT = 2048
- ALL = 2048 + 128 + 64 + 12
- M = Missing
- self.assertEqual(list(CheckedMissing), [M.SIXTY_FOUR, M.ONE_TWENTY_EIGHT, M.TWENTY_FORTY_EIGHT])
- #
- _test_simple_enum(CheckedMissing, Missing)
- class MiscTestCase(unittest.TestCase):
- def test__all__(self):
- support.check__all__(self, enum, not_exported={'bin', 'show_flag_values'})
- def test_doc_1(self):
- class Single(Enum):
- ONE = 1
- self.assertEqual(Single.__doc__, None)
- def test_doc_2(self):
- class Double(Enum):
- ONE = 1
- TWO = 2
- self.assertEqual(Double.__doc__, None)
- def test_doc_1(self):
- class Triple(Enum):
- ONE = 1
- TWO = 2
- THREE = 3
- self.assertEqual(Triple.__doc__, None)
- def test_doc_1(self):
- class Quadruple(Enum):
- ONE = 1
- TWO = 2
- THREE = 3
- FOUR = 4
- self.assertEqual(Quadruple.__doc__, None)
- # These are unordered here on purpose to ensure that declaration order
- # makes no difference.
- CONVERT_TEST_NAME_D = 5
- CONVERT_TEST_NAME_C = 5
- CONVERT_TEST_NAME_B = 5
- CONVERT_TEST_NAME_A = 5 # This one should sort first.
- CONVERT_TEST_NAME_E = 5
- CONVERT_TEST_NAME_F = 5
- CONVERT_STRING_TEST_NAME_D = 5
- CONVERT_STRING_TEST_NAME_C = 5
- CONVERT_STRING_TEST_NAME_B = 5
- CONVERT_STRING_TEST_NAME_A = 5 # This one should sort first.
- CONVERT_STRING_TEST_NAME_E = 5
- CONVERT_STRING_TEST_NAME_F = 5
- # global names for StrEnum._convert_ test
- CONVERT_STR_TEST_2 = 'goodbye'
- CONVERT_STR_TEST_1 = 'hello'
- # We also need values that cannot be compared:
- UNCOMPARABLE_A = 5
- UNCOMPARABLE_C = (9, 1) # naming order is broken on purpose
- UNCOMPARABLE_B = 'value'
- COMPLEX_C = 1j
- COMPLEX_A = 2j
- COMPLEX_B = 3j
- class _ModuleWrapper:
- """We use this class as a namespace for swapping modules."""
- def __init__(self, module):
- self.__dict__.update(module.__dict__)
- class TestConvert(unittest.TestCase):
- def tearDown(self):
- # Reset the module-level test variables to their original integer
- # values, otherwise the already created enum values get converted
- # instead.
- g = globals()
- for suffix in ['A', 'B', 'C', 'D', 'E', 'F']:
- g['CONVERT_TEST_NAME_%s' % suffix] = 5
- g['CONVERT_STRING_TEST_NAME_%s' % suffix] = 5
- for suffix, value in (('A', 5), ('B', (9, 1)), ('C', 'value')):
- g['UNCOMPARABLE_%s' % suffix] = value
- for suffix, value in (('A', 2j), ('B', 3j), ('C', 1j)):
- g['COMPLEX_%s' % suffix] = value
- for suffix, value in (('1', 'hello'), ('2', 'goodbye')):
- g['CONVERT_STR_TEST_%s' % suffix] = value
- def test_convert_value_lookup_priority(self):
- test_type = enum.IntEnum._convert_(
- 'UnittestConvert',
- MODULE,
- filter=lambda x: x.startswith('CONVERT_TEST_'))
- # We don't want the reverse lookup value to vary when there are
- # multiple possible names for a given value. It should always
- # report the first lexigraphical name in that case.
- self.assertEqual(test_type(5).name, 'CONVERT_TEST_NAME_A')
- def test_convert_int(self):
- test_type = enum.IntEnum._convert_(
- 'UnittestConvert',
- MODULE,
- filter=lambda x: x.startswith('CONVERT_TEST_'))
- # Ensure that test_type has all of the desired names and values.
- self.assertEqual(test_type.CONVERT_TEST_NAME_F,
- test_type.CONVERT_TEST_NAME_A)
- self.assertEqual(test_type.CONVERT_TEST_NAME_B, 5)
- self.assertEqual(test_type.CONVERT_TEST_NAME_C, 5)
- self.assertEqual(test_type.CONVERT_TEST_NAME_D, 5)
- self.assertEqual(test_type.CONVERT_TEST_NAME_E, 5)
- # Ensure that test_type only picked up names matching the filter.
- int_dir = dir(int) + [
- 'CONVERT_TEST_NAME_A', 'CONVERT_TEST_NAME_B', 'CONVERT_TEST_NAME_C',
- 'CONVERT_TEST_NAME_D', 'CONVERT_TEST_NAME_E', 'CONVERT_TEST_NAME_F',
- 'CONVERT_TEST_SIGABRT', 'CONVERT_TEST_SIGIOT',
- 'CONVERT_TEST_EIO', 'CONVERT_TEST_EBUS',
- ]
- extra = [name for name in dir(test_type) if name not in enum_dir(test_type)]
- missing = [name for name in enum_dir(test_type) if name not in dir(test_type)]
- self.assertEqual(
- extra + missing,
- [],
- msg='extra names: %r; missing names: %r' % (extra, missing),
- )
- def test_convert_uncomparable(self):
- uncomp = enum.Enum._convert_(
- 'Uncomparable',
- MODULE,
- filter=lambda x: x.startswith('UNCOMPARABLE_'))
- # Should be ordered by `name` only:
- self.assertEqual(
- list(uncomp),
- [uncomp.UNCOMPARABLE_A, uncomp.UNCOMPARABLE_B, uncomp.UNCOMPARABLE_C],
- )
- def test_convert_complex(self):
- uncomp = enum.Enum._convert_(
- 'Uncomparable',
- MODULE,
- filter=lambda x: x.startswith('COMPLEX_'))
- # Should be ordered by `name` only:
- self.assertEqual(
- list(uncomp),
- [uncomp.COMPLEX_A, uncomp.COMPLEX_B, uncomp.COMPLEX_C],
- )
- def test_convert_str(self):
- test_type = enum.StrEnum._convert_(
- 'UnittestConvert',
- MODULE,
- filter=lambda x: x.startswith('CONVERT_STR_'),
- as_global=True)
- # Ensure that test_type has all of the desired names and values.
- self.assertEqual(test_type.CONVERT_STR_TEST_1, 'hello')
- self.assertEqual(test_type.CONVERT_STR_TEST_2, 'goodbye')
- # Ensure that test_type only picked up names matching the filter.
- str_dir = dir(str) + ['CONVERT_STR_TEST_1', 'CONVERT_STR_TEST_2']
- extra = [name for name in dir(test_type) if name not in enum_dir(test_type)]
- missing = [name for name in enum_dir(test_type) if name not in dir(test_type)]
- self.assertEqual(
- extra + missing,
- [],
- msg='extra names: %r; missing names: %r' % (extra, missing),
- )
- self.assertEqual(repr(test_type.CONVERT_STR_TEST_1), '%s.CONVERT_STR_TEST_1' % SHORT_MODULE)
- self.assertEqual(str(test_type.CONVERT_STR_TEST_2), 'goodbye')
- self.assertEqual(format(test_type.CONVERT_STR_TEST_1), 'hello')
- def test_convert_raise(self):
- with self.assertRaises(AttributeError):
- enum.IntEnum._convert(
- 'UnittestConvert',
- MODULE,
- filter=lambda x: x.startswith('CONVERT_TEST_'))
- def test_convert_repr_and_str(self):
- test_type = enum.IntEnum._convert_(
- 'UnittestConvert',
- MODULE,
- filter=lambda x: x.startswith('CONVERT_STRING_TEST_'),
- as_global=True)
- self.assertEqual(repr(test_type.CONVERT_STRING_TEST_NAME_A), '%s.CONVERT_STRING_TEST_NAME_A' % SHORT_MODULE)
- self.assertEqual(str(test_type.CONVERT_STRING_TEST_NAME_A), '5')
- self.assertEqual(format(test_type.CONVERT_STRING_TEST_NAME_A), '5')
- # helpers
- def enum_dir(cls):
- interesting = set([
- '__class__', '__contains__', '__doc__', '__getitem__',
- '__iter__', '__len__', '__members__', '__module__',
- '__name__', '__qualname__',
- ]
- + cls._member_names_
- )
- if cls._new_member_ is not object.__new__:
- interesting.add('__new__')
- if cls.__init_subclass__ is not object.__init_subclass__:
- interesting.add('__init_subclass__')
- if cls._member_type_ is object:
- return sorted(interesting)
- else:
- # return whatever mixed-in data type has
- return sorted(set(dir(cls._member_type_)) | interesting)
- def member_dir(member):
- if member.__class__._member_type_ is object:
- allowed = set(['__class__', '__doc__', '__eq__', '__hash__', '__module__', 'name', 'value'])
- else:
- allowed = set(dir(member))
- for cls in member.__class__.mro():
- for name, obj in cls.__dict__.items():
- if name[0] == '_':
- continue
- if isinstance(obj, enum.property):
- if obj.fget is not None or name not in member._member_map_:
- allowed.add(name)
- else:
- allowed.discard(name)
- else:
- allowed.add(name)
- return sorted(allowed)
- missing = object()
- if __name__ == '__main__':
- unittest.main()
|