blob: 90435a10caac77a2a9118814086c60918613f8a1 [file] [log] [blame]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001"""Get useful information from live Python objects.
2
3This module encapsulates the interface provided by the internal special
Neal Norwitz221085d2007-02-25 20:55:47 +00004attributes (co_*, im_*, tb_*, etc.) in a friendlier fashion.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00005It also provides some help for examining source code and class layout.
6
7Here are some of the useful functions provided by this module:
8
Christian Heimes7131fd92008-02-19 14:21:46 +00009 ismodule(), isclass(), ismethod(), isfunction(), isgeneratorfunction(),
10 isgenerator(), istraceback(), isframe(), iscode(), isbuiltin(),
11 isroutine() - check object types
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000012 getmembers() - get members of an object that satisfy a given condition
13
14 getfile(), getsourcefile(), getsource() - find an object's source code
15 getdoc(), getcomments() - get documentation on an object
16 getmodule() - determine the module that an object came from
17 getclasstree() - arrange classes so as to represent their hierarchy
18
Berker Peksagfa3922c2015-07-31 04:11:29 +030019 getargvalues(), getcallargs() - get info about function arguments
Yury Selivanov0cf3ed62014-04-01 10:17:08 -040020 getfullargspec() - same, with support for Python 3 features
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +020021 formatargvalues() - format an argument spec
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000022 getouterframes(), getinnerframes() - get info about frames
23 currentframe() - get the current stack frame
24 stack(), trace() - get info about frames on the stack or in a traceback
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070025
26 signature() - get a Signature object for the callable
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000027"""
28
29# This module is in the public domain. No warranties.
30
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070031__author__ = ('Ka-Ping Yee <ping@lfw.org>',
32 'Yury Selivanov <yselivanov@sprymix.com>')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000033
Natefcfe80e2017-04-24 10:06:15 -070034import abc
Antoine Pitroua8723a02015-04-15 00:41:29 +020035import dis
Yury Selivanov75445082015-05-11 22:57:16 -040036import collections.abc
Yury Selivanov21e83a52014-03-27 11:23:13 -040037import enum
Brett Cannoncb66eb02012-05-11 12:58:42 -040038import importlib.machinery
39import itertools
Christian Heimes7131fd92008-02-19 14:21:46 +000040import linecache
Brett Cannoncb66eb02012-05-11 12:58:42 -040041import os
42import re
43import sys
44import tokenize
Larry Hastings2623c8c2014-02-08 22:15:29 -080045import token
Brett Cannoncb66eb02012-05-11 12:58:42 -040046import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040047import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070048import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100049import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000050from operator import attrgetter
Inada Naoki21105512020-03-02 18:54:49 +090051from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000052
53# Create constants for the compiler flags in Include/code.h
Antoine Pitroua8723a02015-04-15 00:41:29 +020054# We try to get them from dis to avoid duplication
55mod_dict = globals()
56for k, v in dis.COMPILER_FLAG_NAMES.items():
57 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000058
Christian Heimesbe5b30b2008-03-03 19:18:51 +000059# See Include/object.h
60TPFLAGS_IS_ABSTRACT = 1 << 20
61
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000062# ----------------------------------------------------------- type-checking
63def ismodule(object):
64 """Return true if the object is a module.
65
66 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000067 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000068 __doc__ documentation string
69 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000070 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000071
72def isclass(object):
73 """Return true if the object is a class.
74
75 Class objects provide these attributes:
76 __doc__ documentation string
77 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000078 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000079
80def ismethod(object):
81 """Return true if the object is an instance method.
82
83 Instance method objects provide these attributes:
84 __doc__ documentation string
85 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000086 __func__ function object containing implementation of method
87 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000088 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000089
Tim Peters536d2262001-09-20 05:13:38 +000090def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000091 """Return true if the object is a method descriptor.
92
93 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +000094
95 This is new in Python 2.2, and, for example, is true of int.__add__.
96 An object passing this test has a __get__ attribute but not a __set__
97 attribute, but beyond that the set of attributes varies. __name__ is
98 usually sensible, and __doc__ often is.
99
Tim Petersf1d90b92001-09-20 05:47:55 +0000100 Methods implemented via descriptors that also pass one of the other
101 tests return false from the ismethoddescriptor() test, simply because
102 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000103 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100104 if isclass(object) or ismethod(object) or isfunction(object):
105 # mutual exclusion
106 return False
107 tp = type(object)
108 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000109
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000110def isdatadescriptor(object):
111 """Return true if the object is a data descriptor.
112
Aaron Hall, MBA4054b172018-05-20 19:46:42 -0400113 Data descriptors have a __set__ or a __delete__ attribute. Examples are
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000114 properties (defined in Python) and getsets and members (defined in C).
115 Typically, data descriptors will also have __name__ and __doc__ attributes
116 (properties, getsets, and members have both of these attributes), but this
117 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100118 if isclass(object) or ismethod(object) or isfunction(object):
119 # mutual exclusion
120 return False
121 tp = type(object)
Aaron Hall, MBA4054b172018-05-20 19:46:42 -0400122 return hasattr(tp, "__set__") or hasattr(tp, "__delete__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000123
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000124if hasattr(types, 'MemberDescriptorType'):
125 # CPython and equivalent
126 def ismemberdescriptor(object):
127 """Return true if the object is a member descriptor.
128
129 Member descriptors are specialized descriptors defined in extension
130 modules."""
131 return isinstance(object, types.MemberDescriptorType)
132else:
133 # Other implementations
134 def ismemberdescriptor(object):
135 """Return true if the object is a member descriptor.
136
137 Member descriptors are specialized descriptors defined in extension
138 modules."""
139 return False
140
141if hasattr(types, 'GetSetDescriptorType'):
142 # CPython and equivalent
143 def isgetsetdescriptor(object):
144 """Return true if the object is a getset descriptor.
145
146 getset descriptors are specialized descriptors defined in extension
147 modules."""
148 return isinstance(object, types.GetSetDescriptorType)
149else:
150 # Other implementations
151 def isgetsetdescriptor(object):
152 """Return true if the object is a getset descriptor.
153
154 getset descriptors are specialized descriptors defined in extension
155 modules."""
156 return False
157
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000158def isfunction(object):
159 """Return true if the object is a user-defined function.
160
161 Function objects provide these attributes:
162 __doc__ documentation string
163 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000164 __code__ code object containing compiled function bytecode
165 __defaults__ tuple of any default values for arguments
166 __globals__ global namespace in which this function was defined
167 __annotations__ dict of parameter annotations
168 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000169 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000170
Jeroen Demeyerfcef60f2019-04-02 16:03:42 +0200171def _has_code_flag(f, flag):
172 """Return true if ``f`` is a function (or a method or functools.partial
173 wrapper wrapping a function) whose code object has the given ``flag``
174 set in its flags."""
175 while ismethod(f):
176 f = f.__func__
177 f = functools._unwrap_partial(f)
178 if not isfunction(f):
179 return False
180 return bool(f.__code__.co_flags & flag)
181
Pablo Galindo7cd25432018-10-26 12:19:14 +0100182def isgeneratorfunction(obj):
Christian Heimes7131fd92008-02-19 14:21:46 +0000183 """Return true if the object is a user-defined generator function.
184
Martin Panter0f0eac42016-09-07 11:04:41 +0000185 Generator function objects provide the same attributes as functions.
186 See help(isfunction) for a list of attributes."""
Jeroen Demeyerfcef60f2019-04-02 16:03:42 +0200187 return _has_code_flag(obj, CO_GENERATOR)
Yury Selivanov75445082015-05-11 22:57:16 -0400188
Pablo Galindo7cd25432018-10-26 12:19:14 +0100189def iscoroutinefunction(obj):
Yury Selivanov75445082015-05-11 22:57:16 -0400190 """Return true if the object is a coroutine function.
191
Yury Selivanov4778e132016-11-08 12:23:09 -0500192 Coroutine functions are defined with "async def" syntax.
Yury Selivanov75445082015-05-11 22:57:16 -0400193 """
Jeroen Demeyerfcef60f2019-04-02 16:03:42 +0200194 return _has_code_flag(obj, CO_COROUTINE)
Yury Selivanov75445082015-05-11 22:57:16 -0400195
Pablo Galindo7cd25432018-10-26 12:19:14 +0100196def isasyncgenfunction(obj):
Yury Selivanov4778e132016-11-08 12:23:09 -0500197 """Return true if the object is an asynchronous generator function.
198
199 Asynchronous generator functions are defined with "async def"
200 syntax and have "yield" expressions in their body.
201 """
Jeroen Demeyerfcef60f2019-04-02 16:03:42 +0200202 return _has_code_flag(obj, CO_ASYNC_GENERATOR)
Yury Selivanoveb636452016-09-08 22:01:51 -0700203
204def isasyncgen(object):
Yury Selivanov4778e132016-11-08 12:23:09 -0500205 """Return true if the object is an asynchronous generator."""
Yury Selivanoveb636452016-09-08 22:01:51 -0700206 return isinstance(object, types.AsyncGeneratorType)
207
Christian Heimes7131fd92008-02-19 14:21:46 +0000208def isgenerator(object):
209 """Return true if the object is a generator.
210
211 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300212 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000213 close raises a new GeneratorExit exception inside the
214 generator to terminate the iteration
215 gi_code code object
216 gi_frame frame object or possibly None once the generator has
217 been exhausted
218 gi_running set to 1 when generator is executing, 0 otherwise
219 next return the next item from the container
220 send resumes the generator and "sends" a value that becomes
221 the result of the current yield-expression
222 throw used to raise an exception inside the generator"""
Yury Selivanov5376ba92015-06-22 12:19:30 -0400223 return isinstance(object, types.GeneratorType)
Yury Selivanov75445082015-05-11 22:57:16 -0400224
225def iscoroutine(object):
226 """Return true if the object is a coroutine."""
Yury Selivanov5376ba92015-06-22 12:19:30 -0400227 return isinstance(object, types.CoroutineType)
Christian Heimes7131fd92008-02-19 14:21:46 +0000228
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400229def isawaitable(object):
Yury Selivanovc0215df2016-11-08 19:57:44 -0500230 """Return true if object can be passed to an ``await`` expression."""
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400231 return (isinstance(object, types.CoroutineType) or
232 isinstance(object, types.GeneratorType) and
Yury Selivanovc0215df2016-11-08 19:57:44 -0500233 bool(object.gi_code.co_flags & CO_ITERABLE_COROUTINE) or
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400234 isinstance(object, collections.abc.Awaitable))
235
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000236def istraceback(object):
237 """Return true if the object is a traceback.
238
239 Traceback objects provide these attributes:
240 tb_frame frame object at this level
241 tb_lasti index of last attempted instruction in bytecode
242 tb_lineno current line number in Python source code
243 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000244 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000245
246def isframe(object):
247 """Return true if the object is a frame object.
248
249 Frame objects provide these attributes:
250 f_back next outer frame object (this frame's caller)
251 f_builtins built-in namespace seen by this frame
252 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000253 f_globals global namespace seen by this frame
254 f_lasti index of last attempted instruction in bytecode
255 f_lineno current line number in Python source code
256 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000257 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000258 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000259
260def iscode(object):
261 """Return true if the object is a code object.
262
263 Code objects provide these attributes:
Xiang Zhanga6902e62017-04-13 10:38:28 +0800264 co_argcount number of arguments (not including *, ** args
265 or keyword only arguments)
266 co_code string of raw compiled bytecode
267 co_cellvars tuple of names of cell variables
268 co_consts tuple of constants used in the bytecode
269 co_filename name of file in which this code object was created
270 co_firstlineno number of first line in Python source code
271 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
272 | 16=nested | 32=generator | 64=nofree | 128=coroutine
273 | 256=iterable_coroutine | 512=async_generator
274 co_freevars tuple of names of free variables
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100275 co_posonlyargcount number of positional only arguments
Xiang Zhanga6902e62017-04-13 10:38:28 +0800276 co_kwonlyargcount number of keyword only arguments (not including ** arg)
277 co_lnotab encoded mapping of line numbers to bytecode indices
278 co_name name with which this code object was defined
279 co_names tuple of names of local variables
280 co_nlocals number of local variables
281 co_stacksize virtual machine stack space required
282 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000283 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000284
285def isbuiltin(object):
286 """Return true if the object is a built-in function or method.
287
288 Built-in functions and methods provide these attributes:
289 __doc__ documentation string
290 __name__ original name of this function or method
291 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000292 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000293
294def isroutine(object):
295 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000296 return (isbuiltin(object)
297 or isfunction(object)
298 or ismethod(object)
299 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000300
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000301def isabstract(object):
302 """Return true if the object is an abstract base class (ABC)."""
Natefcfe80e2017-04-24 10:06:15 -0700303 if not isinstance(object, type):
304 return False
305 if object.__flags__ & TPFLAGS_IS_ABSTRACT:
306 return True
307 if not issubclass(type(object), abc.ABCMeta):
308 return False
309 if hasattr(object, '__abstractmethods__'):
310 # It looks like ABCMeta.__new__ has finished running;
311 # TPFLAGS_IS_ABSTRACT should have been accurate.
312 return False
313 # It looks like ABCMeta.__new__ has not finished running yet; we're
314 # probably in __init_subclass__. We'll look for abstractmethods manually.
315 for name, value in object.__dict__.items():
316 if getattr(value, "__isabstractmethod__", False):
317 return True
318 for base in object.__bases__:
319 for name in getattr(base, "__abstractmethods__", ()):
320 value = getattr(object, name, None)
321 if getattr(value, "__isabstractmethod__", False):
322 return True
323 return False
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000324
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000325def getmembers(object, predicate=None):
326 """Return all members of an object as (name, value) pairs sorted by name.
327 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100328 if isclass(object):
329 mro = (object,) + getmro(object)
330 else:
331 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000332 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700333 processed = set()
334 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700335 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700336 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700337 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700338 try:
339 for base in object.__bases__:
340 for k, v in base.__dict__.items():
341 if isinstance(v, types.DynamicClassAttribute):
342 names.append(k)
343 except AttributeError:
344 pass
345 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700346 # First try to get the value via getattr. Some descriptors don't
347 # like calling their __get__ (see bug #1785), so fall back to
348 # looking in the __dict__.
349 try:
350 value = getattr(object, key)
351 # handle the duplicate key
352 if key in processed:
353 raise AttributeError
354 except AttributeError:
355 for base in mro:
356 if key in base.__dict__:
357 value = base.__dict__[key]
358 break
359 else:
360 # could be a (currently) missing slot member, or a buggy
361 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100362 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000363 if not predicate or predicate(value):
364 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700365 processed.add(key)
366 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000367 return results
368
Christian Heimes25bb7832008-01-11 16:17:00 +0000369Attribute = namedtuple('Attribute', 'name kind defining_class object')
370
Tim Peters13b49d32001-09-23 02:00:29 +0000371def classify_class_attrs(cls):
372 """Return list of attribute-descriptor tuples.
373
374 For each name in dir(cls), the return list contains a 4-tuple
375 with these elements:
376
377 0. The name (a string).
378
379 1. The kind of attribute this is, one of these strings:
380 'class method' created via classmethod()
381 'static method' created via staticmethod()
382 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700383 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000384 'data' not a method
385
386 2. The class which defined this attribute (a class).
387
Ethan Furmane03ea372013-09-25 07:14:41 -0700388 3. The object as obtained by calling getattr; if this fails, or if the
389 resulting object does not live anywhere in the class' mro (including
390 metaclasses) then the object is looked up in the defining class's
391 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700392
393 If one of the items in dir(cls) is stored in the metaclass it will now
394 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700395 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000396 """
397
398 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700399 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Jon Dufresne39726282017-05-18 07:35:54 -0700400 metamro = tuple(cls for cls in metamro if cls not in (type, object))
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700401 class_bases = (cls,) + mro
402 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000403 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700404 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700405 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700406 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700407 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700408 for k, v in base.__dict__.items():
409 if isinstance(v, types.DynamicClassAttribute):
410 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000411 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700412 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700413
Tim Peters13b49d32001-09-23 02:00:29 +0000414 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100415 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700416 # Normal objects will be looked up with both getattr and directly in
417 # its class' dict (in case getattr fails [bug #1785], and also to look
418 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700419 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700420 # class's dict.
421 #
Tim Peters13b49d32001-09-23 02:00:29 +0000422 # Getting an obj from the __dict__ sometimes reveals more than
423 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100424 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700425 get_obj = None
426 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700427 if name not in processed:
428 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700429 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700430 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700431 get_obj = getattr(cls, name)
432 except Exception as exc:
433 pass
434 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700435 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700436 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700437 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700438 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700439 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700440 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700441 # first look in the classes
442 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700443 srch_obj = getattr(srch_cls, name, None)
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400444 if srch_obj is get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700445 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700446 # then check the metaclasses
447 for srch_cls in metamro:
448 try:
449 srch_obj = srch_cls.__getattr__(cls, name)
450 except AttributeError:
451 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400452 if srch_obj is get_obj:
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700453 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700454 if last_cls is not None:
455 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700456 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700457 if name in base.__dict__:
458 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700459 if homecls not in metamro:
460 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700461 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700462 if homecls is None:
463 # unable to locate the attribute anywhere, most likely due to
464 # buggy custom __dir__; discard and move on
465 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400466 obj = get_obj if get_obj is not None else dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700467 # Classify the object or its descriptor.
Serhiy Storchaka3327a2d2017-12-15 14:13:41 +0200468 if isinstance(dict_obj, (staticmethod, types.BuiltinMethodType)):
Tim Peters13b49d32001-09-23 02:00:29 +0000469 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700470 obj = dict_obj
Serhiy Storchaka3327a2d2017-12-15 14:13:41 +0200471 elif isinstance(dict_obj, (classmethod, types.ClassMethodDescriptorType)):
Tim Peters13b49d32001-09-23 02:00:29 +0000472 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700473 obj = dict_obj
474 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000475 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700476 obj = dict_obj
Yury Selivanov0860a0b2014-01-31 14:28:44 -0500477 elif isroutine(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000478 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100479 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700480 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000481 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700482 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000483 return result
484
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000485# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000486
487def getmro(cls):
488 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000489 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000490
Nick Coghlane8c45d62013-07-28 20:00:01 +1000491# -------------------------------------------------------- function helpers
492
493def unwrap(func, *, stop=None):
494 """Get the object wrapped by *func*.
495
496 Follows the chain of :attr:`__wrapped__` attributes returning the last
497 object in the chain.
498
499 *stop* is an optional callback accepting an object in the wrapper chain
500 as its sole argument that allows the unwrapping to be terminated early if
501 the callback returns a true value. If the callback never returns a true
502 value, the last object in the chain is returned as usual. For example,
503 :func:`signature` uses this to stop unwrapping if any object in the
504 chain has a ``__signature__`` attribute defined.
505
506 :exc:`ValueError` is raised if a cycle is encountered.
507
508 """
509 if stop is None:
510 def _is_wrapper(f):
511 return hasattr(f, '__wrapped__')
512 else:
513 def _is_wrapper(f):
514 return hasattr(f, '__wrapped__') and not stop(f)
515 f = func # remember the original func for error reporting
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100516 # Memoise by id to tolerate non-hashable objects, but store objects to
517 # ensure they aren't destroyed, which would allow their IDs to be reused.
518 memo = {id(f): f}
519 recursion_limit = sys.getrecursionlimit()
Nick Coghlane8c45d62013-07-28 20:00:01 +1000520 while _is_wrapper(func):
521 func = func.__wrapped__
522 id_func = id(func)
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100523 if (id_func in memo) or (len(memo) >= recursion_limit):
Nick Coghlane8c45d62013-07-28 20:00:01 +1000524 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100525 memo[id_func] = func
Nick Coghlane8c45d62013-07-28 20:00:01 +1000526 return func
527
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000528# -------------------------------------------------- source code extraction
529def indentsize(line):
530 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000531 expline = line.expandtabs()
532 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000533
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300534def _findclass(func):
535 cls = sys.modules.get(func.__module__)
536 if cls is None:
537 return None
538 for name in func.__qualname__.split('.')[:-1]:
539 cls = getattr(cls, name)
540 if not isclass(cls):
541 return None
542 return cls
543
544def _finddoc(obj):
545 if isclass(obj):
546 for base in obj.__mro__:
547 if base is not object:
548 try:
549 doc = base.__doc__
550 except AttributeError:
551 continue
552 if doc is not None:
553 return doc
554 return None
555
556 if ismethod(obj):
557 name = obj.__func__.__name__
558 self = obj.__self__
559 if (isclass(self) and
560 getattr(getattr(self, name, None), '__func__') is obj.__func__):
561 # classmethod
562 cls = self
563 else:
564 cls = self.__class__
565 elif isfunction(obj):
566 name = obj.__name__
567 cls = _findclass(obj)
568 if cls is None or getattr(cls, name) is not obj:
569 return None
570 elif isbuiltin(obj):
571 name = obj.__name__
572 self = obj.__self__
573 if (isclass(self) and
574 self.__qualname__ + '.' + name == obj.__qualname__):
575 # classmethod
576 cls = self
577 else:
578 cls = self.__class__
Serhiy Storchakaac4bdcc2015-10-29 08:15:50 +0200579 # Should be tested before isdatadescriptor().
580 elif isinstance(obj, property):
581 func = obj.fget
582 name = func.__name__
583 cls = _findclass(func)
584 if cls is None or getattr(cls, name) is not obj:
585 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300586 elif ismethoddescriptor(obj) or isdatadescriptor(obj):
587 name = obj.__name__
588 cls = obj.__objclass__
589 if getattr(cls, name) is not obj:
590 return None
Raymond Hettingerd1e768a2019-03-25 13:01:13 -0700591 if ismemberdescriptor(obj):
592 slots = getattr(cls, '__slots__', None)
593 if isinstance(slots, dict) and name in slots:
594 return slots[name]
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300595 else:
596 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300597 for base in cls.__mro__:
598 try:
599 doc = getattr(base, name).__doc__
600 except AttributeError:
601 continue
602 if doc is not None:
603 return doc
604 return None
605
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000606def getdoc(object):
607 """Get the documentation string for an object.
608
609 All tabs are expanded to spaces. To clean up docstrings that are
610 indented to line up with blocks of code, any whitespace than can be
611 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000612 try:
613 doc = object.__doc__
614 except AttributeError:
615 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300616 if doc is None:
617 try:
618 doc = _finddoc(object)
619 except (AttributeError, TypeError):
620 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000621 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000622 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000623 return cleandoc(doc)
624
625def cleandoc(doc):
626 """Clean up indentation from docstrings.
627
628 Any whitespace that can be uniformly removed from the second line
629 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000630 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000631 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000632 except UnicodeError:
633 return None
634 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000635 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000636 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000637 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000638 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000639 if content:
640 indent = len(line) - content
641 margin = min(margin, indent)
642 # Remove indentation.
643 if lines:
644 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000645 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000646 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000647 # Remove any trailing or leading blank lines.
648 while lines and not lines[-1]:
649 lines.pop()
650 while lines and not lines[0]:
651 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000652 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000653
654def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000655 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000656 if ismodule(object):
Jason R. Coombsb9650a02018-03-05 18:29:08 -0500657 if getattr(object, '__file__', None):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000658 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000659 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000660 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500661 if hasattr(object, '__module__'):
Philipp Ad407d2a2019-06-08 14:05:46 +0200662 module = sys.modules.get(object.__module__)
663 if getattr(module, '__file__', None):
664 return module.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000665 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000666 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000667 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000668 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000669 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000670 if istraceback(object):
671 object = object.tb_frame
672 if isframe(object):
673 object = object.f_code
674 if iscode(object):
675 return object.co_filename
Thomas Kluyvere968bc732017-10-24 13:42:36 +0100676 raise TypeError('module, class, method, function, traceback, frame, or '
677 'code object was expected, got {}'.format(
678 type(object).__name__))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000679
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000680def getmodulename(path):
681 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000682 fname = os.path.basename(path)
683 # Check for paths that look like an actual module file
684 suffixes = [(-len(suffix), suffix)
685 for suffix in importlib.machinery.all_suffixes()]
686 suffixes.sort() # try longest suffixes first, in case they overlap
687 for neglen, suffix in suffixes:
688 if fname.endswith(suffix):
689 return fname[:neglen]
690 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000691
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000692def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000693 """Return the filename that can be used to locate an object's source.
694 Return None if no way can be identified to get the source.
695 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000696 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400697 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
698 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
699 if any(filename.endswith(s) for s in all_bytecode_suffixes):
700 filename = (os.path.splitext(filename)[0] +
701 importlib.machinery.SOURCE_SUFFIXES[0])
702 elif any(filename.endswith(s) for s in
703 importlib.machinery.EXTENSION_SUFFIXES):
704 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000705 if os.path.exists(filename):
706 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000707 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400708 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000709 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000710 # or it is in the linecache
711 if filename in linecache.cache:
712 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000713
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000714def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000715 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000716
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000717 The idea is for each object to have a unique origin, so this routine
718 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000719 if _filename is None:
720 _filename = getsourcefile(object) or getfile(object)
721 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000722
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000723modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000724_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000725
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000726def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000727 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000728 if ismodule(object):
729 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000730 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000731 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000732 # Try the filename to modulename cache
733 if _filename is not None and _filename in modulesbyfile:
734 return sys.modules.get(modulesbyfile[_filename])
735 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000736 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000737 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000738 except TypeError:
739 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000740 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000741 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000742 # Update the filename to module name cache and check yet again
743 # Copy sys.modules in order to cope with changes while iterating
Gregory P. Smith85cf1d52020-03-04 16:45:22 -0800744 for modname, module in sys.modules.copy().items():
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000745 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000746 f = module.__file__
747 if f == _filesbymodname.get(modname, None):
748 # Have already mapped this module, so skip it
749 continue
750 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000751 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000752 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000753 modulesbyfile[f] = modulesbyfile[
754 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000755 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000756 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000757 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000758 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000759 if not hasattr(object, '__name__'):
760 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000761 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000762 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000763 if mainobject is object:
764 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000765 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000766 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000767 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000768 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000769 if builtinobject is object:
770 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000771
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000772def findsource(object):
773 """Return the entire source file and starting line number for an object.
774
775 The argument may be a module, class, method, function, traceback, frame,
776 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200777 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000778 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500779
Yury Selivanovef1e7502014-12-08 16:05:34 -0500780 file = getsourcefile(object)
781 if file:
782 # Invalidate cache if needed.
783 linecache.checkcache(file)
784 else:
785 file = getfile(object)
786 # Allow filenames in form of "<something>" to pass through.
787 # `doctest` monkeypatches `linecache` module to enable
788 # inspection, so let `linecache.getlines` to be called.
789 if not (file.startswith('<') and file.endswith('>')):
790 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500791
Thomas Wouters89f507f2006-12-13 04:49:30 +0000792 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000793 if module:
794 lines = linecache.getlines(file, module.__dict__)
795 else:
796 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000797 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200798 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000799
800 if ismodule(object):
801 return lines, 0
802
803 if isclass(object):
804 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000805 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
806 # make some effort to find the best matching class definition:
807 # use the one with the least indentation, which is the one
808 # that's most probably not inside a function definition.
809 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000810 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000811 match = pat.match(lines[i])
812 if match:
813 # if it's at toplevel, it's already the best one
814 if lines[i][0] == 'c':
815 return lines, i
816 # else add whitespace to candidate list
817 candidates.append((match.group(1), i))
818 if candidates:
819 # this will sort by whitespace, and by line number,
820 # less whitespace first
821 candidates.sort()
822 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000823 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200824 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000825
826 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000827 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000828 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000829 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000830 if istraceback(object):
831 object = object.tb_frame
832 if isframe(object):
833 object = object.f_code
834 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000835 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200836 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000837 lnum = object.co_firstlineno - 1
Yury Selivanove4e811d2015-07-21 19:01:52 +0300838 pat = re.compile(r'^(\s*def\s)|(\s*async\s+def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000839 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000840 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000841 lnum = lnum - 1
842 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200843 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000844
845def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000846 """Get lines of comments immediately preceding an object's source code.
847
848 Returns None when source can't be found.
849 """
850 try:
851 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200852 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000853 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000854
855 if ismodule(object):
856 # Look for a comment block at the top of the file.
857 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000858 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000859 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000860 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000861 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000862 comments = []
863 end = start
864 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000865 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000866 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000867 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000868
869 # Look for a preceding block of comments at the same indentation.
870 elif lnum > 0:
871 indent = indentsize(lines[lnum])
872 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000873 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000874 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000875 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000876 if end > 0:
877 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000878 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000879 while comment[:1] == '#' and indentsize(lines[end]) == indent:
880 comments[:0] = [comment]
881 end = end - 1
882 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000883 comment = lines[end].expandtabs().lstrip()
884 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000885 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000886 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000887 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000888 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000889
Tim Peters4efb6e92001-06-29 23:51:08 +0000890class EndOfBlock(Exception): pass
891
892class BlockFinder:
893 """Provide a tokeneater() method to detect the end of a code block."""
894 def __init__(self):
895 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000896 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000897 self.started = False
898 self.passline = False
Meador Inge5b718d72015-07-23 22:49:37 -0500899 self.indecorator = False
900 self.decoratorhasargs = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000901 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000902
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000903 def tokeneater(self, type, token, srowcol, erowcol, line):
Meador Inge5b718d72015-07-23 22:49:37 -0500904 if not self.started and not self.indecorator:
905 # skip any decorators
906 if token == "@":
907 self.indecorator = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000908 # look for the first "def", "class" or "lambda"
Meador Inge5b718d72015-07-23 22:49:37 -0500909 elif token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000910 if token == "lambda":
911 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000912 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000913 self.passline = True # skip to the end of the line
Meador Inge5b718d72015-07-23 22:49:37 -0500914 elif token == "(":
915 if self.indecorator:
916 self.decoratorhasargs = True
917 elif token == ")":
918 if self.indecorator:
919 self.indecorator = False
920 self.decoratorhasargs = False
Tim Peters4efb6e92001-06-29 23:51:08 +0000921 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000922 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000923 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000924 if self.islambda: # lambdas always end at the first NEWLINE
925 raise EndOfBlock
Meador Inge5b718d72015-07-23 22:49:37 -0500926 # hitting a NEWLINE when in a decorator without args
927 # ends the decorator
928 if self.indecorator and not self.decoratorhasargs:
929 self.indecorator = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000930 elif self.passline:
931 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000932 elif type == tokenize.INDENT:
933 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000934 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000935 elif type == tokenize.DEDENT:
936 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000937 # the end of matching indent/dedent pairs end a block
938 # (note that this only works for "def"/"class" blocks,
939 # not e.g. for "if: else:" or "try: finally:" blocks)
940 if self.indent <= 0:
941 raise EndOfBlock
942 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
943 # any other token on the same indentation level end the previous
944 # block as well, except the pseudo-tokens COMMENT and NL.
945 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000946
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000947def getblock(lines):
948 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000949 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000950 try:
Trent Nelson428de652008-03-18 22:41:35 +0000951 tokens = tokenize.generate_tokens(iter(lines).__next__)
952 for _token in tokens:
953 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000954 except (EndOfBlock, IndentationError):
955 pass
956 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000957
958def getsourcelines(object):
959 """Return a list of source lines and starting line number for an object.
960
961 The argument may be a module, class, method, function, traceback, frame,
962 or code object. The source code is returned as a list of the lines
963 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200964 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000965 raised if the source code cannot be retrieved."""
Yury Selivanov081bbf62014-09-26 17:34:54 -0400966 object = unwrap(object)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000967 lines, lnum = findsource(object)
968
Vladimir Matveev91cb2982018-08-24 07:18:00 -0700969 if istraceback(object):
970 object = object.tb_frame
971
972 # for module or frame that corresponds to module, return all source lines
973 if (ismodule(object) or
974 (isframe(object) and object.f_code.co_name == "<module>")):
Meador Inge5b718d72015-07-23 22:49:37 -0500975 return lines, 0
976 else:
977 return getblock(lines[lnum:]), lnum + 1
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000978
979def getsource(object):
980 """Return the text of the source code for an object.
981
982 The argument may be a module, class, method, function, traceback, frame,
983 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200984 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000985 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000986 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000987
988# --------------------------------------------------- class tree extraction
989def walktree(classes, children, parent):
990 """Recursive helper function for getclasstree()."""
991 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000992 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000993 for c in classes:
994 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000995 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000996 results.append(walktree(children[c], children, c))
997 return results
998
Georg Brandl5ce83a02009-06-01 17:23:51 +0000999def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001000 """Arrange the given list of classes into a hierarchy of nested lists.
1001
1002 Where a nested list appears, it contains classes derived from the class
1003 whose entry immediately precedes the list. Each entry is a 2-tuple
1004 containing a class and a tuple of its base classes. If the 'unique'
1005 argument is true, exactly one entry appears in the returned structure
1006 for each class in the given list. Otherwise, classes using multiple
1007 inheritance and their descendants will appear multiple times."""
1008 children = {}
1009 roots = []
1010 for c in classes:
1011 if c.__bases__:
1012 for parent in c.__bases__:
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301013 if parent not in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001014 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +03001015 if c not in children[parent]:
1016 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001017 if unique and parent in classes: break
1018 elif c not in roots:
1019 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +00001020 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001021 if parent not in classes:
1022 roots.append(parent)
1023 return walktree(roots, children, None)
1024
1025# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001026Arguments = namedtuple('Arguments', 'args, varargs, varkw')
1027
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001028def getargs(co):
1029 """Get information about the arguments accepted by a code object.
1030
Guido van Rossum2e65f892007-02-28 22:03:49 +00001031 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001032 'args' is the list of argument names. Keyword-only arguments are
1033 appended. 'varargs' and 'varkw' are the names of the * and **
1034 arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +00001035 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001036 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001037
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001038 names = co.co_varnames
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001039 nargs = co.co_argcount
Guido van Rossum2e65f892007-02-28 22:03:49 +00001040 nkwargs = co.co_kwonlyargcount
Pablo Galindocd74e662019-06-01 18:08:04 +01001041 args = list(names[:nargs])
1042 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001043 step = 0
1044
Guido van Rossum2e65f892007-02-28 22:03:49 +00001045 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001046 varargs = None
1047 if co.co_flags & CO_VARARGS:
1048 varargs = co.co_varnames[nargs]
1049 nargs = nargs + 1
1050 varkw = None
1051 if co.co_flags & CO_VARKEYWORDS:
1052 varkw = co.co_varnames[nargs]
Pablo Galindocd74e662019-06-01 18:08:04 +01001053 return Arguments(args + kwonlyargs, varargs, varkw)
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001054
1055ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
1056
1057def getargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001058 """Get the names and default values of a function's parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001059
1060 A tuple of four things is returned: (args, varargs, keywords, defaults).
1061 'args' is a list of the argument names, including keyword-only argument names.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001062 'varargs' and 'keywords' are the names of the * and ** parameters or None.
1063 'defaults' is an n-tuple of the default values of the last n parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001064
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001065 This function is deprecated, as it does not support annotations or
1066 keyword-only parameters and will raise ValueError if either is present
1067 on the supplied callable.
1068
1069 For a more structured introspection API, use inspect.signature() instead.
1070
1071 Alternatively, use getfullargspec() for an API with a similar namedtuple
1072 based interface, but full support for annotations and keyword-only
1073 parameters.
Matthias Bussonnierded87d82018-10-19 16:40:45 -07001074
1075 Deprecated since Python 3.5, use `inspect.getfullargspec()`.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001076 """
Matthias Bussonnierded87d82018-10-19 16:40:45 -07001077 warnings.warn("inspect.getargspec() is deprecated since Python 3.0, "
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001078 "use inspect.signature() or inspect.getfullargspec()",
1079 DeprecationWarning, stacklevel=2)
Pablo Galindod5d2b452019-04-30 02:01:14 +01001080 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
1081 getfullargspec(func)
1082 if kwonlyargs or ann:
1083 raise ValueError("Function has keyword-only parameters or annotations"
1084 ", use inspect.signature() API which can support them")
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001085 return ArgSpec(args, varargs, varkw, defaults)
1086
Christian Heimes25bb7832008-01-11 16:17:00 +00001087FullArgSpec = namedtuple('FullArgSpec',
Pablo Galindod5d2b452019-04-30 02:01:14 +01001088 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001089
1090def getfullargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001091 """Get the names and default values of a callable object's parameters.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001092
Brett Cannon504d8852007-09-07 02:12:14 +00001093 A tuple of seven things is returned:
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001094 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).
1095 'args' is a list of the parameter names.
1096 'varargs' and 'varkw' are the names of the * and ** parameters or None.
1097 'defaults' is an n-tuple of the default values of the last n parameters.
1098 'kwonlyargs' is a list of keyword-only parameter names.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001099 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001100 'annotations' is a dictionary mapping parameter names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001101
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001102 Notable differences from inspect.signature():
1103 - the "self" parameter is always reported, even for bound methods
1104 - wrapper chains defined by __wrapped__ *not* unwrapped automatically
Jeremy Hylton64967882003-06-27 18:14:39 +00001105 """
Yury Selivanov57d240e2014-02-19 16:27:23 -05001106 try:
1107 # Re: `skip_bound_arg=False`
1108 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001109 # There is a notable difference in behaviour between getfullargspec
1110 # and Signature: the former always returns 'self' parameter for bound
1111 # methods, whereas the Signature always shows the actual calling
1112 # signature of the passed object.
1113 #
1114 # To simulate this behaviour, we "unbind" bound methods, to trick
1115 # inspect.signature to always return their first parameter ("self",
1116 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001117
Yury Selivanov57d240e2014-02-19 16:27:23 -05001118 # Re: `follow_wrapper_chains=False`
1119 #
1120 # getfullargspec() historically ignored __wrapped__ attributes,
1121 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001122
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001123 sig = _signature_from_callable(func,
1124 follow_wrapper_chains=False,
1125 skip_bound_arg=False,
1126 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001127 except Exception as ex:
1128 # Most of the times 'signature' will raise ValueError.
1129 # But, it can also raise AttributeError, and, maybe something
1130 # else. So to be fully backwards compatible, we catch all
1131 # possible exceptions here, and reraise a TypeError.
1132 raise TypeError('unsupported callable') from ex
1133
1134 args = []
1135 varargs = None
1136 varkw = None
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001137 posonlyargs = []
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001138 kwonlyargs = []
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001139 annotations = {}
1140 defaults = ()
1141 kwdefaults = {}
1142
1143 if sig.return_annotation is not sig.empty:
1144 annotations['return'] = sig.return_annotation
1145
1146 for param in sig.parameters.values():
1147 kind = param.kind
1148 name = param.name
1149
1150 if kind is _POSITIONAL_ONLY:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001151 posonlyargs.append(name)
1152 if param.default is not param.empty:
1153 defaults += (param.default,)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001154 elif kind is _POSITIONAL_OR_KEYWORD:
1155 args.append(name)
1156 if param.default is not param.empty:
1157 defaults += (param.default,)
1158 elif kind is _VAR_POSITIONAL:
1159 varargs = name
1160 elif kind is _KEYWORD_ONLY:
1161 kwonlyargs.append(name)
1162 if param.default is not param.empty:
1163 kwdefaults[name] = param.default
1164 elif kind is _VAR_KEYWORD:
1165 varkw = name
1166
1167 if param.annotation is not param.empty:
1168 annotations[name] = param.annotation
1169
1170 if not kwdefaults:
1171 # compatibility with 'func.__kwdefaults__'
1172 kwdefaults = None
1173
1174 if not defaults:
1175 # compatibility with 'func.__defaults__'
1176 defaults = None
1177
Pablo Galindod5d2b452019-04-30 02:01:14 +01001178 return FullArgSpec(posonlyargs + args, varargs, varkw, defaults,
1179 kwonlyargs, kwdefaults, annotations)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001180
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001181
Christian Heimes25bb7832008-01-11 16:17:00 +00001182ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1183
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001184def getargvalues(frame):
1185 """Get information about arguments passed into a particular frame.
1186
1187 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001188 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001189 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1190 'locals' is the locals dictionary of the given frame."""
1191 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001192 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001193
Guido van Rossum2e65f892007-02-28 22:03:49 +00001194def formatannotation(annotation, base_module=None):
Guido van Rossum52e50042016-10-22 07:55:18 -07001195 if getattr(annotation, '__module__', None) == 'typing':
1196 return repr(annotation).replace('typing.', '')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001197 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001198 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001199 return annotation.__qualname__
1200 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001201 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001202
Guido van Rossum2e65f892007-02-28 22:03:49 +00001203def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001204 module = getattr(object, '__module__', None)
1205 def _formatannotation(annotation):
1206 return formatannotation(annotation, module)
1207 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001208
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001209def formatargspec(args, varargs=None, varkw=None, defaults=None,
Pablo Galindod5d2b452019-04-30 02:01:14 +01001210 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001211 formatarg=str,
1212 formatvarargs=lambda name: '*' + name,
1213 formatvarkw=lambda name: '**' + name,
1214 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001215 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001216 formatannotation=formatannotation):
Berker Peksagfa3922c2015-07-31 04:11:29 +03001217 """Format an argument spec from the values returned by getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001218
Guido van Rossum2e65f892007-02-28 22:03:49 +00001219 The first seven arguments are (args, varargs, varkw, defaults,
1220 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1221 are the corresponding optional formatting functions that are called to
1222 turn names and values into strings. The last argument is an optional
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001223 function to format the sequence of arguments.
1224
1225 Deprecated since Python 3.5: use the `signature` function and `Signature`
1226 objects.
1227 """
1228
1229 from warnings import warn
1230
1231 warn("`formatargspec` is deprecated since Python 3.5. Use `signature` and "
Zackery Spytz41254eb2018-06-11 21:16:18 -06001232 "the `Signature` object directly",
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001233 DeprecationWarning,
1234 stacklevel=2)
1235
Guido van Rossum2e65f892007-02-28 22:03:49 +00001236 def formatargandannotation(arg):
1237 result = formatarg(arg)
1238 if arg in annotations:
1239 result += ': ' + formatannotation(annotations[arg])
1240 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001241 specs = []
1242 if defaults:
Pablo Galindod5d2b452019-04-30 02:01:14 +01001243 firstdefault = len(args) - len(defaults)
1244 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001245 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001246 if defaults and i >= firstdefault:
1247 spec = spec + formatvalue(defaults[i - firstdefault])
1248 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001249 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001250 specs.append(formatvarargs(formatargandannotation(varargs)))
1251 else:
1252 if kwonlyargs:
1253 specs.append('*')
1254 if kwonlyargs:
1255 for kwonlyarg in kwonlyargs:
1256 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001257 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001258 spec += formatvalue(kwonlydefaults[kwonlyarg])
1259 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001260 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001261 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001262 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001263 if 'return' in annotations:
1264 result += formatreturns(formatannotation(annotations['return']))
1265 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001266
1267def formatargvalues(args, varargs, varkw, locals,
1268 formatarg=str,
1269 formatvarargs=lambda name: '*' + name,
1270 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001271 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001272 """Format an argument spec from the 4 values returned by getargvalues.
1273
1274 The first four arguments are (args, varargs, varkw, locals). The
1275 next four arguments are the corresponding optional formatting functions
1276 that are called to turn names and values into strings. The ninth
1277 argument is an optional function to format the sequence of arguments."""
1278 def convert(name, locals=locals,
1279 formatarg=formatarg, formatvalue=formatvalue):
1280 return formatarg(name) + formatvalue(locals[name])
1281 specs = []
1282 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001283 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001284 if varargs:
1285 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1286 if varkw:
1287 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001288 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001289
Benjamin Petersone109c702011-06-24 09:37:26 -05001290def _missing_arguments(f_name, argnames, pos, values):
1291 names = [repr(name) for name in argnames if name not in values]
1292 missing = len(names)
1293 if missing == 1:
1294 s = names[0]
1295 elif missing == 2:
1296 s = "{} and {}".format(*names)
1297 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001298 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001299 del names[-2:]
1300 s = ", ".join(names) + tail
1301 raise TypeError("%s() missing %i required %s argument%s: %s" %
1302 (f_name, missing,
1303 "positional" if pos else "keyword-only",
1304 "" if missing == 1 else "s", s))
1305
1306def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001307 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001308 kwonly_given = len([arg for arg in kwonly if arg in values])
1309 if varargs:
1310 plural = atleast != 1
1311 sig = "at least %d" % (atleast,)
1312 elif defcount:
1313 plural = True
1314 sig = "from %d to %d" % (atleast, len(args))
1315 else:
1316 plural = len(args) != 1
1317 sig = str(len(args))
1318 kwonly_sig = ""
1319 if kwonly_given:
1320 msg = " positional argument%s (and %d keyword-only argument%s)"
1321 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1322 "s" if kwonly_given != 1 else ""))
1323 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1324 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1325 "was" if given == 1 and not kwonly_given else "were"))
1326
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03001327def getcallargs(func, /, *positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001328 """Get the mapping of arguments to values.
1329
1330 A dict is returned, with keys the function argument names (including the
1331 names of the * and ** arguments, if any), and values the respective bound
1332 values from 'positional' and 'named'."""
1333 spec = getfullargspec(func)
Pablo Galindod5d2b452019-04-30 02:01:14 +01001334 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001335 f_name = func.__name__
1336 arg2value = {}
1337
Benjamin Petersonb204a422011-06-05 22:04:07 -05001338
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001339 if ismethod(func) and func.__self__ is not None:
1340 # implicit 'self' (or 'cls' for classmethods) argument
1341 positional = (func.__self__,) + positional
1342 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001343 num_args = len(args)
1344 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001345
Benjamin Petersonb204a422011-06-05 22:04:07 -05001346 n = min(num_pos, num_args)
1347 for i in range(n):
Pablo Galindod5d2b452019-04-30 02:01:14 +01001348 arg2value[args[i]] = positional[i]
Benjamin Petersonb204a422011-06-05 22:04:07 -05001349 if varargs:
1350 arg2value[varargs] = tuple(positional[n:])
1351 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001352 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001353 arg2value[varkw] = {}
1354 for kw, value in named.items():
1355 if kw not in possible_kwargs:
1356 if not varkw:
1357 raise TypeError("%s() got an unexpected keyword argument %r" %
1358 (f_name, kw))
1359 arg2value[varkw][kw] = value
1360 continue
1361 if kw in arg2value:
1362 raise TypeError("%s() got multiple values for argument %r" %
1363 (f_name, kw))
1364 arg2value[kw] = value
1365 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001366 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1367 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001368 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001369 req = args[:num_args - num_defaults]
1370 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001371 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001372 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001373 for i, arg in enumerate(args[num_args - num_defaults:]):
1374 if arg not in arg2value:
1375 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001376 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001377 for kwarg in kwonlyargs:
1378 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001379 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001380 arg2value[kwarg] = kwonlydefaults[kwarg]
1381 else:
1382 missing += 1
1383 if missing:
1384 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001385 return arg2value
1386
Nick Coghlan2f92e542012-06-23 19:39:55 +10001387ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1388
1389def getclosurevars(func):
1390 """
1391 Get the mapping of free variables to their current values.
1392
Meador Inge8fda3592012-07-19 21:33:21 -05001393 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001394 and builtin references as seen by the body of the function. A final
1395 set of unbound names that could not be resolved is also provided.
1396 """
1397
1398 if ismethod(func):
1399 func = func.__func__
1400
1401 if not isfunction(func):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001402 raise TypeError("{!r} is not a Python function".format(func))
Nick Coghlan2f92e542012-06-23 19:39:55 +10001403
1404 code = func.__code__
1405 # Nonlocal references are named in co_freevars and resolved
1406 # by looking them up in __closure__ by positional index
1407 if func.__closure__ is None:
1408 nonlocal_vars = {}
1409 else:
1410 nonlocal_vars = {
1411 var : cell.cell_contents
1412 for var, cell in zip(code.co_freevars, func.__closure__)
1413 }
1414
1415 # Global and builtin references are named in co_names and resolved
1416 # by looking them up in __globals__ or __builtins__
1417 global_ns = func.__globals__
1418 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1419 if ismodule(builtin_ns):
1420 builtin_ns = builtin_ns.__dict__
1421 global_vars = {}
1422 builtin_vars = {}
1423 unbound_names = set()
1424 for name in code.co_names:
1425 if name in ("None", "True", "False"):
1426 # Because these used to be builtins instead of keywords, they
1427 # may still show up as name references. We ignore them.
1428 continue
1429 try:
1430 global_vars[name] = global_ns[name]
1431 except KeyError:
1432 try:
1433 builtin_vars[name] = builtin_ns[name]
1434 except KeyError:
1435 unbound_names.add(name)
1436
1437 return ClosureVars(nonlocal_vars, global_vars,
1438 builtin_vars, unbound_names)
1439
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001440# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001441
1442Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1443
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001444def getframeinfo(frame, context=1):
1445 """Get information about a frame or traceback object.
1446
1447 A tuple of five things is returned: the filename, the line number of
1448 the current line, the function name, a list of lines of context from
1449 the source code, and the index of the current line within that list.
1450 The optional second argument specifies the number of lines of context
1451 to return, which are centered around the current line."""
1452 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001453 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001454 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001455 else:
1456 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001457 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001458 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001459
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001460 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001461 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001462 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001463 try:
1464 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001465 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001466 lines = index = None
1467 else:
Raymond Hettingera0501712004-06-15 11:22:53 +00001468 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001469 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001470 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001471 else:
1472 lines = index = None
1473
Christian Heimes25bb7832008-01-11 16:17:00 +00001474 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001475
1476def getlineno(frame):
1477 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001478 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1479 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001480
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001481FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1482
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001483def getouterframes(frame, context=1):
1484 """Get a list of records for a frame and all higher (calling) frames.
1485
1486 Each record contains a frame object, filename, line number, function
1487 name, a list of lines of context, and index within the context."""
1488 framelist = []
1489 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001490 frameinfo = (frame,) + getframeinfo(frame, context)
1491 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001492 frame = frame.f_back
1493 return framelist
1494
1495def getinnerframes(tb, context=1):
1496 """Get a list of records for a traceback's frame and all lower frames.
1497
1498 Each record contains a frame object, filename, line number, function
1499 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001500 framelist = []
1501 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001502 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1503 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001504 tb = tb.tb_next
1505 return framelist
1506
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001507def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001508 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001509 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001510
1511def stack(context=1):
1512 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001513 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001514
1515def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001516 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001517 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001518
1519
1520# ------------------------------------------------ static version of getattr
1521
1522_sentinel = object()
1523
Michael Foorde5162652010-11-20 16:40:44 +00001524def _static_getmro(klass):
1525 return type.__dict__['__mro__'].__get__(klass)
1526
Michael Foord95fc51d2010-11-20 15:07:30 +00001527def _check_instance(obj, attr):
1528 instance_dict = {}
1529 try:
1530 instance_dict = object.__getattribute__(obj, "__dict__")
1531 except AttributeError:
1532 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001533 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001534
1535
1536def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001537 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001538 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001539 try:
1540 return entry.__dict__[attr]
1541 except KeyError:
1542 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001543 return _sentinel
1544
Michael Foord35184ed2010-11-20 16:58:30 +00001545def _is_type(obj):
1546 try:
1547 _static_getmro(obj)
1548 except TypeError:
1549 return False
1550 return True
1551
Michael Foorddcebe0f2011-03-15 19:20:44 -04001552def _shadowed_dict(klass):
1553 dict_attr = type.__dict__["__dict__"]
1554 for entry in _static_getmro(klass):
1555 try:
1556 class_dict = dict_attr.__get__(entry)["__dict__"]
1557 except KeyError:
1558 pass
1559 else:
Inada Naoki8f9cc872019-09-05 13:07:08 +09001560 if not (type(class_dict) is types.GetSetDescriptorType and
Michael Foorddcebe0f2011-03-15 19:20:44 -04001561 class_dict.__name__ == "__dict__" and
1562 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001563 return class_dict
1564 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001565
1566def getattr_static(obj, attr, default=_sentinel):
1567 """Retrieve attributes without triggering dynamic lookup via the
1568 descriptor protocol, __getattr__ or __getattribute__.
1569
1570 Note: this function may not be able to retrieve all attributes
1571 that getattr can fetch (like dynamically created attributes)
1572 and may find attributes that getattr can't (like descriptors
1573 that raise AttributeError). It can also return descriptor objects
1574 instead of instance members in some cases. See the
1575 documentation for details.
1576 """
1577 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001578 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001579 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001580 dict_attr = _shadowed_dict(klass)
1581 if (dict_attr is _sentinel or
Inada Naoki8f9cc872019-09-05 13:07:08 +09001582 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001583 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001584 else:
1585 klass = obj
1586
1587 klass_result = _check_class(klass, attr)
1588
1589 if instance_result is not _sentinel and klass_result is not _sentinel:
1590 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1591 _check_class(type(klass_result), '__set__') is not _sentinel):
1592 return klass_result
1593
1594 if instance_result is not _sentinel:
1595 return instance_result
1596 if klass_result is not _sentinel:
1597 return klass_result
1598
1599 if obj is klass:
1600 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001601 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001602 if _shadowed_dict(type(entry)) is _sentinel:
1603 try:
1604 return entry.__dict__[attr]
1605 except KeyError:
1606 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001607 if default is not _sentinel:
1608 return default
1609 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001610
1611
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001612# ------------------------------------------------ generator introspection
1613
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001614GEN_CREATED = 'GEN_CREATED'
1615GEN_RUNNING = 'GEN_RUNNING'
1616GEN_SUSPENDED = 'GEN_SUSPENDED'
1617GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001618
1619def getgeneratorstate(generator):
1620 """Get current state of a generator-iterator.
1621
1622 Possible states are:
1623 GEN_CREATED: Waiting to start execution.
1624 GEN_RUNNING: Currently being executed by the interpreter.
1625 GEN_SUSPENDED: Currently suspended at a yield expression.
1626 GEN_CLOSED: Execution has completed.
1627 """
1628 if generator.gi_running:
1629 return GEN_RUNNING
1630 if generator.gi_frame is None:
1631 return GEN_CLOSED
1632 if generator.gi_frame.f_lasti == -1:
1633 return GEN_CREATED
1634 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001635
1636
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001637def getgeneratorlocals(generator):
1638 """
1639 Get the mapping of generator local variables to their current values.
1640
1641 A dict is returned, with the keys the local variable names and values the
1642 bound values."""
1643
1644 if not isgenerator(generator):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001645 raise TypeError("{!r} is not a Python generator".format(generator))
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001646
1647 frame = getattr(generator, "gi_frame", None)
1648 if frame is not None:
1649 return generator.gi_frame.f_locals
1650 else:
1651 return {}
1652
Yury Selivanov5376ba92015-06-22 12:19:30 -04001653
1654# ------------------------------------------------ coroutine introspection
1655
1656CORO_CREATED = 'CORO_CREATED'
1657CORO_RUNNING = 'CORO_RUNNING'
1658CORO_SUSPENDED = 'CORO_SUSPENDED'
1659CORO_CLOSED = 'CORO_CLOSED'
1660
1661def getcoroutinestate(coroutine):
1662 """Get current state of a coroutine object.
1663
1664 Possible states are:
1665 CORO_CREATED: Waiting to start execution.
1666 CORO_RUNNING: Currently being executed by the interpreter.
1667 CORO_SUSPENDED: Currently suspended at an await expression.
1668 CORO_CLOSED: Execution has completed.
1669 """
1670 if coroutine.cr_running:
1671 return CORO_RUNNING
1672 if coroutine.cr_frame is None:
1673 return CORO_CLOSED
1674 if coroutine.cr_frame.f_lasti == -1:
1675 return CORO_CREATED
1676 return CORO_SUSPENDED
1677
1678
1679def getcoroutinelocals(coroutine):
1680 """
1681 Get the mapping of coroutine local variables to their current values.
1682
1683 A dict is returned, with the keys the local variable names and values the
1684 bound values."""
1685 frame = getattr(coroutine, "cr_frame", None)
1686 if frame is not None:
1687 return frame.f_locals
1688 else:
1689 return {}
1690
1691
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001692###############################################################################
1693### Function Signature Object (PEP 362)
1694###############################################################################
1695
1696
1697_WrapperDescriptor = type(type.__call__)
1698_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001699_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001700
1701_NonUserDefinedCallables = (_WrapperDescriptor,
1702 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001703 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001704 types.BuiltinFunctionType)
1705
1706
Yury Selivanov421f0c72014-01-29 12:05:40 -05001707def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001708 """Private helper. Checks if ``cls`` has an attribute
1709 named ``method_name`` and returns it only if it is a
1710 pure python function.
1711 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001712 try:
1713 meth = getattr(cls, method_name)
1714 except AttributeError:
1715 return
1716 else:
1717 if not isinstance(meth, _NonUserDefinedCallables):
1718 # Once '__signature__' will be added to 'C'-level
1719 # callables, this check won't be necessary
1720 return meth
1721
1722
Yury Selivanov62560fb2014-01-28 12:26:24 -05001723def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001724 """Private helper to calculate how 'wrapped_sig' signature will
1725 look like after applying a 'functools.partial' object (or alike)
1726 on it.
1727 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001728
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001729 old_params = wrapped_sig.parameters
Inada Naoki21105512020-03-02 18:54:49 +09001730 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001731
1732 partial_args = partial.args or ()
1733 partial_keywords = partial.keywords or {}
1734
1735 if extra_args:
1736 partial_args = extra_args + partial_args
1737
1738 try:
1739 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1740 except TypeError as ex:
1741 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1742 raise ValueError(msg) from ex
1743
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001744
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001745 transform_to_kwonly = False
1746 for param_name, param in old_params.items():
1747 try:
1748 arg_value = ba.arguments[param_name]
1749 except KeyError:
1750 pass
1751 else:
1752 if param.kind is _POSITIONAL_ONLY:
1753 # If positional-only parameter is bound by partial,
1754 # it effectively disappears from the signature
Inada Naoki21105512020-03-02 18:54:49 +09001755 new_params.pop(param_name)
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001756 continue
1757
1758 if param.kind is _POSITIONAL_OR_KEYWORD:
1759 if param_name in partial_keywords:
1760 # This means that this parameter, and all parameters
1761 # after it should be keyword-only (and var-positional
1762 # should be removed). Here's why. Consider the following
1763 # function:
1764 # foo(a, b, *args, c):
1765 # pass
1766 #
1767 # "partial(foo, a='spam')" will have the following
1768 # signature: "(*, a='spam', b, c)". Because attempting
1769 # to call that partial with "(10, 20)" arguments will
1770 # raise a TypeError, saying that "a" argument received
1771 # multiple values.
1772 transform_to_kwonly = True
1773 # Set the new default value
Inada Naoki21105512020-03-02 18:54:49 +09001774 new_params[param_name] = param.replace(default=arg_value)
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001775 else:
1776 # was passed as a positional argument
Inada Naoki21105512020-03-02 18:54:49 +09001777 new_params.pop(param.name)
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001778 continue
1779
1780 if param.kind is _KEYWORD_ONLY:
1781 # Set the new default value
Inada Naoki21105512020-03-02 18:54:49 +09001782 new_params[param_name] = param.replace(default=arg_value)
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001783
1784 if transform_to_kwonly:
1785 assert param.kind is not _POSITIONAL_ONLY
1786
1787 if param.kind is _POSITIONAL_OR_KEYWORD:
Inada Naoki21105512020-03-02 18:54:49 +09001788 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1789 new_params[param_name] = new_param
1790 new_params.move_to_end(param_name)
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001791 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
Inada Naoki21105512020-03-02 18:54:49 +09001792 new_params.move_to_end(param_name)
1793 elif param.kind is _VAR_POSITIONAL:
1794 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001795
1796 return wrapped_sig.replace(parameters=new_params.values())
1797
1798
Yury Selivanov62560fb2014-01-28 12:26:24 -05001799def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001800 """Private helper to transform signatures for unbound
1801 functions to bound methods.
1802 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001803
1804 params = tuple(sig.parameters.values())
1805
1806 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1807 raise ValueError('invalid method signature')
1808
1809 kind = params[0].kind
1810 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1811 # Drop first parameter:
1812 # '(p1, p2[, ...])' -> '(p2[, ...])'
1813 params = params[1:]
1814 else:
1815 if kind is not _VAR_POSITIONAL:
1816 # Unless we add a new parameter type we never
1817 # get here
1818 raise ValueError('invalid argument type')
1819 # It's a var-positional parameter.
1820 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1821
1822 return sig.replace(parameters=params)
1823
1824
Yury Selivanovb77511d2014-01-29 10:46:14 -05001825def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001826 """Private helper to test if `obj` is a callable that might
1827 support Argument Clinic's __text_signature__ protocol.
1828 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001829 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001830 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001831 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001832 # Can't test 'isinstance(type)' here, as it would
1833 # also be True for regular python classes
1834 obj in (type, object))
1835
1836
Yury Selivanov63da7c72014-01-31 14:48:37 -05001837def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001838 """Private helper to test if `obj` is a duck type of FunctionType.
1839 A good example of such objects are functions compiled with
1840 Cython, which have all attributes that a pure Python function
1841 would have, but have their code statically compiled.
1842 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001843
1844 if not callable(obj) or isclass(obj):
1845 # All function-like objects are obviously callables,
1846 # and not classes.
1847 return False
1848
1849 name = getattr(obj, '__name__', None)
1850 code = getattr(obj, '__code__', None)
1851 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1852 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1853 annotations = getattr(obj, '__annotations__', None)
1854
1855 return (isinstance(code, types.CodeType) and
1856 isinstance(name, str) and
1857 (defaults is None or isinstance(defaults, tuple)) and
1858 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1859 isinstance(annotations, dict))
1860
1861
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001862def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001863 """ Private helper to get first parameter name from a
1864 __text_signature__ of a builtin method, which should
1865 be in the following format: '($param1, ...)'.
1866 Assumptions are that the first argument won't have
1867 a default value or an annotation.
1868 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001869
1870 assert spec.startswith('($')
1871
1872 pos = spec.find(',')
1873 if pos == -1:
1874 pos = spec.find(')')
1875
1876 cpos = spec.find(':')
1877 assert cpos == -1 or cpos > pos
1878
1879 cpos = spec.find('=')
1880 assert cpos == -1 or cpos > pos
1881
1882 return spec[2:pos]
1883
1884
Larry Hastings2623c8c2014-02-08 22:15:29 -08001885def _signature_strip_non_python_syntax(signature):
1886 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001887 Private helper function. Takes a signature in Argument Clinic's
1888 extended signature format.
1889
Larry Hastings2623c8c2014-02-08 22:15:29 -08001890 Returns a tuple of three things:
1891 * that signature re-rendered in standard Python syntax,
1892 * the index of the "self" parameter (generally 0), or None if
1893 the function does not have a "self" parameter, and
1894 * the index of the last "positional only" parameter,
1895 or None if the signature has no positional-only parameters.
1896 """
1897
1898 if not signature:
1899 return signature, None, None
1900
1901 self_parameter = None
1902 last_positional_only = None
1903
1904 lines = [l.encode('ascii') for l in signature.split('\n')]
1905 generator = iter(lines).__next__
1906 token_stream = tokenize.tokenize(generator)
1907
1908 delayed_comma = False
1909 skip_next_comma = False
1910 text = []
1911 add = text.append
1912
1913 current_parameter = 0
1914 OP = token.OP
1915 ERRORTOKEN = token.ERRORTOKEN
1916
1917 # token stream always starts with ENCODING token, skip it
1918 t = next(token_stream)
1919 assert t.type == tokenize.ENCODING
1920
1921 for t in token_stream:
1922 type, string = t.type, t.string
1923
1924 if type == OP:
1925 if string == ',':
1926 if skip_next_comma:
1927 skip_next_comma = False
1928 else:
1929 assert not delayed_comma
1930 delayed_comma = True
1931 current_parameter += 1
1932 continue
1933
1934 if string == '/':
1935 assert not skip_next_comma
1936 assert last_positional_only is None
1937 skip_next_comma = True
1938 last_positional_only = current_parameter - 1
1939 continue
1940
1941 if (type == ERRORTOKEN) and (string == '$'):
1942 assert self_parameter is None
1943 self_parameter = current_parameter
1944 continue
1945
1946 if delayed_comma:
1947 delayed_comma = False
1948 if not ((type == OP) and (string == ')')):
1949 add(', ')
1950 add(string)
1951 if (string == ','):
1952 add(' ')
1953 clean_signature = ''.join(text)
1954 return clean_signature, self_parameter, last_positional_only
1955
1956
Yury Selivanov57d240e2014-02-19 16:27:23 -05001957def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001958 """Private helper to parse content of '__text_signature__'
1959 and return a Signature based on it.
1960 """
INADA Naoki37420de2018-01-27 10:10:06 +09001961 # Lazy import ast because it's relatively heavy and
1962 # it's not used for other than this function.
1963 import ast
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001964
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001965 Parameter = cls._parameter_cls
1966
Larry Hastings2623c8c2014-02-08 22:15:29 -08001967 clean_signature, self_parameter, last_positional_only = \
1968 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001969
Larry Hastings2623c8c2014-02-08 22:15:29 -08001970 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001971
1972 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001973 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001974 except SyntaxError:
1975 module = None
1976
1977 if not isinstance(module, ast.Module):
1978 raise ValueError("{!r} builtin has invalid signature".format(obj))
1979
1980 f = module.body[0]
1981
1982 parameters = []
1983 empty = Parameter.empty
1984 invalid = object()
1985
1986 module = None
1987 module_dict = {}
1988 module_name = getattr(obj, '__module__', None)
1989 if module_name:
1990 module = sys.modules.get(module_name, None)
1991 if module:
1992 module_dict = module.__dict__
INADA Naoki6f85b822018-10-05 01:47:09 +09001993 sys_module_dict = sys.modules.copy()
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001994
1995 def parse_name(node):
1996 assert isinstance(node, ast.arg)
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301997 if node.annotation is not None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001998 raise ValueError("Annotations are not currently supported")
1999 return node.arg
2000
2001 def wrap_value(s):
2002 try:
2003 value = eval(s, module_dict)
2004 except NameError:
2005 try:
2006 value = eval(s, sys_module_dict)
2007 except NameError:
2008 raise RuntimeError()
2009
Serhiy Storchaka3f228112018-09-27 17:42:37 +03002010 if isinstance(value, (str, int, float, bytes, bool, type(None))):
2011 return ast.Constant(value)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002012 raise RuntimeError()
2013
2014 class RewriteSymbolics(ast.NodeTransformer):
2015 def visit_Attribute(self, node):
2016 a = []
2017 n = node
2018 while isinstance(n, ast.Attribute):
2019 a.append(n.attr)
2020 n = n.value
2021 if not isinstance(n, ast.Name):
2022 raise RuntimeError()
2023 a.append(n.id)
2024 value = ".".join(reversed(a))
2025 return wrap_value(value)
2026
2027 def visit_Name(self, node):
2028 if not isinstance(node.ctx, ast.Load):
2029 raise ValueError()
2030 return wrap_value(node.id)
2031
2032 def p(name_node, default_node, default=empty):
2033 name = parse_name(name_node)
2034 if name is invalid:
2035 return None
2036 if default_node and default_node is not _empty:
2037 try:
2038 default_node = RewriteSymbolics().visit(default_node)
2039 o = ast.literal_eval(default_node)
2040 except ValueError:
2041 o = invalid
2042 if o is invalid:
2043 return None
2044 default = o if o is not invalid else default
2045 parameters.append(Parameter(name, kind, default=default, annotation=empty))
2046
2047 # non-keyword-only parameters
2048 args = reversed(f.args.args)
2049 defaults = reversed(f.args.defaults)
2050 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002051 if last_positional_only is not None:
2052 kind = Parameter.POSITIONAL_ONLY
2053 else:
2054 kind = Parameter.POSITIONAL_OR_KEYWORD
2055 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002056 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002057 if i == last_positional_only:
2058 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002059
2060 # *args
2061 if f.args.vararg:
2062 kind = Parameter.VAR_POSITIONAL
2063 p(f.args.vararg, empty)
2064
2065 # keyword-only arguments
2066 kind = Parameter.KEYWORD_ONLY
2067 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
2068 p(name, default)
2069
2070 # **kwargs
2071 if f.args.kwarg:
2072 kind = Parameter.VAR_KEYWORD
2073 p(f.args.kwarg, empty)
2074
Larry Hastings2623c8c2014-02-08 22:15:29 -08002075 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002076 # Possibly strip the bound argument:
2077 # - We *always* strip first bound argument if
2078 # it is a module.
2079 # - We don't strip first bound argument if
2080 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002081 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002082 _self = getattr(obj, '__self__', None)
2083 self_isbound = _self is not None
2084 self_ismodule = ismodule(_self)
2085 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002086 parameters.pop(0)
2087 else:
2088 # for builtins, self parameter is always positional-only!
2089 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2090 parameters[0] = p
2091
2092 return cls(parameters, return_annotation=cls.empty)
2093
2094
Yury Selivanov57d240e2014-02-19 16:27:23 -05002095def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002096 """Private helper function to get signature for
2097 builtin callables.
2098 """
2099
Yury Selivanov57d240e2014-02-19 16:27:23 -05002100 if not _signature_is_builtin(func):
2101 raise TypeError("{!r} is not a Python builtin "
2102 "function".format(func))
2103
2104 s = getattr(func, "__text_signature__", None)
2105 if not s:
2106 raise ValueError("no signature found for builtin {!r}".format(func))
2107
2108 return _signature_fromstr(cls, func, s, skip_bound_arg)
2109
2110
Serhiy Storchakad53cf992019-05-06 22:40:27 +03002111def _signature_from_function(cls, func, skip_bound_arg=True):
Yury Selivanovcf45f022015-05-20 14:38:50 -04002112 """Private helper: constructs Signature for the given python function."""
2113
2114 is_duck_function = False
2115 if not isfunction(func):
2116 if _signature_is_functionlike(func):
2117 is_duck_function = True
2118 else:
2119 # If it's not a pure Python function, and not a duck type
2120 # of pure function:
2121 raise TypeError('{!r} is not a Python function'.format(func))
2122
Serhiy Storchakad53cf992019-05-06 22:40:27 +03002123 s = getattr(func, "__text_signature__", None)
2124 if s:
2125 return _signature_fromstr(cls, func, s, skip_bound_arg)
2126
Yury Selivanovcf45f022015-05-20 14:38:50 -04002127 Parameter = cls._parameter_cls
2128
2129 # Parameter information.
2130 func_code = func.__code__
2131 pos_count = func_code.co_argcount
2132 arg_names = func_code.co_varnames
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002133 posonly_count = func_code.co_posonlyargcount
Pablo Galindocd74e662019-06-01 18:08:04 +01002134 positional = arg_names[:pos_count]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002135 keyword_only_count = func_code.co_kwonlyargcount
Pablo Galindocd74e662019-06-01 18:08:04 +01002136 keyword_only = arg_names[pos_count:pos_count + keyword_only_count]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002137 annotations = func.__annotations__
2138 defaults = func.__defaults__
2139 kwdefaults = func.__kwdefaults__
2140
2141 if defaults:
2142 pos_default_count = len(defaults)
2143 else:
2144 pos_default_count = 0
2145
2146 parameters = []
2147
Pablo Galindocd74e662019-06-01 18:08:04 +01002148 non_default_count = pos_count - pos_default_count
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002149 posonly_left = posonly_count
2150
Yury Selivanovcf45f022015-05-20 14:38:50 -04002151 # Non-keyword-only parameters w/o defaults.
Pablo Galindocd74e662019-06-01 18:08:04 +01002152 for name in positional[:non_default_count]:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002153 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002154 annotation = annotations.get(name, _empty)
2155 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002156 kind=kind))
2157 if posonly_left:
2158 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002159
2160 # ... w/ defaults.
Pablo Galindocd74e662019-06-01 18:08:04 +01002161 for offset, name in enumerate(positional[non_default_count:]):
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002162 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002163 annotation = annotations.get(name, _empty)
2164 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002165 kind=kind,
Yury Selivanovcf45f022015-05-20 14:38:50 -04002166 default=defaults[offset]))
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002167 if posonly_left:
2168 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002169
2170 # *args
2171 if func_code.co_flags & CO_VARARGS:
Pablo Galindocd74e662019-06-01 18:08:04 +01002172 name = arg_names[pos_count + keyword_only_count]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002173 annotation = annotations.get(name, _empty)
2174 parameters.append(Parameter(name, annotation=annotation,
2175 kind=_VAR_POSITIONAL))
2176
2177 # Keyword-only parameters.
2178 for name in keyword_only:
2179 default = _empty
2180 if kwdefaults is not None:
2181 default = kwdefaults.get(name, _empty)
2182
2183 annotation = annotations.get(name, _empty)
2184 parameters.append(Parameter(name, annotation=annotation,
2185 kind=_KEYWORD_ONLY,
2186 default=default))
2187 # **kwargs
2188 if func_code.co_flags & CO_VARKEYWORDS:
Pablo Galindocd74e662019-06-01 18:08:04 +01002189 index = pos_count + keyword_only_count
Yury Selivanovcf45f022015-05-20 14:38:50 -04002190 if func_code.co_flags & CO_VARARGS:
2191 index += 1
2192
2193 name = arg_names[index]
2194 annotation = annotations.get(name, _empty)
2195 parameters.append(Parameter(name, annotation=annotation,
2196 kind=_VAR_KEYWORD))
2197
2198 # Is 'func' is a pure Python function - don't validate the
2199 # parameters list (for correct order and defaults), it should be OK.
2200 return cls(parameters,
2201 return_annotation=annotations.get('return', _empty),
2202 __validate_parameters__=is_duck_function)
2203
2204
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002205def _signature_from_callable(obj, *,
2206 follow_wrapper_chains=True,
2207 skip_bound_arg=True,
2208 sigcls):
2209
2210 """Private helper function to get signature for arbitrary
2211 callable objects.
2212 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002213
2214 if not callable(obj):
2215 raise TypeError('{!r} is not a callable object'.format(obj))
2216
2217 if isinstance(obj, types.MethodType):
2218 # In this case we skip the first parameter of the underlying
2219 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002220 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002221 obj.__func__,
2222 follow_wrapper_chains=follow_wrapper_chains,
2223 skip_bound_arg=skip_bound_arg,
2224 sigcls=sigcls)
2225
Yury Selivanov57d240e2014-02-19 16:27:23 -05002226 if skip_bound_arg:
2227 return _signature_bound_method(sig)
2228 else:
2229 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002230
Nick Coghlane8c45d62013-07-28 20:00:01 +10002231 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05002232 if follow_wrapper_chains:
2233 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Yury Selivanov46c759d2015-05-27 21:56:53 -04002234 if isinstance(obj, types.MethodType):
2235 # If the unwrapped object is a *method*, we might want to
2236 # skip its first parameter (self).
2237 # See test_signature_wrapped_bound_method for details.
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002238 return _signature_from_callable(
Yury Selivanov46c759d2015-05-27 21:56:53 -04002239 obj,
2240 follow_wrapper_chains=follow_wrapper_chains,
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002241 skip_bound_arg=skip_bound_arg,
2242 sigcls=sigcls)
Nick Coghlane8c45d62013-07-28 20:00:01 +10002243
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002244 try:
2245 sig = obj.__signature__
2246 except AttributeError:
2247 pass
2248 else:
2249 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07002250 if not isinstance(sig, Signature):
2251 raise TypeError(
2252 'unexpected object {!r} in __signature__ '
2253 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002254 return sig
2255
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002256 try:
2257 partialmethod = obj._partialmethod
2258 except AttributeError:
2259 pass
2260 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05002261 if isinstance(partialmethod, functools.partialmethod):
2262 # Unbound partialmethod (see functools.partialmethod)
2263 # This means, that we need to calculate the signature
2264 # as if it's a regular partial object, but taking into
2265 # account that the first positional argument
2266 # (usually `self`, or `cls`) will not be passed
2267 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002268
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002269 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002270 partialmethod.func,
2271 follow_wrapper_chains=follow_wrapper_chains,
2272 skip_bound_arg=skip_bound_arg,
2273 sigcls=sigcls)
2274
Yury Selivanov0486f812014-01-29 12:18:59 -05002275 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanov0486f812014-01-29 12:18:59 -05002276 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
Dong-hee Na378d7062017-05-18 04:00:51 +09002277 if first_wrapped_param.kind is Parameter.VAR_POSITIONAL:
2278 # First argument of the wrapped callable is `*args`, as in
2279 # `partialmethod(lambda *args)`.
2280 return sig
2281 else:
2282 sig_params = tuple(sig.parameters.values())
Yury Selivanov8a387212018-03-06 12:59:45 -05002283 assert (not sig_params or
2284 first_wrapped_param is not sig_params[0])
Dong-hee Na378d7062017-05-18 04:00:51 +09002285 new_params = (first_wrapped_param,) + sig_params
2286 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002287
Yury Selivanov63da7c72014-01-31 14:48:37 -05002288 if isfunction(obj) or _signature_is_functionlike(obj):
2289 # If it's a pure Python function, or an object that is duck type
2290 # of a Python function (Cython functions, for instance), then:
Serhiy Storchakad53cf992019-05-06 22:40:27 +03002291 return _signature_from_function(sigcls, obj,
2292 skip_bound_arg=skip_bound_arg)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002293
Yury Selivanova773de02014-02-21 18:30:53 -05002294 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04002295 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05002296 skip_bound_arg=skip_bound_arg)
2297
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002298 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002299 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002300 obj.func,
2301 follow_wrapper_chains=follow_wrapper_chains,
2302 skip_bound_arg=skip_bound_arg,
2303 sigcls=sigcls)
Yury Selivanov62560fb2014-01-28 12:26:24 -05002304 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002305
2306 sig = None
2307 if isinstance(obj, type):
2308 # obj is a class or a metaclass
2309
2310 # First, let's see if it has an overloaded __call__ defined
2311 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002312 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002313 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002314 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002315 call,
2316 follow_wrapper_chains=follow_wrapper_chains,
2317 skip_bound_arg=skip_bound_arg,
2318 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002319 else:
2320 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002321 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002322 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002323 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002324 new,
2325 follow_wrapper_chains=follow_wrapper_chains,
2326 skip_bound_arg=skip_bound_arg,
2327 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002328 else:
2329 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002330 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002331 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002332 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002333 init,
2334 follow_wrapper_chains=follow_wrapper_chains,
2335 skip_bound_arg=skip_bound_arg,
2336 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002337
2338 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002339 # At this point we know, that `obj` is a class, with no user-
2340 # defined '__init__', '__new__', or class-level '__call__'
2341
Larry Hastings2623c8c2014-02-08 22:15:29 -08002342 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002343 # Since '__text_signature__' is implemented as a
2344 # descriptor that extracts text signature from the
2345 # class docstring, if 'obj' is derived from a builtin
2346 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002347 # Therefore, we go through the MRO (except the last
2348 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002349 # class with non-empty text signature.
2350 try:
2351 text_sig = base.__text_signature__
2352 except AttributeError:
2353 pass
2354 else:
2355 if text_sig:
2356 # If 'obj' class has a __text_signature__ attribute:
2357 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002358 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002359
2360 # No '__text_signature__' was found for the 'obj' class.
2361 # Last option is to check if its '__init__' is
2362 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002363 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002364 # We have a class (not metaclass), but no user-defined
2365 # __init__ or __new__ for it
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002366 if (obj.__init__ is object.__init__ and
2367 obj.__new__ is object.__new__):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002368 # Return a signature of 'object' builtin.
Gregory P. Smith5b9ff7a2019-09-13 17:13:51 +01002369 return sigcls.from_callable(object)
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002370 else:
2371 raise ValueError(
2372 'no signature found for builtin type {!r}'.format(obj))
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002373
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002374 elif not isinstance(obj, _NonUserDefinedCallables):
2375 # An object with __call__
2376 # We also check that the 'obj' is not an instance of
2377 # _WrapperDescriptor or _MethodWrapper to avoid
2378 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002379 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002380 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002381 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002382 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002383 call,
2384 follow_wrapper_chains=follow_wrapper_chains,
2385 skip_bound_arg=skip_bound_arg,
2386 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002387 except ValueError as ex:
2388 msg = 'no signature found for {!r}'.format(obj)
2389 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002390
2391 if sig is not None:
2392 # For classes and objects we skip the first parameter of their
2393 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002394 if skip_bound_arg:
2395 return _signature_bound_method(sig)
2396 else:
2397 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002398
2399 if isinstance(obj, types.BuiltinFunctionType):
2400 # Raise a nicer error message for builtins
2401 msg = 'no signature found for builtin function {!r}'.format(obj)
2402 raise ValueError(msg)
2403
2404 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2405
2406
2407class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002408 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002409
2410
2411class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002412 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002413
2414
Yury Selivanov21e83a52014-03-27 11:23:13 -04002415class _ParameterKind(enum.IntEnum):
2416 POSITIONAL_ONLY = 0
2417 POSITIONAL_OR_KEYWORD = 1
2418 VAR_POSITIONAL = 2
2419 KEYWORD_ONLY = 3
2420 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002421
2422 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002423 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002424
Dong-hee Na4aa30062018-06-08 12:46:31 +09002425 @property
2426 def description(self):
2427 return _PARAM_NAME_MAPPING[self]
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002428
Yury Selivanov21e83a52014-03-27 11:23:13 -04002429_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2430_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2431_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2432_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2433_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002434
Dong-hee Naa9cab432018-05-30 00:04:08 +09002435_PARAM_NAME_MAPPING = {
2436 _POSITIONAL_ONLY: 'positional-only',
2437 _POSITIONAL_OR_KEYWORD: 'positional or keyword',
2438 _VAR_POSITIONAL: 'variadic positional',
2439 _KEYWORD_ONLY: 'keyword-only',
2440 _VAR_KEYWORD: 'variadic keyword'
2441}
2442
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002443
2444class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002445 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002446
2447 Has the following public attributes:
2448
2449 * name : str
2450 The name of the parameter as a string.
2451 * default : object
2452 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002453 parameter has no default value, this attribute is set to
2454 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002455 * annotation
2456 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002457 parameter has no annotation, this attribute is set to
2458 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002459 * kind : str
2460 Describes how argument values are bound to the parameter.
2461 Possible values: `Parameter.POSITIONAL_ONLY`,
2462 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2463 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002464 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002465
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002466 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002467
2468 POSITIONAL_ONLY = _POSITIONAL_ONLY
2469 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2470 VAR_POSITIONAL = _VAR_POSITIONAL
2471 KEYWORD_ONLY = _KEYWORD_ONLY
2472 VAR_KEYWORD = _VAR_KEYWORD
2473
2474 empty = _empty
2475
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002476 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002477 try:
2478 self._kind = _ParameterKind(kind)
2479 except ValueError:
2480 raise ValueError(f'value {kind!r} is not a valid Parameter.kind')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002481 if default is not _empty:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002482 if self._kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2483 msg = '{} parameters cannot have default values'
Dong-hee Na4aa30062018-06-08 12:46:31 +09002484 msg = msg.format(self._kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002485 raise ValueError(msg)
2486 self._default = default
2487 self._annotation = annotation
2488
Yury Selivanov2393dca2014-01-27 15:07:58 -05002489 if name is _empty:
2490 raise ValueError('name is a required attribute for Parameter')
2491
2492 if not isinstance(name, str):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002493 msg = 'name must be a str, not a {}'.format(type(name).__name__)
2494 raise TypeError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002495
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002496 if name[0] == '.' and name[1:].isdigit():
2497 # These are implicit arguments generated by comprehensions. In
2498 # order to provide a friendlier interface to users, we recast
2499 # their name as "implicitN" and treat them as positional-only.
2500 # See issue 19611.
Dong-hee Naa9cab432018-05-30 00:04:08 +09002501 if self._kind != _POSITIONAL_OR_KEYWORD:
2502 msg = (
2503 'implicit arguments must be passed as '
2504 'positional or keyword arguments, not {}'
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002505 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002506 msg = msg.format(self._kind.description)
Dong-hee Naa9cab432018-05-30 00:04:08 +09002507 raise ValueError(msg)
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002508 self._kind = _POSITIONAL_ONLY
2509 name = 'implicit{}'.format(name[1:])
2510
Yury Selivanov2393dca2014-01-27 15:07:58 -05002511 if not name.isidentifier():
2512 raise ValueError('{!r} is not a valid parameter name'.format(name))
2513
2514 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002515
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002516 def __reduce__(self):
2517 return (type(self),
2518 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002519 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002520 '_annotation': self._annotation})
2521
2522 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002523 self._default = state['_default']
2524 self._annotation = state['_annotation']
2525
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002526 @property
2527 def name(self):
2528 return self._name
2529
2530 @property
2531 def default(self):
2532 return self._default
2533
2534 @property
2535 def annotation(self):
2536 return self._annotation
2537
2538 @property
2539 def kind(self):
2540 return self._kind
2541
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002542 def replace(self, *, name=_void, kind=_void,
2543 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002544 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002545
2546 if name is _void:
2547 name = self._name
2548
2549 if kind is _void:
2550 kind = self._kind
2551
2552 if annotation is _void:
2553 annotation = self._annotation
2554
2555 if default is _void:
2556 default = self._default
2557
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002558 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002559
2560 def __str__(self):
2561 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002562 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002563
2564 # Add annotation and default value
2565 if self._annotation is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002566 formatted = '{}: {}'.format(formatted,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002567 formatannotation(self._annotation))
2568
2569 if self._default is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002570 if self._annotation is not _empty:
2571 formatted = '{} = {}'.format(formatted, repr(self._default))
2572 else:
2573 formatted = '{}={}'.format(formatted, repr(self._default))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002574
2575 if kind == _VAR_POSITIONAL:
2576 formatted = '*' + formatted
2577 elif kind == _VAR_KEYWORD:
2578 formatted = '**' + formatted
2579
2580 return formatted
2581
2582 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002583 return '<{} "{}">'.format(self.__class__.__name__, self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002584
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002585 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002586 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002587
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002588 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002589 if self is other:
2590 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002591 if not isinstance(other, Parameter):
2592 return NotImplemented
2593 return (self._name == other._name and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002594 self._kind == other._kind and
2595 self._default == other._default and
2596 self._annotation == other._annotation)
2597
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002598
2599class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002600 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002601 to the function's parameters.
2602
2603 Has the following public attributes:
2604
Rémi Lapeyre2cca8ef2020-01-28 13:47:03 +01002605 * arguments : dict
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002606 An ordered mutable mapping of parameters' names to arguments' values.
2607 Does not contain arguments' default values.
2608 * signature : Signature
2609 The Signature object that created this instance.
2610 * args : tuple
2611 Tuple of positional arguments values.
2612 * kwargs : dict
2613 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002614 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002615
Yury Selivanov6abe0322015-05-13 17:18:41 -04002616 __slots__ = ('arguments', '_signature', '__weakref__')
2617
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002618 def __init__(self, signature, arguments):
2619 self.arguments = arguments
2620 self._signature = signature
2621
2622 @property
2623 def signature(self):
2624 return self._signature
2625
2626 @property
2627 def args(self):
2628 args = []
2629 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002630 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002631 break
2632
2633 try:
2634 arg = self.arguments[param_name]
2635 except KeyError:
2636 # We're done here. Other arguments
2637 # will be mapped in 'BoundArguments.kwargs'
2638 break
2639 else:
2640 if param.kind == _VAR_POSITIONAL:
2641 # *args
2642 args.extend(arg)
2643 else:
2644 # plain argument
2645 args.append(arg)
2646
2647 return tuple(args)
2648
2649 @property
2650 def kwargs(self):
2651 kwargs = {}
2652 kwargs_started = False
2653 for param_name, param in self._signature.parameters.items():
2654 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002655 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002656 kwargs_started = True
2657 else:
2658 if param_name not in self.arguments:
2659 kwargs_started = True
2660 continue
2661
2662 if not kwargs_started:
2663 continue
2664
2665 try:
2666 arg = self.arguments[param_name]
2667 except KeyError:
2668 pass
2669 else:
2670 if param.kind == _VAR_KEYWORD:
2671 # **kwargs
2672 kwargs.update(arg)
2673 else:
2674 # plain keyword argument
2675 kwargs[param_name] = arg
2676
2677 return kwargs
2678
Yury Selivanovb907a512015-05-16 13:45:09 -04002679 def apply_defaults(self):
2680 """Set default values for missing arguments.
2681
2682 For variable-positional arguments (*args) the default is an
2683 empty tuple.
2684
2685 For variable-keyword arguments (**kwargs) the default is an
2686 empty dict.
2687 """
2688 arguments = self.arguments
Yury Selivanovb907a512015-05-16 13:45:09 -04002689 new_arguments = []
2690 for name, param in self._signature.parameters.items():
2691 try:
2692 new_arguments.append((name, arguments[name]))
2693 except KeyError:
2694 if param.default is not _empty:
2695 val = param.default
2696 elif param.kind is _VAR_POSITIONAL:
2697 val = ()
2698 elif param.kind is _VAR_KEYWORD:
2699 val = {}
2700 else:
2701 # This BoundArguments was likely produced by
2702 # Signature.bind_partial().
2703 continue
2704 new_arguments.append((name, val))
Rémi Lapeyre2cca8ef2020-01-28 13:47:03 +01002705 self.arguments = dict(new_arguments)
Yury Selivanovb907a512015-05-16 13:45:09 -04002706
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002707 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002708 if self is other:
2709 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002710 if not isinstance(other, BoundArguments):
2711 return NotImplemented
2712 return (self.signature == other.signature and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002713 self.arguments == other.arguments)
2714
Yury Selivanov6abe0322015-05-13 17:18:41 -04002715 def __setstate__(self, state):
2716 self._signature = state['_signature']
2717 self.arguments = state['arguments']
2718
2719 def __getstate__(self):
2720 return {'_signature': self._signature, 'arguments': self.arguments}
2721
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002722 def __repr__(self):
2723 args = []
2724 for arg, value in self.arguments.items():
2725 args.append('{}={!r}'.format(arg, value))
Yury Selivanovf229bc52015-05-15 12:53:56 -04002726 return '<{} ({})>'.format(self.__class__.__name__, ', '.join(args))
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002727
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002728
2729class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002730 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002731 It stores a Parameter object for each parameter accepted by the
2732 function, as well as information specific to the function itself.
2733
2734 A Signature object has the following public attributes and methods:
2735
Jens Reidel611836a2020-03-18 03:22:46 +01002736 * parameters : OrderedDict
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002737 An ordered mapping of parameters' names to the corresponding
2738 Parameter objects (keyword-only arguments are in the same order
2739 as listed in `code.co_varnames`).
2740 * return_annotation : object
2741 The annotation for the return type of the function if specified.
2742 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002743 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002744 * bind(*args, **kwargs) -> BoundArguments
2745 Creates a mapping from positional and keyword arguments to
2746 parameters.
2747 * bind_partial(*args, **kwargs) -> BoundArguments
2748 Creates a partial mapping from positional and keyword arguments
2749 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002750 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002751
2752 __slots__ = ('_return_annotation', '_parameters')
2753
2754 _parameter_cls = Parameter
2755 _bound_arguments_cls = BoundArguments
2756
2757 empty = _empty
2758
2759 def __init__(self, parameters=None, *, return_annotation=_empty,
2760 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002761 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002762 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002763 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002764
2765 if parameters is None:
Jens Reidel611836a2020-03-18 03:22:46 +01002766 params = OrderedDict()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002767 else:
2768 if __validate_parameters__:
Jens Reidel611836a2020-03-18 03:22:46 +01002769 params = OrderedDict()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002770 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002771 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002772
Rémi Lapeyre2cca8ef2020-01-28 13:47:03 +01002773 for param in parameters:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002774 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002775 name = param.name
2776
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002777 if kind < top_kind:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002778 msg = (
2779 'wrong parameter order: {} parameter before {} '
2780 'parameter'
2781 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002782 msg = msg.format(top_kind.description,
2783 kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002784 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002785 elif kind > top_kind:
2786 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002787 top_kind = kind
2788
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002789 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002790 if param.default is _empty:
2791 if kind_defaults:
2792 # No default for this parameter, but the
2793 # previous parameter of the same kind had
2794 # a default
2795 msg = 'non-default argument follows default ' \
2796 'argument'
2797 raise ValueError(msg)
2798 else:
2799 # There is a default for this parameter.
2800 kind_defaults = True
2801
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002802 if name in params:
2803 msg = 'duplicate parameter name: {!r}'.format(name)
2804 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002805
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002806 params[name] = param
2807 else:
Jens Reidel611836a2020-03-18 03:22:46 +01002808 params = OrderedDict((param.name, param) for param in parameters)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002809
2810 self._parameters = types.MappingProxyType(params)
2811 self._return_annotation = return_annotation
2812
2813 @classmethod
2814 def from_function(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002815 """Constructs Signature for the given python function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002816
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002817 Deprecated since Python 3.5, use `Signature.from_callable()`.
2818 """
2819
2820 warnings.warn("inspect.Signature.from_function() is deprecated since "
2821 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002822 DeprecationWarning, stacklevel=2)
Yury Selivanovcf45f022015-05-20 14:38:50 -04002823 return _signature_from_function(cls, func)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002824
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002825 @classmethod
2826 def from_builtin(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002827 """Constructs Signature for the given builtin function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002828
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002829 Deprecated since Python 3.5, use `Signature.from_callable()`.
2830 """
2831
2832 warnings.warn("inspect.Signature.from_builtin() is deprecated since "
2833 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002834 DeprecationWarning, stacklevel=2)
Yury Selivanov57d240e2014-02-19 16:27:23 -05002835 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002836
Yury Selivanovda396452014-03-27 12:09:24 -04002837 @classmethod
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002838 def from_callable(cls, obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002839 """Constructs Signature for the given callable object."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002840 return _signature_from_callable(obj, sigcls=cls,
2841 follow_wrapper_chains=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002842
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002843 @property
2844 def parameters(self):
2845 return self._parameters
2846
2847 @property
2848 def return_annotation(self):
2849 return self._return_annotation
2850
2851 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002852 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002853 Pass 'parameters' and/or 'return_annotation' arguments
2854 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002855 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002856
2857 if parameters is _void:
2858 parameters = self.parameters.values()
2859
2860 if return_annotation is _void:
2861 return_annotation = self._return_annotation
2862
2863 return type(self)(parameters,
2864 return_annotation=return_annotation)
2865
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002866 def _hash_basis(self):
2867 params = tuple(param for param in self.parameters.values()
2868 if param.kind != _KEYWORD_ONLY)
2869
2870 kwo_params = {param.name: param for param in self.parameters.values()
2871 if param.kind == _KEYWORD_ONLY}
2872
2873 return params, kwo_params, self.return_annotation
2874
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002875 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002876 params, kwo_params, return_annotation = self._hash_basis()
2877 kwo_params = frozenset(kwo_params.values())
2878 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002879
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002880 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002881 if self is other:
2882 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002883 if not isinstance(other, Signature):
2884 return NotImplemented
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002885 return self._hash_basis() == other._hash_basis()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002886
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002887 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002888 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002889
Rémi Lapeyre2cca8ef2020-01-28 13:47:03 +01002890 arguments = {}
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002891
2892 parameters = iter(self.parameters.values())
2893 parameters_ex = ()
2894 arg_vals = iter(args)
2895
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002896 while True:
2897 # Let's iterate through the positional arguments and corresponding
2898 # parameters
2899 try:
2900 arg_val = next(arg_vals)
2901 except StopIteration:
2902 # No more positional arguments
2903 try:
2904 param = next(parameters)
2905 except StopIteration:
2906 # No more parameters. That's it. Just need to check that
2907 # we have no `kwargs` after this while loop
2908 break
2909 else:
2910 if param.kind == _VAR_POSITIONAL:
2911 # That's OK, just empty *args. Let's start parsing
2912 # kwargs
2913 break
2914 elif param.name in kwargs:
2915 if param.kind == _POSITIONAL_ONLY:
2916 msg = '{arg!r} parameter is positional only, ' \
2917 'but was passed as a keyword'
2918 msg = msg.format(arg=param.name)
2919 raise TypeError(msg) from None
2920 parameters_ex = (param,)
2921 break
2922 elif (param.kind == _VAR_KEYWORD or
2923 param.default is not _empty):
2924 # That's fine too - we have a default value for this
2925 # parameter. So, lets start parsing `kwargs`, starting
2926 # with the current parameter
2927 parameters_ex = (param,)
2928 break
2929 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002930 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2931 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002932 if partial:
2933 parameters_ex = (param,)
2934 break
2935 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002936 msg = 'missing a required argument: {arg!r}'
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002937 msg = msg.format(arg=param.name)
2938 raise TypeError(msg) from None
2939 else:
2940 # We have a positional argument to process
2941 try:
2942 param = next(parameters)
2943 except StopIteration:
2944 raise TypeError('too many positional arguments') from None
2945 else:
2946 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2947 # Looks like we have no parameter for this positional
2948 # argument
Yury Selivanov86872752015-05-19 00:27:49 -04002949 raise TypeError(
2950 'too many positional arguments') from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002951
2952 if param.kind == _VAR_POSITIONAL:
2953 # We have an '*args'-like argument, let's fill it with
2954 # all positional arguments we have left and move on to
2955 # the next phase
2956 values = [arg_val]
2957 values.extend(arg_vals)
2958 arguments[param.name] = tuple(values)
2959 break
2960
Pablo Galindof3ef06a2019-10-15 12:40:02 +01002961 if param.name in kwargs and param.kind != _POSITIONAL_ONLY:
Yury Selivanov86872752015-05-19 00:27:49 -04002962 raise TypeError(
2963 'multiple values for argument {arg!r}'.format(
2964 arg=param.name)) from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002965
2966 arguments[param.name] = arg_val
2967
2968 # Now, we iterate through the remaining parameters to process
2969 # keyword arguments
2970 kwargs_param = None
2971 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002972 if param.kind == _VAR_KEYWORD:
2973 # Memorize that we have a '**kwargs'-like parameter
2974 kwargs_param = param
2975 continue
2976
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002977 if param.kind == _VAR_POSITIONAL:
2978 # Named arguments don't refer to '*args'-like parameters.
2979 # We only arrive here if the positional arguments ended
2980 # before reaching the last parameter before *args.
2981 continue
2982
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002983 param_name = param.name
2984 try:
2985 arg_val = kwargs.pop(param_name)
2986 except KeyError:
2987 # We have no value for this parameter. It's fine though,
2988 # if it has a default value, or it is an '*args'-like
2989 # parameter, left alone by the processing of positional
2990 # arguments.
2991 if (not partial and param.kind != _VAR_POSITIONAL and
2992 param.default is _empty):
Yury Selivanov86872752015-05-19 00:27:49 -04002993 raise TypeError('missing a required argument: {arg!r}'. \
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002994 format(arg=param_name)) from None
2995
2996 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002997 if param.kind == _POSITIONAL_ONLY:
2998 # This should never happen in case of a properly built
2999 # Signature object (but let's have this check here
3000 # to ensure correct behaviour just in case)
3001 raise TypeError('{arg!r} parameter is positional only, '
3002 'but was passed as a keyword'. \
3003 format(arg=param.name))
3004
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003005 arguments[param_name] = arg_val
3006
3007 if kwargs:
3008 if kwargs_param is not None:
3009 # Process our '**kwargs'-like parameter
3010 arguments[kwargs_param.name] = kwargs
3011 else:
Yury Selivanov86872752015-05-19 00:27:49 -04003012 raise TypeError(
3013 'got an unexpected keyword argument {arg!r}'.format(
3014 arg=next(iter(kwargs))))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003015
3016 return self._bound_arguments_cls(self, arguments)
3017
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03003018 def bind(self, /, *args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003019 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003020 and `kwargs` to the function's signature. Raises `TypeError`
3021 if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003022 """
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03003023 return self._bind(args, kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003024
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03003025 def bind_partial(self, /, *args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003026 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003027 passed `args` and `kwargs` to the function's signature.
3028 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003029 """
Serhiy Storchaka2085bd02019-06-01 11:00:15 +03003030 return self._bind(args, kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003031
Yury Selivanova5d63dd2014-03-27 11:31:43 -04003032 def __reduce__(self):
3033 return (type(self),
3034 (tuple(self._parameters.values()),),
3035 {'_return_annotation': self._return_annotation})
3036
3037 def __setstate__(self, state):
3038 self._return_annotation = state['_return_annotation']
3039
Yury Selivanov374375d2014-03-27 12:41:53 -04003040 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04003041 return '<{} {}>'.format(self.__class__.__name__, self)
Yury Selivanov374375d2014-03-27 12:41:53 -04003042
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003043 def __str__(self):
3044 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05003045 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003046 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05003047 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003048 formatted = str(param)
3049
3050 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05003051
3052 if kind == _POSITIONAL_ONLY:
3053 render_pos_only_separator = True
3054 elif render_pos_only_separator:
3055 # It's not a positional-only parameter, and the flag
3056 # is set to 'True' (there were pos-only params before.)
3057 result.append('/')
3058 render_pos_only_separator = False
3059
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003060 if kind == _VAR_POSITIONAL:
3061 # OK, we have an '*args'-like parameter, so we won't need
3062 # a '*' to separate keyword-only arguments
3063 render_kw_only_separator = False
3064 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
3065 # We have a keyword-only parameter to render and we haven't
3066 # rendered an '*args'-like parameter before, so add a '*'
3067 # separator to the parameters list ("foo(arg1, *, arg2)" case)
3068 result.append('*')
3069 # This condition should be only triggered once, so
3070 # reset the flag
3071 render_kw_only_separator = False
3072
3073 result.append(formatted)
3074
Yury Selivanov2393dca2014-01-27 15:07:58 -05003075 if render_pos_only_separator:
3076 # There were only positional-only parameters, hence the
3077 # flag was not reset to 'False'
3078 result.append('/')
3079
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003080 rendered = '({})'.format(', '.join(result))
3081
3082 if self.return_annotation is not _empty:
3083 anno = formatannotation(self.return_annotation)
3084 rendered += ' -> {}'.format(anno)
3085
3086 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003087
Yury Selivanovda396452014-03-27 12:09:24 -04003088
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003089def signature(obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003090 """Get a signature object for the passed callable."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003091 return Signature.from_callable(obj, follow_wrapped=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04003092
3093
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003094def _main():
3095 """ Logic for inspecting an object given at command line """
3096 import argparse
3097 import importlib
3098
3099 parser = argparse.ArgumentParser()
3100 parser.add_argument(
3101 'object',
3102 help="The object to be analysed. "
3103 "It supports the 'module:qualname' syntax")
3104 parser.add_argument(
3105 '-d', '--details', action='store_true',
3106 help='Display info about the module rather than its source code')
3107
3108 args = parser.parse_args()
3109
3110 target = args.object
3111 mod_name, has_attrs, attrs = target.partition(":")
3112 try:
3113 obj = module = importlib.import_module(mod_name)
3114 except Exception as exc:
3115 msg = "Failed to import {} ({}: {})".format(mod_name,
3116 type(exc).__name__,
3117 exc)
3118 print(msg, file=sys.stderr)
Alan Yeee3c59a72019-09-09 07:15:43 -07003119 sys.exit(2)
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003120
3121 if has_attrs:
3122 parts = attrs.split(".")
3123 obj = module
3124 for part in parts:
3125 obj = getattr(obj, part)
3126
3127 if module.__name__ in sys.builtin_module_names:
3128 print("Can't get info for builtin modules.", file=sys.stderr)
Alan Yeee3c59a72019-09-09 07:15:43 -07003129 sys.exit(1)
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003130
3131 if args.details:
3132 print('Target: {}'.format(target))
3133 print('Origin: {}'.format(getsourcefile(module)))
3134 print('Cached: {}'.format(module.__cached__))
3135 if obj is module:
3136 print('Loader: {}'.format(repr(module.__loader__)))
3137 if hasattr(module, '__path__'):
3138 print('Submodule search path: {}'.format(module.__path__))
3139 else:
3140 try:
3141 __, lineno = findsource(obj)
3142 except Exception:
3143 pass
3144 else:
3145 print('Line: {}'.format(lineno))
3146
3147 print('\n')
3148 else:
3149 print(getsource(obj))
3150
3151
3152if __name__ == "__main__":
3153 _main()