test_inspect.py 173 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435
  1. import builtins
  2. import collections
  3. import datetime
  4. import functools
  5. import importlib
  6. import inspect
  7. import io
  8. import linecache
  9. import os
  10. import dis
  11. from os.path import normcase
  12. import _pickle
  13. import pickle
  14. import shutil
  15. import sys
  16. import types
  17. import textwrap
  18. import unicodedata
  19. import unittest
  20. import unittest.mock
  21. import warnings
  22. try:
  23. from concurrent.futures import ThreadPoolExecutor
  24. except ImportError:
  25. ThreadPoolExecutor = None
  26. from test.support import cpython_only
  27. from test.support import MISSING_C_DOCSTRINGS, ALWAYS_EQ
  28. from test.support.import_helper import DirsOnSysPath
  29. from test.support.os_helper import TESTFN
  30. from test.support.script_helper import assert_python_ok, assert_python_failure
  31. from test import inspect_fodder as mod
  32. from test import inspect_fodder2 as mod2
  33. from test import support
  34. from test import inspect_stock_annotations
  35. from test import inspect_stringized_annotations
  36. from test import inspect_stringized_annotations_2
  37. from test.test_import import _ready_to_import
  38. # Functions tested in this suite:
  39. # ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode,
  40. # isbuiltin, isroutine, isgenerator, isgeneratorfunction, getmembers,
  41. # getdoc, getfile, getmodule, getsourcefile, getcomments, getsource,
  42. # getclasstree, getargvalues, formatargvalues,
  43. # currentframe, stack, trace, isdatadescriptor,
  44. # ismethodwrapper
  45. # NOTE: There are some additional tests relating to interaction with
  46. # zipimport in the test_zipimport_support test module.
  47. modfile = mod.__file__
  48. if modfile.endswith(('c', 'o')):
  49. modfile = modfile[:-1]
  50. # Normalize file names: on Windows, the case of file names of compiled
  51. # modules depends on the path used to start the python executable.
  52. modfile = normcase(modfile)
  53. def revise(filename, *args):
  54. return (normcase(filename),) + args
  55. git = mod.StupidGit()
  56. def signatures_with_lexicographic_keyword_only_parameters():
  57. """
  58. Yields a whole bunch of functions with only keyword-only parameters,
  59. where those parameters are always in lexicographically sorted order.
  60. """
  61. parameters = ['a', 'bar', 'c', 'delta', 'ephraim', 'magical', 'yoyo', 'z']
  62. for i in range(1, 2**len(parameters)):
  63. p = []
  64. bit = 1
  65. for j in range(len(parameters)):
  66. if i & (bit << j):
  67. p.append(parameters[j])
  68. fn_text = "def foo(*, " + ", ".join(p) + "): pass"
  69. symbols = {}
  70. exec(fn_text, symbols, symbols)
  71. yield symbols['foo']
  72. def unsorted_keyword_only_parameters_fn(*, throw, out, the, baby, with_,
  73. the_, bathwater):
  74. pass
  75. unsorted_keyword_only_parameters = 'throw out the baby with_ the_ bathwater'.split()
  76. class IsTestBase(unittest.TestCase):
  77. predicates = set([inspect.isbuiltin, inspect.isclass, inspect.iscode,
  78. inspect.isframe, inspect.isfunction, inspect.ismethod,
  79. inspect.ismodule, inspect.istraceback,
  80. inspect.isgenerator, inspect.isgeneratorfunction,
  81. inspect.iscoroutine, inspect.iscoroutinefunction,
  82. inspect.isasyncgen, inspect.isasyncgenfunction,
  83. inspect.ismethodwrapper])
  84. def istest(self, predicate, exp):
  85. obj = eval(exp)
  86. self.assertTrue(predicate(obj), '%s(%s)' % (predicate.__name__, exp))
  87. for other in self.predicates - set([predicate]):
  88. if (predicate == inspect.isgeneratorfunction or \
  89. predicate == inspect.isasyncgenfunction or \
  90. predicate == inspect.iscoroutinefunction) and \
  91. other == inspect.isfunction:
  92. continue
  93. self.assertFalse(other(obj), 'not %s(%s)' % (other.__name__, exp))
  94. def test__all__(self):
  95. support.check__all__(self, inspect, not_exported=("modulesbyfile",))
  96. def generator_function_example(self):
  97. for i in range(2):
  98. yield i
  99. async def async_generator_function_example(self):
  100. async for i in range(2):
  101. yield i
  102. async def coroutine_function_example(self):
  103. return 'spam'
  104. @types.coroutine
  105. def gen_coroutine_function_example(self):
  106. yield
  107. return 'spam'
  108. class TestPredicates(IsTestBase):
  109. def test_excluding_predicates(self):
  110. global tb
  111. self.istest(inspect.isbuiltin, 'sys.exit')
  112. self.istest(inspect.isbuiltin, '[].append')
  113. self.istest(inspect.iscode, 'mod.spam.__code__')
  114. try:
  115. 1/0
  116. except Exception as e:
  117. tb = e.__traceback__
  118. self.istest(inspect.isframe, 'tb.tb_frame')
  119. self.istest(inspect.istraceback, 'tb')
  120. if hasattr(types, 'GetSetDescriptorType'):
  121. self.istest(inspect.isgetsetdescriptor,
  122. 'type(tb.tb_frame).f_locals')
  123. else:
  124. self.assertFalse(inspect.isgetsetdescriptor(type(tb.tb_frame).f_locals))
  125. finally:
  126. # Clear traceback and all the frames and local variables hanging to it.
  127. tb = None
  128. self.istest(inspect.isfunction, 'mod.spam')
  129. self.istest(inspect.isfunction, 'mod.StupidGit.abuse')
  130. self.istest(inspect.ismethod, 'git.argue')
  131. self.istest(inspect.ismethod, 'mod.custom_method')
  132. self.istest(inspect.ismodule, 'mod')
  133. self.istest(inspect.isdatadescriptor, 'collections.defaultdict.default_factory')
  134. self.istest(inspect.isgenerator, '(x for x in range(2))')
  135. self.istest(inspect.isgeneratorfunction, 'generator_function_example')
  136. self.istest(inspect.isasyncgen,
  137. 'async_generator_function_example(1)')
  138. self.istest(inspect.isasyncgenfunction,
  139. 'async_generator_function_example')
  140. with warnings.catch_warnings():
  141. warnings.simplefilter("ignore")
  142. self.istest(inspect.iscoroutine, 'coroutine_function_example(1)')
  143. self.istest(inspect.iscoroutinefunction, 'coroutine_function_example')
  144. if hasattr(types, 'MemberDescriptorType'):
  145. self.istest(inspect.ismemberdescriptor, 'datetime.timedelta.days')
  146. else:
  147. self.assertFalse(inspect.ismemberdescriptor(datetime.timedelta.days))
  148. self.istest(inspect.ismethodwrapper, "object().__str__")
  149. self.istest(inspect.ismethodwrapper, "object().__eq__")
  150. self.istest(inspect.ismethodwrapper, "object().__repr__")
  151. self.assertFalse(inspect.ismethodwrapper(type))
  152. self.assertFalse(inspect.ismethodwrapper(int))
  153. self.assertFalse(inspect.ismethodwrapper(type("AnyClass", (), {})))
  154. def test_iscoroutine(self):
  155. async_gen_coro = async_generator_function_example(1)
  156. gen_coro = gen_coroutine_function_example(1)
  157. coro = coroutine_function_example(1)
  158. self.assertFalse(
  159. inspect.iscoroutinefunction(gen_coroutine_function_example))
  160. self.assertFalse(
  161. inspect.iscoroutinefunction(
  162. functools.partial(functools.partial(
  163. gen_coroutine_function_example))))
  164. self.assertFalse(inspect.iscoroutine(gen_coro))
  165. self.assertTrue(
  166. inspect.isgeneratorfunction(gen_coroutine_function_example))
  167. self.assertTrue(
  168. inspect.isgeneratorfunction(
  169. functools.partial(functools.partial(
  170. gen_coroutine_function_example))))
  171. self.assertTrue(inspect.isgenerator(gen_coro))
  172. self.assertFalse(
  173. inspect.iscoroutinefunction(unittest.mock.Mock()))
  174. self.assertTrue(
  175. inspect.iscoroutinefunction(unittest.mock.AsyncMock()))
  176. self.assertTrue(
  177. inspect.iscoroutinefunction(coroutine_function_example))
  178. self.assertTrue(
  179. inspect.iscoroutinefunction(
  180. functools.partial(functools.partial(
  181. coroutine_function_example))))
  182. self.assertTrue(inspect.iscoroutine(coro))
  183. self.assertFalse(
  184. inspect.isgeneratorfunction(unittest.mock.Mock()))
  185. self.assertFalse(
  186. inspect.isgeneratorfunction(unittest.mock.AsyncMock()))
  187. self.assertFalse(
  188. inspect.isgeneratorfunction(coroutine_function_example))
  189. self.assertFalse(
  190. inspect.isgeneratorfunction(
  191. functools.partial(functools.partial(
  192. coroutine_function_example))))
  193. self.assertFalse(inspect.isgenerator(coro))
  194. self.assertFalse(
  195. inspect.isasyncgenfunction(unittest.mock.Mock()))
  196. self.assertFalse(
  197. inspect.isasyncgenfunction(unittest.mock.AsyncMock()))
  198. self.assertFalse(
  199. inspect.isasyncgenfunction(coroutine_function_example))
  200. self.assertTrue(
  201. inspect.isasyncgenfunction(async_generator_function_example))
  202. self.assertTrue(
  203. inspect.isasyncgenfunction(
  204. functools.partial(functools.partial(
  205. async_generator_function_example))))
  206. self.assertTrue(inspect.isasyncgen(async_gen_coro))
  207. coro.close(); gen_coro.close(); # silence warnings
  208. def test_isawaitable(self):
  209. def gen(): yield
  210. self.assertFalse(inspect.isawaitable(gen()))
  211. coro = coroutine_function_example(1)
  212. gen_coro = gen_coroutine_function_example(1)
  213. self.assertTrue(inspect.isawaitable(coro))
  214. self.assertTrue(inspect.isawaitable(gen_coro))
  215. class Future:
  216. def __await__():
  217. pass
  218. self.assertTrue(inspect.isawaitable(Future()))
  219. self.assertFalse(inspect.isawaitable(Future))
  220. class NotFuture: pass
  221. not_fut = NotFuture()
  222. not_fut.__await__ = lambda: None
  223. self.assertFalse(inspect.isawaitable(not_fut))
  224. coro.close(); gen_coro.close() # silence warnings
  225. def test_isroutine(self):
  226. # method
  227. self.assertTrue(inspect.isroutine(git.argue))
  228. self.assertTrue(inspect.isroutine(mod.custom_method))
  229. self.assertTrue(inspect.isroutine([].count))
  230. # function
  231. self.assertTrue(inspect.isroutine(mod.spam))
  232. self.assertTrue(inspect.isroutine(mod.StupidGit.abuse))
  233. # slot-wrapper
  234. self.assertTrue(inspect.isroutine(object.__init__))
  235. self.assertTrue(inspect.isroutine(object.__str__))
  236. self.assertTrue(inspect.isroutine(object.__lt__))
  237. self.assertTrue(inspect.isroutine(int.__lt__))
  238. # method-wrapper
  239. self.assertTrue(inspect.isroutine(object().__init__))
  240. self.assertTrue(inspect.isroutine(object().__str__))
  241. self.assertTrue(inspect.isroutine(object().__lt__))
  242. self.assertTrue(inspect.isroutine((42).__lt__))
  243. # method-descriptor
  244. self.assertTrue(inspect.isroutine(str.join))
  245. self.assertTrue(inspect.isroutine(list.append))
  246. self.assertTrue(inspect.isroutine(''.join))
  247. self.assertTrue(inspect.isroutine([].append))
  248. # object
  249. self.assertFalse(inspect.isroutine(object))
  250. self.assertFalse(inspect.isroutine(object()))
  251. self.assertFalse(inspect.isroutine(str()))
  252. # module
  253. self.assertFalse(inspect.isroutine(mod))
  254. # type
  255. self.assertFalse(inspect.isroutine(type))
  256. self.assertFalse(inspect.isroutine(int))
  257. self.assertFalse(inspect.isroutine(type('some_class', (), {})))
  258. def test_isclass(self):
  259. self.istest(inspect.isclass, 'mod.StupidGit')
  260. self.assertTrue(inspect.isclass(list))
  261. class CustomGetattr(object):
  262. def __getattr__(self, attr):
  263. return None
  264. self.assertFalse(inspect.isclass(CustomGetattr()))
  265. def test_get_slot_members(self):
  266. class C(object):
  267. __slots__ = ("a", "b")
  268. x = C()
  269. x.a = 42
  270. members = dict(inspect.getmembers(x))
  271. self.assertIn('a', members)
  272. self.assertNotIn('b', members)
  273. def test_isabstract(self):
  274. from abc import ABCMeta, abstractmethod
  275. class AbstractClassExample(metaclass=ABCMeta):
  276. @abstractmethod
  277. def foo(self):
  278. pass
  279. class ClassExample(AbstractClassExample):
  280. def foo(self):
  281. pass
  282. a = ClassExample()
  283. # Test general behaviour.
  284. self.assertTrue(inspect.isabstract(AbstractClassExample))
  285. self.assertFalse(inspect.isabstract(ClassExample))
  286. self.assertFalse(inspect.isabstract(a))
  287. self.assertFalse(inspect.isabstract(int))
  288. self.assertFalse(inspect.isabstract(5))
  289. def test_isabstract_during_init_subclass(self):
  290. from abc import ABCMeta, abstractmethod
  291. isabstract_checks = []
  292. class AbstractChecker(metaclass=ABCMeta):
  293. def __init_subclass__(cls):
  294. isabstract_checks.append(inspect.isabstract(cls))
  295. class AbstractClassExample(AbstractChecker):
  296. @abstractmethod
  297. def foo(self):
  298. pass
  299. class ClassExample(AbstractClassExample):
  300. def foo(self):
  301. pass
  302. self.assertEqual(isabstract_checks, [True, False])
  303. isabstract_checks.clear()
  304. class AbstractChild(AbstractClassExample):
  305. pass
  306. class AbstractGrandchild(AbstractChild):
  307. pass
  308. class ConcreteGrandchild(ClassExample):
  309. pass
  310. self.assertEqual(isabstract_checks, [True, True, False])
  311. class TestInterpreterStack(IsTestBase):
  312. def __init__(self, *args, **kwargs):
  313. unittest.TestCase.__init__(self, *args, **kwargs)
  314. git.abuse(7, 8, 9)
  315. def test_abuse_done(self):
  316. self.istest(inspect.istraceback, 'git.ex[2]')
  317. self.istest(inspect.isframe, 'mod.fr')
  318. def test_stack(self):
  319. self.assertTrue(len(mod.st) >= 5)
  320. frame1, frame2, frame3, frame4, *_ = mod.st
  321. frameinfo = revise(*frame1[1:])
  322. self.assertEqual(frameinfo,
  323. (modfile, 16, 'eggs', [' st = inspect.stack()\n'], 0))
  324. self.assertEqual(frame1.positions, dis.Positions(16, 16, 9, 24))
  325. frameinfo = revise(*frame2[1:])
  326. self.assertEqual(frameinfo,
  327. (modfile, 9, 'spam', [' eggs(b + d, c + f)\n'], 0))
  328. self.assertEqual(frame2.positions, dis.Positions(9, 9, 4, 22))
  329. frameinfo = revise(*frame3[1:])
  330. self.assertEqual(frameinfo,
  331. (modfile, 43, 'argue', [' spam(a, b, c)\n'], 0))
  332. self.assertEqual(frame3.positions, dis.Positions(43, 43, 12, 25))
  333. frameinfo = revise(*frame4[1:])
  334. self.assertEqual(frameinfo,
  335. (modfile, 39, 'abuse', [' self.argue(a, b, c)\n'], 0))
  336. self.assertEqual(frame4.positions, dis.Positions(39, 39, 8, 27))
  337. # Test named tuple fields
  338. record = mod.st[0]
  339. self.assertIs(record.frame, mod.fr)
  340. self.assertEqual(record.lineno, 16)
  341. self.assertEqual(record.filename, mod.__file__)
  342. self.assertEqual(record.function, 'eggs')
  343. self.assertIn('inspect.stack()', record.code_context[0])
  344. self.assertEqual(record.index, 0)
  345. def test_trace(self):
  346. self.assertEqual(len(git.tr), 3)
  347. frame1, frame2, frame3, = git.tr
  348. self.assertEqual(revise(*frame1[1:]),
  349. (modfile, 43, 'argue', [' spam(a, b, c)\n'], 0))
  350. self.assertEqual(frame1.positions, dis.Positions(43, 43, 12, 25))
  351. self.assertEqual(revise(*frame2[1:]),
  352. (modfile, 9, 'spam', [' eggs(b + d, c + f)\n'], 0))
  353. self.assertEqual(frame2.positions, dis.Positions(9, 9, 4, 22))
  354. self.assertEqual(revise(*frame3[1:]),
  355. (modfile, 18, 'eggs', [' q = y / 0\n'], 0))
  356. self.assertEqual(frame3.positions, dis.Positions(18, 18, 8, 13))
  357. def test_frame(self):
  358. args, varargs, varkw, locals = inspect.getargvalues(mod.fr)
  359. self.assertEqual(args, ['x', 'y'])
  360. self.assertEqual(varargs, None)
  361. self.assertEqual(varkw, None)
  362. self.assertEqual(locals, {'x': 11, 'p': 11, 'y': 14})
  363. self.assertEqual(inspect.formatargvalues(args, varargs, varkw, locals),
  364. '(x=11, y=14)')
  365. def test_previous_frame(self):
  366. args, varargs, varkw, locals = inspect.getargvalues(mod.fr.f_back)
  367. self.assertEqual(args, ['a', 'b', 'c', 'd', 'e', 'f'])
  368. self.assertEqual(varargs, 'g')
  369. self.assertEqual(varkw, 'h')
  370. self.assertEqual(inspect.formatargvalues(args, varargs, varkw, locals),
  371. '(a=7, b=8, c=9, d=3, e=4, f=5, *g=(), **h={})')
  372. class GetSourceBase(unittest.TestCase):
  373. # Subclasses must override.
  374. fodderModule = None
  375. def setUp(self):
  376. with open(inspect.getsourcefile(self.fodderModule), encoding="utf-8") as fp:
  377. self.source = fp.read()
  378. def sourcerange(self, top, bottom):
  379. lines = self.source.split("\n")
  380. return "\n".join(lines[top-1:bottom]) + ("\n" if bottom else "")
  381. def assertSourceEqual(self, obj, top, bottom):
  382. self.assertEqual(inspect.getsource(obj),
  383. self.sourcerange(top, bottom))
  384. class SlotUser:
  385. 'Docstrings for __slots__'
  386. __slots__ = {'power': 'measured in kilowatts',
  387. 'distance': 'measured in kilometers'}
  388. class TestRetrievingSourceCode(GetSourceBase):
  389. fodderModule = mod
  390. def test_getclasses(self):
  391. classes = inspect.getmembers(mod, inspect.isclass)
  392. self.assertEqual(classes,
  393. [('FesteringGob', mod.FesteringGob),
  394. ('MalodorousPervert', mod.MalodorousPervert),
  395. ('ParrotDroppings', mod.ParrotDroppings),
  396. ('StupidGit', mod.StupidGit),
  397. ('Tit', mod.MalodorousPervert),
  398. ('WhichComments', mod.WhichComments),
  399. ])
  400. tree = inspect.getclasstree([cls[1] for cls in classes])
  401. self.assertEqual(tree,
  402. [(object, ()),
  403. [(mod.ParrotDroppings, (object,)),
  404. [(mod.FesteringGob, (mod.MalodorousPervert,
  405. mod.ParrotDroppings))
  406. ],
  407. (mod.StupidGit, (object,)),
  408. [(mod.MalodorousPervert, (mod.StupidGit,)),
  409. [(mod.FesteringGob, (mod.MalodorousPervert,
  410. mod.ParrotDroppings))
  411. ]
  412. ],
  413. (mod.WhichComments, (object,),)
  414. ]
  415. ])
  416. tree = inspect.getclasstree([cls[1] for cls in classes], True)
  417. self.assertEqual(tree,
  418. [(object, ()),
  419. [(mod.ParrotDroppings, (object,)),
  420. (mod.StupidGit, (object,)),
  421. [(mod.MalodorousPervert, (mod.StupidGit,)),
  422. [(mod.FesteringGob, (mod.MalodorousPervert,
  423. mod.ParrotDroppings))
  424. ]
  425. ],
  426. (mod.WhichComments, (object,),)
  427. ]
  428. ])
  429. def test_getfunctions(self):
  430. functions = inspect.getmembers(mod, inspect.isfunction)
  431. self.assertEqual(functions, [('eggs', mod.eggs),
  432. ('lobbest', mod.lobbest),
  433. ('spam', mod.spam)])
  434. @unittest.skipIf(sys.flags.optimize >= 2,
  435. "Docstrings are omitted with -O2 and above")
  436. def test_getdoc(self):
  437. self.assertEqual(inspect.getdoc(mod), 'A module docstring.')
  438. self.assertEqual(inspect.getdoc(mod.StupidGit),
  439. 'A longer,\n\nindented\n\ndocstring.')
  440. self.assertEqual(inspect.getdoc(git.abuse),
  441. 'Another\n\ndocstring\n\ncontaining\n\ntabs')
  442. self.assertEqual(inspect.getdoc(SlotUser.power),
  443. 'measured in kilowatts')
  444. self.assertEqual(inspect.getdoc(SlotUser.distance),
  445. 'measured in kilometers')
  446. @unittest.skipIf(sys.flags.optimize >= 2,
  447. "Docstrings are omitted with -O2 and above")
  448. def test_getdoc_inherited(self):
  449. self.assertEqual(inspect.getdoc(mod.FesteringGob),
  450. 'A longer,\n\nindented\n\ndocstring.')
  451. self.assertEqual(inspect.getdoc(mod.FesteringGob.abuse),
  452. 'Another\n\ndocstring\n\ncontaining\n\ntabs')
  453. self.assertEqual(inspect.getdoc(mod.FesteringGob().abuse),
  454. 'Another\n\ndocstring\n\ncontaining\n\ntabs')
  455. self.assertEqual(inspect.getdoc(mod.FesteringGob.contradiction),
  456. 'The automatic gainsaying.')
  457. @unittest.skipIf(MISSING_C_DOCSTRINGS, "test requires docstrings")
  458. def test_finddoc(self):
  459. finddoc = inspect._finddoc
  460. self.assertEqual(finddoc(int), int.__doc__)
  461. self.assertEqual(finddoc(int.to_bytes), int.to_bytes.__doc__)
  462. self.assertEqual(finddoc(int().to_bytes), int.to_bytes.__doc__)
  463. self.assertEqual(finddoc(int.from_bytes), int.from_bytes.__doc__)
  464. self.assertEqual(finddoc(int.real), int.real.__doc__)
  465. def test_cleandoc(self):
  466. self.assertEqual(inspect.cleandoc('An\n indented\n docstring.'),
  467. 'An\nindented\ndocstring.')
  468. def test_getcomments(self):
  469. self.assertEqual(inspect.getcomments(mod), '# line 1\n')
  470. self.assertEqual(inspect.getcomments(mod.StupidGit), '# line 20\n')
  471. self.assertEqual(inspect.getcomments(mod2.cls160), '# line 159\n')
  472. # If the object source file is not available, return None.
  473. co = compile('x=1', '_non_existing_filename.py', 'exec')
  474. self.assertIsNone(inspect.getcomments(co))
  475. # If the object has been defined in C, return None.
  476. self.assertIsNone(inspect.getcomments(list))
  477. def test_getmodule(self):
  478. # Check actual module
  479. self.assertEqual(inspect.getmodule(mod), mod)
  480. # Check class (uses __module__ attribute)
  481. self.assertEqual(inspect.getmodule(mod.StupidGit), mod)
  482. # Check a method (no __module__ attribute, falls back to filename)
  483. self.assertEqual(inspect.getmodule(mod.StupidGit.abuse), mod)
  484. # Do it again (check the caching isn't broken)
  485. self.assertEqual(inspect.getmodule(mod.StupidGit.abuse), mod)
  486. # Check a builtin
  487. self.assertEqual(inspect.getmodule(str), sys.modules["builtins"])
  488. # Check filename override
  489. self.assertEqual(inspect.getmodule(None, modfile), mod)
  490. def test_getmodule_file_not_found(self):
  491. # See bpo-45406
  492. def _getabsfile(obj, _filename):
  493. raise FileNotFoundError('bad file')
  494. with unittest.mock.patch('inspect.getabsfile', _getabsfile):
  495. f = inspect.currentframe()
  496. self.assertIsNone(inspect.getmodule(f))
  497. inspect.getouterframes(f) # smoke test
  498. def test_getframeinfo_get_first_line(self):
  499. frame_info = inspect.getframeinfo(self.fodderModule.fr, 50)
  500. self.assertEqual(frame_info.code_context[0], "# line 1\n")
  501. self.assertEqual(frame_info.code_context[1], "'A module docstring.'\n")
  502. def test_getsource(self):
  503. self.assertSourceEqual(git.abuse, 29, 39)
  504. self.assertSourceEqual(mod.StupidGit, 21, 51)
  505. self.assertSourceEqual(mod.lobbest, 75, 76)
  506. def test_getsourcefile(self):
  507. self.assertEqual(normcase(inspect.getsourcefile(mod.spam)), modfile)
  508. self.assertEqual(normcase(inspect.getsourcefile(git.abuse)), modfile)
  509. fn = "_non_existing_filename_used_for_sourcefile_test.py"
  510. co = compile("x=1", fn, "exec")
  511. self.assertEqual(inspect.getsourcefile(co), None)
  512. linecache.cache[co.co_filename] = (1, None, "None", co.co_filename)
  513. try:
  514. self.assertEqual(normcase(inspect.getsourcefile(co)), fn)
  515. finally:
  516. del linecache.cache[co.co_filename]
  517. def test_getfile(self):
  518. self.assertEqual(inspect.getfile(mod.StupidGit), mod.__file__)
  519. def test_getfile_builtin_module(self):
  520. with self.assertRaises(TypeError) as e:
  521. inspect.getfile(sys)
  522. self.assertTrue(str(e.exception).startswith('<module'))
  523. def test_getfile_builtin_class(self):
  524. with self.assertRaises(TypeError) as e:
  525. inspect.getfile(int)
  526. self.assertTrue(str(e.exception).startswith('<class'))
  527. def test_getfile_builtin_function_or_method(self):
  528. with self.assertRaises(TypeError) as e_abs:
  529. inspect.getfile(abs)
  530. self.assertIn('expected, got', str(e_abs.exception))
  531. with self.assertRaises(TypeError) as e_append:
  532. inspect.getfile(list.append)
  533. self.assertIn('expected, got', str(e_append.exception))
  534. def test_getfile_class_without_module(self):
  535. class CM(type):
  536. @property
  537. def __module__(cls):
  538. raise AttributeError
  539. class C(metaclass=CM):
  540. pass
  541. with self.assertRaises(TypeError):
  542. inspect.getfile(C)
  543. def test_getfile_broken_repr(self):
  544. class ErrorRepr:
  545. def __repr__(self):
  546. raise Exception('xyz')
  547. er = ErrorRepr()
  548. with self.assertRaises(TypeError):
  549. inspect.getfile(er)
  550. def test_getmodule_recursion(self):
  551. from types import ModuleType
  552. name = '__inspect_dummy'
  553. m = sys.modules[name] = ModuleType(name)
  554. m.__file__ = "<string>" # hopefully not a real filename...
  555. m.__loader__ = "dummy" # pretend the filename is understood by a loader
  556. exec("def x(): pass", m.__dict__)
  557. self.assertEqual(inspect.getsourcefile(m.x.__code__), '<string>')
  558. del sys.modules[name]
  559. inspect.getmodule(compile('a=10','','single'))
  560. def test_proceed_with_fake_filename(self):
  561. '''doctest monkeypatches linecache to enable inspection'''
  562. fn, source = '<test>', 'def x(): pass\n'
  563. getlines = linecache.getlines
  564. def monkey(filename, module_globals=None):
  565. if filename == fn:
  566. return source.splitlines(keepends=True)
  567. else:
  568. return getlines(filename, module_globals)
  569. linecache.getlines = monkey
  570. try:
  571. ns = {}
  572. exec(compile(source, fn, 'single'), ns)
  573. inspect.getsource(ns["x"])
  574. finally:
  575. linecache.getlines = getlines
  576. def test_getsource_on_code_object(self):
  577. self.assertSourceEqual(mod.eggs.__code__, 12, 18)
  578. class TestGetsourceInteractive(unittest.TestCase):
  579. def test_getclasses_interactive(self):
  580. # bpo-44648: simulate a REPL session;
  581. # there is no `__file__` in the __main__ module
  582. code = "import sys, inspect; \
  583. assert not hasattr(sys.modules['__main__'], '__file__'); \
  584. A = type('A', (), {}); \
  585. inspect.getsource(A)"
  586. _, _, stderr = assert_python_failure("-c", code, __isolated=True)
  587. self.assertIn(b'OSError: source code not available', stderr)
  588. class TestGettingSourceOfToplevelFrames(GetSourceBase):
  589. fodderModule = mod
  590. def test_range_toplevel_frame(self):
  591. self.maxDiff = None
  592. self.assertSourceEqual(mod.currentframe, 1, None)
  593. def test_range_traceback_toplevel_frame(self):
  594. self.assertSourceEqual(mod.tb, 1, None)
  595. class TestDecorators(GetSourceBase):
  596. fodderModule = mod2
  597. def test_wrapped_decorator(self):
  598. self.assertSourceEqual(mod2.wrapped, 14, 17)
  599. def test_replacing_decorator(self):
  600. self.assertSourceEqual(mod2.gone, 9, 10)
  601. def test_getsource_unwrap(self):
  602. self.assertSourceEqual(mod2.real, 130, 132)
  603. def test_decorator_with_lambda(self):
  604. self.assertSourceEqual(mod2.func114, 113, 115)
  605. class TestOneliners(GetSourceBase):
  606. fodderModule = mod2
  607. def test_oneline_lambda(self):
  608. # Test inspect.getsource with a one-line lambda function.
  609. self.assertSourceEqual(mod2.oll, 25, 25)
  610. def test_threeline_lambda(self):
  611. # Test inspect.getsource with a three-line lambda function,
  612. # where the second and third lines are _not_ indented.
  613. self.assertSourceEqual(mod2.tll, 28, 30)
  614. def test_twoline_indented_lambda(self):
  615. # Test inspect.getsource with a two-line lambda function,
  616. # where the second line _is_ indented.
  617. self.assertSourceEqual(mod2.tlli, 33, 34)
  618. def test_onelinefunc(self):
  619. # Test inspect.getsource with a regular one-line function.
  620. self.assertSourceEqual(mod2.onelinefunc, 37, 37)
  621. def test_manyargs(self):
  622. # Test inspect.getsource with a regular function where
  623. # the arguments are on two lines and _not_ indented and
  624. # the body on the second line with the last arguments.
  625. self.assertSourceEqual(mod2.manyargs, 40, 41)
  626. def test_twolinefunc(self):
  627. # Test inspect.getsource with a regular function where
  628. # the body is on two lines, following the argument list and
  629. # continued on the next line by a \\.
  630. self.assertSourceEqual(mod2.twolinefunc, 44, 45)
  631. def test_lambda_in_list(self):
  632. # Test inspect.getsource with a one-line lambda function
  633. # defined in a list, indented.
  634. self.assertSourceEqual(mod2.a[1], 49, 49)
  635. def test_anonymous(self):
  636. # Test inspect.getsource with a lambda function defined
  637. # as argument to another function.
  638. self.assertSourceEqual(mod2.anonymous, 55, 55)
  639. class TestBlockComments(GetSourceBase):
  640. fodderModule = mod
  641. def test_toplevel_class(self):
  642. self.assertSourceEqual(mod.WhichComments, 96, 114)
  643. def test_class_method(self):
  644. self.assertSourceEqual(mod.WhichComments.f, 99, 104)
  645. def test_class_async_method(self):
  646. self.assertSourceEqual(mod.WhichComments.asyncf, 109, 112)
  647. class TestBuggyCases(GetSourceBase):
  648. fodderModule = mod2
  649. def test_with_comment(self):
  650. self.assertSourceEqual(mod2.with_comment, 58, 59)
  651. def test_multiline_sig(self):
  652. self.assertSourceEqual(mod2.multiline_sig[0], 63, 64)
  653. def test_nested_class(self):
  654. self.assertSourceEqual(mod2.func69().func71, 71, 72)
  655. def test_one_liner_followed_by_non_name(self):
  656. self.assertSourceEqual(mod2.func77, 77, 77)
  657. def test_one_liner_dedent_non_name(self):
  658. self.assertSourceEqual(mod2.cls82.func83, 83, 83)
  659. def test_with_comment_instead_of_docstring(self):
  660. self.assertSourceEqual(mod2.func88, 88, 90)
  661. def test_method_in_dynamic_class(self):
  662. self.assertSourceEqual(mod2.method_in_dynamic_class, 95, 97)
  663. # This should not skip for CPython, but might on a repackaged python where
  664. # unicodedata is not an external module, or on pypy.
  665. @unittest.skipIf(not hasattr(unicodedata, '__file__') or
  666. unicodedata.__file__.endswith('.py'),
  667. "unicodedata is not an external binary module")
  668. def test_findsource_binary(self):
  669. self.assertRaises(OSError, inspect.getsource, unicodedata)
  670. self.assertRaises(OSError, inspect.findsource, unicodedata)
  671. def test_findsource_code_in_linecache(self):
  672. lines = ["x=1"]
  673. co = compile(lines[0], "_dynamically_created_file", "exec")
  674. self.assertRaises(OSError, inspect.findsource, co)
  675. self.assertRaises(OSError, inspect.getsource, co)
  676. linecache.cache[co.co_filename] = (1, None, lines, co.co_filename)
  677. try:
  678. self.assertEqual(inspect.findsource(co), (lines,0))
  679. self.assertEqual(inspect.getsource(co), lines[0])
  680. finally:
  681. del linecache.cache[co.co_filename]
  682. def test_findsource_without_filename(self):
  683. for fname in ['', '<string>']:
  684. co = compile('x=1', fname, "exec")
  685. self.assertRaises(IOError, inspect.findsource, co)
  686. self.assertRaises(IOError, inspect.getsource, co)
  687. def test_findsource_with_out_of_bounds_lineno(self):
  688. mod_len = len(inspect.getsource(mod))
  689. src = '\n' * 2* mod_len + "def f(): pass"
  690. co = compile(src, mod.__file__, "exec")
  691. g, l = {}, {}
  692. eval(co, g, l)
  693. func = l['f']
  694. self.assertEqual(func.__code__.co_firstlineno, 1+2*mod_len)
  695. with self.assertRaisesRegex(IOError, "lineno is out of bounds"):
  696. inspect.findsource(func)
  697. def test_getsource_on_method(self):
  698. self.assertSourceEqual(mod2.ClassWithMethod.method, 118, 119)
  699. def test_nested_func(self):
  700. self.assertSourceEqual(mod2.cls135.func136, 136, 139)
  701. def test_class_definition_in_multiline_string_definition(self):
  702. self.assertSourceEqual(mod2.cls149, 149, 152)
  703. def test_class_definition_in_multiline_comment(self):
  704. self.assertSourceEqual(mod2.cls160, 160, 163)
  705. def test_nested_class_definition_indented_string(self):
  706. self.assertSourceEqual(mod2.cls173.cls175, 175, 176)
  707. def test_nested_class_definition(self):
  708. self.assertSourceEqual(mod2.cls183, 183, 188)
  709. self.assertSourceEqual(mod2.cls183.cls185, 185, 188)
  710. def test_class_decorator(self):
  711. self.assertSourceEqual(mod2.cls196, 194, 201)
  712. self.assertSourceEqual(mod2.cls196.cls200, 198, 201)
  713. def test_class_inside_conditional(self):
  714. self.assertSourceEqual(mod2.cls238, 238, 240)
  715. self.assertSourceEqual(mod2.cls238.cls239, 239, 240)
  716. def test_multiple_children_classes(self):
  717. self.assertSourceEqual(mod2.cls203, 203, 209)
  718. self.assertSourceEqual(mod2.cls203.cls204, 204, 206)
  719. self.assertSourceEqual(mod2.cls203.cls204.cls205, 205, 206)
  720. self.assertSourceEqual(mod2.cls203.cls207, 207, 209)
  721. self.assertSourceEqual(mod2.cls203.cls207.cls205, 208, 209)
  722. def test_nested_class_definition_inside_function(self):
  723. self.assertSourceEqual(mod2.func212(), 213, 214)
  724. self.assertSourceEqual(mod2.cls213, 218, 222)
  725. self.assertSourceEqual(mod2.cls213().func219(), 220, 221)
  726. @unittest.skipIf(
  727. support.is_emscripten or support.is_wasi,
  728. "socket.accept is broken"
  729. )
  730. def test_nested_class_definition_inside_async_function(self):
  731. import asyncio
  732. self.addCleanup(asyncio.set_event_loop_policy, None)
  733. self.assertSourceEqual(asyncio.run(mod2.func225()), 226, 227)
  734. self.assertSourceEqual(mod2.cls226, 231, 235)
  735. self.assertSourceEqual(asyncio.run(mod2.cls226().func232()), 233, 234)
  736. class TestNoEOL(GetSourceBase):
  737. def setUp(self):
  738. self.tempdir = TESTFN + '_dir'
  739. os.mkdir(self.tempdir)
  740. with open(os.path.join(self.tempdir, 'inspect_fodder3%spy' % os.extsep),
  741. 'w', encoding='utf-8') as f:
  742. f.write("class X:\n pass # No EOL")
  743. with DirsOnSysPath(self.tempdir):
  744. import inspect_fodder3 as mod3
  745. self.fodderModule = mod3
  746. super().setUp()
  747. def tearDown(self):
  748. shutil.rmtree(self.tempdir)
  749. def test_class(self):
  750. self.assertSourceEqual(self.fodderModule.X, 1, 2)
  751. class TestComplexDecorator(GetSourceBase):
  752. fodderModule = mod2
  753. def test_parens_in_decorator(self):
  754. self.assertSourceEqual(self.fodderModule.complex_decorated, 273, 275)
  755. class _BrokenDataDescriptor(object):
  756. """
  757. A broken data descriptor. See bug #1785.
  758. """
  759. def __get__(*args):
  760. raise AttributeError("broken data descriptor")
  761. def __set__(*args):
  762. raise RuntimeError
  763. def __getattr__(*args):
  764. raise AttributeError("broken data descriptor")
  765. class _BrokenMethodDescriptor(object):
  766. """
  767. A broken method descriptor. See bug #1785.
  768. """
  769. def __get__(*args):
  770. raise AttributeError("broken method descriptor")
  771. def __getattr__(*args):
  772. raise AttributeError("broken method descriptor")
  773. # Helper for testing classify_class_attrs.
  774. def attrs_wo_objs(cls):
  775. return [t[:3] for t in inspect.classify_class_attrs(cls)]
  776. class TestClassesAndFunctions(unittest.TestCase):
  777. def test_newstyle_mro(self):
  778. # The same w/ new-class MRO.
  779. class A(object): pass
  780. class B(A): pass
  781. class C(A): pass
  782. class D(B, C): pass
  783. expected = (D, B, C, A, object)
  784. got = inspect.getmro(D)
  785. self.assertEqual(expected, got)
  786. def assertFullArgSpecEquals(self, routine, args_e, varargs_e=None,
  787. varkw_e=None, defaults_e=None,
  788. posonlyargs_e=[], kwonlyargs_e=[],
  789. kwonlydefaults_e=None,
  790. ann_e={}):
  791. args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
  792. inspect.getfullargspec(routine)
  793. self.assertEqual(args, args_e)
  794. self.assertEqual(varargs, varargs_e)
  795. self.assertEqual(varkw, varkw_e)
  796. self.assertEqual(defaults, defaults_e)
  797. self.assertEqual(kwonlyargs, kwonlyargs_e)
  798. self.assertEqual(kwonlydefaults, kwonlydefaults_e)
  799. self.assertEqual(ann, ann_e)
  800. def test_getfullargspec(self):
  801. self.assertFullArgSpecEquals(mod2.keyworded, [], varargs_e='arg1',
  802. kwonlyargs_e=['arg2'],
  803. kwonlydefaults_e={'arg2':1})
  804. self.assertFullArgSpecEquals(mod2.annotated, ['arg1'],
  805. ann_e={'arg1' : list})
  806. self.assertFullArgSpecEquals(mod2.keyword_only_arg, [],
  807. kwonlyargs_e=['arg'])
  808. self.assertFullArgSpecEquals(mod2.all_markers, ['a', 'b', 'c', 'd'],
  809. kwonlyargs_e=['e', 'f'])
  810. self.assertFullArgSpecEquals(mod2.all_markers_with_args_and_kwargs,
  811. ['a', 'b', 'c', 'd'],
  812. varargs_e='args',
  813. varkw_e='kwargs',
  814. kwonlyargs_e=['e', 'f'])
  815. self.assertFullArgSpecEquals(mod2.all_markers_with_defaults, ['a', 'b', 'c', 'd'],
  816. defaults_e=(1,2,3),
  817. kwonlyargs_e=['e', 'f'],
  818. kwonlydefaults_e={'e': 4, 'f': 5})
  819. def test_argspec_api_ignores_wrapped(self):
  820. # Issue 20684: low level introspection API must ignore __wrapped__
  821. @functools.wraps(mod.spam)
  822. def ham(x, y):
  823. pass
  824. # Basic check
  825. self.assertFullArgSpecEquals(ham, ['x', 'y'])
  826. self.assertFullArgSpecEquals(functools.partial(ham),
  827. ['x', 'y'])
  828. def test_getfullargspec_signature_attr(self):
  829. def test():
  830. pass
  831. spam_param = inspect.Parameter('spam', inspect.Parameter.POSITIONAL_ONLY)
  832. test.__signature__ = inspect.Signature(parameters=(spam_param,))
  833. self.assertFullArgSpecEquals(test, ['spam'])
  834. def test_getfullargspec_signature_annos(self):
  835. def test(a:'spam') -> 'ham': pass
  836. spec = inspect.getfullargspec(test)
  837. self.assertEqual(test.__annotations__, spec.annotations)
  838. def test(): pass
  839. spec = inspect.getfullargspec(test)
  840. self.assertEqual(test.__annotations__, spec.annotations)
  841. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  842. "Signature information for builtins requires docstrings")
  843. def test_getfullargspec_builtin_methods(self):
  844. self.assertFullArgSpecEquals(_pickle.Pickler.dump, ['self', 'obj'])
  845. self.assertFullArgSpecEquals(_pickle.Pickler(io.BytesIO()).dump, ['self', 'obj'])
  846. self.assertFullArgSpecEquals(
  847. os.stat,
  848. args_e=['path'],
  849. kwonlyargs_e=['dir_fd', 'follow_symlinks'],
  850. kwonlydefaults_e={'dir_fd': None, 'follow_symlinks': True})
  851. @cpython_only
  852. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  853. "Signature information for builtins requires docstrings")
  854. def test_getfullargspec_builtin_func(self):
  855. import _testcapi
  856. builtin = _testcapi.docstring_with_signature_with_defaults
  857. spec = inspect.getfullargspec(builtin)
  858. self.assertEqual(spec.defaults[0], 'avocado')
  859. @cpython_only
  860. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  861. "Signature information for builtins requires docstrings")
  862. def test_getfullargspec_builtin_func_no_signature(self):
  863. import _testcapi
  864. builtin = _testcapi.docstring_no_signature
  865. with self.assertRaises(TypeError):
  866. inspect.getfullargspec(builtin)
  867. def test_getfullargspec_definition_order_preserved_on_kwonly(self):
  868. for fn in signatures_with_lexicographic_keyword_only_parameters():
  869. signature = inspect.getfullargspec(fn)
  870. l = list(signature.kwonlyargs)
  871. sorted_l = sorted(l)
  872. self.assertTrue(l)
  873. self.assertEqual(l, sorted_l)
  874. signature = inspect.getfullargspec(unsorted_keyword_only_parameters_fn)
  875. l = list(signature.kwonlyargs)
  876. self.assertEqual(l, unsorted_keyword_only_parameters)
  877. def test_classify_newstyle(self):
  878. class A(object):
  879. def s(): pass
  880. s = staticmethod(s)
  881. def c(cls): pass
  882. c = classmethod(c)
  883. def getp(self): pass
  884. p = property(getp)
  885. def m(self): pass
  886. def m1(self): pass
  887. datablob = '1'
  888. dd = _BrokenDataDescriptor()
  889. md = _BrokenMethodDescriptor()
  890. attrs = attrs_wo_objs(A)
  891. self.assertIn(('__new__', 'static method', object), attrs,
  892. 'missing __new__')
  893. self.assertIn(('__init__', 'method', object), attrs, 'missing __init__')
  894. self.assertIn(('s', 'static method', A), attrs, 'missing static method')
  895. self.assertIn(('c', 'class method', A), attrs, 'missing class method')
  896. self.assertIn(('p', 'property', A), attrs, 'missing property')
  897. self.assertIn(('m', 'method', A), attrs,
  898. 'missing plain method: %r' % attrs)
  899. self.assertIn(('m1', 'method', A), attrs, 'missing plain method')
  900. self.assertIn(('datablob', 'data', A), attrs, 'missing data')
  901. self.assertIn(('md', 'method', A), attrs, 'missing method descriptor')
  902. self.assertIn(('dd', 'data', A), attrs, 'missing data descriptor')
  903. class B(A):
  904. def m(self): pass
  905. attrs = attrs_wo_objs(B)
  906. self.assertIn(('s', 'static method', A), attrs, 'missing static method')
  907. self.assertIn(('c', 'class method', A), attrs, 'missing class method')
  908. self.assertIn(('p', 'property', A), attrs, 'missing property')
  909. self.assertIn(('m', 'method', B), attrs, 'missing plain method')
  910. self.assertIn(('m1', 'method', A), attrs, 'missing plain method')
  911. self.assertIn(('datablob', 'data', A), attrs, 'missing data')
  912. self.assertIn(('md', 'method', A), attrs, 'missing method descriptor')
  913. self.assertIn(('dd', 'data', A), attrs, 'missing data descriptor')
  914. class C(A):
  915. def m(self): pass
  916. def c(self): pass
  917. attrs = attrs_wo_objs(C)
  918. self.assertIn(('s', 'static method', A), attrs, 'missing static method')
  919. self.assertIn(('c', 'method', C), attrs, 'missing plain method')
  920. self.assertIn(('p', 'property', A), attrs, 'missing property')
  921. self.assertIn(('m', 'method', C), attrs, 'missing plain method')
  922. self.assertIn(('m1', 'method', A), attrs, 'missing plain method')
  923. self.assertIn(('datablob', 'data', A), attrs, 'missing data')
  924. self.assertIn(('md', 'method', A), attrs, 'missing method descriptor')
  925. self.assertIn(('dd', 'data', A), attrs, 'missing data descriptor')
  926. class D(B, C):
  927. def m1(self): pass
  928. attrs = attrs_wo_objs(D)
  929. self.assertIn(('s', 'static method', A), attrs, 'missing static method')
  930. self.assertIn(('c', 'method', C), attrs, 'missing plain method')
  931. self.assertIn(('p', 'property', A), attrs, 'missing property')
  932. self.assertIn(('m', 'method', B), attrs, 'missing plain method')
  933. self.assertIn(('m1', 'method', D), attrs, 'missing plain method')
  934. self.assertIn(('datablob', 'data', A), attrs, 'missing data')
  935. self.assertIn(('md', 'method', A), attrs, 'missing method descriptor')
  936. self.assertIn(('dd', 'data', A), attrs, 'missing data descriptor')
  937. def test_classify_builtin_types(self):
  938. # Simple sanity check that all built-in types can have their
  939. # attributes classified.
  940. for name in dir(__builtins__):
  941. builtin = getattr(__builtins__, name)
  942. if isinstance(builtin, type):
  943. inspect.classify_class_attrs(builtin)
  944. attrs = attrs_wo_objs(bool)
  945. self.assertIn(('__new__', 'static method', bool), attrs,
  946. 'missing __new__')
  947. self.assertIn(('from_bytes', 'class method', int), attrs,
  948. 'missing class method')
  949. self.assertIn(('to_bytes', 'method', int), attrs,
  950. 'missing plain method')
  951. self.assertIn(('__add__', 'method', int), attrs,
  952. 'missing plain method')
  953. self.assertIn(('__and__', 'method', bool), attrs,
  954. 'missing plain method')
  955. def test_classify_DynamicClassAttribute(self):
  956. class Meta(type):
  957. def __getattr__(self, name):
  958. if name == 'ham':
  959. return 'spam'
  960. return super().__getattr__(name)
  961. class VA(metaclass=Meta):
  962. @types.DynamicClassAttribute
  963. def ham(self):
  964. return 'eggs'
  965. should_find_dca = inspect.Attribute('ham', 'data', VA, VA.__dict__['ham'])
  966. self.assertIn(should_find_dca, inspect.classify_class_attrs(VA))
  967. should_find_ga = inspect.Attribute('ham', 'data', Meta, 'spam')
  968. self.assertIn(should_find_ga, inspect.classify_class_attrs(VA))
  969. def test_classify_overrides_bool(self):
  970. class NoBool(object):
  971. def __eq__(self, other):
  972. return NoBool()
  973. def __bool__(self):
  974. raise NotImplementedError(
  975. "This object does not specify a boolean value")
  976. class HasNB(object):
  977. dd = NoBool()
  978. should_find_attr = inspect.Attribute('dd', 'data', HasNB, HasNB.dd)
  979. self.assertIn(should_find_attr, inspect.classify_class_attrs(HasNB))
  980. def test_classify_metaclass_class_attribute(self):
  981. class Meta(type):
  982. fish = 'slap'
  983. def __dir__(self):
  984. return ['__class__', '__module__', '__name__', 'fish']
  985. class Class(metaclass=Meta):
  986. pass
  987. should_find = inspect.Attribute('fish', 'data', Meta, 'slap')
  988. self.assertIn(should_find, inspect.classify_class_attrs(Class))
  989. def test_classify_VirtualAttribute(self):
  990. class Meta(type):
  991. def __dir__(cls):
  992. return ['__class__', '__module__', '__name__', 'BOOM']
  993. def __getattr__(self, name):
  994. if name =='BOOM':
  995. return 42
  996. return super().__getattr(name)
  997. class Class(metaclass=Meta):
  998. pass
  999. should_find = inspect.Attribute('BOOM', 'data', Meta, 42)
  1000. self.assertIn(should_find, inspect.classify_class_attrs(Class))
  1001. def test_classify_VirtualAttribute_multi_classes(self):
  1002. class Meta1(type):
  1003. def __dir__(cls):
  1004. return ['__class__', '__module__', '__name__', 'one']
  1005. def __getattr__(self, name):
  1006. if name =='one':
  1007. return 1
  1008. return super().__getattr__(name)
  1009. class Meta2(type):
  1010. def __dir__(cls):
  1011. return ['__class__', '__module__', '__name__', 'two']
  1012. def __getattr__(self, name):
  1013. if name =='two':
  1014. return 2
  1015. return super().__getattr__(name)
  1016. class Meta3(Meta1, Meta2):
  1017. def __dir__(cls):
  1018. return list(sorted(set(['__class__', '__module__', '__name__', 'three'] +
  1019. Meta1.__dir__(cls) + Meta2.__dir__(cls))))
  1020. def __getattr__(self, name):
  1021. if name =='three':
  1022. return 3
  1023. return super().__getattr__(name)
  1024. class Class1(metaclass=Meta1):
  1025. pass
  1026. class Class2(Class1, metaclass=Meta3):
  1027. pass
  1028. should_find1 = inspect.Attribute('one', 'data', Meta1, 1)
  1029. should_find2 = inspect.Attribute('two', 'data', Meta2, 2)
  1030. should_find3 = inspect.Attribute('three', 'data', Meta3, 3)
  1031. cca = inspect.classify_class_attrs(Class2)
  1032. for sf in (should_find1, should_find2, should_find3):
  1033. self.assertIn(sf, cca)
  1034. def test_classify_class_attrs_with_buggy_dir(self):
  1035. class M(type):
  1036. def __dir__(cls):
  1037. return ['__class__', '__name__', 'missing']
  1038. class C(metaclass=M):
  1039. pass
  1040. attrs = [a[0] for a in inspect.classify_class_attrs(C)]
  1041. self.assertNotIn('missing', attrs)
  1042. def test_getmembers_descriptors(self):
  1043. class A(object):
  1044. dd = _BrokenDataDescriptor()
  1045. md = _BrokenMethodDescriptor()
  1046. def pred_wrapper(pred):
  1047. # A quick'n'dirty way to discard standard attributes of new-style
  1048. # classes.
  1049. class Empty(object):
  1050. pass
  1051. def wrapped(x):
  1052. if '__name__' in dir(x) and hasattr(Empty, x.__name__):
  1053. return False
  1054. return pred(x)
  1055. return wrapped
  1056. ismethoddescriptor = pred_wrapper(inspect.ismethoddescriptor)
  1057. isdatadescriptor = pred_wrapper(inspect.isdatadescriptor)
  1058. self.assertEqual(inspect.getmembers(A, ismethoddescriptor),
  1059. [('md', A.__dict__['md'])])
  1060. self.assertEqual(inspect.getmembers(A, isdatadescriptor),
  1061. [('dd', A.__dict__['dd'])])
  1062. class B(A):
  1063. pass
  1064. self.assertEqual(inspect.getmembers(B, ismethoddescriptor),
  1065. [('md', A.__dict__['md'])])
  1066. self.assertEqual(inspect.getmembers(B, isdatadescriptor),
  1067. [('dd', A.__dict__['dd'])])
  1068. def test_getmembers_method(self):
  1069. class B:
  1070. def f(self):
  1071. pass
  1072. self.assertIn(('f', B.f), inspect.getmembers(B))
  1073. self.assertNotIn(('f', B.f), inspect.getmembers(B, inspect.ismethod))
  1074. b = B()
  1075. self.assertIn(('f', b.f), inspect.getmembers(b))
  1076. self.assertIn(('f', b.f), inspect.getmembers(b, inspect.ismethod))
  1077. def test_getmembers_VirtualAttribute(self):
  1078. class M(type):
  1079. def __getattr__(cls, name):
  1080. if name == 'eggs':
  1081. return 'scrambled'
  1082. return super().__getattr__(name)
  1083. class A(metaclass=M):
  1084. @types.DynamicClassAttribute
  1085. def eggs(self):
  1086. return 'spam'
  1087. class B:
  1088. def __getattr__(self, attribute):
  1089. return None
  1090. self.assertIn(('eggs', 'scrambled'), inspect.getmembers(A))
  1091. self.assertIn(('eggs', 'spam'), inspect.getmembers(A()))
  1092. b = B()
  1093. self.assertIn(('__getattr__', b.__getattr__), inspect.getmembers(b))
  1094. def test_getmembers_static(self):
  1095. class A:
  1096. @property
  1097. def name(self):
  1098. raise NotImplementedError
  1099. @types.DynamicClassAttribute
  1100. def eggs(self):
  1101. raise NotImplementedError
  1102. a = A()
  1103. instance_members = inspect.getmembers_static(a)
  1104. class_members = inspect.getmembers_static(A)
  1105. self.assertIn(('name', inspect.getattr_static(a, 'name')), instance_members)
  1106. self.assertIn(('eggs', inspect.getattr_static(a, 'eggs')), instance_members)
  1107. self.assertIn(('name', inspect.getattr_static(A, 'name')), class_members)
  1108. self.assertIn(('eggs', inspect.getattr_static(A, 'eggs')), class_members)
  1109. def test_getmembers_with_buggy_dir(self):
  1110. class M(type):
  1111. def __dir__(cls):
  1112. return ['__class__', '__name__', 'missing']
  1113. class C(metaclass=M):
  1114. pass
  1115. attrs = [a[0] for a in inspect.getmembers(C)]
  1116. self.assertNotIn('missing', attrs)
  1117. def test_get_annotations_with_stock_annotations(self):
  1118. def foo(a:int, b:str): pass
  1119. self.assertEqual(inspect.get_annotations(foo), {'a': int, 'b': str})
  1120. foo.__annotations__ = {'a': 'foo', 'b':'str'}
  1121. self.assertEqual(inspect.get_annotations(foo), {'a': 'foo', 'b': 'str'})
  1122. self.assertEqual(inspect.get_annotations(foo, eval_str=True, locals=locals()), {'a': foo, 'b': str})
  1123. self.assertEqual(inspect.get_annotations(foo, eval_str=True, globals=locals()), {'a': foo, 'b': str})
  1124. isa = inspect_stock_annotations
  1125. self.assertEqual(inspect.get_annotations(isa), {'a': int, 'b': str})
  1126. self.assertEqual(inspect.get_annotations(isa.MyClass), {'a': int, 'b': str})
  1127. self.assertEqual(inspect.get_annotations(isa.function), {'a': int, 'b': str, 'return': isa.MyClass})
  1128. self.assertEqual(inspect.get_annotations(isa.function2), {'a': int, 'b': 'str', 'c': isa.MyClass, 'return': isa.MyClass})
  1129. self.assertEqual(inspect.get_annotations(isa.function3), {'a': 'int', 'b': 'str', 'c': 'MyClass'})
  1130. self.assertEqual(inspect.get_annotations(inspect), {}) # inspect module has no annotations
  1131. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass), {})
  1132. self.assertEqual(inspect.get_annotations(isa.unannotated_function), {})
  1133. self.assertEqual(inspect.get_annotations(isa, eval_str=True), {'a': int, 'b': str})
  1134. self.assertEqual(inspect.get_annotations(isa.MyClass, eval_str=True), {'a': int, 'b': str})
  1135. self.assertEqual(inspect.get_annotations(isa.function, eval_str=True), {'a': int, 'b': str, 'return': isa.MyClass})
  1136. self.assertEqual(inspect.get_annotations(isa.function2, eval_str=True), {'a': int, 'b': str, 'c': isa.MyClass, 'return': isa.MyClass})
  1137. self.assertEqual(inspect.get_annotations(isa.function3, eval_str=True), {'a': int, 'b': str, 'c': isa.MyClass})
  1138. self.assertEqual(inspect.get_annotations(inspect, eval_str=True), {})
  1139. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass, eval_str=True), {})
  1140. self.assertEqual(inspect.get_annotations(isa.unannotated_function, eval_str=True), {})
  1141. self.assertEqual(inspect.get_annotations(isa, eval_str=False), {'a': int, 'b': str})
  1142. self.assertEqual(inspect.get_annotations(isa.MyClass, eval_str=False), {'a': int, 'b': str})
  1143. self.assertEqual(inspect.get_annotations(isa.function, eval_str=False), {'a': int, 'b': str, 'return': isa.MyClass})
  1144. self.assertEqual(inspect.get_annotations(isa.function2, eval_str=False), {'a': int, 'b': 'str', 'c': isa.MyClass, 'return': isa.MyClass})
  1145. self.assertEqual(inspect.get_annotations(isa.function3, eval_str=False), {'a': 'int', 'b': 'str', 'c': 'MyClass'})
  1146. self.assertEqual(inspect.get_annotations(inspect, eval_str=False), {})
  1147. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass, eval_str=False), {})
  1148. self.assertEqual(inspect.get_annotations(isa.unannotated_function, eval_str=False), {})
  1149. def times_three(fn):
  1150. @functools.wraps(fn)
  1151. def wrapper(a, b):
  1152. return fn(a*3, b*3)
  1153. return wrapper
  1154. wrapped = times_three(isa.function)
  1155. self.assertEqual(wrapped(1, 'x'), isa.MyClass(3, 'xxx'))
  1156. self.assertIsNot(wrapped.__globals__, isa.function.__globals__)
  1157. self.assertEqual(inspect.get_annotations(wrapped), {'a': int, 'b': str, 'return': isa.MyClass})
  1158. self.assertEqual(inspect.get_annotations(wrapped, eval_str=True), {'a': int, 'b': str, 'return': isa.MyClass})
  1159. self.assertEqual(inspect.get_annotations(wrapped, eval_str=False), {'a': int, 'b': str, 'return': isa.MyClass})
  1160. def test_get_annotations_with_stringized_annotations(self):
  1161. isa = inspect_stringized_annotations
  1162. self.assertEqual(inspect.get_annotations(isa), {'a': 'int', 'b': 'str'})
  1163. self.assertEqual(inspect.get_annotations(isa.MyClass), {'a': 'int', 'b': 'str'})
  1164. self.assertEqual(inspect.get_annotations(isa.function), {'a': 'int', 'b': 'str', 'return': 'MyClass'})
  1165. self.assertEqual(inspect.get_annotations(isa.function2), {'a': 'int', 'b': "'str'", 'c': 'MyClass', 'return': 'MyClass'})
  1166. self.assertEqual(inspect.get_annotations(isa.function3), {'a': "'int'", 'b': "'str'", 'c': "'MyClass'"})
  1167. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass), {})
  1168. self.assertEqual(inspect.get_annotations(isa.unannotated_function), {})
  1169. self.assertEqual(inspect.get_annotations(isa, eval_str=True), {'a': int, 'b': str})
  1170. self.assertEqual(inspect.get_annotations(isa.MyClass, eval_str=True), {'a': int, 'b': str})
  1171. self.assertEqual(inspect.get_annotations(isa.function, eval_str=True), {'a': int, 'b': str, 'return': isa.MyClass})
  1172. self.assertEqual(inspect.get_annotations(isa.function2, eval_str=True), {'a': int, 'b': 'str', 'c': isa.MyClass, 'return': isa.MyClass})
  1173. self.assertEqual(inspect.get_annotations(isa.function3, eval_str=True), {'a': 'int', 'b': 'str', 'c': 'MyClass'})
  1174. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass, eval_str=True), {})
  1175. self.assertEqual(inspect.get_annotations(isa.unannotated_function, eval_str=True), {})
  1176. self.assertEqual(inspect.get_annotations(isa, eval_str=False), {'a': 'int', 'b': 'str'})
  1177. self.assertEqual(inspect.get_annotations(isa.MyClass, eval_str=False), {'a': 'int', 'b': 'str'})
  1178. self.assertEqual(inspect.get_annotations(isa.function, eval_str=False), {'a': 'int', 'b': 'str', 'return': 'MyClass'})
  1179. self.assertEqual(inspect.get_annotations(isa.function2, eval_str=False), {'a': 'int', 'b': "'str'", 'c': 'MyClass', 'return': 'MyClass'})
  1180. self.assertEqual(inspect.get_annotations(isa.function3, eval_str=False), {'a': "'int'", 'b': "'str'", 'c': "'MyClass'"})
  1181. self.assertEqual(inspect.get_annotations(isa.UnannotatedClass, eval_str=False), {})
  1182. self.assertEqual(inspect.get_annotations(isa.unannotated_function, eval_str=False), {})
  1183. isa2 = inspect_stringized_annotations_2
  1184. self.assertEqual(inspect.get_annotations(isa2), {})
  1185. self.assertEqual(inspect.get_annotations(isa2, eval_str=True), {})
  1186. self.assertEqual(inspect.get_annotations(isa2, eval_str=False), {})
  1187. def times_three(fn):
  1188. @functools.wraps(fn)
  1189. def wrapper(a, b):
  1190. return fn(a*3, b*3)
  1191. return wrapper
  1192. wrapped = times_three(isa.function)
  1193. self.assertEqual(wrapped(1, 'x'), isa.MyClass(3, 'xxx'))
  1194. self.assertIsNot(wrapped.__globals__, isa.function.__globals__)
  1195. self.assertEqual(inspect.get_annotations(wrapped), {'a': 'int', 'b': 'str', 'return': 'MyClass'})
  1196. self.assertEqual(inspect.get_annotations(wrapped, eval_str=True), {'a': int, 'b': str, 'return': isa.MyClass})
  1197. self.assertEqual(inspect.get_annotations(wrapped, eval_str=False), {'a': 'int', 'b': 'str', 'return': 'MyClass'})
  1198. # test that local namespace lookups work
  1199. self.assertEqual(inspect.get_annotations(isa.MyClassWithLocalAnnotations), {'x': 'mytype'})
  1200. self.assertEqual(inspect.get_annotations(isa.MyClassWithLocalAnnotations, eval_str=True), {'x': int})
  1201. class TestFormatAnnotation(unittest.TestCase):
  1202. def test_typing_replacement(self):
  1203. from test.typinganndata.ann_module9 import ann, ann1
  1204. self.assertEqual(inspect.formatannotation(ann), 'Union[List[str], int]')
  1205. self.assertEqual(inspect.formatannotation(ann1), 'Union[List[testModule.typing.A], int]')
  1206. class TestIsDataDescriptor(unittest.TestCase):
  1207. def test_custom_descriptors(self):
  1208. class NonDataDescriptor:
  1209. def __get__(self, value, type=None): pass
  1210. class DataDescriptor0:
  1211. def __set__(self, name, value): pass
  1212. class DataDescriptor1:
  1213. def __delete__(self, name): pass
  1214. class DataDescriptor2:
  1215. __set__ = None
  1216. self.assertFalse(inspect.isdatadescriptor(NonDataDescriptor()),
  1217. 'class with only __get__ not a data descriptor')
  1218. self.assertTrue(inspect.isdatadescriptor(DataDescriptor0()),
  1219. 'class with __set__ is a data descriptor')
  1220. self.assertTrue(inspect.isdatadescriptor(DataDescriptor1()),
  1221. 'class with __delete__ is a data descriptor')
  1222. self.assertTrue(inspect.isdatadescriptor(DataDescriptor2()),
  1223. 'class with __set__ = None is a data descriptor')
  1224. def test_slot(self):
  1225. class Slotted:
  1226. __slots__ = 'foo',
  1227. self.assertTrue(inspect.isdatadescriptor(Slotted.foo),
  1228. 'a slot is a data descriptor')
  1229. def test_property(self):
  1230. class Propertied:
  1231. @property
  1232. def a_property(self):
  1233. pass
  1234. self.assertTrue(inspect.isdatadescriptor(Propertied.a_property),
  1235. 'a property is a data descriptor')
  1236. def test_functions(self):
  1237. class Test(object):
  1238. def instance_method(self): pass
  1239. @classmethod
  1240. def class_method(cls): pass
  1241. @staticmethod
  1242. def static_method(): pass
  1243. def function():
  1244. pass
  1245. a_lambda = lambda: None
  1246. self.assertFalse(inspect.isdatadescriptor(Test().instance_method),
  1247. 'a instance method is not a data descriptor')
  1248. self.assertFalse(inspect.isdatadescriptor(Test().class_method),
  1249. 'a class method is not a data descriptor')
  1250. self.assertFalse(inspect.isdatadescriptor(Test().static_method),
  1251. 'a static method is not a data descriptor')
  1252. self.assertFalse(inspect.isdatadescriptor(function),
  1253. 'a function is not a data descriptor')
  1254. self.assertFalse(inspect.isdatadescriptor(a_lambda),
  1255. 'a lambda is not a data descriptor')
  1256. _global_ref = object()
  1257. class TestGetClosureVars(unittest.TestCase):
  1258. def test_name_resolution(self):
  1259. # Basic test of the 4 different resolution mechanisms
  1260. def f(nonlocal_ref):
  1261. def g(local_ref):
  1262. print(local_ref, nonlocal_ref, _global_ref, unbound_ref)
  1263. return g
  1264. _arg = object()
  1265. nonlocal_vars = {"nonlocal_ref": _arg}
  1266. global_vars = {"_global_ref": _global_ref}
  1267. builtin_vars = {"print": print}
  1268. unbound_names = {"unbound_ref"}
  1269. expected = inspect.ClosureVars(nonlocal_vars, global_vars,
  1270. builtin_vars, unbound_names)
  1271. self.assertEqual(inspect.getclosurevars(f(_arg)), expected)
  1272. def test_generator_closure(self):
  1273. def f(nonlocal_ref):
  1274. def g(local_ref):
  1275. print(local_ref, nonlocal_ref, _global_ref, unbound_ref)
  1276. yield
  1277. return g
  1278. _arg = object()
  1279. nonlocal_vars = {"nonlocal_ref": _arg}
  1280. global_vars = {"_global_ref": _global_ref}
  1281. builtin_vars = {"print": print}
  1282. unbound_names = {"unbound_ref"}
  1283. expected = inspect.ClosureVars(nonlocal_vars, global_vars,
  1284. builtin_vars, unbound_names)
  1285. self.assertEqual(inspect.getclosurevars(f(_arg)), expected)
  1286. def test_method_closure(self):
  1287. class C:
  1288. def f(self, nonlocal_ref):
  1289. def g(local_ref):
  1290. print(local_ref, nonlocal_ref, _global_ref, unbound_ref)
  1291. return g
  1292. _arg = object()
  1293. nonlocal_vars = {"nonlocal_ref": _arg}
  1294. global_vars = {"_global_ref": _global_ref}
  1295. builtin_vars = {"print": print}
  1296. unbound_names = {"unbound_ref"}
  1297. expected = inspect.ClosureVars(nonlocal_vars, global_vars,
  1298. builtin_vars, unbound_names)
  1299. self.assertEqual(inspect.getclosurevars(C().f(_arg)), expected)
  1300. def test_nonlocal_vars(self):
  1301. # More complex tests of nonlocal resolution
  1302. def _nonlocal_vars(f):
  1303. return inspect.getclosurevars(f).nonlocals
  1304. def make_adder(x):
  1305. def add(y):
  1306. return x + y
  1307. return add
  1308. def curry(func, arg1):
  1309. return lambda arg2: func(arg1, arg2)
  1310. def less_than(a, b):
  1311. return a < b
  1312. # The infamous Y combinator.
  1313. def Y(le):
  1314. def g(f):
  1315. return le(lambda x: f(f)(x))
  1316. Y.g_ref = g
  1317. return g(g)
  1318. def check_y_combinator(func):
  1319. self.assertEqual(_nonlocal_vars(func), {'f': Y.g_ref})
  1320. inc = make_adder(1)
  1321. add_two = make_adder(2)
  1322. greater_than_five = curry(less_than, 5)
  1323. self.assertEqual(_nonlocal_vars(inc), {'x': 1})
  1324. self.assertEqual(_nonlocal_vars(add_two), {'x': 2})
  1325. self.assertEqual(_nonlocal_vars(greater_than_five),
  1326. {'arg1': 5, 'func': less_than})
  1327. self.assertEqual(_nonlocal_vars((lambda x: lambda y: x + y)(3)),
  1328. {'x': 3})
  1329. Y(check_y_combinator)
  1330. def test_getclosurevars_empty(self):
  1331. def foo(): pass
  1332. _empty = inspect.ClosureVars({}, {}, {}, set())
  1333. self.assertEqual(inspect.getclosurevars(lambda: True), _empty)
  1334. self.assertEqual(inspect.getclosurevars(foo), _empty)
  1335. def test_getclosurevars_error(self):
  1336. class T: pass
  1337. self.assertRaises(TypeError, inspect.getclosurevars, 1)
  1338. self.assertRaises(TypeError, inspect.getclosurevars, list)
  1339. self.assertRaises(TypeError, inspect.getclosurevars, {})
  1340. def _private_globals(self):
  1341. code = """def f(): print(path)"""
  1342. ns = {}
  1343. exec(code, ns)
  1344. return ns["f"], ns
  1345. def test_builtins_fallback(self):
  1346. f, ns = self._private_globals()
  1347. ns.pop("__builtins__", None)
  1348. expected = inspect.ClosureVars({}, {}, {"print":print}, {"path"})
  1349. self.assertEqual(inspect.getclosurevars(f), expected)
  1350. def test_builtins_as_dict(self):
  1351. f, ns = self._private_globals()
  1352. ns["__builtins__"] = {"path":1}
  1353. expected = inspect.ClosureVars({}, {}, {"path":1}, {"print"})
  1354. self.assertEqual(inspect.getclosurevars(f), expected)
  1355. def test_builtins_as_module(self):
  1356. f, ns = self._private_globals()
  1357. ns["__builtins__"] = os
  1358. expected = inspect.ClosureVars({}, {}, {"path":os.path}, {"print"})
  1359. self.assertEqual(inspect.getclosurevars(f), expected)
  1360. class TestGetcallargsFunctions(unittest.TestCase):
  1361. def assertEqualCallArgs(self, func, call_params_string, locs=None):
  1362. locs = dict(locs or {}, func=func)
  1363. r1 = eval('func(%s)' % call_params_string, None, locs)
  1364. r2 = eval('inspect.getcallargs(func, %s)' % call_params_string, None,
  1365. locs)
  1366. self.assertEqual(r1, r2)
  1367. def assertEqualException(self, func, call_param_string, locs=None):
  1368. locs = dict(locs or {}, func=func)
  1369. try:
  1370. eval('func(%s)' % call_param_string, None, locs)
  1371. except Exception as e:
  1372. ex1 = e
  1373. else:
  1374. self.fail('Exception not raised')
  1375. try:
  1376. eval('inspect.getcallargs(func, %s)' % call_param_string, None,
  1377. locs)
  1378. except Exception as e:
  1379. ex2 = e
  1380. else:
  1381. self.fail('Exception not raised')
  1382. self.assertIs(type(ex1), type(ex2))
  1383. self.assertEqual(str(ex1), str(ex2))
  1384. del ex1, ex2
  1385. def makeCallable(self, signature):
  1386. """Create a function that returns its locals()"""
  1387. code = "lambda %s: locals()"
  1388. return eval(code % signature)
  1389. def test_plain(self):
  1390. f = self.makeCallable('a, b=1')
  1391. self.assertEqualCallArgs(f, '2')
  1392. self.assertEqualCallArgs(f, '2, 3')
  1393. self.assertEqualCallArgs(f, 'a=2')
  1394. self.assertEqualCallArgs(f, 'b=3, a=2')
  1395. self.assertEqualCallArgs(f, '2, b=3')
  1396. # expand *iterable / **mapping
  1397. self.assertEqualCallArgs(f, '*(2,)')
  1398. self.assertEqualCallArgs(f, '*[2]')
  1399. self.assertEqualCallArgs(f, '*(2, 3)')
  1400. self.assertEqualCallArgs(f, '*[2, 3]')
  1401. self.assertEqualCallArgs(f, '**{"a":2}')
  1402. self.assertEqualCallArgs(f, 'b=3, **{"a":2}')
  1403. self.assertEqualCallArgs(f, '2, **{"b":3}')
  1404. self.assertEqualCallArgs(f, '**{"b":3, "a":2}')
  1405. # expand UserList / UserDict
  1406. self.assertEqualCallArgs(f, '*collections.UserList([2])')
  1407. self.assertEqualCallArgs(f, '*collections.UserList([2, 3])')
  1408. self.assertEqualCallArgs(f, '**collections.UserDict(a=2)')
  1409. self.assertEqualCallArgs(f, '2, **collections.UserDict(b=3)')
  1410. self.assertEqualCallArgs(f, 'b=2, **collections.UserDict(a=3)')
  1411. def test_varargs(self):
  1412. f = self.makeCallable('a, b=1, *c')
  1413. self.assertEqualCallArgs(f, '2')
  1414. self.assertEqualCallArgs(f, '2, 3')
  1415. self.assertEqualCallArgs(f, '2, 3, 4')
  1416. self.assertEqualCallArgs(f, '*(2,3,4)')
  1417. self.assertEqualCallArgs(f, '2, *[3,4]')
  1418. self.assertEqualCallArgs(f, '2, 3, *collections.UserList([4])')
  1419. def test_varkw(self):
  1420. f = self.makeCallable('a, b=1, **c')
  1421. self.assertEqualCallArgs(f, 'a=2')
  1422. self.assertEqualCallArgs(f, '2, b=3, c=4')
  1423. self.assertEqualCallArgs(f, 'b=3, a=2, c=4')
  1424. self.assertEqualCallArgs(f, 'c=4, **{"a":2, "b":3}')
  1425. self.assertEqualCallArgs(f, '2, c=4, **{"b":3}')
  1426. self.assertEqualCallArgs(f, 'b=2, **{"a":3, "c":4}')
  1427. self.assertEqualCallArgs(f, '**collections.UserDict(a=2, b=3, c=4)')
  1428. self.assertEqualCallArgs(f, '2, c=4, **collections.UserDict(b=3)')
  1429. self.assertEqualCallArgs(f, 'b=2, **collections.UserDict(a=3, c=4)')
  1430. def test_varkw_only(self):
  1431. # issue11256:
  1432. f = self.makeCallable('**c')
  1433. self.assertEqualCallArgs(f, '')
  1434. self.assertEqualCallArgs(f, 'a=1')
  1435. self.assertEqualCallArgs(f, 'a=1, b=2')
  1436. self.assertEqualCallArgs(f, 'c=3, **{"a": 1, "b": 2}')
  1437. self.assertEqualCallArgs(f, '**collections.UserDict(a=1, b=2)')
  1438. self.assertEqualCallArgs(f, 'c=3, **collections.UserDict(a=1, b=2)')
  1439. def test_keyword_only(self):
  1440. f = self.makeCallable('a=3, *, c, d=2')
  1441. self.assertEqualCallArgs(f, 'c=3')
  1442. self.assertEqualCallArgs(f, 'c=3, a=3')
  1443. self.assertEqualCallArgs(f, 'a=2, c=4')
  1444. self.assertEqualCallArgs(f, '4, c=4')
  1445. self.assertEqualException(f, '')
  1446. self.assertEqualException(f, '3')
  1447. self.assertEqualException(f, 'a=3')
  1448. self.assertEqualException(f, 'd=4')
  1449. f = self.makeCallable('*, c, d=2')
  1450. self.assertEqualCallArgs(f, 'c=3')
  1451. self.assertEqualCallArgs(f, 'c=3, d=4')
  1452. self.assertEqualCallArgs(f, 'd=4, c=3')
  1453. def test_multiple_features(self):
  1454. f = self.makeCallable('a, b=2, *f, **g')
  1455. self.assertEqualCallArgs(f, '2, 3, 7')
  1456. self.assertEqualCallArgs(f, '2, 3, x=8')
  1457. self.assertEqualCallArgs(f, '2, 3, x=8, *[(4,[5,6]), 7]')
  1458. self.assertEqualCallArgs(f, '2, x=8, *[3, (4,[5,6]), 7], y=9')
  1459. self.assertEqualCallArgs(f, 'x=8, *[2, 3, (4,[5,6])], y=9')
  1460. self.assertEqualCallArgs(f, 'x=8, *collections.UserList('
  1461. '[2, 3, (4,[5,6])]), **{"y":9, "z":10}')
  1462. self.assertEqualCallArgs(f, '2, x=8, *collections.UserList([3, '
  1463. '(4,[5,6])]), **collections.UserDict('
  1464. 'y=9, z=10)')
  1465. f = self.makeCallable('a, b=2, *f, x, y=99, **g')
  1466. self.assertEqualCallArgs(f, '2, 3, x=8')
  1467. self.assertEqualCallArgs(f, '2, 3, x=8, *[(4,[5,6]), 7]')
  1468. self.assertEqualCallArgs(f, '2, x=8, *[3, (4,[5,6]), 7], y=9, z=10')
  1469. self.assertEqualCallArgs(f, 'x=8, *[2, 3, (4,[5,6])], y=9, z=10')
  1470. self.assertEqualCallArgs(f, 'x=8, *collections.UserList('
  1471. '[2, 3, (4,[5,6])]), q=0, **{"y":9, "z":10}')
  1472. self.assertEqualCallArgs(f, '2, x=8, *collections.UserList([3, '
  1473. '(4,[5,6])]), q=0, **collections.UserDict('
  1474. 'y=9, z=10)')
  1475. def test_errors(self):
  1476. f0 = self.makeCallable('')
  1477. f1 = self.makeCallable('a, b')
  1478. f2 = self.makeCallable('a, b=1')
  1479. # f0 takes no arguments
  1480. self.assertEqualException(f0, '1')
  1481. self.assertEqualException(f0, 'x=1')
  1482. self.assertEqualException(f0, '1,x=1')
  1483. # f1 takes exactly 2 arguments
  1484. self.assertEqualException(f1, '')
  1485. self.assertEqualException(f1, '1')
  1486. self.assertEqualException(f1, 'a=2')
  1487. self.assertEqualException(f1, 'b=3')
  1488. # f2 takes at least 1 argument
  1489. self.assertEqualException(f2, '')
  1490. self.assertEqualException(f2, 'b=3')
  1491. for f in f1, f2:
  1492. # f1/f2 takes exactly/at most 2 arguments
  1493. self.assertEqualException(f, '2, 3, 4')
  1494. self.assertEqualException(f, '1, 2, 3, a=1')
  1495. self.assertEqualException(f, '2, 3, 4, c=5')
  1496. # XXX: success of this one depends on dict order
  1497. ## self.assertEqualException(f, '2, 3, 4, a=1, c=5')
  1498. # f got an unexpected keyword argument
  1499. self.assertEqualException(f, 'c=2')
  1500. self.assertEqualException(f, '2, c=3')
  1501. self.assertEqualException(f, '2, 3, c=4')
  1502. self.assertEqualException(f, '2, c=4, b=3')
  1503. self.assertEqualException(f, '**{u"\u03c0\u03b9": 4}')
  1504. # f got multiple values for keyword argument
  1505. self.assertEqualException(f, '1, a=2')
  1506. self.assertEqualException(f, '1, **{"a":2}')
  1507. self.assertEqualException(f, '1, 2, b=3')
  1508. # XXX: Python inconsistency
  1509. # - for functions and bound methods: unexpected keyword 'c'
  1510. # - for unbound methods: multiple values for keyword 'a'
  1511. #self.assertEqualException(f, '1, c=3, a=2')
  1512. # issue11256:
  1513. f3 = self.makeCallable('**c')
  1514. self.assertEqualException(f3, '1, 2')
  1515. self.assertEqualException(f3, '1, 2, a=1, b=2')
  1516. f4 = self.makeCallable('*, a, b=0')
  1517. self.assertEqualException(f3, '1, 2')
  1518. self.assertEqualException(f3, '1, 2, a=1, b=2')
  1519. # issue #20816: getcallargs() fails to iterate over non-existent
  1520. # kwonlydefaults and raises a wrong TypeError
  1521. def f5(*, a): pass
  1522. with self.assertRaisesRegex(TypeError,
  1523. 'missing 1 required keyword-only'):
  1524. inspect.getcallargs(f5)
  1525. # issue20817:
  1526. def f6(a, b, c):
  1527. pass
  1528. with self.assertRaisesRegex(TypeError, "'a', 'b' and 'c'"):
  1529. inspect.getcallargs(f6)
  1530. # bpo-33197
  1531. with self.assertRaisesRegex(ValueError,
  1532. 'variadic keyword parameters cannot'
  1533. ' have default values'):
  1534. inspect.Parameter("foo", kind=inspect.Parameter.VAR_KEYWORD,
  1535. default=42)
  1536. with self.assertRaisesRegex(ValueError,
  1537. "value 5 is not a valid Parameter.kind"):
  1538. inspect.Parameter("bar", kind=5, default=42)
  1539. with self.assertRaisesRegex(TypeError,
  1540. 'name must be a str, not a int'):
  1541. inspect.Parameter(123, kind=4)
  1542. class TestGetcallargsMethods(TestGetcallargsFunctions):
  1543. def setUp(self):
  1544. class Foo(object):
  1545. pass
  1546. self.cls = Foo
  1547. self.inst = Foo()
  1548. def makeCallable(self, signature):
  1549. assert 'self' not in signature
  1550. mk = super(TestGetcallargsMethods, self).makeCallable
  1551. self.cls.method = mk('self, ' + signature)
  1552. return self.inst.method
  1553. class TestGetcallargsUnboundMethods(TestGetcallargsMethods):
  1554. def makeCallable(self, signature):
  1555. super(TestGetcallargsUnboundMethods, self).makeCallable(signature)
  1556. return self.cls.method
  1557. def assertEqualCallArgs(self, func, call_params_string, locs=None):
  1558. return super(TestGetcallargsUnboundMethods, self).assertEqualCallArgs(
  1559. *self._getAssertEqualParams(func, call_params_string, locs))
  1560. def assertEqualException(self, func, call_params_string, locs=None):
  1561. return super(TestGetcallargsUnboundMethods, self).assertEqualException(
  1562. *self._getAssertEqualParams(func, call_params_string, locs))
  1563. def _getAssertEqualParams(self, func, call_params_string, locs=None):
  1564. assert 'inst' not in call_params_string
  1565. locs = dict(locs or {}, inst=self.inst)
  1566. return (func, 'inst,' + call_params_string, locs)
  1567. class TestGetattrStatic(unittest.TestCase):
  1568. def test_basic(self):
  1569. class Thing(object):
  1570. x = object()
  1571. thing = Thing()
  1572. self.assertEqual(inspect.getattr_static(thing, 'x'), Thing.x)
  1573. self.assertEqual(inspect.getattr_static(thing, 'x', None), Thing.x)
  1574. with self.assertRaises(AttributeError):
  1575. inspect.getattr_static(thing, 'y')
  1576. self.assertEqual(inspect.getattr_static(thing, 'y', 3), 3)
  1577. def test_inherited(self):
  1578. class Thing(object):
  1579. x = object()
  1580. class OtherThing(Thing):
  1581. pass
  1582. something = OtherThing()
  1583. self.assertEqual(inspect.getattr_static(something, 'x'), Thing.x)
  1584. def test_instance_attr(self):
  1585. class Thing(object):
  1586. x = 2
  1587. def __init__(self, x):
  1588. self.x = x
  1589. thing = Thing(3)
  1590. self.assertEqual(inspect.getattr_static(thing, 'x'), 3)
  1591. del thing.x
  1592. self.assertEqual(inspect.getattr_static(thing, 'x'), 2)
  1593. def test_property(self):
  1594. class Thing(object):
  1595. @property
  1596. def x(self):
  1597. raise AttributeError("I'm pretending not to exist")
  1598. thing = Thing()
  1599. self.assertEqual(inspect.getattr_static(thing, 'x'), Thing.x)
  1600. def test_descriptor_raises_AttributeError(self):
  1601. class descriptor(object):
  1602. def __get__(*_):
  1603. raise AttributeError("I'm pretending not to exist")
  1604. desc = descriptor()
  1605. class Thing(object):
  1606. x = desc
  1607. thing = Thing()
  1608. self.assertEqual(inspect.getattr_static(thing, 'x'), desc)
  1609. def test_classAttribute(self):
  1610. class Thing(object):
  1611. x = object()
  1612. self.assertEqual(inspect.getattr_static(Thing, 'x'), Thing.x)
  1613. def test_classVirtualAttribute(self):
  1614. class Thing(object):
  1615. @types.DynamicClassAttribute
  1616. def x(self):
  1617. return self._x
  1618. _x = object()
  1619. self.assertEqual(inspect.getattr_static(Thing, 'x'), Thing.__dict__['x'])
  1620. def test_inherited_classattribute(self):
  1621. class Thing(object):
  1622. x = object()
  1623. class OtherThing(Thing):
  1624. pass
  1625. self.assertEqual(inspect.getattr_static(OtherThing, 'x'), Thing.x)
  1626. def test_slots(self):
  1627. class Thing(object):
  1628. y = 'bar'
  1629. __slots__ = ['x']
  1630. def __init__(self):
  1631. self.x = 'foo'
  1632. thing = Thing()
  1633. self.assertEqual(inspect.getattr_static(thing, 'x'), Thing.x)
  1634. self.assertEqual(inspect.getattr_static(thing, 'y'), 'bar')
  1635. del thing.x
  1636. self.assertEqual(inspect.getattr_static(thing, 'x'), Thing.x)
  1637. def test_metaclass(self):
  1638. class meta(type):
  1639. attr = 'foo'
  1640. class Thing(object, metaclass=meta):
  1641. pass
  1642. self.assertEqual(inspect.getattr_static(Thing, 'attr'), 'foo')
  1643. class sub(meta):
  1644. pass
  1645. class OtherThing(object, metaclass=sub):
  1646. x = 3
  1647. self.assertEqual(inspect.getattr_static(OtherThing, 'attr'), 'foo')
  1648. class OtherOtherThing(OtherThing):
  1649. pass
  1650. # this test is odd, but it was added as it exposed a bug
  1651. self.assertEqual(inspect.getattr_static(OtherOtherThing, 'x'), 3)
  1652. def test_no_dict_no_slots(self):
  1653. self.assertEqual(inspect.getattr_static(1, 'foo', None), None)
  1654. self.assertNotEqual(inspect.getattr_static('foo', 'lower'), None)
  1655. def test_no_dict_no_slots_instance_member(self):
  1656. # returns descriptor
  1657. with open(__file__, encoding='utf-8') as handle:
  1658. self.assertEqual(inspect.getattr_static(handle, 'name'), type(handle).name)
  1659. def test_inherited_slots(self):
  1660. # returns descriptor
  1661. class Thing(object):
  1662. __slots__ = ['x']
  1663. def __init__(self):
  1664. self.x = 'foo'
  1665. class OtherThing(Thing):
  1666. pass
  1667. # it would be nice if this worked...
  1668. # we get the descriptor instead of the instance attribute
  1669. self.assertEqual(inspect.getattr_static(OtherThing(), 'x'), Thing.x)
  1670. def test_descriptor(self):
  1671. class descriptor(object):
  1672. def __get__(self, instance, owner):
  1673. return 3
  1674. class Foo(object):
  1675. d = descriptor()
  1676. foo = Foo()
  1677. # for a non data descriptor we return the instance attribute
  1678. foo.__dict__['d'] = 1
  1679. self.assertEqual(inspect.getattr_static(foo, 'd'), 1)
  1680. # if the descriptor is a data-descriptor we should return the
  1681. # descriptor
  1682. descriptor.__set__ = lambda s, i, v: None
  1683. self.assertEqual(inspect.getattr_static(foo, 'd'), Foo.__dict__['d'])
  1684. def test_metaclass_with_descriptor(self):
  1685. class descriptor(object):
  1686. def __get__(self, instance, owner):
  1687. return 3
  1688. class meta(type):
  1689. d = descriptor()
  1690. class Thing(object, metaclass=meta):
  1691. pass
  1692. self.assertEqual(inspect.getattr_static(Thing, 'd'), meta.__dict__['d'])
  1693. def test_class_as_property(self):
  1694. class Base(object):
  1695. foo = 3
  1696. class Something(Base):
  1697. executed = False
  1698. @property
  1699. def __class__(self):
  1700. self.executed = True
  1701. return object
  1702. instance = Something()
  1703. self.assertEqual(inspect.getattr_static(instance, 'foo'), 3)
  1704. self.assertFalse(instance.executed)
  1705. self.assertEqual(inspect.getattr_static(Something, 'foo'), 3)
  1706. def test_mro_as_property(self):
  1707. class Meta(type):
  1708. @property
  1709. def __mro__(self):
  1710. return (object,)
  1711. class Base(object):
  1712. foo = 3
  1713. class Something(Base, metaclass=Meta):
  1714. pass
  1715. self.assertEqual(inspect.getattr_static(Something(), 'foo'), 3)
  1716. self.assertEqual(inspect.getattr_static(Something, 'foo'), 3)
  1717. def test_dict_as_property(self):
  1718. test = self
  1719. test.called = False
  1720. class Foo(dict):
  1721. a = 3
  1722. @property
  1723. def __dict__(self):
  1724. test.called = True
  1725. return {}
  1726. foo = Foo()
  1727. foo.a = 4
  1728. self.assertEqual(inspect.getattr_static(foo, 'a'), 3)
  1729. self.assertFalse(test.called)
  1730. def test_custom_object_dict(self):
  1731. test = self
  1732. test.called = False
  1733. class Custom(dict):
  1734. def get(self, key, default=None):
  1735. test.called = True
  1736. super().get(key, default)
  1737. class Foo(object):
  1738. a = 3
  1739. foo = Foo()
  1740. foo.__dict__ = Custom()
  1741. self.assertEqual(inspect.getattr_static(foo, 'a'), 3)
  1742. self.assertFalse(test.called)
  1743. def test_metaclass_dict_as_property(self):
  1744. class Meta(type):
  1745. @property
  1746. def __dict__(self):
  1747. self.executed = True
  1748. class Thing(metaclass=Meta):
  1749. executed = False
  1750. def __init__(self):
  1751. self.spam = 42
  1752. instance = Thing()
  1753. self.assertEqual(inspect.getattr_static(instance, "spam"), 42)
  1754. self.assertFalse(Thing.executed)
  1755. def test_module(self):
  1756. sentinel = object()
  1757. self.assertIsNot(inspect.getattr_static(sys, "version", sentinel),
  1758. sentinel)
  1759. def test_metaclass_with_metaclass_with_dict_as_property(self):
  1760. class MetaMeta(type):
  1761. @property
  1762. def __dict__(self):
  1763. self.executed = True
  1764. return dict(spam=42)
  1765. class Meta(type, metaclass=MetaMeta):
  1766. executed = False
  1767. class Thing(metaclass=Meta):
  1768. pass
  1769. with self.assertRaises(AttributeError):
  1770. inspect.getattr_static(Thing, "spam")
  1771. self.assertFalse(Thing.executed)
  1772. class TestGetGeneratorState(unittest.TestCase):
  1773. def setUp(self):
  1774. def number_generator():
  1775. for number in range(5):
  1776. yield number
  1777. self.generator = number_generator()
  1778. def _generatorstate(self):
  1779. return inspect.getgeneratorstate(self.generator)
  1780. def test_created(self):
  1781. self.assertEqual(self._generatorstate(), inspect.GEN_CREATED)
  1782. def test_suspended(self):
  1783. next(self.generator)
  1784. self.assertEqual(self._generatorstate(), inspect.GEN_SUSPENDED)
  1785. def test_closed_after_exhaustion(self):
  1786. for i in self.generator:
  1787. pass
  1788. self.assertEqual(self._generatorstate(), inspect.GEN_CLOSED)
  1789. def test_closed_after_immediate_exception(self):
  1790. with self.assertRaises(RuntimeError):
  1791. self.generator.throw(RuntimeError)
  1792. self.assertEqual(self._generatorstate(), inspect.GEN_CLOSED)
  1793. def test_running(self):
  1794. # As mentioned on issue #10220, checking for the RUNNING state only
  1795. # makes sense inside the generator itself.
  1796. # The following generator checks for this by using the closure's
  1797. # reference to self and the generator state checking helper method
  1798. def running_check_generator():
  1799. for number in range(5):
  1800. self.assertEqual(self._generatorstate(), inspect.GEN_RUNNING)
  1801. yield number
  1802. self.assertEqual(self._generatorstate(), inspect.GEN_RUNNING)
  1803. self.generator = running_check_generator()
  1804. # Running up to the first yield
  1805. next(self.generator)
  1806. # Running after the first yield
  1807. next(self.generator)
  1808. def test_easy_debugging(self):
  1809. # repr() and str() of a generator state should contain the state name
  1810. names = 'GEN_CREATED GEN_RUNNING GEN_SUSPENDED GEN_CLOSED'.split()
  1811. for name in names:
  1812. state = getattr(inspect, name)
  1813. self.assertIn(name, repr(state))
  1814. self.assertIn(name, str(state))
  1815. def test_getgeneratorlocals(self):
  1816. def each(lst, a=None):
  1817. b=(1, 2, 3)
  1818. for v in lst:
  1819. if v == 3:
  1820. c = 12
  1821. yield v
  1822. numbers = each([1, 2, 3])
  1823. self.assertEqual(inspect.getgeneratorlocals(numbers),
  1824. {'a': None, 'lst': [1, 2, 3]})
  1825. next(numbers)
  1826. self.assertEqual(inspect.getgeneratorlocals(numbers),
  1827. {'a': None, 'lst': [1, 2, 3], 'v': 1,
  1828. 'b': (1, 2, 3)})
  1829. next(numbers)
  1830. self.assertEqual(inspect.getgeneratorlocals(numbers),
  1831. {'a': None, 'lst': [1, 2, 3], 'v': 2,
  1832. 'b': (1, 2, 3)})
  1833. next(numbers)
  1834. self.assertEqual(inspect.getgeneratorlocals(numbers),
  1835. {'a': None, 'lst': [1, 2, 3], 'v': 3,
  1836. 'b': (1, 2, 3), 'c': 12})
  1837. try:
  1838. next(numbers)
  1839. except StopIteration:
  1840. pass
  1841. self.assertEqual(inspect.getgeneratorlocals(numbers), {})
  1842. def test_getgeneratorlocals_empty(self):
  1843. def yield_one():
  1844. yield 1
  1845. one = yield_one()
  1846. self.assertEqual(inspect.getgeneratorlocals(one), {})
  1847. try:
  1848. next(one)
  1849. except StopIteration:
  1850. pass
  1851. self.assertEqual(inspect.getgeneratorlocals(one), {})
  1852. def test_getgeneratorlocals_error(self):
  1853. self.assertRaises(TypeError, inspect.getgeneratorlocals, 1)
  1854. self.assertRaises(TypeError, inspect.getgeneratorlocals, lambda x: True)
  1855. self.assertRaises(TypeError, inspect.getgeneratorlocals, set)
  1856. self.assertRaises(TypeError, inspect.getgeneratorlocals, (2,3))
  1857. class TestGetCoroutineState(unittest.TestCase):
  1858. def setUp(self):
  1859. @types.coroutine
  1860. def number_coroutine():
  1861. for number in range(5):
  1862. yield number
  1863. async def coroutine():
  1864. await number_coroutine()
  1865. self.coroutine = coroutine()
  1866. def tearDown(self):
  1867. self.coroutine.close()
  1868. def _coroutinestate(self):
  1869. return inspect.getcoroutinestate(self.coroutine)
  1870. def test_created(self):
  1871. self.assertEqual(self._coroutinestate(), inspect.CORO_CREATED)
  1872. def test_suspended(self):
  1873. self.coroutine.send(None)
  1874. self.assertEqual(self._coroutinestate(), inspect.CORO_SUSPENDED)
  1875. def test_closed_after_exhaustion(self):
  1876. while True:
  1877. try:
  1878. self.coroutine.send(None)
  1879. except StopIteration:
  1880. break
  1881. self.assertEqual(self._coroutinestate(), inspect.CORO_CLOSED)
  1882. def test_closed_after_immediate_exception(self):
  1883. with self.assertRaises(RuntimeError):
  1884. self.coroutine.throw(RuntimeError)
  1885. self.assertEqual(self._coroutinestate(), inspect.CORO_CLOSED)
  1886. def test_easy_debugging(self):
  1887. # repr() and str() of a coroutine state should contain the state name
  1888. names = 'CORO_CREATED CORO_RUNNING CORO_SUSPENDED CORO_CLOSED'.split()
  1889. for name in names:
  1890. state = getattr(inspect, name)
  1891. self.assertIn(name, repr(state))
  1892. self.assertIn(name, str(state))
  1893. def test_getcoroutinelocals(self):
  1894. @types.coroutine
  1895. def gencoro():
  1896. yield
  1897. gencoro = gencoro()
  1898. async def func(a=None):
  1899. b = 'spam'
  1900. await gencoro
  1901. coro = func()
  1902. self.assertEqual(inspect.getcoroutinelocals(coro),
  1903. {'a': None, 'gencoro': gencoro})
  1904. coro.send(None)
  1905. self.assertEqual(inspect.getcoroutinelocals(coro),
  1906. {'a': None, 'gencoro': gencoro, 'b': 'spam'})
  1907. class MySignature(inspect.Signature):
  1908. # Top-level to make it picklable;
  1909. # used in test_signature_object_pickle
  1910. pass
  1911. class MyParameter(inspect.Parameter):
  1912. # Top-level to make it picklable;
  1913. # used in test_signature_object_pickle
  1914. pass
  1915. class TestSignatureObject(unittest.TestCase):
  1916. @staticmethod
  1917. def signature(func, **kw):
  1918. sig = inspect.signature(func, **kw)
  1919. return (tuple((param.name,
  1920. (... if param.default is param.empty else param.default),
  1921. (... if param.annotation is param.empty
  1922. else param.annotation),
  1923. str(param.kind).lower())
  1924. for param in sig.parameters.values()),
  1925. (... if sig.return_annotation is sig.empty
  1926. else sig.return_annotation))
  1927. def test_signature_object(self):
  1928. S = inspect.Signature
  1929. P = inspect.Parameter
  1930. self.assertEqual(str(S()), '()')
  1931. self.assertEqual(repr(S().parameters), 'mappingproxy(OrderedDict())')
  1932. def test(po, pk, pod=42, pkd=100, *args, ko, **kwargs):
  1933. pass
  1934. sig = inspect.signature(test)
  1935. po = sig.parameters['po'].replace(kind=P.POSITIONAL_ONLY)
  1936. pod = sig.parameters['pod'].replace(kind=P.POSITIONAL_ONLY)
  1937. pk = sig.parameters['pk']
  1938. pkd = sig.parameters['pkd']
  1939. args = sig.parameters['args']
  1940. ko = sig.parameters['ko']
  1941. kwargs = sig.parameters['kwargs']
  1942. S((po, pk, args, ko, kwargs))
  1943. with self.assertRaisesRegex(ValueError, 'wrong parameter order'):
  1944. S((pk, po, args, ko, kwargs))
  1945. with self.assertRaisesRegex(ValueError, 'wrong parameter order'):
  1946. S((po, args, pk, ko, kwargs))
  1947. with self.assertRaisesRegex(ValueError, 'wrong parameter order'):
  1948. S((args, po, pk, ko, kwargs))
  1949. with self.assertRaisesRegex(ValueError, 'wrong parameter order'):
  1950. S((po, pk, args, kwargs, ko))
  1951. kwargs2 = kwargs.replace(name='args')
  1952. with self.assertRaisesRegex(ValueError, 'duplicate parameter name'):
  1953. S((po, pk, args, kwargs2, ko))
  1954. with self.assertRaisesRegex(ValueError, 'follows default argument'):
  1955. S((pod, po))
  1956. with self.assertRaisesRegex(ValueError, 'follows default argument'):
  1957. S((po, pkd, pk))
  1958. with self.assertRaisesRegex(ValueError, 'follows default argument'):
  1959. S((pkd, pk))
  1960. self.assertTrue(repr(sig).startswith('<Signature'))
  1961. self.assertTrue('(po, pk' in repr(sig))
  1962. def test_signature_object_pickle(self):
  1963. def foo(a, b, *, c:1={}, **kw) -> {42:'ham'}: pass
  1964. foo_partial = functools.partial(foo, a=1)
  1965. sig = inspect.signature(foo_partial)
  1966. for ver in range(pickle.HIGHEST_PROTOCOL + 1):
  1967. with self.subTest(pickle_ver=ver, subclass=False):
  1968. sig_pickled = pickle.loads(pickle.dumps(sig, ver))
  1969. self.assertEqual(sig, sig_pickled)
  1970. # Test that basic sub-classing works
  1971. sig = inspect.signature(foo)
  1972. myparam = MyParameter(name='z', kind=inspect.Parameter.POSITIONAL_ONLY)
  1973. myparams = collections.OrderedDict(sig.parameters, a=myparam)
  1974. mysig = MySignature().replace(parameters=myparams.values(),
  1975. return_annotation=sig.return_annotation)
  1976. self.assertTrue(isinstance(mysig, MySignature))
  1977. self.assertTrue(isinstance(mysig.parameters['z'], MyParameter))
  1978. for ver in range(pickle.HIGHEST_PROTOCOL + 1):
  1979. with self.subTest(pickle_ver=ver, subclass=True):
  1980. sig_pickled = pickle.loads(pickle.dumps(mysig, ver))
  1981. self.assertEqual(mysig, sig_pickled)
  1982. self.assertTrue(isinstance(sig_pickled, MySignature))
  1983. self.assertTrue(isinstance(sig_pickled.parameters['z'],
  1984. MyParameter))
  1985. def test_signature_immutability(self):
  1986. def test(a):
  1987. pass
  1988. sig = inspect.signature(test)
  1989. with self.assertRaises(AttributeError):
  1990. sig.foo = 'bar'
  1991. with self.assertRaises(TypeError):
  1992. sig.parameters['a'] = None
  1993. def test_signature_on_noarg(self):
  1994. def test():
  1995. pass
  1996. self.assertEqual(self.signature(test), ((), ...))
  1997. def test_signature_on_wargs(self):
  1998. def test(a, b:'foo') -> 123:
  1999. pass
  2000. self.assertEqual(self.signature(test),
  2001. ((('a', ..., ..., "positional_or_keyword"),
  2002. ('b', ..., 'foo', "positional_or_keyword")),
  2003. 123))
  2004. def test_signature_on_wkwonly(self):
  2005. def test(*, a:float, b:str) -> int:
  2006. pass
  2007. self.assertEqual(self.signature(test),
  2008. ((('a', ..., float, "keyword_only"),
  2009. ('b', ..., str, "keyword_only")),
  2010. int))
  2011. def test_signature_on_complex_args(self):
  2012. def test(a, b:'foo'=10, *args:'bar', spam:'baz', ham=123, **kwargs:int):
  2013. pass
  2014. self.assertEqual(self.signature(test),
  2015. ((('a', ..., ..., "positional_or_keyword"),
  2016. ('b', 10, 'foo', "positional_or_keyword"),
  2017. ('args', ..., 'bar', "var_positional"),
  2018. ('spam', ..., 'baz', "keyword_only"),
  2019. ('ham', 123, ..., "keyword_only"),
  2020. ('kwargs', ..., int, "var_keyword")),
  2021. ...))
  2022. def test_signature_without_self(self):
  2023. def test_args_only(*args): # NOQA
  2024. pass
  2025. def test_args_kwargs_only(*args, **kwargs): # NOQA
  2026. pass
  2027. class A:
  2028. @classmethod
  2029. def test_classmethod(*args): # NOQA
  2030. pass
  2031. @staticmethod
  2032. def test_staticmethod(*args): # NOQA
  2033. pass
  2034. f1 = functools.partialmethod((test_classmethod), 1)
  2035. f2 = functools.partialmethod((test_args_only), 1)
  2036. f3 = functools.partialmethod((test_staticmethod), 1)
  2037. f4 = functools.partialmethod((test_args_kwargs_only),1)
  2038. self.assertEqual(self.signature(test_args_only),
  2039. ((('args', ..., ..., 'var_positional'),), ...))
  2040. self.assertEqual(self.signature(test_args_kwargs_only),
  2041. ((('args', ..., ..., 'var_positional'),
  2042. ('kwargs', ..., ..., 'var_keyword')), ...))
  2043. self.assertEqual(self.signature(A.f1),
  2044. ((('args', ..., ..., 'var_positional'),), ...))
  2045. self.assertEqual(self.signature(A.f2),
  2046. ((('args', ..., ..., 'var_positional'),), ...))
  2047. self.assertEqual(self.signature(A.f3),
  2048. ((('args', ..., ..., 'var_positional'),), ...))
  2049. self.assertEqual(self.signature(A.f4),
  2050. ((('args', ..., ..., 'var_positional'),
  2051. ('kwargs', ..., ..., 'var_keyword')), ...))
  2052. @cpython_only
  2053. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  2054. "Signature information for builtins requires docstrings")
  2055. def test_signature_on_builtins(self):
  2056. import _testcapi
  2057. def test_unbound_method(o):
  2058. """Use this to test unbound methods (things that should have a self)"""
  2059. signature = inspect.signature(o)
  2060. self.assertTrue(isinstance(signature, inspect.Signature))
  2061. self.assertEqual(list(signature.parameters.values())[0].name, 'self')
  2062. return signature
  2063. def test_callable(o):
  2064. """Use this to test bound methods or normal callables (things that don't expect self)"""
  2065. signature = inspect.signature(o)
  2066. self.assertTrue(isinstance(signature, inspect.Signature))
  2067. if signature.parameters:
  2068. self.assertNotEqual(list(signature.parameters.values())[0].name, 'self')
  2069. return signature
  2070. signature = test_callable(_testcapi.docstring_with_signature_with_defaults)
  2071. def p(name): return signature.parameters[name].default
  2072. self.assertEqual(p('s'), 'avocado')
  2073. self.assertEqual(p('b'), b'bytes')
  2074. self.assertEqual(p('d'), 3.14)
  2075. self.assertEqual(p('i'), 35)
  2076. self.assertEqual(p('n'), None)
  2077. self.assertEqual(p('t'), True)
  2078. self.assertEqual(p('f'), False)
  2079. self.assertEqual(p('local'), 3)
  2080. self.assertEqual(p('sys'), sys.maxsize)
  2081. self.assertEqual(p('exp'), sys.maxsize - 1)
  2082. test_callable(object)
  2083. # normal method
  2084. # (PyMethodDescr_Type, "method_descriptor")
  2085. test_unbound_method(_pickle.Pickler.dump)
  2086. d = _pickle.Pickler(io.StringIO())
  2087. test_callable(d.dump)
  2088. # static method
  2089. test_callable(bytes.maketrans)
  2090. test_callable(b'abc'.maketrans)
  2091. # class method
  2092. test_callable(dict.fromkeys)
  2093. test_callable({}.fromkeys)
  2094. # wrapper around slot (PyWrapperDescr_Type, "wrapper_descriptor")
  2095. test_unbound_method(type.__call__)
  2096. test_unbound_method(int.__add__)
  2097. test_callable((3).__add__)
  2098. # _PyMethodWrapper_Type
  2099. # support for 'method-wrapper'
  2100. test_callable(min.__call__)
  2101. # This doesn't work now.
  2102. # (We don't have a valid signature for "type" in 3.4)
  2103. with self.assertRaisesRegex(ValueError, "no signature found"):
  2104. class ThisWorksNow:
  2105. __call__ = type
  2106. test_callable(ThisWorksNow())
  2107. # Regression test for issue #20786
  2108. test_unbound_method(dict.__delitem__)
  2109. test_unbound_method(property.__delete__)
  2110. # Regression test for issue #20586
  2111. test_callable(_testcapi.docstring_with_signature_but_no_doc)
  2112. @cpython_only
  2113. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  2114. "Signature information for builtins requires docstrings")
  2115. def test_signature_on_decorated_builtins(self):
  2116. import _testcapi
  2117. func = _testcapi.docstring_with_signature_with_defaults
  2118. def decorator(func):
  2119. @functools.wraps(func)
  2120. def wrapper(*args, **kwargs) -> int:
  2121. return func(*args, **kwargs)
  2122. return wrapper
  2123. decorated_func = decorator(func)
  2124. self.assertEqual(inspect.signature(func),
  2125. inspect.signature(decorated_func))
  2126. def wrapper_like(*args, **kwargs) -> int: pass
  2127. self.assertEqual(inspect.signature(decorated_func,
  2128. follow_wrapped=False),
  2129. inspect.signature(wrapper_like))
  2130. @cpython_only
  2131. def test_signature_on_builtins_no_signature(self):
  2132. import _testcapi
  2133. with self.assertRaisesRegex(ValueError,
  2134. 'no signature found for builtin'):
  2135. inspect.signature(_testcapi.docstring_no_signature)
  2136. with self.assertRaisesRegex(ValueError,
  2137. 'no signature found for builtin'):
  2138. inspect.signature(str)
  2139. def test_signature_on_non_function(self):
  2140. with self.assertRaisesRegex(TypeError, 'is not a callable object'):
  2141. inspect.signature(42)
  2142. def test_signature_from_functionlike_object(self):
  2143. def func(a,b, *args, kwonly=True, kwonlyreq, **kwargs):
  2144. pass
  2145. class funclike:
  2146. # Has to be callable, and have correct
  2147. # __code__, __annotations__, __defaults__, __name__,
  2148. # and __kwdefaults__ attributes
  2149. def __init__(self, func):
  2150. self.__name__ = func.__name__
  2151. self.__code__ = func.__code__
  2152. self.__annotations__ = func.__annotations__
  2153. self.__defaults__ = func.__defaults__
  2154. self.__kwdefaults__ = func.__kwdefaults__
  2155. self.func = func
  2156. def __call__(self, *args, **kwargs):
  2157. return self.func(*args, **kwargs)
  2158. sig_func = inspect.Signature.from_callable(func)
  2159. sig_funclike = inspect.Signature.from_callable(funclike(func))
  2160. self.assertEqual(sig_funclike, sig_func)
  2161. sig_funclike = inspect.signature(funclike(func))
  2162. self.assertEqual(sig_funclike, sig_func)
  2163. # If object is not a duck type of function, then
  2164. # signature will try to get a signature for its '__call__'
  2165. # method
  2166. fl = funclike(func)
  2167. del fl.__defaults__
  2168. self.assertEqual(self.signature(fl),
  2169. ((('args', ..., ..., "var_positional"),
  2170. ('kwargs', ..., ..., "var_keyword")),
  2171. ...))
  2172. # Test with cython-like builtins:
  2173. _orig_isdesc = inspect.ismethoddescriptor
  2174. def _isdesc(obj):
  2175. if hasattr(obj, '_builtinmock'):
  2176. return True
  2177. return _orig_isdesc(obj)
  2178. with unittest.mock.patch('inspect.ismethoddescriptor', _isdesc):
  2179. builtin_func = funclike(func)
  2180. # Make sure that our mock setup is working
  2181. self.assertFalse(inspect.ismethoddescriptor(builtin_func))
  2182. builtin_func._builtinmock = True
  2183. self.assertTrue(inspect.ismethoddescriptor(builtin_func))
  2184. self.assertEqual(inspect.signature(builtin_func), sig_func)
  2185. def test_signature_functionlike_class(self):
  2186. # We only want to duck type function-like objects,
  2187. # not classes.
  2188. def func(a,b, *args, kwonly=True, kwonlyreq, **kwargs):
  2189. pass
  2190. class funclike:
  2191. def __init__(self, marker):
  2192. pass
  2193. __name__ = func.__name__
  2194. __code__ = func.__code__
  2195. __annotations__ = func.__annotations__
  2196. __defaults__ = func.__defaults__
  2197. __kwdefaults__ = func.__kwdefaults__
  2198. self.assertEqual(str(inspect.signature(funclike)), '(marker)')
  2199. def test_signature_on_method(self):
  2200. class Test:
  2201. def __init__(*args):
  2202. pass
  2203. def m1(self, arg1, arg2=1) -> int:
  2204. pass
  2205. def m2(*args):
  2206. pass
  2207. def __call__(*, a):
  2208. pass
  2209. self.assertEqual(self.signature(Test().m1),
  2210. ((('arg1', ..., ..., "positional_or_keyword"),
  2211. ('arg2', 1, ..., "positional_or_keyword")),
  2212. int))
  2213. self.assertEqual(self.signature(Test().m2),
  2214. ((('args', ..., ..., "var_positional"),),
  2215. ...))
  2216. self.assertEqual(self.signature(Test),
  2217. ((('args', ..., ..., "var_positional"),),
  2218. ...))
  2219. with self.assertRaisesRegex(ValueError, 'invalid method signature'):
  2220. self.signature(Test())
  2221. def test_signature_wrapped_bound_method(self):
  2222. # Issue 24298
  2223. class Test:
  2224. def m1(self, arg1, arg2=1) -> int:
  2225. pass
  2226. @functools.wraps(Test().m1)
  2227. def m1d(*args, **kwargs):
  2228. pass
  2229. self.assertEqual(self.signature(m1d),
  2230. ((('arg1', ..., ..., "positional_or_keyword"),
  2231. ('arg2', 1, ..., "positional_or_keyword")),
  2232. int))
  2233. def test_signature_on_classmethod(self):
  2234. class Test:
  2235. @classmethod
  2236. def foo(cls, arg1, *, arg2=1):
  2237. pass
  2238. meth = Test().foo
  2239. self.assertEqual(self.signature(meth),
  2240. ((('arg1', ..., ..., "positional_or_keyword"),
  2241. ('arg2', 1, ..., "keyword_only")),
  2242. ...))
  2243. meth = Test.foo
  2244. self.assertEqual(self.signature(meth),
  2245. ((('arg1', ..., ..., "positional_or_keyword"),
  2246. ('arg2', 1, ..., "keyword_only")),
  2247. ...))
  2248. def test_signature_on_staticmethod(self):
  2249. class Test:
  2250. @staticmethod
  2251. def foo(cls, *, arg):
  2252. pass
  2253. meth = Test().foo
  2254. self.assertEqual(self.signature(meth),
  2255. ((('cls', ..., ..., "positional_or_keyword"),
  2256. ('arg', ..., ..., "keyword_only")),
  2257. ...))
  2258. meth = Test.foo
  2259. self.assertEqual(self.signature(meth),
  2260. ((('cls', ..., ..., "positional_or_keyword"),
  2261. ('arg', ..., ..., "keyword_only")),
  2262. ...))
  2263. def test_signature_on_partial(self):
  2264. from functools import partial
  2265. Parameter = inspect.Parameter
  2266. def test():
  2267. pass
  2268. self.assertEqual(self.signature(partial(test)), ((), ...))
  2269. with self.assertRaisesRegex(ValueError, "has incorrect arguments"):
  2270. inspect.signature(partial(test, 1))
  2271. with self.assertRaisesRegex(ValueError, "has incorrect arguments"):
  2272. inspect.signature(partial(test, a=1))
  2273. def test(a, b, *, c, d):
  2274. pass
  2275. self.assertEqual(self.signature(partial(test)),
  2276. ((('a', ..., ..., "positional_or_keyword"),
  2277. ('b', ..., ..., "positional_or_keyword"),
  2278. ('c', ..., ..., "keyword_only"),
  2279. ('d', ..., ..., "keyword_only")),
  2280. ...))
  2281. self.assertEqual(self.signature(partial(test, 1)),
  2282. ((('b', ..., ..., "positional_or_keyword"),
  2283. ('c', ..., ..., "keyword_only"),
  2284. ('d', ..., ..., "keyword_only")),
  2285. ...))
  2286. self.assertEqual(self.signature(partial(test, 1, c=2)),
  2287. ((('b', ..., ..., "positional_or_keyword"),
  2288. ('c', 2, ..., "keyword_only"),
  2289. ('d', ..., ..., "keyword_only")),
  2290. ...))
  2291. self.assertEqual(self.signature(partial(test, b=1, c=2)),
  2292. ((('a', ..., ..., "positional_or_keyword"),
  2293. ('b', 1, ..., "keyword_only"),
  2294. ('c', 2, ..., "keyword_only"),
  2295. ('d', ..., ..., "keyword_only")),
  2296. ...))
  2297. self.assertEqual(self.signature(partial(test, 0, b=1, c=2)),
  2298. ((('b', 1, ..., "keyword_only"),
  2299. ('c', 2, ..., "keyword_only"),
  2300. ('d', ..., ..., "keyword_only")),
  2301. ...))
  2302. self.assertEqual(self.signature(partial(test, a=1)),
  2303. ((('a', 1, ..., "keyword_only"),
  2304. ('b', ..., ..., "keyword_only"),
  2305. ('c', ..., ..., "keyword_only"),
  2306. ('d', ..., ..., "keyword_only")),
  2307. ...))
  2308. def test(a, *args, b, **kwargs):
  2309. pass
  2310. self.assertEqual(self.signature(partial(test, 1)),
  2311. ((('args', ..., ..., "var_positional"),
  2312. ('b', ..., ..., "keyword_only"),
  2313. ('kwargs', ..., ..., "var_keyword")),
  2314. ...))
  2315. self.assertEqual(self.signature(partial(test, a=1)),
  2316. ((('a', 1, ..., "keyword_only"),
  2317. ('b', ..., ..., "keyword_only"),
  2318. ('kwargs', ..., ..., "var_keyword")),
  2319. ...))
  2320. self.assertEqual(self.signature(partial(test, 1, 2, 3)),
  2321. ((('args', ..., ..., "var_positional"),
  2322. ('b', ..., ..., "keyword_only"),
  2323. ('kwargs', ..., ..., "var_keyword")),
  2324. ...))
  2325. self.assertEqual(self.signature(partial(test, 1, 2, 3, test=True)),
  2326. ((('args', ..., ..., "var_positional"),
  2327. ('b', ..., ..., "keyword_only"),
  2328. ('kwargs', ..., ..., "var_keyword")),
  2329. ...))
  2330. self.assertEqual(self.signature(partial(test, 1, 2, 3, test=1, b=0)),
  2331. ((('args', ..., ..., "var_positional"),
  2332. ('b', 0, ..., "keyword_only"),
  2333. ('kwargs', ..., ..., "var_keyword")),
  2334. ...))
  2335. self.assertEqual(self.signature(partial(test, b=0)),
  2336. ((('a', ..., ..., "positional_or_keyword"),
  2337. ('args', ..., ..., "var_positional"),
  2338. ('b', 0, ..., "keyword_only"),
  2339. ('kwargs', ..., ..., "var_keyword")),
  2340. ...))
  2341. self.assertEqual(self.signature(partial(test, b=0, test=1)),
  2342. ((('a', ..., ..., "positional_or_keyword"),
  2343. ('args', ..., ..., "var_positional"),
  2344. ('b', 0, ..., "keyword_only"),
  2345. ('kwargs', ..., ..., "var_keyword")),
  2346. ...))
  2347. def test(a, b, c:int) -> 42:
  2348. pass
  2349. sig = test.__signature__ = inspect.signature(test)
  2350. self.assertEqual(self.signature(partial(partial(test, 1))),
  2351. ((('b', ..., ..., "positional_or_keyword"),
  2352. ('c', ..., int, "positional_or_keyword")),
  2353. 42))
  2354. self.assertEqual(self.signature(partial(partial(test, 1), 2)),
  2355. ((('c', ..., int, "positional_or_keyword"),),
  2356. 42))
  2357. psig = inspect.signature(partial(partial(test, 1), 2))
  2358. def foo(a):
  2359. return a
  2360. _foo = partial(partial(foo, a=10), a=20)
  2361. self.assertEqual(self.signature(_foo),
  2362. ((('a', 20, ..., "keyword_only"),),
  2363. ...))
  2364. # check that we don't have any side-effects in signature(),
  2365. # and the partial object is still functioning
  2366. self.assertEqual(_foo(), 20)
  2367. def foo(a, b, c):
  2368. return a, b, c
  2369. _foo = partial(partial(foo, 1, b=20), b=30)
  2370. self.assertEqual(self.signature(_foo),
  2371. ((('b', 30, ..., "keyword_only"),
  2372. ('c', ..., ..., "keyword_only")),
  2373. ...))
  2374. self.assertEqual(_foo(c=10), (1, 30, 10))
  2375. def foo(a, b, c, *, d):
  2376. return a, b, c, d
  2377. _foo = partial(partial(foo, d=20, c=20), b=10, d=30)
  2378. self.assertEqual(self.signature(_foo),
  2379. ((('a', ..., ..., "positional_or_keyword"),
  2380. ('b', 10, ..., "keyword_only"),
  2381. ('c', 20, ..., "keyword_only"),
  2382. ('d', 30, ..., "keyword_only"),
  2383. ),
  2384. ...))
  2385. ba = inspect.signature(_foo).bind(a=200, b=11)
  2386. self.assertEqual(_foo(*ba.args, **ba.kwargs), (200, 11, 20, 30))
  2387. def foo(a=1, b=2, c=3):
  2388. return a, b, c
  2389. _foo = partial(foo, c=13) # (a=1, b=2, *, c=13)
  2390. ba = inspect.signature(_foo).bind(a=11)
  2391. self.assertEqual(_foo(*ba.args, **ba.kwargs), (11, 2, 13))
  2392. ba = inspect.signature(_foo).bind(11, 12)
  2393. self.assertEqual(_foo(*ba.args, **ba.kwargs), (11, 12, 13))
  2394. ba = inspect.signature(_foo).bind(11, b=12)
  2395. self.assertEqual(_foo(*ba.args, **ba.kwargs), (11, 12, 13))
  2396. ba = inspect.signature(_foo).bind(b=12)
  2397. self.assertEqual(_foo(*ba.args, **ba.kwargs), (1, 12, 13))
  2398. _foo = partial(_foo, b=10, c=20)
  2399. ba = inspect.signature(_foo).bind(12)
  2400. self.assertEqual(_foo(*ba.args, **ba.kwargs), (12, 10, 20))
  2401. def foo(a, b, c, d, **kwargs):
  2402. pass
  2403. sig = inspect.signature(foo)
  2404. params = sig.parameters.copy()
  2405. params['a'] = params['a'].replace(kind=Parameter.POSITIONAL_ONLY)
  2406. params['b'] = params['b'].replace(kind=Parameter.POSITIONAL_ONLY)
  2407. foo.__signature__ = inspect.Signature(params.values())
  2408. sig = inspect.signature(foo)
  2409. self.assertEqual(str(sig), '(a, b, /, c, d, **kwargs)')
  2410. self.assertEqual(self.signature(partial(foo, 1)),
  2411. ((('b', ..., ..., 'positional_only'),
  2412. ('c', ..., ..., 'positional_or_keyword'),
  2413. ('d', ..., ..., 'positional_or_keyword'),
  2414. ('kwargs', ..., ..., 'var_keyword')),
  2415. ...))
  2416. self.assertEqual(self.signature(partial(foo, 1, 2)),
  2417. ((('c', ..., ..., 'positional_or_keyword'),
  2418. ('d', ..., ..., 'positional_or_keyword'),
  2419. ('kwargs', ..., ..., 'var_keyword')),
  2420. ...))
  2421. self.assertEqual(self.signature(partial(foo, 1, 2, 3)),
  2422. ((('d', ..., ..., 'positional_or_keyword'),
  2423. ('kwargs', ..., ..., 'var_keyword')),
  2424. ...))
  2425. self.assertEqual(self.signature(partial(foo, 1, 2, c=3)),
  2426. ((('c', 3, ..., 'keyword_only'),
  2427. ('d', ..., ..., 'keyword_only'),
  2428. ('kwargs', ..., ..., 'var_keyword')),
  2429. ...))
  2430. self.assertEqual(self.signature(partial(foo, 1, c=3)),
  2431. ((('b', ..., ..., 'positional_only'),
  2432. ('c', 3, ..., 'keyword_only'),
  2433. ('d', ..., ..., 'keyword_only'),
  2434. ('kwargs', ..., ..., 'var_keyword')),
  2435. ...))
  2436. def test_signature_on_partialmethod(self):
  2437. from functools import partialmethod
  2438. class Spam:
  2439. def test():
  2440. pass
  2441. ham = partialmethod(test)
  2442. with self.assertRaisesRegex(ValueError, "has incorrect arguments"):
  2443. inspect.signature(Spam.ham)
  2444. class Spam:
  2445. def test(it, a, *, c) -> 'spam':
  2446. pass
  2447. ham = partialmethod(test, c=1)
  2448. self.assertEqual(self.signature(Spam.ham, eval_str=False),
  2449. ((('it', ..., ..., 'positional_or_keyword'),
  2450. ('a', ..., ..., 'positional_or_keyword'),
  2451. ('c', 1, ..., 'keyword_only')),
  2452. 'spam'))
  2453. self.assertEqual(self.signature(Spam().ham, eval_str=False),
  2454. ((('a', ..., ..., 'positional_or_keyword'),
  2455. ('c', 1, ..., 'keyword_only')),
  2456. 'spam'))
  2457. class Spam:
  2458. def test(self: 'anno', x):
  2459. pass
  2460. g = partialmethod(test, 1)
  2461. self.assertEqual(self.signature(Spam.g, eval_str=False),
  2462. ((('self', ..., 'anno', 'positional_or_keyword'),),
  2463. ...))
  2464. def test_signature_on_fake_partialmethod(self):
  2465. def foo(a): pass
  2466. foo._partialmethod = 'spam'
  2467. self.assertEqual(str(inspect.signature(foo)), '(a)')
  2468. def test_signature_on_decorated(self):
  2469. def decorator(func):
  2470. @functools.wraps(func)
  2471. def wrapper(*args, **kwargs) -> int:
  2472. return func(*args, **kwargs)
  2473. return wrapper
  2474. class Foo:
  2475. @decorator
  2476. def bar(self, a, b):
  2477. pass
  2478. bar = decorator(Foo().bar)
  2479. self.assertEqual(self.signature(Foo.bar),
  2480. ((('self', ..., ..., "positional_or_keyword"),
  2481. ('a', ..., ..., "positional_or_keyword"),
  2482. ('b', ..., ..., "positional_or_keyword")),
  2483. ...))
  2484. self.assertEqual(self.signature(Foo().bar),
  2485. ((('a', ..., ..., "positional_or_keyword"),
  2486. ('b', ..., ..., "positional_or_keyword")),
  2487. ...))
  2488. self.assertEqual(self.signature(Foo.bar, follow_wrapped=False),
  2489. ((('args', ..., ..., "var_positional"),
  2490. ('kwargs', ..., ..., "var_keyword")),
  2491. ...)) # functools.wraps will copy __annotations__
  2492. # from "func" to "wrapper", hence no
  2493. # return_annotation
  2494. self.assertEqual(self.signature(bar),
  2495. ((('a', ..., ..., "positional_or_keyword"),
  2496. ('b', ..., ..., "positional_or_keyword")),
  2497. ...))
  2498. # Test that we handle method wrappers correctly
  2499. def decorator(func):
  2500. @functools.wraps(func)
  2501. def wrapper(*args, **kwargs) -> int:
  2502. return func(42, *args, **kwargs)
  2503. sig = inspect.signature(func)
  2504. new_params = tuple(sig.parameters.values())[1:]
  2505. wrapper.__signature__ = sig.replace(parameters=new_params)
  2506. return wrapper
  2507. class Foo:
  2508. @decorator
  2509. def __call__(self, a, b):
  2510. pass
  2511. self.assertEqual(self.signature(Foo.__call__),
  2512. ((('a', ..., ..., "positional_or_keyword"),
  2513. ('b', ..., ..., "positional_or_keyword")),
  2514. ...))
  2515. self.assertEqual(self.signature(Foo().__call__),
  2516. ((('b', ..., ..., "positional_or_keyword"),),
  2517. ...))
  2518. # Test we handle __signature__ partway down the wrapper stack
  2519. def wrapped_foo_call():
  2520. pass
  2521. wrapped_foo_call.__wrapped__ = Foo.__call__
  2522. self.assertEqual(self.signature(wrapped_foo_call),
  2523. ((('a', ..., ..., "positional_or_keyword"),
  2524. ('b', ..., ..., "positional_or_keyword")),
  2525. ...))
  2526. def test_signature_on_class(self):
  2527. class C:
  2528. def __init__(self, a):
  2529. pass
  2530. self.assertEqual(self.signature(C),
  2531. ((('a', ..., ..., "positional_or_keyword"),),
  2532. ...))
  2533. class CM(type):
  2534. def __call__(cls, a):
  2535. pass
  2536. class C(metaclass=CM):
  2537. def __init__(self, b):
  2538. pass
  2539. self.assertEqual(self.signature(C),
  2540. ((('a', ..., ..., "positional_or_keyword"),),
  2541. ...))
  2542. class CM(type):
  2543. def __new__(mcls, name, bases, dct, *, foo=1):
  2544. return super().__new__(mcls, name, bases, dct)
  2545. class C(metaclass=CM):
  2546. def __init__(self, b):
  2547. pass
  2548. self.assertEqual(self.signature(C),
  2549. ((('b', ..., ..., "positional_or_keyword"),),
  2550. ...))
  2551. self.assertEqual(self.signature(CM),
  2552. ((('name', ..., ..., "positional_or_keyword"),
  2553. ('bases', ..., ..., "positional_or_keyword"),
  2554. ('dct', ..., ..., "positional_or_keyword"),
  2555. ('foo', 1, ..., "keyword_only")),
  2556. ...))
  2557. class CMM(type):
  2558. def __new__(mcls, name, bases, dct, *, foo=1):
  2559. return super().__new__(mcls, name, bases, dct)
  2560. def __call__(cls, nm, bs, dt):
  2561. return type(nm, bs, dt)
  2562. class CM(type, metaclass=CMM):
  2563. def __new__(mcls, name, bases, dct, *, bar=2):
  2564. return super().__new__(mcls, name, bases, dct)
  2565. class C(metaclass=CM):
  2566. def __init__(self, b):
  2567. pass
  2568. self.assertEqual(self.signature(CMM),
  2569. ((('name', ..., ..., "positional_or_keyword"),
  2570. ('bases', ..., ..., "positional_or_keyword"),
  2571. ('dct', ..., ..., "positional_or_keyword"),
  2572. ('foo', 1, ..., "keyword_only")),
  2573. ...))
  2574. self.assertEqual(self.signature(CM),
  2575. ((('nm', ..., ..., "positional_or_keyword"),
  2576. ('bs', ..., ..., "positional_or_keyword"),
  2577. ('dt', ..., ..., "positional_or_keyword")),
  2578. ...))
  2579. self.assertEqual(self.signature(C),
  2580. ((('b', ..., ..., "positional_or_keyword"),),
  2581. ...))
  2582. class CM(type):
  2583. def __init__(cls, name, bases, dct, *, bar=2):
  2584. return super().__init__(name, bases, dct)
  2585. class C(metaclass=CM):
  2586. def __init__(self, b):
  2587. pass
  2588. self.assertEqual(self.signature(CM),
  2589. ((('name', ..., ..., "positional_or_keyword"),
  2590. ('bases', ..., ..., "positional_or_keyword"),
  2591. ('dct', ..., ..., "positional_or_keyword"),
  2592. ('bar', 2, ..., "keyword_only")),
  2593. ...))
  2594. def test_signature_on_subclass(self):
  2595. class A:
  2596. def __new__(cls, a=1, *args, **kwargs):
  2597. return object.__new__(cls)
  2598. class B(A):
  2599. def __init__(self, b):
  2600. pass
  2601. class C(A):
  2602. def __new__(cls, a=1, b=2, *args, **kwargs):
  2603. return object.__new__(cls)
  2604. class D(A):
  2605. pass
  2606. self.assertEqual(self.signature(B),
  2607. ((('b', ..., ..., "positional_or_keyword"),),
  2608. ...))
  2609. self.assertEqual(self.signature(C),
  2610. ((('a', 1, ..., 'positional_or_keyword'),
  2611. ('b', 2, ..., 'positional_or_keyword'),
  2612. ('args', ..., ..., 'var_positional'),
  2613. ('kwargs', ..., ..., 'var_keyword')),
  2614. ...))
  2615. self.assertEqual(self.signature(D),
  2616. ((('a', 1, ..., 'positional_or_keyword'),
  2617. ('args', ..., ..., 'var_positional'),
  2618. ('kwargs', ..., ..., 'var_keyword')),
  2619. ...))
  2620. def test_signature_on_generic_subclass(self):
  2621. from typing import Generic, TypeVar
  2622. T = TypeVar('T')
  2623. class A(Generic[T]):
  2624. def __init__(self, *, a: int) -> None:
  2625. pass
  2626. self.assertEqual(self.signature(A),
  2627. ((('a', ..., int, 'keyword_only'),),
  2628. None))
  2629. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  2630. "Signature information for builtins requires docstrings")
  2631. def test_signature_on_class_without_init(self):
  2632. # Test classes without user-defined __init__ or __new__
  2633. class C: pass
  2634. self.assertEqual(str(inspect.signature(C)), '()')
  2635. class D(C): pass
  2636. self.assertEqual(str(inspect.signature(D)), '()')
  2637. # Test meta-classes without user-defined __init__ or __new__
  2638. class C(type): pass
  2639. class D(C): pass
  2640. with self.assertRaisesRegex(ValueError, "callable.*is not supported"):
  2641. self.assertEqual(inspect.signature(C), None)
  2642. with self.assertRaisesRegex(ValueError, "callable.*is not supported"):
  2643. self.assertEqual(inspect.signature(D), None)
  2644. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  2645. "Signature information for builtins requires docstrings")
  2646. def test_signature_on_builtin_class(self):
  2647. expected = ('(file, protocol=None, fix_imports=True, '
  2648. 'buffer_callback=None)')
  2649. self.assertEqual(str(inspect.signature(_pickle.Pickler)), expected)
  2650. class P(_pickle.Pickler): pass
  2651. class EmptyTrait: pass
  2652. class P2(EmptyTrait, P): pass
  2653. self.assertEqual(str(inspect.signature(P)), expected)
  2654. self.assertEqual(str(inspect.signature(P2)), expected)
  2655. class P3(P2):
  2656. def __init__(self, spam):
  2657. pass
  2658. self.assertEqual(str(inspect.signature(P3)), '(spam)')
  2659. class MetaP(type):
  2660. def __call__(cls, foo, bar):
  2661. pass
  2662. class P4(P2, metaclass=MetaP):
  2663. pass
  2664. self.assertEqual(str(inspect.signature(P4)), '(foo, bar)')
  2665. def test_signature_on_callable_objects(self):
  2666. class Foo:
  2667. def __call__(self, a):
  2668. pass
  2669. self.assertEqual(self.signature(Foo()),
  2670. ((('a', ..., ..., "positional_or_keyword"),),
  2671. ...))
  2672. class Spam:
  2673. pass
  2674. with self.assertRaisesRegex(TypeError, "is not a callable object"):
  2675. inspect.signature(Spam())
  2676. class Bar(Spam, Foo):
  2677. pass
  2678. self.assertEqual(self.signature(Bar()),
  2679. ((('a', ..., ..., "positional_or_keyword"),),
  2680. ...))
  2681. class Wrapped:
  2682. pass
  2683. Wrapped.__wrapped__ = lambda a: None
  2684. self.assertEqual(self.signature(Wrapped),
  2685. ((('a', ..., ..., "positional_or_keyword"),),
  2686. ...))
  2687. # wrapper loop:
  2688. Wrapped.__wrapped__ = Wrapped
  2689. with self.assertRaisesRegex(ValueError, 'wrapper loop'):
  2690. self.signature(Wrapped)
  2691. def test_signature_on_lambdas(self):
  2692. self.assertEqual(self.signature((lambda a=10: a)),
  2693. ((('a', 10, ..., "positional_or_keyword"),),
  2694. ...))
  2695. def test_signature_equality(self):
  2696. def foo(a, *, b:int) -> float: pass
  2697. self.assertFalse(inspect.signature(foo) == 42)
  2698. self.assertTrue(inspect.signature(foo) != 42)
  2699. self.assertTrue(inspect.signature(foo) == ALWAYS_EQ)
  2700. self.assertFalse(inspect.signature(foo) != ALWAYS_EQ)
  2701. def bar(a, *, b:int) -> float: pass
  2702. self.assertTrue(inspect.signature(foo) == inspect.signature(bar))
  2703. self.assertFalse(inspect.signature(foo) != inspect.signature(bar))
  2704. self.assertEqual(
  2705. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2706. def bar(a, *, b:int) -> int: pass
  2707. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2708. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2709. self.assertNotEqual(
  2710. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2711. def bar(a, *, b:int): pass
  2712. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2713. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2714. self.assertNotEqual(
  2715. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2716. def bar(a, *, b:int=42) -> float: pass
  2717. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2718. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2719. self.assertNotEqual(
  2720. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2721. def bar(a, *, c) -> float: pass
  2722. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2723. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2724. self.assertNotEqual(
  2725. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2726. def bar(a, b:int) -> float: pass
  2727. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2728. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2729. self.assertNotEqual(
  2730. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2731. def spam(b:int, a) -> float: pass
  2732. self.assertFalse(inspect.signature(spam) == inspect.signature(bar))
  2733. self.assertTrue(inspect.signature(spam) != inspect.signature(bar))
  2734. self.assertNotEqual(
  2735. hash(inspect.signature(spam)), hash(inspect.signature(bar)))
  2736. def foo(*, a, b, c): pass
  2737. def bar(*, c, b, a): pass
  2738. self.assertTrue(inspect.signature(foo) == inspect.signature(bar))
  2739. self.assertFalse(inspect.signature(foo) != inspect.signature(bar))
  2740. self.assertEqual(
  2741. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2742. def foo(*, a=1, b, c): pass
  2743. def bar(*, c, b, a=1): pass
  2744. self.assertTrue(inspect.signature(foo) == inspect.signature(bar))
  2745. self.assertFalse(inspect.signature(foo) != inspect.signature(bar))
  2746. self.assertEqual(
  2747. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2748. def foo(pos, *, a=1, b, c): pass
  2749. def bar(pos, *, c, b, a=1): pass
  2750. self.assertTrue(inspect.signature(foo) == inspect.signature(bar))
  2751. self.assertFalse(inspect.signature(foo) != inspect.signature(bar))
  2752. self.assertEqual(
  2753. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2754. def foo(pos, *, a, b, c): pass
  2755. def bar(pos, *, c, b, a=1): pass
  2756. self.assertFalse(inspect.signature(foo) == inspect.signature(bar))
  2757. self.assertTrue(inspect.signature(foo) != inspect.signature(bar))
  2758. self.assertNotEqual(
  2759. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2760. def foo(pos, *args, a=42, b, c, **kwargs:int): pass
  2761. def bar(pos, *args, c, b, a=42, **kwargs:int): pass
  2762. self.assertTrue(inspect.signature(foo) == inspect.signature(bar))
  2763. self.assertFalse(inspect.signature(foo) != inspect.signature(bar))
  2764. self.assertEqual(
  2765. hash(inspect.signature(foo)), hash(inspect.signature(bar)))
  2766. def test_signature_hashable(self):
  2767. S = inspect.Signature
  2768. P = inspect.Parameter
  2769. def foo(a): pass
  2770. foo_sig = inspect.signature(foo)
  2771. manual_sig = S(parameters=[P('a', P.POSITIONAL_OR_KEYWORD)])
  2772. self.assertEqual(hash(foo_sig), hash(manual_sig))
  2773. self.assertNotEqual(hash(foo_sig),
  2774. hash(manual_sig.replace(return_annotation='spam')))
  2775. def bar(a) -> 1: pass
  2776. self.assertNotEqual(hash(foo_sig), hash(inspect.signature(bar)))
  2777. def foo(a={}): pass
  2778. with self.assertRaisesRegex(TypeError, 'unhashable type'):
  2779. hash(inspect.signature(foo))
  2780. def foo(a) -> {}: pass
  2781. with self.assertRaisesRegex(TypeError, 'unhashable type'):
  2782. hash(inspect.signature(foo))
  2783. def test_signature_str(self):
  2784. def foo(a:int=1, *, b, c=None, **kwargs) -> 42:
  2785. pass
  2786. self.assertEqual(str(inspect.signature(foo)),
  2787. '(a: int = 1, *, b, c=None, **kwargs) -> 42')
  2788. def foo(a:int=1, *args, b, c=None, **kwargs) -> 42:
  2789. pass
  2790. self.assertEqual(str(inspect.signature(foo)),
  2791. '(a: int = 1, *args, b, c=None, **kwargs) -> 42')
  2792. def foo():
  2793. pass
  2794. self.assertEqual(str(inspect.signature(foo)), '()')
  2795. def foo(a: list[str]) -> tuple[str, float]:
  2796. pass
  2797. self.assertEqual(str(inspect.signature(foo)),
  2798. '(a: list[str]) -> tuple[str, float]')
  2799. from typing import Tuple
  2800. def foo(a: list[str]) -> Tuple[str, float]:
  2801. pass
  2802. self.assertEqual(str(inspect.signature(foo)),
  2803. '(a: list[str]) -> Tuple[str, float]')
  2804. def test_signature_str_positional_only(self):
  2805. P = inspect.Parameter
  2806. S = inspect.Signature
  2807. def test(a_po, *, b, **kwargs):
  2808. return a_po, kwargs
  2809. sig = inspect.signature(test)
  2810. new_params = list(sig.parameters.values())
  2811. new_params[0] = new_params[0].replace(kind=P.POSITIONAL_ONLY)
  2812. test.__signature__ = sig.replace(parameters=new_params)
  2813. self.assertEqual(str(inspect.signature(test)),
  2814. '(a_po, /, *, b, **kwargs)')
  2815. self.assertEqual(str(S(parameters=[P('foo', P.POSITIONAL_ONLY)])),
  2816. '(foo, /)')
  2817. self.assertEqual(str(S(parameters=[
  2818. P('foo', P.POSITIONAL_ONLY),
  2819. P('bar', P.VAR_KEYWORD)])),
  2820. '(foo, /, **bar)')
  2821. self.assertEqual(str(S(parameters=[
  2822. P('foo', P.POSITIONAL_ONLY),
  2823. P('bar', P.VAR_POSITIONAL)])),
  2824. '(foo, /, *bar)')
  2825. def test_signature_replace_anno(self):
  2826. def test() -> 42:
  2827. pass
  2828. sig = inspect.signature(test)
  2829. sig = sig.replace(return_annotation=None)
  2830. self.assertIs(sig.return_annotation, None)
  2831. sig = sig.replace(return_annotation=sig.empty)
  2832. self.assertIs(sig.return_annotation, sig.empty)
  2833. sig = sig.replace(return_annotation=42)
  2834. self.assertEqual(sig.return_annotation, 42)
  2835. self.assertEqual(sig, inspect.signature(test))
  2836. def test_signature_on_mangled_parameters(self):
  2837. class Spam:
  2838. def foo(self, __p1:1=2, *, __p2:2=3):
  2839. pass
  2840. class Ham(Spam):
  2841. pass
  2842. self.assertEqual(self.signature(Spam.foo),
  2843. ((('self', ..., ..., "positional_or_keyword"),
  2844. ('_Spam__p1', 2, 1, "positional_or_keyword"),
  2845. ('_Spam__p2', 3, 2, "keyword_only")),
  2846. ...))
  2847. self.assertEqual(self.signature(Spam.foo),
  2848. self.signature(Ham.foo))
  2849. def test_signature_from_callable_python_obj(self):
  2850. class MySignature(inspect.Signature): pass
  2851. def foo(a, *, b:1): pass
  2852. foo_sig = MySignature.from_callable(foo)
  2853. self.assertIsInstance(foo_sig, MySignature)
  2854. def test_signature_from_callable_class(self):
  2855. # A regression test for a class inheriting its signature from `object`.
  2856. class MySignature(inspect.Signature): pass
  2857. class foo: pass
  2858. foo_sig = MySignature.from_callable(foo)
  2859. self.assertIsInstance(foo_sig, MySignature)
  2860. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  2861. "Signature information for builtins requires docstrings")
  2862. def test_signature_from_callable_builtin_obj(self):
  2863. class MySignature(inspect.Signature): pass
  2864. sig = MySignature.from_callable(_pickle.Pickler)
  2865. self.assertIsInstance(sig, MySignature)
  2866. def test_signature_definition_order_preserved_on_kwonly(self):
  2867. for fn in signatures_with_lexicographic_keyword_only_parameters():
  2868. signature = inspect.signature(fn)
  2869. l = list(signature.parameters)
  2870. sorted_l = sorted(l)
  2871. self.assertTrue(l)
  2872. self.assertEqual(l, sorted_l)
  2873. signature = inspect.signature(unsorted_keyword_only_parameters_fn)
  2874. l = list(signature.parameters)
  2875. self.assertEqual(l, unsorted_keyword_only_parameters)
  2876. def test_signater_parameters_is_ordered(self):
  2877. p1 = inspect.signature(lambda x, y: None).parameters
  2878. p2 = inspect.signature(lambda y, x: None).parameters
  2879. self.assertNotEqual(p1, p2)
  2880. def test_signature_annotations_with_local_namespaces(self):
  2881. class Foo: ...
  2882. def func(foo: Foo) -> int: pass
  2883. def func2(foo: Foo, bar: 'Bar') -> int: pass
  2884. for signature_func in (inspect.signature, inspect.Signature.from_callable):
  2885. with self.subTest(signature_func = signature_func):
  2886. sig1 = signature_func(func)
  2887. self.assertEqual(sig1.return_annotation, int)
  2888. self.assertEqual(sig1.parameters['foo'].annotation, Foo)
  2889. sig2 = signature_func(func, locals=locals())
  2890. self.assertEqual(sig2.return_annotation, int)
  2891. self.assertEqual(sig2.parameters['foo'].annotation, Foo)
  2892. sig3 = signature_func(func2, globals={'Bar': int}, locals=locals())
  2893. self.assertEqual(sig3.return_annotation, int)
  2894. self.assertEqual(sig3.parameters['foo'].annotation, Foo)
  2895. self.assertEqual(sig3.parameters['bar'].annotation, 'Bar')
  2896. def test_signature_eval_str(self):
  2897. isa = inspect_stringized_annotations
  2898. sig = inspect.Signature
  2899. par = inspect.Parameter
  2900. PORK = inspect.Parameter.POSITIONAL_OR_KEYWORD
  2901. for signature_func in (inspect.signature, inspect.Signature.from_callable):
  2902. with self.subTest(signature_func = signature_func):
  2903. self.assertEqual(
  2904. signature_func(isa.MyClass),
  2905. sig(
  2906. parameters=(
  2907. par('a', PORK),
  2908. par('b', PORK),
  2909. )))
  2910. self.assertEqual(
  2911. signature_func(isa.function),
  2912. sig(
  2913. return_annotation='MyClass',
  2914. parameters=(
  2915. par('a', PORK, annotation='int'),
  2916. par('b', PORK, annotation='str'),
  2917. )))
  2918. self.assertEqual(
  2919. signature_func(isa.function2),
  2920. sig(
  2921. return_annotation='MyClass',
  2922. parameters=(
  2923. par('a', PORK, annotation='int'),
  2924. par('b', PORK, annotation="'str'"),
  2925. par('c', PORK, annotation="MyClass"),
  2926. )))
  2927. self.assertEqual(
  2928. signature_func(isa.function3),
  2929. sig(
  2930. parameters=(
  2931. par('a', PORK, annotation="'int'"),
  2932. par('b', PORK, annotation="'str'"),
  2933. par('c', PORK, annotation="'MyClass'"),
  2934. )))
  2935. self.assertEqual(signature_func(isa.UnannotatedClass), sig())
  2936. self.assertEqual(signature_func(isa.unannotated_function),
  2937. sig(
  2938. parameters=(
  2939. par('a', PORK),
  2940. par('b', PORK),
  2941. par('c', PORK),
  2942. )))
  2943. self.assertEqual(
  2944. signature_func(isa.MyClass, eval_str=True),
  2945. sig(
  2946. parameters=(
  2947. par('a', PORK),
  2948. par('b', PORK),
  2949. )))
  2950. self.assertEqual(
  2951. signature_func(isa.function, eval_str=True),
  2952. sig(
  2953. return_annotation=isa.MyClass,
  2954. parameters=(
  2955. par('a', PORK, annotation=int),
  2956. par('b', PORK, annotation=str),
  2957. )))
  2958. self.assertEqual(
  2959. signature_func(isa.function2, eval_str=True),
  2960. sig(
  2961. return_annotation=isa.MyClass,
  2962. parameters=(
  2963. par('a', PORK, annotation=int),
  2964. par('b', PORK, annotation='str'),
  2965. par('c', PORK, annotation=isa.MyClass),
  2966. )))
  2967. self.assertEqual(
  2968. signature_func(isa.function3, eval_str=True),
  2969. sig(
  2970. parameters=(
  2971. par('a', PORK, annotation='int'),
  2972. par('b', PORK, annotation='str'),
  2973. par('c', PORK, annotation='MyClass'),
  2974. )))
  2975. globalns = {'int': float, 'str': complex}
  2976. localns = {'str': tuple, 'MyClass': dict}
  2977. with self.assertRaises(NameError):
  2978. signature_func(isa.function, eval_str=True, globals=globalns)
  2979. self.assertEqual(
  2980. signature_func(isa.function, eval_str=True, locals=localns),
  2981. sig(
  2982. return_annotation=dict,
  2983. parameters=(
  2984. par('a', PORK, annotation=int),
  2985. par('b', PORK, annotation=tuple),
  2986. )))
  2987. self.assertEqual(
  2988. signature_func(isa.function, eval_str=True, globals=globalns, locals=localns),
  2989. sig(
  2990. return_annotation=dict,
  2991. parameters=(
  2992. par('a', PORK, annotation=float),
  2993. par('b', PORK, annotation=tuple),
  2994. )))
  2995. def test_signature_none_annotation(self):
  2996. class funclike:
  2997. # Has to be callable, and have correct
  2998. # __code__, __annotations__, __defaults__, __name__,
  2999. # and __kwdefaults__ attributes
  3000. def __init__(self, func):
  3001. self.__name__ = func.__name__
  3002. self.__code__ = func.__code__
  3003. self.__annotations__ = func.__annotations__
  3004. self.__defaults__ = func.__defaults__
  3005. self.__kwdefaults__ = func.__kwdefaults__
  3006. self.func = func
  3007. def __call__(self, *args, **kwargs):
  3008. return self.func(*args, **kwargs)
  3009. def foo(): pass
  3010. foo = funclike(foo)
  3011. foo.__annotations__ = None
  3012. for signature_func in (inspect.signature, inspect.Signature.from_callable):
  3013. with self.subTest(signature_func = signature_func):
  3014. self.assertEqual(signature_func(foo), inspect.Signature())
  3015. self.assertEqual(inspect.get_annotations(foo), {})
  3016. class TestParameterObject(unittest.TestCase):
  3017. def test_signature_parameter_kinds(self):
  3018. P = inspect.Parameter
  3019. self.assertTrue(P.POSITIONAL_ONLY < P.POSITIONAL_OR_KEYWORD < \
  3020. P.VAR_POSITIONAL < P.KEYWORD_ONLY < P.VAR_KEYWORD)
  3021. self.assertEqual(str(P.POSITIONAL_ONLY), 'POSITIONAL_ONLY')
  3022. self.assertTrue('POSITIONAL_ONLY' in repr(P.POSITIONAL_ONLY))
  3023. def test_signature_parameter_object(self):
  3024. p = inspect.Parameter('foo', default=10,
  3025. kind=inspect.Parameter.POSITIONAL_ONLY)
  3026. self.assertEqual(p.name, 'foo')
  3027. self.assertEqual(p.default, 10)
  3028. self.assertIs(p.annotation, p.empty)
  3029. self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
  3030. with self.assertRaisesRegex(ValueError, "value '123' is "
  3031. "not a valid Parameter.kind"):
  3032. inspect.Parameter('foo', default=10, kind='123')
  3033. with self.assertRaisesRegex(ValueError, 'not a valid parameter name'):
  3034. inspect.Parameter('1', kind=inspect.Parameter.VAR_KEYWORD)
  3035. with self.assertRaisesRegex(ValueError, 'not a valid parameter name'):
  3036. inspect.Parameter('from', kind=inspect.Parameter.VAR_KEYWORD)
  3037. with self.assertRaisesRegex(TypeError, 'name must be a str'):
  3038. inspect.Parameter(None, kind=inspect.Parameter.VAR_KEYWORD)
  3039. with self.assertRaisesRegex(ValueError,
  3040. 'is not a valid parameter name'):
  3041. inspect.Parameter('$', kind=inspect.Parameter.VAR_KEYWORD)
  3042. with self.assertRaisesRegex(ValueError,
  3043. 'is not a valid parameter name'):
  3044. inspect.Parameter('.a', kind=inspect.Parameter.VAR_KEYWORD)
  3045. with self.assertRaisesRegex(ValueError, 'cannot have default values'):
  3046. inspect.Parameter('a', default=42,
  3047. kind=inspect.Parameter.VAR_KEYWORD)
  3048. with self.assertRaisesRegex(ValueError, 'cannot have default values'):
  3049. inspect.Parameter('a', default=42,
  3050. kind=inspect.Parameter.VAR_POSITIONAL)
  3051. p = inspect.Parameter('a', default=42,
  3052. kind=inspect.Parameter.POSITIONAL_OR_KEYWORD)
  3053. with self.assertRaisesRegex(ValueError, 'cannot have default values'):
  3054. p.replace(kind=inspect.Parameter.VAR_POSITIONAL)
  3055. self.assertTrue(repr(p).startswith('<Parameter'))
  3056. self.assertTrue('"a=42"' in repr(p))
  3057. def test_signature_parameter_hashable(self):
  3058. P = inspect.Parameter
  3059. foo = P('foo', kind=P.POSITIONAL_ONLY)
  3060. self.assertEqual(hash(foo), hash(P('foo', kind=P.POSITIONAL_ONLY)))
  3061. self.assertNotEqual(hash(foo), hash(P('foo', kind=P.POSITIONAL_ONLY,
  3062. default=42)))
  3063. self.assertNotEqual(hash(foo),
  3064. hash(foo.replace(kind=P.VAR_POSITIONAL)))
  3065. def test_signature_parameter_equality(self):
  3066. P = inspect.Parameter
  3067. p = P('foo', default=42, kind=inspect.Parameter.KEYWORD_ONLY)
  3068. self.assertTrue(p == p)
  3069. self.assertFalse(p != p)
  3070. self.assertFalse(p == 42)
  3071. self.assertTrue(p != 42)
  3072. self.assertTrue(p == ALWAYS_EQ)
  3073. self.assertFalse(p != ALWAYS_EQ)
  3074. self.assertTrue(p == P('foo', default=42,
  3075. kind=inspect.Parameter.KEYWORD_ONLY))
  3076. self.assertFalse(p != P('foo', default=42,
  3077. kind=inspect.Parameter.KEYWORD_ONLY))
  3078. def test_signature_parameter_replace(self):
  3079. p = inspect.Parameter('foo', default=42,
  3080. kind=inspect.Parameter.KEYWORD_ONLY)
  3081. self.assertIsNot(p, p.replace())
  3082. self.assertEqual(p, p.replace())
  3083. p2 = p.replace(annotation=1)
  3084. self.assertEqual(p2.annotation, 1)
  3085. p2 = p2.replace(annotation=p2.empty)
  3086. self.assertEqual(p, p2)
  3087. p2 = p2.replace(name='bar')
  3088. self.assertEqual(p2.name, 'bar')
  3089. self.assertNotEqual(p2, p)
  3090. with self.assertRaisesRegex(ValueError,
  3091. 'name is a required attribute'):
  3092. p2 = p2.replace(name=p2.empty)
  3093. p2 = p2.replace(name='foo', default=None)
  3094. self.assertIs(p2.default, None)
  3095. self.assertNotEqual(p2, p)
  3096. p2 = p2.replace(name='foo', default=p2.empty)
  3097. self.assertIs(p2.default, p2.empty)
  3098. p2 = p2.replace(default=42, kind=p2.POSITIONAL_OR_KEYWORD)
  3099. self.assertEqual(p2.kind, p2.POSITIONAL_OR_KEYWORD)
  3100. self.assertNotEqual(p2, p)
  3101. with self.assertRaisesRegex(ValueError,
  3102. "value <class 'inspect._empty'> "
  3103. "is not a valid Parameter.kind"):
  3104. p2 = p2.replace(kind=p2.empty)
  3105. p2 = p2.replace(kind=p2.KEYWORD_ONLY)
  3106. self.assertEqual(p2, p)
  3107. def test_signature_parameter_positional_only(self):
  3108. with self.assertRaisesRegex(TypeError, 'name must be a str'):
  3109. inspect.Parameter(None, kind=inspect.Parameter.POSITIONAL_ONLY)
  3110. @cpython_only
  3111. def test_signature_parameter_implicit(self):
  3112. with self.assertRaisesRegex(ValueError,
  3113. 'implicit arguments must be passed as '
  3114. 'positional or keyword arguments, '
  3115. 'not positional-only'):
  3116. inspect.Parameter('.0', kind=inspect.Parameter.POSITIONAL_ONLY)
  3117. param = inspect.Parameter(
  3118. '.0', kind=inspect.Parameter.POSITIONAL_OR_KEYWORD)
  3119. self.assertEqual(param.kind, inspect.Parameter.POSITIONAL_ONLY)
  3120. self.assertEqual(param.name, 'implicit0')
  3121. def test_signature_parameter_immutability(self):
  3122. p = inspect.Parameter('spam', kind=inspect.Parameter.KEYWORD_ONLY)
  3123. with self.assertRaises(AttributeError):
  3124. p.foo = 'bar'
  3125. with self.assertRaises(AttributeError):
  3126. p.kind = 123
  3127. class TestSignatureBind(unittest.TestCase):
  3128. @staticmethod
  3129. def call(func, *args, **kwargs):
  3130. sig = inspect.signature(func)
  3131. ba = sig.bind(*args, **kwargs)
  3132. return func(*ba.args, **ba.kwargs)
  3133. def test_signature_bind_empty(self):
  3134. def test():
  3135. return 42
  3136. self.assertEqual(self.call(test), 42)
  3137. with self.assertRaisesRegex(TypeError, 'too many positional arguments'):
  3138. self.call(test, 1)
  3139. with self.assertRaisesRegex(TypeError, 'too many positional arguments'):
  3140. self.call(test, 1, spam=10)
  3141. with self.assertRaisesRegex(
  3142. TypeError, "got an unexpected keyword argument 'spam'"):
  3143. self.call(test, spam=1)
  3144. def test_signature_bind_var(self):
  3145. def test(*args, **kwargs):
  3146. return args, kwargs
  3147. self.assertEqual(self.call(test), ((), {}))
  3148. self.assertEqual(self.call(test, 1), ((1,), {}))
  3149. self.assertEqual(self.call(test, 1, 2), ((1, 2), {}))
  3150. self.assertEqual(self.call(test, foo='bar'), ((), {'foo': 'bar'}))
  3151. self.assertEqual(self.call(test, 1, foo='bar'), ((1,), {'foo': 'bar'}))
  3152. self.assertEqual(self.call(test, args=10), ((), {'args': 10}))
  3153. self.assertEqual(self.call(test, 1, 2, foo='bar'),
  3154. ((1, 2), {'foo': 'bar'}))
  3155. def test_signature_bind_just_args(self):
  3156. def test(a, b, c):
  3157. return a, b, c
  3158. self.assertEqual(self.call(test, 1, 2, 3), (1, 2, 3))
  3159. with self.assertRaisesRegex(TypeError, 'too many positional arguments'):
  3160. self.call(test, 1, 2, 3, 4)
  3161. with self.assertRaisesRegex(TypeError,
  3162. "missing a required argument: 'b'"):
  3163. self.call(test, 1)
  3164. with self.assertRaisesRegex(TypeError,
  3165. "missing a required argument: 'a'"):
  3166. self.call(test)
  3167. def test(a, b, c=10):
  3168. return a, b, c
  3169. self.assertEqual(self.call(test, 1, 2, 3), (1, 2, 3))
  3170. self.assertEqual(self.call(test, 1, 2), (1, 2, 10))
  3171. def test(a=1, b=2, c=3):
  3172. return a, b, c
  3173. self.assertEqual(self.call(test, a=10, c=13), (10, 2, 13))
  3174. self.assertEqual(self.call(test, a=10), (10, 2, 3))
  3175. self.assertEqual(self.call(test, b=10), (1, 10, 3))
  3176. def test_signature_bind_varargs_order(self):
  3177. def test(*args):
  3178. return args
  3179. self.assertEqual(self.call(test), ())
  3180. self.assertEqual(self.call(test, 1, 2, 3), (1, 2, 3))
  3181. def test_signature_bind_args_and_varargs(self):
  3182. def test(a, b, c=3, *args):
  3183. return a, b, c, args
  3184. self.assertEqual(self.call(test, 1, 2, 3, 4, 5), (1, 2, 3, (4, 5)))
  3185. self.assertEqual(self.call(test, 1, 2), (1, 2, 3, ()))
  3186. self.assertEqual(self.call(test, b=1, a=2), (2, 1, 3, ()))
  3187. self.assertEqual(self.call(test, 1, b=2), (1, 2, 3, ()))
  3188. with self.assertRaisesRegex(TypeError,
  3189. "multiple values for argument 'c'"):
  3190. self.call(test, 1, 2, 3, c=4)
  3191. def test_signature_bind_just_kwargs(self):
  3192. def test(**kwargs):
  3193. return kwargs
  3194. self.assertEqual(self.call(test), {})
  3195. self.assertEqual(self.call(test, foo='bar', spam='ham'),
  3196. {'foo': 'bar', 'spam': 'ham'})
  3197. def test_signature_bind_args_and_kwargs(self):
  3198. def test(a, b, c=3, **kwargs):
  3199. return a, b, c, kwargs
  3200. self.assertEqual(self.call(test, 1, 2), (1, 2, 3, {}))
  3201. self.assertEqual(self.call(test, 1, 2, foo='bar', spam='ham'),
  3202. (1, 2, 3, {'foo': 'bar', 'spam': 'ham'}))
  3203. self.assertEqual(self.call(test, b=2, a=1, foo='bar', spam='ham'),
  3204. (1, 2, 3, {'foo': 'bar', 'spam': 'ham'}))
  3205. self.assertEqual(self.call(test, a=1, b=2, foo='bar', spam='ham'),
  3206. (1, 2, 3, {'foo': 'bar', 'spam': 'ham'}))
  3207. self.assertEqual(self.call(test, 1, b=2, foo='bar', spam='ham'),
  3208. (1, 2, 3, {'foo': 'bar', 'spam': 'ham'}))
  3209. self.assertEqual(self.call(test, 1, b=2, c=4, foo='bar', spam='ham'),
  3210. (1, 2, 4, {'foo': 'bar', 'spam': 'ham'}))
  3211. self.assertEqual(self.call(test, 1, 2, 4, foo='bar'),
  3212. (1, 2, 4, {'foo': 'bar'}))
  3213. self.assertEqual(self.call(test, c=5, a=4, b=3),
  3214. (4, 3, 5, {}))
  3215. def test_signature_bind_kwonly(self):
  3216. def test(*, foo):
  3217. return foo
  3218. with self.assertRaisesRegex(TypeError,
  3219. 'too many positional arguments'):
  3220. self.call(test, 1)
  3221. self.assertEqual(self.call(test, foo=1), 1)
  3222. def test(a, *, foo=1, bar):
  3223. return foo
  3224. with self.assertRaisesRegex(TypeError,
  3225. "missing a required argument: 'bar'"):
  3226. self.call(test, 1)
  3227. def test(foo, *, bar):
  3228. return foo, bar
  3229. self.assertEqual(self.call(test, 1, bar=2), (1, 2))
  3230. self.assertEqual(self.call(test, bar=2, foo=1), (1, 2))
  3231. with self.assertRaisesRegex(
  3232. TypeError, "got an unexpected keyword argument 'spam'"):
  3233. self.call(test, bar=2, foo=1, spam=10)
  3234. with self.assertRaisesRegex(TypeError,
  3235. 'too many positional arguments'):
  3236. self.call(test, 1, 2)
  3237. with self.assertRaisesRegex(TypeError,
  3238. 'too many positional arguments'):
  3239. self.call(test, 1, 2, bar=2)
  3240. with self.assertRaisesRegex(
  3241. TypeError, "got an unexpected keyword argument 'spam'"):
  3242. self.call(test, 1, bar=2, spam='ham')
  3243. with self.assertRaisesRegex(TypeError,
  3244. "missing a required argument: 'bar'"):
  3245. self.call(test, 1)
  3246. def test(foo, *, bar, **bin):
  3247. return foo, bar, bin
  3248. self.assertEqual(self.call(test, 1, bar=2), (1, 2, {}))
  3249. self.assertEqual(self.call(test, foo=1, bar=2), (1, 2, {}))
  3250. self.assertEqual(self.call(test, 1, bar=2, spam='ham'),
  3251. (1, 2, {'spam': 'ham'}))
  3252. self.assertEqual(self.call(test, spam='ham', foo=1, bar=2),
  3253. (1, 2, {'spam': 'ham'}))
  3254. with self.assertRaisesRegex(TypeError,
  3255. "missing a required argument: 'foo'"):
  3256. self.call(test, spam='ham', bar=2)
  3257. self.assertEqual(self.call(test, 1, bar=2, bin=1, spam=10),
  3258. (1, 2, {'bin': 1, 'spam': 10}))
  3259. def test_signature_bind_arguments(self):
  3260. def test(a, *args, b, z=100, **kwargs):
  3261. pass
  3262. sig = inspect.signature(test)
  3263. ba = sig.bind(10, 20, b=30, c=40, args=50, kwargs=60)
  3264. # we won't have 'z' argument in the bound arguments object, as we didn't
  3265. # pass it to the 'bind'
  3266. self.assertEqual(tuple(ba.arguments.items()),
  3267. (('a', 10), ('args', (20,)), ('b', 30),
  3268. ('kwargs', {'c': 40, 'args': 50, 'kwargs': 60})))
  3269. self.assertEqual(ba.kwargs,
  3270. {'b': 30, 'c': 40, 'args': 50, 'kwargs': 60})
  3271. self.assertEqual(ba.args, (10, 20))
  3272. def test_signature_bind_positional_only(self):
  3273. P = inspect.Parameter
  3274. def test(a_po, b_po, c_po=3, foo=42, *, bar=50, **kwargs):
  3275. return a_po, b_po, c_po, foo, bar, kwargs
  3276. sig = inspect.signature(test)
  3277. new_params = collections.OrderedDict(tuple(sig.parameters.items()))
  3278. for name in ('a_po', 'b_po', 'c_po'):
  3279. new_params[name] = new_params[name].replace(kind=P.POSITIONAL_ONLY)
  3280. new_sig = sig.replace(parameters=new_params.values())
  3281. test.__signature__ = new_sig
  3282. self.assertEqual(self.call(test, 1, 2, 4, 5, bar=6),
  3283. (1, 2, 4, 5, 6, {}))
  3284. self.assertEqual(self.call(test, 1, 2),
  3285. (1, 2, 3, 42, 50, {}))
  3286. self.assertEqual(self.call(test, 1, 2, foo=4, bar=5),
  3287. (1, 2, 3, 4, 5, {}))
  3288. with self.assertRaisesRegex(TypeError, "but was passed as a keyword"):
  3289. self.call(test, 1, 2, foo=4, bar=5, c_po=10)
  3290. with self.assertRaisesRegex(TypeError, "parameter is positional only"):
  3291. self.call(test, 1, 2, c_po=4)
  3292. with self.assertRaisesRegex(TypeError, "parameter is positional only"):
  3293. self.call(test, a_po=1, b_po=2)
  3294. def test_signature_bind_with_self_arg(self):
  3295. # Issue #17071: one of the parameters is named "self
  3296. def test(a, self, b):
  3297. pass
  3298. sig = inspect.signature(test)
  3299. ba = sig.bind(1, 2, 3)
  3300. self.assertEqual(ba.args, (1, 2, 3))
  3301. ba = sig.bind(1, self=2, b=3)
  3302. self.assertEqual(ba.args, (1, 2, 3))
  3303. def test_signature_bind_vararg_name(self):
  3304. def test(a, *args):
  3305. return a, args
  3306. sig = inspect.signature(test)
  3307. with self.assertRaisesRegex(
  3308. TypeError, "got an unexpected keyword argument 'args'"):
  3309. sig.bind(a=0, args=1)
  3310. def test(*args, **kwargs):
  3311. return args, kwargs
  3312. self.assertEqual(self.call(test, args=1), ((), {'args': 1}))
  3313. sig = inspect.signature(test)
  3314. ba = sig.bind(args=1)
  3315. self.assertEqual(ba.arguments, {'kwargs': {'args': 1}})
  3316. @cpython_only
  3317. def test_signature_bind_implicit_arg(self):
  3318. # Issue #19611: getcallargs should work with set comprehensions
  3319. def make_set():
  3320. return {z * z for z in range(5)}
  3321. setcomp_code = make_set.__code__.co_consts[1]
  3322. setcomp_func = types.FunctionType(setcomp_code, {})
  3323. iterator = iter(range(5))
  3324. self.assertEqual(self.call(setcomp_func, iterator), {0, 1, 4, 9, 16})
  3325. def test_signature_bind_posonly_kwargs(self):
  3326. def foo(bar, /, **kwargs):
  3327. return bar, kwargs.get(bar)
  3328. sig = inspect.signature(foo)
  3329. result = sig.bind("pos-only", bar="keyword")
  3330. self.assertEqual(result.kwargs, {"bar": "keyword"})
  3331. self.assertIn(("bar", "pos-only"), result.arguments.items())
  3332. class TestBoundArguments(unittest.TestCase):
  3333. def test_signature_bound_arguments_unhashable(self):
  3334. def foo(a): pass
  3335. ba = inspect.signature(foo).bind(1)
  3336. with self.assertRaisesRegex(TypeError, 'unhashable type'):
  3337. hash(ba)
  3338. def test_signature_bound_arguments_equality(self):
  3339. def foo(a): pass
  3340. ba = inspect.signature(foo).bind(1)
  3341. self.assertTrue(ba == ba)
  3342. self.assertFalse(ba != ba)
  3343. self.assertTrue(ba == ALWAYS_EQ)
  3344. self.assertFalse(ba != ALWAYS_EQ)
  3345. ba2 = inspect.signature(foo).bind(1)
  3346. self.assertTrue(ba == ba2)
  3347. self.assertFalse(ba != ba2)
  3348. ba3 = inspect.signature(foo).bind(2)
  3349. self.assertFalse(ba == ba3)
  3350. self.assertTrue(ba != ba3)
  3351. ba3.arguments['a'] = 1
  3352. self.assertTrue(ba == ba3)
  3353. self.assertFalse(ba != ba3)
  3354. def bar(b): pass
  3355. ba4 = inspect.signature(bar).bind(1)
  3356. self.assertFalse(ba == ba4)
  3357. self.assertTrue(ba != ba4)
  3358. def foo(*, a, b): pass
  3359. sig = inspect.signature(foo)
  3360. ba1 = sig.bind(a=1, b=2)
  3361. ba2 = sig.bind(b=2, a=1)
  3362. self.assertTrue(ba1 == ba2)
  3363. self.assertFalse(ba1 != ba2)
  3364. def test_signature_bound_arguments_pickle(self):
  3365. def foo(a, b, *, c:1={}, **kw) -> {42:'ham'}: pass
  3366. sig = inspect.signature(foo)
  3367. ba = sig.bind(20, 30, z={})
  3368. for ver in range(pickle.HIGHEST_PROTOCOL + 1):
  3369. with self.subTest(pickle_ver=ver):
  3370. ba_pickled = pickle.loads(pickle.dumps(ba, ver))
  3371. self.assertEqual(ba, ba_pickled)
  3372. def test_signature_bound_arguments_repr(self):
  3373. def foo(a, b, *, c:1={}, **kw) -> {42:'ham'}: pass
  3374. sig = inspect.signature(foo)
  3375. ba = sig.bind(20, 30, z={})
  3376. self.assertRegex(repr(ba), r'<BoundArguments \(a=20,.*\}\}\)>')
  3377. def test_signature_bound_arguments_apply_defaults(self):
  3378. def foo(a, b=1, *args, c:1={}, **kw): pass
  3379. sig = inspect.signature(foo)
  3380. ba = sig.bind(20)
  3381. ba.apply_defaults()
  3382. self.assertEqual(
  3383. list(ba.arguments.items()),
  3384. [('a', 20), ('b', 1), ('args', ()), ('c', {}), ('kw', {})])
  3385. # Make sure that we preserve the order:
  3386. # i.e. 'c' should be *before* 'kw'.
  3387. ba = sig.bind(10, 20, 30, d=1)
  3388. ba.apply_defaults()
  3389. self.assertEqual(
  3390. list(ba.arguments.items()),
  3391. [('a', 10), ('b', 20), ('args', (30,)), ('c', {}), ('kw', {'d':1})])
  3392. # Make sure that BoundArguments produced by bind_partial()
  3393. # are supported.
  3394. def foo(a, b): pass
  3395. sig = inspect.signature(foo)
  3396. ba = sig.bind_partial(20)
  3397. ba.apply_defaults()
  3398. self.assertEqual(
  3399. list(ba.arguments.items()),
  3400. [('a', 20)])
  3401. # Test no args
  3402. def foo(): pass
  3403. sig = inspect.signature(foo)
  3404. ba = sig.bind()
  3405. ba.apply_defaults()
  3406. self.assertEqual(list(ba.arguments.items()), [])
  3407. # Make sure a no-args binding still acquires proper defaults.
  3408. def foo(a='spam'): pass
  3409. sig = inspect.signature(foo)
  3410. ba = sig.bind()
  3411. ba.apply_defaults()
  3412. self.assertEqual(list(ba.arguments.items()), [('a', 'spam')])
  3413. def test_signature_bound_arguments_arguments_type(self):
  3414. def foo(a): pass
  3415. ba = inspect.signature(foo).bind(1)
  3416. self.assertIs(type(ba.arguments), dict)
  3417. class TestSignaturePrivateHelpers(unittest.TestCase):
  3418. def _strip_non_python_syntax(self, input,
  3419. clean_signature, self_parameter, last_positional_only):
  3420. computed_clean_signature, \
  3421. computed_self_parameter, \
  3422. computed_last_positional_only = \
  3423. inspect._signature_strip_non_python_syntax(input)
  3424. self.assertEqual(computed_clean_signature, clean_signature)
  3425. self.assertEqual(computed_self_parameter, self_parameter)
  3426. self.assertEqual(computed_last_positional_only, last_positional_only)
  3427. def test_signature_strip_non_python_syntax(self):
  3428. self._strip_non_python_syntax(
  3429. "($module, /, path, mode, *, dir_fd=None, " +
  3430. "effective_ids=False,\n follow_symlinks=True)",
  3431. "(module, path, mode, *, dir_fd=None, " +
  3432. "effective_ids=False, follow_symlinks=True)",
  3433. 0,
  3434. 0)
  3435. self._strip_non_python_syntax(
  3436. "($module, word, salt, /)",
  3437. "(module, word, salt)",
  3438. 0,
  3439. 2)
  3440. self._strip_non_python_syntax(
  3441. "(x, y=None, z=None, /)",
  3442. "(x, y=None, z=None)",
  3443. None,
  3444. 2)
  3445. self._strip_non_python_syntax(
  3446. "(x, y=None, z=None)",
  3447. "(x, y=None, z=None)",
  3448. None,
  3449. None)
  3450. self._strip_non_python_syntax(
  3451. "(x,\n y=None,\n z = None )",
  3452. "(x, y=None, z=None)",
  3453. None,
  3454. None)
  3455. self._strip_non_python_syntax(
  3456. "",
  3457. "",
  3458. None,
  3459. None)
  3460. self._strip_non_python_syntax(
  3461. None,
  3462. None,
  3463. None,
  3464. None)
  3465. class TestSignatureDefinitions(unittest.TestCase):
  3466. # This test case provides a home for checking that particular APIs
  3467. # have signatures available for introspection
  3468. @cpython_only
  3469. @unittest.skipIf(MISSING_C_DOCSTRINGS,
  3470. "Signature information for builtins requires docstrings")
  3471. def test_builtins_have_signatures(self):
  3472. # This checks all builtin callables in CPython have signatures
  3473. # A few have signatures Signature can't yet handle, so we skip those
  3474. # since they will have to wait until PEP 457 adds the required
  3475. # introspection support to the inspect module
  3476. # Some others also haven't been converted yet for various other
  3477. # reasons, so we also skip those for the time being, but design
  3478. # the test to fail in order to indicate when it needs to be
  3479. # updated.
  3480. no_signature = set()
  3481. # These need PEP 457 groups
  3482. needs_groups = {"range", "slice", "dir", "getattr",
  3483. "next", "iter", "vars"}
  3484. no_signature |= needs_groups
  3485. # These have unrepresentable parameter default values of NULL
  3486. needs_null = {"anext"}
  3487. no_signature |= needs_null
  3488. # These need PEP 457 groups or a signature change to accept None
  3489. needs_semantic_update = {"round"}
  3490. no_signature |= needs_semantic_update
  3491. # These need *args support in Argument Clinic
  3492. needs_varargs = {"breakpoint", "min", "max", "print",
  3493. "__build_class__"}
  3494. no_signature |= needs_varargs
  3495. # These simply weren't covered in the initial AC conversion
  3496. # for builtin callables
  3497. not_converted_yet = {"open", "__import__"}
  3498. no_signature |= not_converted_yet
  3499. # These builtin types are expected to provide introspection info
  3500. types_with_signatures = set()
  3501. # Check the signatures we expect to be there
  3502. ns = vars(builtins)
  3503. for name, obj in sorted(ns.items()):
  3504. if not callable(obj):
  3505. continue
  3506. # The builtin types haven't been converted to AC yet
  3507. if isinstance(obj, type) and (name not in types_with_signatures):
  3508. # Note that this also skips all the exception types
  3509. no_signature.add(name)
  3510. if (name in no_signature):
  3511. # Not yet converted
  3512. continue
  3513. with self.subTest(builtin=name):
  3514. self.assertIsNotNone(inspect.signature(obj))
  3515. # Check callables that haven't been converted don't claim a signature
  3516. # This ensures this test will start failing as more signatures are
  3517. # added, so the affected items can be moved into the scope of the
  3518. # regression test above
  3519. for name in no_signature:
  3520. with self.subTest(builtin=name):
  3521. self.assertIsNone(obj.__text_signature__)
  3522. def test_python_function_override_signature(self):
  3523. def func(*args, **kwargs):
  3524. pass
  3525. func.__text_signature__ = '($self, a, b=1, *args, c, d=2, **kwargs)'
  3526. sig = inspect.signature(func)
  3527. self.assertIsNotNone(sig)
  3528. self.assertEqual(str(sig), '(self, /, a, b=1, *args, c, d=2, **kwargs)')
  3529. func.__text_signature__ = '($self, a, b=1, /, *args, c, d=2, **kwargs)'
  3530. sig = inspect.signature(func)
  3531. self.assertEqual(str(sig), '(self, a, b=1, /, *args, c, d=2, **kwargs)')
  3532. func.__text_signature__ = '(self, a=1+2, b=4-3, c=1 | 3 | 16)'
  3533. sig = inspect.signature(func)
  3534. self.assertEqual(str(sig), '(self, a=3, b=1, c=19)')
  3535. func.__text_signature__ = '(self, a=1,\nb=2,\n\n\n c=3)'
  3536. sig = inspect.signature(func)
  3537. self.assertEqual(str(sig), '(self, a=1, b=2, c=3)')
  3538. func.__text_signature__ = '(self, x=does_not_exist)'
  3539. with self.assertRaises(ValueError):
  3540. inspect.signature(func)
  3541. func.__text_signature__ = '(self, x=sys, y=inspect)'
  3542. with self.assertRaises(ValueError):
  3543. inspect.signature(func)
  3544. func.__text_signature__ = '(self, 123)'
  3545. with self.assertRaises(ValueError):
  3546. inspect.signature(func)
  3547. def test_base_class_have_text_signature(self):
  3548. # see issue 43118
  3549. from test.ann_module7 import BufferedReader
  3550. class MyBufferedReader(BufferedReader):
  3551. """buffer reader class."""
  3552. text_signature = BufferedReader.__text_signature__
  3553. self.assertEqual(text_signature, '(raw, buffer_size=DEFAULT_BUFFER_SIZE)')
  3554. sig = inspect.signature(MyBufferedReader)
  3555. self.assertEqual(str(sig), '(raw, buffer_size=8192)')
  3556. class NTimesUnwrappable:
  3557. def __init__(self, n):
  3558. self.n = n
  3559. self._next = None
  3560. @property
  3561. def __wrapped__(self):
  3562. if self.n <= 0:
  3563. raise Exception("Unwrapped too many times")
  3564. if self._next is None:
  3565. self._next = NTimesUnwrappable(self.n - 1)
  3566. return self._next
  3567. class TestUnwrap(unittest.TestCase):
  3568. def test_unwrap_one(self):
  3569. def func(a, b):
  3570. return a + b
  3571. wrapper = functools.lru_cache(maxsize=20)(func)
  3572. self.assertIs(inspect.unwrap(wrapper), func)
  3573. def test_unwrap_several(self):
  3574. def func(a, b):
  3575. return a + b
  3576. wrapper = func
  3577. for __ in range(10):
  3578. @functools.wraps(wrapper)
  3579. def wrapper():
  3580. pass
  3581. self.assertIsNot(wrapper.__wrapped__, func)
  3582. self.assertIs(inspect.unwrap(wrapper), func)
  3583. def test_stop(self):
  3584. def func1(a, b):
  3585. return a + b
  3586. @functools.wraps(func1)
  3587. def func2():
  3588. pass
  3589. @functools.wraps(func2)
  3590. def wrapper():
  3591. pass
  3592. func2.stop_here = 1
  3593. unwrapped = inspect.unwrap(wrapper,
  3594. stop=(lambda f: hasattr(f, "stop_here")))
  3595. self.assertIs(unwrapped, func2)
  3596. def test_cycle(self):
  3597. def func1(): pass
  3598. func1.__wrapped__ = func1
  3599. with self.assertRaisesRegex(ValueError, 'wrapper loop'):
  3600. inspect.unwrap(func1)
  3601. def func2(): pass
  3602. func2.__wrapped__ = func1
  3603. func1.__wrapped__ = func2
  3604. with self.assertRaisesRegex(ValueError, 'wrapper loop'):
  3605. inspect.unwrap(func1)
  3606. with self.assertRaisesRegex(ValueError, 'wrapper loop'):
  3607. inspect.unwrap(func2)
  3608. def test_unhashable(self):
  3609. def func(): pass
  3610. func.__wrapped__ = None
  3611. class C:
  3612. __hash__ = None
  3613. __wrapped__ = func
  3614. self.assertIsNone(inspect.unwrap(C()))
  3615. def test_recursion_limit(self):
  3616. obj = NTimesUnwrappable(sys.getrecursionlimit() + 1)
  3617. with self.assertRaisesRegex(ValueError, 'wrapper loop'):
  3618. inspect.unwrap(obj)
  3619. class TestMain(unittest.TestCase):
  3620. def test_only_source(self):
  3621. module = importlib.import_module('unittest')
  3622. rc, out, err = assert_python_ok('-m', 'inspect',
  3623. 'unittest')
  3624. lines = out.decode().splitlines()
  3625. # ignore the final newline
  3626. self.assertEqual(lines[:-1], inspect.getsource(module).splitlines())
  3627. self.assertEqual(err, b'')
  3628. def test_custom_getattr(self):
  3629. def foo():
  3630. pass
  3631. foo.__signature__ = 42
  3632. with self.assertRaises(TypeError):
  3633. inspect.signature(foo)
  3634. @unittest.skipIf(ThreadPoolExecutor is None,
  3635. 'threads required to test __qualname__ for source files')
  3636. def test_qualname_source(self):
  3637. rc, out, err = assert_python_ok('-m', 'inspect',
  3638. 'concurrent.futures:ThreadPoolExecutor')
  3639. lines = out.decode().splitlines()
  3640. # ignore the final newline
  3641. self.assertEqual(lines[:-1],
  3642. inspect.getsource(ThreadPoolExecutor).splitlines())
  3643. self.assertEqual(err, b'')
  3644. def test_builtins(self):
  3645. module = importlib.import_module('unittest')
  3646. _, out, err = assert_python_failure('-m', 'inspect',
  3647. 'sys')
  3648. lines = err.decode().splitlines()
  3649. self.assertEqual(lines, ["Can't get info for builtin modules."])
  3650. def test_details(self):
  3651. module = importlib.import_module('unittest')
  3652. args = support.optim_args_from_interpreter_flags()
  3653. rc, out, err = assert_python_ok(*args, '-m', 'inspect',
  3654. 'unittest', '--details')
  3655. output = out.decode()
  3656. # Just a quick sanity check on the output
  3657. self.assertIn(module.__name__, output)
  3658. self.assertIn(module.__file__, output)
  3659. self.assertIn(module.__cached__, output)
  3660. self.assertEqual(err, b'')
  3661. class TestReload(unittest.TestCase):
  3662. src_before = textwrap.dedent("""\
  3663. def foo():
  3664. print("Bla")
  3665. """)
  3666. src_after = textwrap.dedent("""\
  3667. def foo():
  3668. print("Oh no!")
  3669. """)
  3670. def assertInspectEqual(self, path, source):
  3671. inspected_src = inspect.getsource(source)
  3672. with open(path, encoding='utf-8') as src:
  3673. self.assertEqual(
  3674. src.read().splitlines(True),
  3675. inspected_src.splitlines(True)
  3676. )
  3677. def test_getsource_reload(self):
  3678. # see issue 1218234
  3679. with _ready_to_import('reload_bug', self.src_before) as (name, path):
  3680. module = importlib.import_module(name)
  3681. self.assertInspectEqual(path, module)
  3682. with open(path, 'w', encoding='utf-8') as src:
  3683. src.write(self.src_after)
  3684. self.assertInspectEqual(path, module)
  3685. if __name__ == "__main__":
  3686. unittest.main()