blob: fffca22357a92817dc5fa6e36f531f421df70487 [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
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070051from 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 Storchaka5cf2b7252015-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 Storchaka5cf2b7252015-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 Storchaka5cf2b7252015-04-03 22:38:53 +0300595 else:
596 return None
Serhiy Storchaka5cf2b7252015-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 Storchaka5cf2b7252015-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__'):
662 object = sys.modules.get(object.__module__)
Jason R. Coombsb9650a02018-03-05 18:29:08 -0500663 if getattr(object, '__file__', None):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500664 return object.__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
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100744 for modname, module in list(sys.modules.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
1040 nposonlyargs = co.co_posonlyargcount
Guido van Rossum2e65f892007-02-28 22:03:49 +00001041 nkwargs = co.co_kwonlyargcount
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001042 nposargs = nargs + nposonlyargs
1043 posonlyargs = list(names[:nposonlyargs])
1044 args = list(names[nposonlyargs:nposonlyargs+nargs])
1045 kwonlyargs = list(names[nposargs:nposargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001046 step = 0
1047
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001048 nargs += nposonlyargs
Guido van Rossum2e65f892007-02-28 22:03:49 +00001049 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001050 varargs = None
1051 if co.co_flags & CO_VARARGS:
1052 varargs = co.co_varnames[nargs]
1053 nargs = nargs + 1
1054 varkw = None
1055 if co.co_flags & CO_VARKEYWORDS:
1056 varkw = co.co_varnames[nargs]
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001057 return Arguments(posonlyargs + args + kwonlyargs, varargs, varkw)
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001058
1059ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
1060
1061def getargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001062 """Get the names and default values of a function's parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001063
1064 A tuple of four things is returned: (args, varargs, keywords, defaults).
1065 'args' is a list of the argument names, including keyword-only argument names.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001066 'varargs' and 'keywords' are the names of the * and ** parameters or None.
1067 'defaults' is an n-tuple of the default values of the last n parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001068
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001069 This function is deprecated, as it does not support annotations or
1070 keyword-only parameters and will raise ValueError if either is present
1071 on the supplied callable.
1072
1073 For a more structured introspection API, use inspect.signature() instead.
1074
1075 Alternatively, use getfullargspec() for an API with a similar namedtuple
1076 based interface, but full support for annotations and keyword-only
1077 parameters.
Matthias Bussonnierded87d82018-10-19 16:40:45 -07001078
1079 Deprecated since Python 3.5, use `inspect.getfullargspec()`.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001080 """
Matthias Bussonnierded87d82018-10-19 16:40:45 -07001081 warnings.warn("inspect.getargspec() is deprecated since Python 3.0, "
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001082 "use inspect.signature() or inspect.getfullargspec()",
1083 DeprecationWarning, stacklevel=2)
Pablo Galindod5d2b452019-04-30 02:01:14 +01001084 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
1085 getfullargspec(func)
1086 if kwonlyargs or ann:
1087 raise ValueError("Function has keyword-only parameters or annotations"
1088 ", use inspect.signature() API which can support them")
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001089 return ArgSpec(args, varargs, varkw, defaults)
1090
Christian Heimes25bb7832008-01-11 16:17:00 +00001091FullArgSpec = namedtuple('FullArgSpec',
Pablo Galindod5d2b452019-04-30 02:01:14 +01001092 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001093
1094def getfullargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001095 """Get the names and default values of a callable object's parameters.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001096
Brett Cannon504d8852007-09-07 02:12:14 +00001097 A tuple of seven things is returned:
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001098 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).
1099 'args' is a list of the parameter names.
1100 'varargs' and 'varkw' are the names of the * and ** parameters or None.
1101 'defaults' is an n-tuple of the default values of the last n parameters.
1102 'kwonlyargs' is a list of keyword-only parameter names.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001103 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001104 'annotations' is a dictionary mapping parameter names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001105
Pablo Galindod5d2b452019-04-30 02:01:14 +01001106 .. deprecated:: 3.8
1107 Use inspect.signature() instead of inspect.getfullargspec().
1108
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001109 Notable differences from inspect.signature():
1110 - the "self" parameter is always reported, even for bound methods
1111 - wrapper chains defined by __wrapped__ *not* unwrapped automatically
Jeremy Hylton64967882003-06-27 18:14:39 +00001112 """
1113
Pablo Galindod5d2b452019-04-30 02:01:14 +01001114 warnings.warn("Use inspect.signature() instead of inspect.getfullargspec()",
1115 DeprecationWarning)
Yury Selivanov57d240e2014-02-19 16:27:23 -05001116 try:
1117 # Re: `skip_bound_arg=False`
1118 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001119 # There is a notable difference in behaviour between getfullargspec
1120 # and Signature: the former always returns 'self' parameter for bound
1121 # methods, whereas the Signature always shows the actual calling
1122 # signature of the passed object.
1123 #
1124 # To simulate this behaviour, we "unbind" bound methods, to trick
1125 # inspect.signature to always return their first parameter ("self",
1126 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001127
Yury Selivanov57d240e2014-02-19 16:27:23 -05001128 # Re: `follow_wrapper_chains=False`
1129 #
1130 # getfullargspec() historically ignored __wrapped__ attributes,
1131 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001132
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001133 sig = _signature_from_callable(func,
1134 follow_wrapper_chains=False,
1135 skip_bound_arg=False,
1136 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001137 except Exception as ex:
1138 # Most of the times 'signature' will raise ValueError.
1139 # But, it can also raise AttributeError, and, maybe something
1140 # else. So to be fully backwards compatible, we catch all
1141 # possible exceptions here, and reraise a TypeError.
1142 raise TypeError('unsupported callable') from ex
1143
1144 args = []
1145 varargs = None
1146 varkw = None
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001147 posonlyargs = []
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001148 kwonlyargs = []
1149 defaults = ()
1150 annotations = {}
1151 defaults = ()
1152 kwdefaults = {}
1153
1154 if sig.return_annotation is not sig.empty:
1155 annotations['return'] = sig.return_annotation
1156
1157 for param in sig.parameters.values():
1158 kind = param.kind
1159 name = param.name
1160
1161 if kind is _POSITIONAL_ONLY:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001162 posonlyargs.append(name)
1163 if param.default is not param.empty:
1164 defaults += (param.default,)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001165 elif kind is _POSITIONAL_OR_KEYWORD:
1166 args.append(name)
1167 if param.default is not param.empty:
1168 defaults += (param.default,)
1169 elif kind is _VAR_POSITIONAL:
1170 varargs = name
1171 elif kind is _KEYWORD_ONLY:
1172 kwonlyargs.append(name)
1173 if param.default is not param.empty:
1174 kwdefaults[name] = param.default
1175 elif kind is _VAR_KEYWORD:
1176 varkw = name
1177
1178 if param.annotation is not param.empty:
1179 annotations[name] = param.annotation
1180
1181 if not kwdefaults:
1182 # compatibility with 'func.__kwdefaults__'
1183 kwdefaults = None
1184
1185 if not defaults:
1186 # compatibility with 'func.__defaults__'
1187 defaults = None
1188
Pablo Galindod5d2b452019-04-30 02:01:14 +01001189 return FullArgSpec(posonlyargs + args, varargs, varkw, defaults,
1190 kwonlyargs, kwdefaults, annotations)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001191
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001192
Christian Heimes25bb7832008-01-11 16:17:00 +00001193ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1194
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001195def getargvalues(frame):
1196 """Get information about arguments passed into a particular frame.
1197
1198 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001199 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001200 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1201 'locals' is the locals dictionary of the given frame."""
1202 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001203 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001204
Guido van Rossum2e65f892007-02-28 22:03:49 +00001205def formatannotation(annotation, base_module=None):
Guido van Rossum52e50042016-10-22 07:55:18 -07001206 if getattr(annotation, '__module__', None) == 'typing':
1207 return repr(annotation).replace('typing.', '')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001208 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001209 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001210 return annotation.__qualname__
1211 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001212 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001213
Guido van Rossum2e65f892007-02-28 22:03:49 +00001214def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001215 module = getattr(object, '__module__', None)
1216 def _formatannotation(annotation):
1217 return formatannotation(annotation, module)
1218 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001219
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001220def formatargspec(args, varargs=None, varkw=None, defaults=None,
Pablo Galindod5d2b452019-04-30 02:01:14 +01001221 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001222 formatarg=str,
1223 formatvarargs=lambda name: '*' + name,
1224 formatvarkw=lambda name: '**' + name,
1225 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001226 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001227 formatannotation=formatannotation):
Berker Peksagfa3922c2015-07-31 04:11:29 +03001228 """Format an argument spec from the values returned by getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001229
Guido van Rossum2e65f892007-02-28 22:03:49 +00001230 The first seven arguments are (args, varargs, varkw, defaults,
1231 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1232 are the corresponding optional formatting functions that are called to
1233 turn names and values into strings. The last argument is an optional
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001234 function to format the sequence of arguments.
1235
1236 Deprecated since Python 3.5: use the `signature` function and `Signature`
1237 objects.
1238 """
1239
1240 from warnings import warn
1241
1242 warn("`formatargspec` is deprecated since Python 3.5. Use `signature` and "
Zackery Spytz41254eb2018-06-11 21:16:18 -06001243 "the `Signature` object directly",
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001244 DeprecationWarning,
1245 stacklevel=2)
1246
Guido van Rossum2e65f892007-02-28 22:03:49 +00001247 def formatargandannotation(arg):
1248 result = formatarg(arg)
1249 if arg in annotations:
1250 result += ': ' + formatannotation(annotations[arg])
1251 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001252 specs = []
1253 if defaults:
Pablo Galindod5d2b452019-04-30 02:01:14 +01001254 firstdefault = len(args) - len(defaults)
1255 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001256 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001257 if defaults and i >= firstdefault:
1258 spec = spec + formatvalue(defaults[i - firstdefault])
1259 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001260 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001261 specs.append(formatvarargs(formatargandannotation(varargs)))
1262 else:
1263 if kwonlyargs:
1264 specs.append('*')
1265 if kwonlyargs:
1266 for kwonlyarg in kwonlyargs:
1267 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001268 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001269 spec += formatvalue(kwonlydefaults[kwonlyarg])
1270 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001271 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001272 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001273 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001274 if 'return' in annotations:
1275 result += formatreturns(formatannotation(annotations['return']))
1276 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001277
1278def formatargvalues(args, varargs, varkw, locals,
1279 formatarg=str,
1280 formatvarargs=lambda name: '*' + name,
1281 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001282 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001283 """Format an argument spec from the 4 values returned by getargvalues.
1284
1285 The first four arguments are (args, varargs, varkw, locals). The
1286 next four arguments are the corresponding optional formatting functions
1287 that are called to turn names and values into strings. The ninth
1288 argument is an optional function to format the sequence of arguments."""
1289 def convert(name, locals=locals,
1290 formatarg=formatarg, formatvalue=formatvalue):
1291 return formatarg(name) + formatvalue(locals[name])
1292 specs = []
1293 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001294 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001295 if varargs:
1296 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1297 if varkw:
1298 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001299 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001300
Benjamin Petersone109c702011-06-24 09:37:26 -05001301def _missing_arguments(f_name, argnames, pos, values):
1302 names = [repr(name) for name in argnames if name not in values]
1303 missing = len(names)
1304 if missing == 1:
1305 s = names[0]
1306 elif missing == 2:
1307 s = "{} and {}".format(*names)
1308 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001309 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001310 del names[-2:]
1311 s = ", ".join(names) + tail
1312 raise TypeError("%s() missing %i required %s argument%s: %s" %
1313 (f_name, missing,
1314 "positional" if pos else "keyword-only",
1315 "" if missing == 1 else "s", s))
1316
1317def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001318 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001319 kwonly_given = len([arg for arg in kwonly if arg in values])
1320 if varargs:
1321 plural = atleast != 1
1322 sig = "at least %d" % (atleast,)
1323 elif defcount:
1324 plural = True
1325 sig = "from %d to %d" % (atleast, len(args))
1326 else:
1327 plural = len(args) != 1
1328 sig = str(len(args))
1329 kwonly_sig = ""
1330 if kwonly_given:
1331 msg = " positional argument%s (and %d keyword-only argument%s)"
1332 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1333 "s" if kwonly_given != 1 else ""))
1334 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1335 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1336 "was" if given == 1 and not kwonly_given else "were"))
1337
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001338def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001339 """Get the mapping of arguments to values.
1340
1341 A dict is returned, with keys the function argument names (including the
1342 names of the * and ** arguments, if any), and values the respective bound
1343 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001344 func = func_and_positional[0]
1345 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001346 spec = getfullargspec(func)
Pablo Galindod5d2b452019-04-30 02:01:14 +01001347 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001348 f_name = func.__name__
1349 arg2value = {}
1350
Benjamin Petersonb204a422011-06-05 22:04:07 -05001351
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001352 if ismethod(func) and func.__self__ is not None:
1353 # implicit 'self' (or 'cls' for classmethods) argument
1354 positional = (func.__self__,) + positional
1355 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001356 num_args = len(args)
1357 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001358
Benjamin Petersonb204a422011-06-05 22:04:07 -05001359 n = min(num_pos, num_args)
1360 for i in range(n):
Pablo Galindod5d2b452019-04-30 02:01:14 +01001361 arg2value[args[i]] = positional[i]
Benjamin Petersonb204a422011-06-05 22:04:07 -05001362 if varargs:
1363 arg2value[varargs] = tuple(positional[n:])
1364 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001365 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001366 arg2value[varkw] = {}
1367 for kw, value in named.items():
1368 if kw not in possible_kwargs:
1369 if not varkw:
1370 raise TypeError("%s() got an unexpected keyword argument %r" %
1371 (f_name, kw))
1372 arg2value[varkw][kw] = value
1373 continue
1374 if kw in arg2value:
1375 raise TypeError("%s() got multiple values for argument %r" %
1376 (f_name, kw))
1377 arg2value[kw] = value
1378 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001379 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1380 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001381 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001382 req = args[:num_args - num_defaults]
1383 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001384 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001385 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001386 for i, arg in enumerate(args[num_args - num_defaults:]):
1387 if arg not in arg2value:
1388 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001389 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001390 for kwarg in kwonlyargs:
1391 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001392 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001393 arg2value[kwarg] = kwonlydefaults[kwarg]
1394 else:
1395 missing += 1
1396 if missing:
1397 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001398 return arg2value
1399
Nick Coghlan2f92e542012-06-23 19:39:55 +10001400ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1401
1402def getclosurevars(func):
1403 """
1404 Get the mapping of free variables to their current values.
1405
Meador Inge8fda3592012-07-19 21:33:21 -05001406 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001407 and builtin references as seen by the body of the function. A final
1408 set of unbound names that could not be resolved is also provided.
1409 """
1410
1411 if ismethod(func):
1412 func = func.__func__
1413
1414 if not isfunction(func):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001415 raise TypeError("{!r} is not a Python function".format(func))
Nick Coghlan2f92e542012-06-23 19:39:55 +10001416
1417 code = func.__code__
1418 # Nonlocal references are named in co_freevars and resolved
1419 # by looking them up in __closure__ by positional index
1420 if func.__closure__ is None:
1421 nonlocal_vars = {}
1422 else:
1423 nonlocal_vars = {
1424 var : cell.cell_contents
1425 for var, cell in zip(code.co_freevars, func.__closure__)
1426 }
1427
1428 # Global and builtin references are named in co_names and resolved
1429 # by looking them up in __globals__ or __builtins__
1430 global_ns = func.__globals__
1431 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1432 if ismodule(builtin_ns):
1433 builtin_ns = builtin_ns.__dict__
1434 global_vars = {}
1435 builtin_vars = {}
1436 unbound_names = set()
1437 for name in code.co_names:
1438 if name in ("None", "True", "False"):
1439 # Because these used to be builtins instead of keywords, they
1440 # may still show up as name references. We ignore them.
1441 continue
1442 try:
1443 global_vars[name] = global_ns[name]
1444 except KeyError:
1445 try:
1446 builtin_vars[name] = builtin_ns[name]
1447 except KeyError:
1448 unbound_names.add(name)
1449
1450 return ClosureVars(nonlocal_vars, global_vars,
1451 builtin_vars, unbound_names)
1452
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001453# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001454
1455Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1456
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001457def getframeinfo(frame, context=1):
1458 """Get information about a frame or traceback object.
1459
1460 A tuple of five things is returned: the filename, the line number of
1461 the current line, the function name, a list of lines of context from
1462 the source code, and the index of the current line within that list.
1463 The optional second argument specifies the number of lines of context
1464 to return, which are centered around the current line."""
1465 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001466 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001467 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001468 else:
1469 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001470 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001471 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001472
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001473 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001474 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001475 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001476 try:
1477 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001478 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001479 lines = index = None
1480 else:
Raymond Hettingera0501712004-06-15 11:22:53 +00001481 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001482 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001483 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001484 else:
1485 lines = index = None
1486
Christian Heimes25bb7832008-01-11 16:17:00 +00001487 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001488
1489def getlineno(frame):
1490 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001491 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1492 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001493
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001494FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1495
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001496def getouterframes(frame, context=1):
1497 """Get a list of records for a frame and all higher (calling) frames.
1498
1499 Each record contains a frame object, filename, line number, function
1500 name, a list of lines of context, and index within the context."""
1501 framelist = []
1502 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001503 frameinfo = (frame,) + getframeinfo(frame, context)
1504 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001505 frame = frame.f_back
1506 return framelist
1507
1508def getinnerframes(tb, context=1):
1509 """Get a list of records for a traceback's frame and all lower frames.
1510
1511 Each record contains a frame object, filename, line number, function
1512 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001513 framelist = []
1514 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001515 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1516 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001517 tb = tb.tb_next
1518 return framelist
1519
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001520def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001521 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001522 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001523
1524def stack(context=1):
1525 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001526 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001527
1528def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001529 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001530 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001531
1532
1533# ------------------------------------------------ static version of getattr
1534
1535_sentinel = object()
1536
Michael Foorde5162652010-11-20 16:40:44 +00001537def _static_getmro(klass):
1538 return type.__dict__['__mro__'].__get__(klass)
1539
Michael Foord95fc51d2010-11-20 15:07:30 +00001540def _check_instance(obj, attr):
1541 instance_dict = {}
1542 try:
1543 instance_dict = object.__getattribute__(obj, "__dict__")
1544 except AttributeError:
1545 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001546 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001547
1548
1549def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001550 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001551 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001552 try:
1553 return entry.__dict__[attr]
1554 except KeyError:
1555 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001556 return _sentinel
1557
Michael Foord35184ed2010-11-20 16:58:30 +00001558def _is_type(obj):
1559 try:
1560 _static_getmro(obj)
1561 except TypeError:
1562 return False
1563 return True
1564
Michael Foorddcebe0f2011-03-15 19:20:44 -04001565def _shadowed_dict(klass):
1566 dict_attr = type.__dict__["__dict__"]
1567 for entry in _static_getmro(klass):
1568 try:
1569 class_dict = dict_attr.__get__(entry)["__dict__"]
1570 except KeyError:
1571 pass
1572 else:
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301573 if not (isinstance(class_dict, types.GetSetDescriptorType) and
Michael Foorddcebe0f2011-03-15 19:20:44 -04001574 class_dict.__name__ == "__dict__" and
1575 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001576 return class_dict
1577 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001578
1579def getattr_static(obj, attr, default=_sentinel):
1580 """Retrieve attributes without triggering dynamic lookup via the
1581 descriptor protocol, __getattr__ or __getattribute__.
1582
1583 Note: this function may not be able to retrieve all attributes
1584 that getattr can fetch (like dynamically created attributes)
1585 and may find attributes that getattr can't (like descriptors
1586 that raise AttributeError). It can also return descriptor objects
1587 instead of instance members in some cases. See the
1588 documentation for details.
1589 """
1590 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001591 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001592 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001593 dict_attr = _shadowed_dict(klass)
1594 if (dict_attr is _sentinel or
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301595 isinstance(dict_attr, types.MemberDescriptorType)):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001596 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001597 else:
1598 klass = obj
1599
1600 klass_result = _check_class(klass, attr)
1601
1602 if instance_result is not _sentinel and klass_result is not _sentinel:
1603 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1604 _check_class(type(klass_result), '__set__') is not _sentinel):
1605 return klass_result
1606
1607 if instance_result is not _sentinel:
1608 return instance_result
1609 if klass_result is not _sentinel:
1610 return klass_result
1611
1612 if obj is klass:
1613 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001614 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001615 if _shadowed_dict(type(entry)) is _sentinel:
1616 try:
1617 return entry.__dict__[attr]
1618 except KeyError:
1619 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001620 if default is not _sentinel:
1621 return default
1622 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001623
1624
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001625# ------------------------------------------------ generator introspection
1626
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001627GEN_CREATED = 'GEN_CREATED'
1628GEN_RUNNING = 'GEN_RUNNING'
1629GEN_SUSPENDED = 'GEN_SUSPENDED'
1630GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001631
1632def getgeneratorstate(generator):
1633 """Get current state of a generator-iterator.
1634
1635 Possible states are:
1636 GEN_CREATED: Waiting to start execution.
1637 GEN_RUNNING: Currently being executed by the interpreter.
1638 GEN_SUSPENDED: Currently suspended at a yield expression.
1639 GEN_CLOSED: Execution has completed.
1640 """
1641 if generator.gi_running:
1642 return GEN_RUNNING
1643 if generator.gi_frame is None:
1644 return GEN_CLOSED
1645 if generator.gi_frame.f_lasti == -1:
1646 return GEN_CREATED
1647 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001648
1649
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001650def getgeneratorlocals(generator):
1651 """
1652 Get the mapping of generator local variables to their current values.
1653
1654 A dict is returned, with the keys the local variable names and values the
1655 bound values."""
1656
1657 if not isgenerator(generator):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001658 raise TypeError("{!r} is not a Python generator".format(generator))
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001659
1660 frame = getattr(generator, "gi_frame", None)
1661 if frame is not None:
1662 return generator.gi_frame.f_locals
1663 else:
1664 return {}
1665
Yury Selivanov5376ba92015-06-22 12:19:30 -04001666
1667# ------------------------------------------------ coroutine introspection
1668
1669CORO_CREATED = 'CORO_CREATED'
1670CORO_RUNNING = 'CORO_RUNNING'
1671CORO_SUSPENDED = 'CORO_SUSPENDED'
1672CORO_CLOSED = 'CORO_CLOSED'
1673
1674def getcoroutinestate(coroutine):
1675 """Get current state of a coroutine object.
1676
1677 Possible states are:
1678 CORO_CREATED: Waiting to start execution.
1679 CORO_RUNNING: Currently being executed by the interpreter.
1680 CORO_SUSPENDED: Currently suspended at an await expression.
1681 CORO_CLOSED: Execution has completed.
1682 """
1683 if coroutine.cr_running:
1684 return CORO_RUNNING
1685 if coroutine.cr_frame is None:
1686 return CORO_CLOSED
1687 if coroutine.cr_frame.f_lasti == -1:
1688 return CORO_CREATED
1689 return CORO_SUSPENDED
1690
1691
1692def getcoroutinelocals(coroutine):
1693 """
1694 Get the mapping of coroutine local variables to their current values.
1695
1696 A dict is returned, with the keys the local variable names and values the
1697 bound values."""
1698 frame = getattr(coroutine, "cr_frame", None)
1699 if frame is not None:
1700 return frame.f_locals
1701 else:
1702 return {}
1703
1704
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001705###############################################################################
1706### Function Signature Object (PEP 362)
1707###############################################################################
1708
1709
1710_WrapperDescriptor = type(type.__call__)
1711_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001712_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001713
1714_NonUserDefinedCallables = (_WrapperDescriptor,
1715 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001716 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001717 types.BuiltinFunctionType)
1718
1719
Yury Selivanov421f0c72014-01-29 12:05:40 -05001720def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001721 """Private helper. Checks if ``cls`` has an attribute
1722 named ``method_name`` and returns it only if it is a
1723 pure python function.
1724 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001725 try:
1726 meth = getattr(cls, method_name)
1727 except AttributeError:
1728 return
1729 else:
1730 if not isinstance(meth, _NonUserDefinedCallables):
1731 # Once '__signature__' will be added to 'C'-level
1732 # callables, this check won't be necessary
1733 return meth
1734
1735
Yury Selivanov62560fb2014-01-28 12:26:24 -05001736def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001737 """Private helper to calculate how 'wrapped_sig' signature will
1738 look like after applying a 'functools.partial' object (or alike)
1739 on it.
1740 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001741
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001742 old_params = wrapped_sig.parameters
1743 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001744
1745 partial_args = partial.args or ()
1746 partial_keywords = partial.keywords or {}
1747
1748 if extra_args:
1749 partial_args = extra_args + partial_args
1750
1751 try:
1752 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1753 except TypeError as ex:
1754 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1755 raise ValueError(msg) from ex
1756
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001757
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001758 transform_to_kwonly = False
1759 for param_name, param in old_params.items():
1760 try:
1761 arg_value = ba.arguments[param_name]
1762 except KeyError:
1763 pass
1764 else:
1765 if param.kind is _POSITIONAL_ONLY:
1766 # If positional-only parameter is bound by partial,
1767 # it effectively disappears from the signature
1768 new_params.pop(param_name)
1769 continue
1770
1771 if param.kind is _POSITIONAL_OR_KEYWORD:
1772 if param_name in partial_keywords:
1773 # This means that this parameter, and all parameters
1774 # after it should be keyword-only (and var-positional
1775 # should be removed). Here's why. Consider the following
1776 # function:
1777 # foo(a, b, *args, c):
1778 # pass
1779 #
1780 # "partial(foo, a='spam')" will have the following
1781 # signature: "(*, a='spam', b, c)". Because attempting
1782 # to call that partial with "(10, 20)" arguments will
1783 # raise a TypeError, saying that "a" argument received
1784 # multiple values.
1785 transform_to_kwonly = True
1786 # Set the new default value
1787 new_params[param_name] = param.replace(default=arg_value)
1788 else:
1789 # was passed as a positional argument
1790 new_params.pop(param.name)
1791 continue
1792
1793 if param.kind is _KEYWORD_ONLY:
1794 # Set the new default value
1795 new_params[param_name] = param.replace(default=arg_value)
1796
1797 if transform_to_kwonly:
1798 assert param.kind is not _POSITIONAL_ONLY
1799
1800 if param.kind is _POSITIONAL_OR_KEYWORD:
1801 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1802 new_params[param_name] = new_param
1803 new_params.move_to_end(param_name)
1804 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
1805 new_params.move_to_end(param_name)
1806 elif param.kind is _VAR_POSITIONAL:
1807 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001808
1809 return wrapped_sig.replace(parameters=new_params.values())
1810
1811
Yury Selivanov62560fb2014-01-28 12:26:24 -05001812def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001813 """Private helper to transform signatures for unbound
1814 functions to bound methods.
1815 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001816
1817 params = tuple(sig.parameters.values())
1818
1819 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1820 raise ValueError('invalid method signature')
1821
1822 kind = params[0].kind
1823 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1824 # Drop first parameter:
1825 # '(p1, p2[, ...])' -> '(p2[, ...])'
1826 params = params[1:]
1827 else:
1828 if kind is not _VAR_POSITIONAL:
1829 # Unless we add a new parameter type we never
1830 # get here
1831 raise ValueError('invalid argument type')
1832 # It's a var-positional parameter.
1833 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1834
1835 return sig.replace(parameters=params)
1836
1837
Yury Selivanovb77511d2014-01-29 10:46:14 -05001838def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001839 """Private helper to test if `obj` is a callable that might
1840 support Argument Clinic's __text_signature__ protocol.
1841 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001842 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001843 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001844 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001845 # Can't test 'isinstance(type)' here, as it would
1846 # also be True for regular python classes
1847 obj in (type, object))
1848
1849
Yury Selivanov63da7c72014-01-31 14:48:37 -05001850def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001851 """Private helper to test if `obj` is a duck type of FunctionType.
1852 A good example of such objects are functions compiled with
1853 Cython, which have all attributes that a pure Python function
1854 would have, but have their code statically compiled.
1855 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001856
1857 if not callable(obj) or isclass(obj):
1858 # All function-like objects are obviously callables,
1859 # and not classes.
1860 return False
1861
1862 name = getattr(obj, '__name__', None)
1863 code = getattr(obj, '__code__', None)
1864 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1865 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1866 annotations = getattr(obj, '__annotations__', None)
1867
1868 return (isinstance(code, types.CodeType) and
1869 isinstance(name, str) and
1870 (defaults is None or isinstance(defaults, tuple)) and
1871 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1872 isinstance(annotations, dict))
1873
1874
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001875def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001876 """ Private helper to get first parameter name from a
1877 __text_signature__ of a builtin method, which should
1878 be in the following format: '($param1, ...)'.
1879 Assumptions are that the first argument won't have
1880 a default value or an annotation.
1881 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001882
1883 assert spec.startswith('($')
1884
1885 pos = spec.find(',')
1886 if pos == -1:
1887 pos = spec.find(')')
1888
1889 cpos = spec.find(':')
1890 assert cpos == -1 or cpos > pos
1891
1892 cpos = spec.find('=')
1893 assert cpos == -1 or cpos > pos
1894
1895 return spec[2:pos]
1896
1897
Larry Hastings2623c8c2014-02-08 22:15:29 -08001898def _signature_strip_non_python_syntax(signature):
1899 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001900 Private helper function. Takes a signature in Argument Clinic's
1901 extended signature format.
1902
Larry Hastings2623c8c2014-02-08 22:15:29 -08001903 Returns a tuple of three things:
1904 * that signature re-rendered in standard Python syntax,
1905 * the index of the "self" parameter (generally 0), or None if
1906 the function does not have a "self" parameter, and
1907 * the index of the last "positional only" parameter,
1908 or None if the signature has no positional-only parameters.
1909 """
1910
1911 if not signature:
1912 return signature, None, None
1913
1914 self_parameter = None
1915 last_positional_only = None
1916
1917 lines = [l.encode('ascii') for l in signature.split('\n')]
1918 generator = iter(lines).__next__
1919 token_stream = tokenize.tokenize(generator)
1920
1921 delayed_comma = False
1922 skip_next_comma = False
1923 text = []
1924 add = text.append
1925
1926 current_parameter = 0
1927 OP = token.OP
1928 ERRORTOKEN = token.ERRORTOKEN
1929
1930 # token stream always starts with ENCODING token, skip it
1931 t = next(token_stream)
1932 assert t.type == tokenize.ENCODING
1933
1934 for t in token_stream:
1935 type, string = t.type, t.string
1936
1937 if type == OP:
1938 if string == ',':
1939 if skip_next_comma:
1940 skip_next_comma = False
1941 else:
1942 assert not delayed_comma
1943 delayed_comma = True
1944 current_parameter += 1
1945 continue
1946
1947 if string == '/':
1948 assert not skip_next_comma
1949 assert last_positional_only is None
1950 skip_next_comma = True
1951 last_positional_only = current_parameter - 1
1952 continue
1953
1954 if (type == ERRORTOKEN) and (string == '$'):
1955 assert self_parameter is None
1956 self_parameter = current_parameter
1957 continue
1958
1959 if delayed_comma:
1960 delayed_comma = False
1961 if not ((type == OP) and (string == ')')):
1962 add(', ')
1963 add(string)
1964 if (string == ','):
1965 add(' ')
1966 clean_signature = ''.join(text)
1967 return clean_signature, self_parameter, last_positional_only
1968
1969
Yury Selivanov57d240e2014-02-19 16:27:23 -05001970def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001971 """Private helper to parse content of '__text_signature__'
1972 and return a Signature based on it.
1973 """
INADA Naoki37420de2018-01-27 10:10:06 +09001974 # Lazy import ast because it's relatively heavy and
1975 # it's not used for other than this function.
1976 import ast
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001977
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001978 Parameter = cls._parameter_cls
1979
Larry Hastings2623c8c2014-02-08 22:15:29 -08001980 clean_signature, self_parameter, last_positional_only = \
1981 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001982
Larry Hastings2623c8c2014-02-08 22:15:29 -08001983 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001984
1985 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001986 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001987 except SyntaxError:
1988 module = None
1989
1990 if not isinstance(module, ast.Module):
1991 raise ValueError("{!r} builtin has invalid signature".format(obj))
1992
1993 f = module.body[0]
1994
1995 parameters = []
1996 empty = Parameter.empty
1997 invalid = object()
1998
1999 module = None
2000 module_dict = {}
2001 module_name = getattr(obj, '__module__', None)
2002 if module_name:
2003 module = sys.modules.get(module_name, None)
2004 if module:
2005 module_dict = module.__dict__
INADA Naoki6f85b822018-10-05 01:47:09 +09002006 sys_module_dict = sys.modules.copy()
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002007
2008 def parse_name(node):
2009 assert isinstance(node, ast.arg)
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05302010 if node.annotation is not None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002011 raise ValueError("Annotations are not currently supported")
2012 return node.arg
2013
2014 def wrap_value(s):
2015 try:
2016 value = eval(s, module_dict)
2017 except NameError:
2018 try:
2019 value = eval(s, sys_module_dict)
2020 except NameError:
2021 raise RuntimeError()
2022
Serhiy Storchaka3f228112018-09-27 17:42:37 +03002023 if isinstance(value, (str, int, float, bytes, bool, type(None))):
2024 return ast.Constant(value)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002025 raise RuntimeError()
2026
2027 class RewriteSymbolics(ast.NodeTransformer):
2028 def visit_Attribute(self, node):
2029 a = []
2030 n = node
2031 while isinstance(n, ast.Attribute):
2032 a.append(n.attr)
2033 n = n.value
2034 if not isinstance(n, ast.Name):
2035 raise RuntimeError()
2036 a.append(n.id)
2037 value = ".".join(reversed(a))
2038 return wrap_value(value)
2039
2040 def visit_Name(self, node):
2041 if not isinstance(node.ctx, ast.Load):
2042 raise ValueError()
2043 return wrap_value(node.id)
2044
2045 def p(name_node, default_node, default=empty):
2046 name = parse_name(name_node)
2047 if name is invalid:
2048 return None
2049 if default_node and default_node is not _empty:
2050 try:
2051 default_node = RewriteSymbolics().visit(default_node)
2052 o = ast.literal_eval(default_node)
2053 except ValueError:
2054 o = invalid
2055 if o is invalid:
2056 return None
2057 default = o if o is not invalid else default
2058 parameters.append(Parameter(name, kind, default=default, annotation=empty))
2059
2060 # non-keyword-only parameters
2061 args = reversed(f.args.args)
2062 defaults = reversed(f.args.defaults)
2063 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002064 if last_positional_only is not None:
2065 kind = Parameter.POSITIONAL_ONLY
2066 else:
2067 kind = Parameter.POSITIONAL_OR_KEYWORD
2068 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002069 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002070 if i == last_positional_only:
2071 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002072
2073 # *args
2074 if f.args.vararg:
2075 kind = Parameter.VAR_POSITIONAL
2076 p(f.args.vararg, empty)
2077
2078 # keyword-only arguments
2079 kind = Parameter.KEYWORD_ONLY
2080 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
2081 p(name, default)
2082
2083 # **kwargs
2084 if f.args.kwarg:
2085 kind = Parameter.VAR_KEYWORD
2086 p(f.args.kwarg, empty)
2087
Larry Hastings2623c8c2014-02-08 22:15:29 -08002088 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002089 # Possibly strip the bound argument:
2090 # - We *always* strip first bound argument if
2091 # it is a module.
2092 # - We don't strip first bound argument if
2093 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002094 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002095 _self = getattr(obj, '__self__', None)
2096 self_isbound = _self is not None
2097 self_ismodule = ismodule(_self)
2098 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002099 parameters.pop(0)
2100 else:
2101 # for builtins, self parameter is always positional-only!
2102 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2103 parameters[0] = p
2104
2105 return cls(parameters, return_annotation=cls.empty)
2106
2107
Yury Selivanov57d240e2014-02-19 16:27:23 -05002108def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002109 """Private helper function to get signature for
2110 builtin callables.
2111 """
2112
Yury Selivanov57d240e2014-02-19 16:27:23 -05002113 if not _signature_is_builtin(func):
2114 raise TypeError("{!r} is not a Python builtin "
2115 "function".format(func))
2116
2117 s = getattr(func, "__text_signature__", None)
2118 if not s:
2119 raise ValueError("no signature found for builtin {!r}".format(func))
2120
2121 return _signature_fromstr(cls, func, s, skip_bound_arg)
2122
2123
Yury Selivanovcf45f022015-05-20 14:38:50 -04002124def _signature_from_function(cls, func):
2125 """Private helper: constructs Signature for the given python function."""
2126
2127 is_duck_function = False
2128 if not isfunction(func):
2129 if _signature_is_functionlike(func):
2130 is_duck_function = True
2131 else:
2132 # If it's not a pure Python function, and not a duck type
2133 # of pure function:
2134 raise TypeError('{!r} is not a Python function'.format(func))
2135
2136 Parameter = cls._parameter_cls
2137
2138 # Parameter information.
2139 func_code = func.__code__
2140 pos_count = func_code.co_argcount
2141 arg_names = func_code.co_varnames
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002142 posonly_count = func_code.co_posonlyargcount
2143 positional_count = posonly_count + pos_count
2144 positional_only = tuple(arg_names[:posonly_count])
2145 positional = tuple(arg_names[posonly_count:positional_count])
Yury Selivanovcf45f022015-05-20 14:38:50 -04002146 keyword_only_count = func_code.co_kwonlyargcount
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002147 keyword_only = arg_names[positional_count:(positional_count + keyword_only_count)]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002148 annotations = func.__annotations__
2149 defaults = func.__defaults__
2150 kwdefaults = func.__kwdefaults__
2151
2152 if defaults:
2153 pos_default_count = len(defaults)
2154 else:
2155 pos_default_count = 0
2156
2157 parameters = []
2158
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002159 non_default_count = positional_count - pos_default_count
2160 all_positional = positional_only + positional
2161
2162 posonly_left = posonly_count
2163
Yury Selivanovcf45f022015-05-20 14:38:50 -04002164 # Non-keyword-only parameters w/o defaults.
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002165 for name in all_positional[:non_default_count]:
2166 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002167 annotation = annotations.get(name, _empty)
2168 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002169 kind=kind))
2170 if posonly_left:
2171 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002172
2173 # ... w/ defaults.
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002174 for offset, name in enumerate(all_positional[non_default_count:]):
2175 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002176 annotation = annotations.get(name, _empty)
2177 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002178 kind=kind,
Yury Selivanovcf45f022015-05-20 14:38:50 -04002179 default=defaults[offset]))
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002180 if posonly_left:
2181 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002182
2183 # *args
2184 if func_code.co_flags & CO_VARARGS:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002185 name = arg_names[positional_count + keyword_only_count]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002186 annotation = annotations.get(name, _empty)
2187 parameters.append(Parameter(name, annotation=annotation,
2188 kind=_VAR_POSITIONAL))
2189
2190 # Keyword-only parameters.
2191 for name in keyword_only:
2192 default = _empty
2193 if kwdefaults is not None:
2194 default = kwdefaults.get(name, _empty)
2195
2196 annotation = annotations.get(name, _empty)
2197 parameters.append(Parameter(name, annotation=annotation,
2198 kind=_KEYWORD_ONLY,
2199 default=default))
2200 # **kwargs
2201 if func_code.co_flags & CO_VARKEYWORDS:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002202 index = positional_count + keyword_only_count
Yury Selivanovcf45f022015-05-20 14:38:50 -04002203 if func_code.co_flags & CO_VARARGS:
2204 index += 1
2205
2206 name = arg_names[index]
2207 annotation = annotations.get(name, _empty)
2208 parameters.append(Parameter(name, annotation=annotation,
2209 kind=_VAR_KEYWORD))
2210
2211 # Is 'func' is a pure Python function - don't validate the
2212 # parameters list (for correct order and defaults), it should be OK.
2213 return cls(parameters,
2214 return_annotation=annotations.get('return', _empty),
2215 __validate_parameters__=is_duck_function)
2216
2217
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002218def _signature_from_callable(obj, *,
2219 follow_wrapper_chains=True,
2220 skip_bound_arg=True,
2221 sigcls):
2222
2223 """Private helper function to get signature for arbitrary
2224 callable objects.
2225 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002226
2227 if not callable(obj):
2228 raise TypeError('{!r} is not a callable object'.format(obj))
2229
2230 if isinstance(obj, types.MethodType):
2231 # In this case we skip the first parameter of the underlying
2232 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002233 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002234 obj.__func__,
2235 follow_wrapper_chains=follow_wrapper_chains,
2236 skip_bound_arg=skip_bound_arg,
2237 sigcls=sigcls)
2238
Yury Selivanov57d240e2014-02-19 16:27:23 -05002239 if skip_bound_arg:
2240 return _signature_bound_method(sig)
2241 else:
2242 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002243
Nick Coghlane8c45d62013-07-28 20:00:01 +10002244 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05002245 if follow_wrapper_chains:
2246 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Yury Selivanov46c759d2015-05-27 21:56:53 -04002247 if isinstance(obj, types.MethodType):
2248 # If the unwrapped object is a *method*, we might want to
2249 # skip its first parameter (self).
2250 # See test_signature_wrapped_bound_method for details.
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002251 return _signature_from_callable(
Yury Selivanov46c759d2015-05-27 21:56:53 -04002252 obj,
2253 follow_wrapper_chains=follow_wrapper_chains,
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002254 skip_bound_arg=skip_bound_arg,
2255 sigcls=sigcls)
Nick Coghlane8c45d62013-07-28 20:00:01 +10002256
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002257 try:
2258 sig = obj.__signature__
2259 except AttributeError:
2260 pass
2261 else:
2262 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07002263 if not isinstance(sig, Signature):
2264 raise TypeError(
2265 'unexpected object {!r} in __signature__ '
2266 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002267 return sig
2268
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002269 try:
2270 partialmethod = obj._partialmethod
2271 except AttributeError:
2272 pass
2273 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05002274 if isinstance(partialmethod, functools.partialmethod):
2275 # Unbound partialmethod (see functools.partialmethod)
2276 # This means, that we need to calculate the signature
2277 # as if it's a regular partial object, but taking into
2278 # account that the first positional argument
2279 # (usually `self`, or `cls`) will not be passed
2280 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002281
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002282 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002283 partialmethod.func,
2284 follow_wrapper_chains=follow_wrapper_chains,
2285 skip_bound_arg=skip_bound_arg,
2286 sigcls=sigcls)
2287
Yury Selivanov0486f812014-01-29 12:18:59 -05002288 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanov0486f812014-01-29 12:18:59 -05002289 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
Dong-hee Na378d7062017-05-18 04:00:51 +09002290 if first_wrapped_param.kind is Parameter.VAR_POSITIONAL:
2291 # First argument of the wrapped callable is `*args`, as in
2292 # `partialmethod(lambda *args)`.
2293 return sig
2294 else:
2295 sig_params = tuple(sig.parameters.values())
Yury Selivanov8a387212018-03-06 12:59:45 -05002296 assert (not sig_params or
2297 first_wrapped_param is not sig_params[0])
Dong-hee Na378d7062017-05-18 04:00:51 +09002298 new_params = (first_wrapped_param,) + sig_params
2299 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002300
Yury Selivanov63da7c72014-01-31 14:48:37 -05002301 if isfunction(obj) or _signature_is_functionlike(obj):
2302 # If it's a pure Python function, or an object that is duck type
2303 # of a Python function (Cython functions, for instance), then:
Yury Selivanovcf45f022015-05-20 14:38:50 -04002304 return _signature_from_function(sigcls, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002305
Yury Selivanova773de02014-02-21 18:30:53 -05002306 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04002307 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05002308 skip_bound_arg=skip_bound_arg)
2309
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002310 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002311 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002312 obj.func,
2313 follow_wrapper_chains=follow_wrapper_chains,
2314 skip_bound_arg=skip_bound_arg,
2315 sigcls=sigcls)
Yury Selivanov62560fb2014-01-28 12:26:24 -05002316 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002317
2318 sig = None
2319 if isinstance(obj, type):
2320 # obj is a class or a metaclass
2321
2322 # First, let's see if it has an overloaded __call__ defined
2323 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002324 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002325 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002326 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002327 call,
2328 follow_wrapper_chains=follow_wrapper_chains,
2329 skip_bound_arg=skip_bound_arg,
2330 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002331 else:
2332 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002333 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002334 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002335 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002336 new,
2337 follow_wrapper_chains=follow_wrapper_chains,
2338 skip_bound_arg=skip_bound_arg,
2339 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002340 else:
2341 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002342 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002343 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002344 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002345 init,
2346 follow_wrapper_chains=follow_wrapper_chains,
2347 skip_bound_arg=skip_bound_arg,
2348 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002349
2350 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002351 # At this point we know, that `obj` is a class, with no user-
2352 # defined '__init__', '__new__', or class-level '__call__'
2353
Larry Hastings2623c8c2014-02-08 22:15:29 -08002354 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002355 # Since '__text_signature__' is implemented as a
2356 # descriptor that extracts text signature from the
2357 # class docstring, if 'obj' is derived from a builtin
2358 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002359 # Therefore, we go through the MRO (except the last
2360 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002361 # class with non-empty text signature.
2362 try:
2363 text_sig = base.__text_signature__
2364 except AttributeError:
2365 pass
2366 else:
2367 if text_sig:
2368 # If 'obj' class has a __text_signature__ attribute:
2369 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002370 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002371
2372 # No '__text_signature__' was found for the 'obj' class.
2373 # Last option is to check if its '__init__' is
2374 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002375 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002376 # We have a class (not metaclass), but no user-defined
2377 # __init__ or __new__ for it
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002378 if (obj.__init__ is object.__init__ and
2379 obj.__new__ is object.__new__):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002380 # Return a signature of 'object' builtin.
2381 return signature(object)
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002382 else:
2383 raise ValueError(
2384 'no signature found for builtin type {!r}'.format(obj))
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002385
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002386 elif not isinstance(obj, _NonUserDefinedCallables):
2387 # An object with __call__
2388 # We also check that the 'obj' is not an instance of
2389 # _WrapperDescriptor or _MethodWrapper to avoid
2390 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002391 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002392 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002393 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002394 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002395 call,
2396 follow_wrapper_chains=follow_wrapper_chains,
2397 skip_bound_arg=skip_bound_arg,
2398 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002399 except ValueError as ex:
2400 msg = 'no signature found for {!r}'.format(obj)
2401 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002402
2403 if sig is not None:
2404 # For classes and objects we skip the first parameter of their
2405 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002406 if skip_bound_arg:
2407 return _signature_bound_method(sig)
2408 else:
2409 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002410
2411 if isinstance(obj, types.BuiltinFunctionType):
2412 # Raise a nicer error message for builtins
2413 msg = 'no signature found for builtin function {!r}'.format(obj)
2414 raise ValueError(msg)
2415
2416 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2417
2418
2419class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002420 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002421
2422
2423class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002424 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002425
2426
Yury Selivanov21e83a52014-03-27 11:23:13 -04002427class _ParameterKind(enum.IntEnum):
2428 POSITIONAL_ONLY = 0
2429 POSITIONAL_OR_KEYWORD = 1
2430 VAR_POSITIONAL = 2
2431 KEYWORD_ONLY = 3
2432 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002433
2434 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002435 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002436
Dong-hee Na4aa30062018-06-08 12:46:31 +09002437 @property
2438 def description(self):
2439 return _PARAM_NAME_MAPPING[self]
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002440
Yury Selivanov21e83a52014-03-27 11:23:13 -04002441_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2442_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2443_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2444_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2445_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002446
Dong-hee Naa9cab432018-05-30 00:04:08 +09002447_PARAM_NAME_MAPPING = {
2448 _POSITIONAL_ONLY: 'positional-only',
2449 _POSITIONAL_OR_KEYWORD: 'positional or keyword',
2450 _VAR_POSITIONAL: 'variadic positional',
2451 _KEYWORD_ONLY: 'keyword-only',
2452 _VAR_KEYWORD: 'variadic keyword'
2453}
2454
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002455
2456class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002457 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002458
2459 Has the following public attributes:
2460
2461 * name : str
2462 The name of the parameter as a string.
2463 * default : object
2464 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002465 parameter has no default value, this attribute is set to
2466 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002467 * annotation
2468 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002469 parameter has no annotation, this attribute is set to
2470 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002471 * kind : str
2472 Describes how argument values are bound to the parameter.
2473 Possible values: `Parameter.POSITIONAL_ONLY`,
2474 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2475 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002476 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002477
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002478 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002479
2480 POSITIONAL_ONLY = _POSITIONAL_ONLY
2481 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2482 VAR_POSITIONAL = _VAR_POSITIONAL
2483 KEYWORD_ONLY = _KEYWORD_ONLY
2484 VAR_KEYWORD = _VAR_KEYWORD
2485
2486 empty = _empty
2487
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002488 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002489 try:
2490 self._kind = _ParameterKind(kind)
2491 except ValueError:
2492 raise ValueError(f'value {kind!r} is not a valid Parameter.kind')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002493 if default is not _empty:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002494 if self._kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2495 msg = '{} parameters cannot have default values'
Dong-hee Na4aa30062018-06-08 12:46:31 +09002496 msg = msg.format(self._kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002497 raise ValueError(msg)
2498 self._default = default
2499 self._annotation = annotation
2500
Yury Selivanov2393dca2014-01-27 15:07:58 -05002501 if name is _empty:
2502 raise ValueError('name is a required attribute for Parameter')
2503
2504 if not isinstance(name, str):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002505 msg = 'name must be a str, not a {}'.format(type(name).__name__)
2506 raise TypeError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002507
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002508 if name[0] == '.' and name[1:].isdigit():
2509 # These are implicit arguments generated by comprehensions. In
2510 # order to provide a friendlier interface to users, we recast
2511 # their name as "implicitN" and treat them as positional-only.
2512 # See issue 19611.
Dong-hee Naa9cab432018-05-30 00:04:08 +09002513 if self._kind != _POSITIONAL_OR_KEYWORD:
2514 msg = (
2515 'implicit arguments must be passed as '
2516 'positional or keyword arguments, not {}'
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002517 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002518 msg = msg.format(self._kind.description)
Dong-hee Naa9cab432018-05-30 00:04:08 +09002519 raise ValueError(msg)
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002520 self._kind = _POSITIONAL_ONLY
2521 name = 'implicit{}'.format(name[1:])
2522
Yury Selivanov2393dca2014-01-27 15:07:58 -05002523 if not name.isidentifier():
2524 raise ValueError('{!r} is not a valid parameter name'.format(name))
2525
2526 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002527
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002528 def __reduce__(self):
2529 return (type(self),
2530 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002531 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002532 '_annotation': self._annotation})
2533
2534 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002535 self._default = state['_default']
2536 self._annotation = state['_annotation']
2537
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002538 @property
2539 def name(self):
2540 return self._name
2541
2542 @property
2543 def default(self):
2544 return self._default
2545
2546 @property
2547 def annotation(self):
2548 return self._annotation
2549
2550 @property
2551 def kind(self):
2552 return self._kind
2553
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002554 def replace(self, *, name=_void, kind=_void,
2555 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002556 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002557
2558 if name is _void:
2559 name = self._name
2560
2561 if kind is _void:
2562 kind = self._kind
2563
2564 if annotation is _void:
2565 annotation = self._annotation
2566
2567 if default is _void:
2568 default = self._default
2569
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002570 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002571
2572 def __str__(self):
2573 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002574 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002575
2576 # Add annotation and default value
2577 if self._annotation is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002578 formatted = '{}: {}'.format(formatted,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002579 formatannotation(self._annotation))
2580
2581 if self._default is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002582 if self._annotation is not _empty:
2583 formatted = '{} = {}'.format(formatted, repr(self._default))
2584 else:
2585 formatted = '{}={}'.format(formatted, repr(self._default))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002586
2587 if kind == _VAR_POSITIONAL:
2588 formatted = '*' + formatted
2589 elif kind == _VAR_KEYWORD:
2590 formatted = '**' + formatted
2591
2592 return formatted
2593
2594 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002595 return '<{} "{}">'.format(self.__class__.__name__, self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002596
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002597 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002598 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002599
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002600 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002601 if self is other:
2602 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002603 if not isinstance(other, Parameter):
2604 return NotImplemented
2605 return (self._name == other._name and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002606 self._kind == other._kind and
2607 self._default == other._default and
2608 self._annotation == other._annotation)
2609
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002610
2611class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002612 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002613 to the function's parameters.
2614
2615 Has the following public attributes:
2616
2617 * arguments : OrderedDict
2618 An ordered mutable mapping of parameters' names to arguments' values.
2619 Does not contain arguments' default values.
2620 * signature : Signature
2621 The Signature object that created this instance.
2622 * args : tuple
2623 Tuple of positional arguments values.
2624 * kwargs : dict
2625 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002626 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002627
Yury Selivanov6abe0322015-05-13 17:18:41 -04002628 __slots__ = ('arguments', '_signature', '__weakref__')
2629
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002630 def __init__(self, signature, arguments):
2631 self.arguments = arguments
2632 self._signature = signature
2633
2634 @property
2635 def signature(self):
2636 return self._signature
2637
2638 @property
2639 def args(self):
2640 args = []
2641 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002642 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002643 break
2644
2645 try:
2646 arg = self.arguments[param_name]
2647 except KeyError:
2648 # We're done here. Other arguments
2649 # will be mapped in 'BoundArguments.kwargs'
2650 break
2651 else:
2652 if param.kind == _VAR_POSITIONAL:
2653 # *args
2654 args.extend(arg)
2655 else:
2656 # plain argument
2657 args.append(arg)
2658
2659 return tuple(args)
2660
2661 @property
2662 def kwargs(self):
2663 kwargs = {}
2664 kwargs_started = False
2665 for param_name, param in self._signature.parameters.items():
2666 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002667 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002668 kwargs_started = True
2669 else:
2670 if param_name not in self.arguments:
2671 kwargs_started = True
2672 continue
2673
2674 if not kwargs_started:
2675 continue
2676
2677 try:
2678 arg = self.arguments[param_name]
2679 except KeyError:
2680 pass
2681 else:
2682 if param.kind == _VAR_KEYWORD:
2683 # **kwargs
2684 kwargs.update(arg)
2685 else:
2686 # plain keyword argument
2687 kwargs[param_name] = arg
2688
2689 return kwargs
2690
Yury Selivanovb907a512015-05-16 13:45:09 -04002691 def apply_defaults(self):
2692 """Set default values for missing arguments.
2693
2694 For variable-positional arguments (*args) the default is an
2695 empty tuple.
2696
2697 For variable-keyword arguments (**kwargs) the default is an
2698 empty dict.
2699 """
2700 arguments = self.arguments
Yury Selivanovb907a512015-05-16 13:45:09 -04002701 new_arguments = []
2702 for name, param in self._signature.parameters.items():
2703 try:
2704 new_arguments.append((name, arguments[name]))
2705 except KeyError:
2706 if param.default is not _empty:
2707 val = param.default
2708 elif param.kind is _VAR_POSITIONAL:
2709 val = ()
2710 elif param.kind is _VAR_KEYWORD:
2711 val = {}
2712 else:
2713 # This BoundArguments was likely produced by
2714 # Signature.bind_partial().
2715 continue
2716 new_arguments.append((name, val))
2717 self.arguments = OrderedDict(new_arguments)
2718
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002719 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002720 if self is other:
2721 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002722 if not isinstance(other, BoundArguments):
2723 return NotImplemented
2724 return (self.signature == other.signature and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002725 self.arguments == other.arguments)
2726
Yury Selivanov6abe0322015-05-13 17:18:41 -04002727 def __setstate__(self, state):
2728 self._signature = state['_signature']
2729 self.arguments = state['arguments']
2730
2731 def __getstate__(self):
2732 return {'_signature': self._signature, 'arguments': self.arguments}
2733
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002734 def __repr__(self):
2735 args = []
2736 for arg, value in self.arguments.items():
2737 args.append('{}={!r}'.format(arg, value))
Yury Selivanovf229bc52015-05-15 12:53:56 -04002738 return '<{} ({})>'.format(self.__class__.__name__, ', '.join(args))
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002739
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002740
2741class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002742 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002743 It stores a Parameter object for each parameter accepted by the
2744 function, as well as information specific to the function itself.
2745
2746 A Signature object has the following public attributes and methods:
2747
2748 * parameters : OrderedDict
2749 An ordered mapping of parameters' names to the corresponding
2750 Parameter objects (keyword-only arguments are in the same order
2751 as listed in `code.co_varnames`).
2752 * return_annotation : object
2753 The annotation for the return type of the function if specified.
2754 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002755 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002756 * bind(*args, **kwargs) -> BoundArguments
2757 Creates a mapping from positional and keyword arguments to
2758 parameters.
2759 * bind_partial(*args, **kwargs) -> BoundArguments
2760 Creates a partial mapping from positional and keyword arguments
2761 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002762 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002763
2764 __slots__ = ('_return_annotation', '_parameters')
2765
2766 _parameter_cls = Parameter
2767 _bound_arguments_cls = BoundArguments
2768
2769 empty = _empty
2770
2771 def __init__(self, parameters=None, *, return_annotation=_empty,
2772 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002773 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002774 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002775 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002776
2777 if parameters is None:
2778 params = OrderedDict()
2779 else:
2780 if __validate_parameters__:
2781 params = OrderedDict()
2782 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002783 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002784
2785 for idx, param in enumerate(parameters):
2786 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002787 name = param.name
2788
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002789 if kind < top_kind:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002790 msg = (
2791 'wrong parameter order: {} parameter before {} '
2792 'parameter'
2793 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002794 msg = msg.format(top_kind.description,
2795 kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002796 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002797 elif kind > top_kind:
2798 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002799 top_kind = kind
2800
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002801 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002802 if param.default is _empty:
2803 if kind_defaults:
2804 # No default for this parameter, but the
2805 # previous parameter of the same kind had
2806 # a default
2807 msg = 'non-default argument follows default ' \
2808 'argument'
2809 raise ValueError(msg)
2810 else:
2811 # There is a default for this parameter.
2812 kind_defaults = True
2813
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002814 if name in params:
2815 msg = 'duplicate parameter name: {!r}'.format(name)
2816 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002817
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002818 params[name] = param
2819 else:
2820 params = OrderedDict(((param.name, param)
2821 for param in parameters))
2822
2823 self._parameters = types.MappingProxyType(params)
2824 self._return_annotation = return_annotation
2825
2826 @classmethod
2827 def from_function(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002828 """Constructs Signature for the given python function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002829
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002830 Deprecated since Python 3.5, use `Signature.from_callable()`.
2831 """
2832
2833 warnings.warn("inspect.Signature.from_function() is deprecated since "
2834 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002835 DeprecationWarning, stacklevel=2)
Yury Selivanovcf45f022015-05-20 14:38:50 -04002836 return _signature_from_function(cls, func)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002837
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002838 @classmethod
2839 def from_builtin(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002840 """Constructs Signature for the given builtin function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002841
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002842 Deprecated since Python 3.5, use `Signature.from_callable()`.
2843 """
2844
2845 warnings.warn("inspect.Signature.from_builtin() is deprecated since "
2846 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002847 DeprecationWarning, stacklevel=2)
Yury Selivanov57d240e2014-02-19 16:27:23 -05002848 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002849
Yury Selivanovda396452014-03-27 12:09:24 -04002850 @classmethod
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002851 def from_callable(cls, obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002852 """Constructs Signature for the given callable object."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002853 return _signature_from_callable(obj, sigcls=cls,
2854 follow_wrapper_chains=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002855
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002856 @property
2857 def parameters(self):
2858 return self._parameters
2859
2860 @property
2861 def return_annotation(self):
2862 return self._return_annotation
2863
2864 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002865 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002866 Pass 'parameters' and/or 'return_annotation' arguments
2867 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002868 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002869
2870 if parameters is _void:
2871 parameters = self.parameters.values()
2872
2873 if return_annotation is _void:
2874 return_annotation = self._return_annotation
2875
2876 return type(self)(parameters,
2877 return_annotation=return_annotation)
2878
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002879 def _hash_basis(self):
2880 params = tuple(param for param in self.parameters.values()
2881 if param.kind != _KEYWORD_ONLY)
2882
2883 kwo_params = {param.name: param for param in self.parameters.values()
2884 if param.kind == _KEYWORD_ONLY}
2885
2886 return params, kwo_params, self.return_annotation
2887
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002888 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002889 params, kwo_params, return_annotation = self._hash_basis()
2890 kwo_params = frozenset(kwo_params.values())
2891 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002892
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002893 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002894 if self is other:
2895 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002896 if not isinstance(other, Signature):
2897 return NotImplemented
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002898 return self._hash_basis() == other._hash_basis()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002899
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002900 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002901 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002902
2903 arguments = OrderedDict()
2904
2905 parameters = iter(self.parameters.values())
2906 parameters_ex = ()
2907 arg_vals = iter(args)
2908
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002909 while True:
2910 # Let's iterate through the positional arguments and corresponding
2911 # parameters
2912 try:
2913 arg_val = next(arg_vals)
2914 except StopIteration:
2915 # No more positional arguments
2916 try:
2917 param = next(parameters)
2918 except StopIteration:
2919 # No more parameters. That's it. Just need to check that
2920 # we have no `kwargs` after this while loop
2921 break
2922 else:
2923 if param.kind == _VAR_POSITIONAL:
2924 # That's OK, just empty *args. Let's start parsing
2925 # kwargs
2926 break
2927 elif param.name in kwargs:
2928 if param.kind == _POSITIONAL_ONLY:
2929 msg = '{arg!r} parameter is positional only, ' \
2930 'but was passed as a keyword'
2931 msg = msg.format(arg=param.name)
2932 raise TypeError(msg) from None
2933 parameters_ex = (param,)
2934 break
2935 elif (param.kind == _VAR_KEYWORD or
2936 param.default is not _empty):
2937 # That's fine too - we have a default value for this
2938 # parameter. So, lets start parsing `kwargs`, starting
2939 # with the current parameter
2940 parameters_ex = (param,)
2941 break
2942 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002943 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2944 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002945 if partial:
2946 parameters_ex = (param,)
2947 break
2948 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002949 msg = 'missing a required argument: {arg!r}'
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002950 msg = msg.format(arg=param.name)
2951 raise TypeError(msg) from None
2952 else:
2953 # We have a positional argument to process
2954 try:
2955 param = next(parameters)
2956 except StopIteration:
2957 raise TypeError('too many positional arguments') from None
2958 else:
2959 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2960 # Looks like we have no parameter for this positional
2961 # argument
Yury Selivanov86872752015-05-19 00:27:49 -04002962 raise TypeError(
2963 'too many positional arguments') from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002964
2965 if param.kind == _VAR_POSITIONAL:
2966 # We have an '*args'-like argument, let's fill it with
2967 # all positional arguments we have left and move on to
2968 # the next phase
2969 values = [arg_val]
2970 values.extend(arg_vals)
2971 arguments[param.name] = tuple(values)
2972 break
2973
2974 if param.name in kwargs:
Yury Selivanov86872752015-05-19 00:27:49 -04002975 raise TypeError(
2976 'multiple values for argument {arg!r}'.format(
2977 arg=param.name)) from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002978
2979 arguments[param.name] = arg_val
2980
2981 # Now, we iterate through the remaining parameters to process
2982 # keyword arguments
2983 kwargs_param = None
2984 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002985 if param.kind == _VAR_KEYWORD:
2986 # Memorize that we have a '**kwargs'-like parameter
2987 kwargs_param = param
2988 continue
2989
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002990 if param.kind == _VAR_POSITIONAL:
2991 # Named arguments don't refer to '*args'-like parameters.
2992 # We only arrive here if the positional arguments ended
2993 # before reaching the last parameter before *args.
2994 continue
2995
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002996 param_name = param.name
2997 try:
2998 arg_val = kwargs.pop(param_name)
2999 except KeyError:
3000 # We have no value for this parameter. It's fine though,
3001 # if it has a default value, or it is an '*args'-like
3002 # parameter, left alone by the processing of positional
3003 # arguments.
3004 if (not partial and param.kind != _VAR_POSITIONAL and
3005 param.default is _empty):
Yury Selivanov86872752015-05-19 00:27:49 -04003006 raise TypeError('missing a required argument: {arg!r}'. \
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003007 format(arg=param_name)) from None
3008
3009 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05003010 if param.kind == _POSITIONAL_ONLY:
3011 # This should never happen in case of a properly built
3012 # Signature object (but let's have this check here
3013 # to ensure correct behaviour just in case)
3014 raise TypeError('{arg!r} parameter is positional only, '
3015 'but was passed as a keyword'. \
3016 format(arg=param.name))
3017
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003018 arguments[param_name] = arg_val
3019
3020 if kwargs:
3021 if kwargs_param is not None:
3022 # Process our '**kwargs'-like parameter
3023 arguments[kwargs_param.name] = kwargs
3024 else:
Yury Selivanov86872752015-05-19 00:27:49 -04003025 raise TypeError(
3026 'got an unexpected keyword argument {arg!r}'.format(
3027 arg=next(iter(kwargs))))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003028
3029 return self._bound_arguments_cls(self, arguments)
3030
Yury Selivanovc45873e2014-01-29 12:10:27 -05003031 def bind(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003032 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003033 and `kwargs` to the function's signature. Raises `TypeError`
3034 if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003035 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05003036 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003037
Yury Selivanovc45873e2014-01-29 12:10:27 -05003038 def bind_partial(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003039 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003040 passed `args` and `kwargs` to the function's signature.
3041 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003042 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05003043 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003044
Yury Selivanova5d63dd2014-03-27 11:31:43 -04003045 def __reduce__(self):
3046 return (type(self),
3047 (tuple(self._parameters.values()),),
3048 {'_return_annotation': self._return_annotation})
3049
3050 def __setstate__(self, state):
3051 self._return_annotation = state['_return_annotation']
3052
Yury Selivanov374375d2014-03-27 12:41:53 -04003053 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04003054 return '<{} {}>'.format(self.__class__.__name__, self)
Yury Selivanov374375d2014-03-27 12:41:53 -04003055
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003056 def __str__(self):
3057 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05003058 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003059 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05003060 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003061 formatted = str(param)
3062
3063 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05003064
3065 if kind == _POSITIONAL_ONLY:
3066 render_pos_only_separator = True
3067 elif render_pos_only_separator:
3068 # It's not a positional-only parameter, and the flag
3069 # is set to 'True' (there were pos-only params before.)
3070 result.append('/')
3071 render_pos_only_separator = False
3072
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003073 if kind == _VAR_POSITIONAL:
3074 # OK, we have an '*args'-like parameter, so we won't need
3075 # a '*' to separate keyword-only arguments
3076 render_kw_only_separator = False
3077 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
3078 # We have a keyword-only parameter to render and we haven't
3079 # rendered an '*args'-like parameter before, so add a '*'
3080 # separator to the parameters list ("foo(arg1, *, arg2)" case)
3081 result.append('*')
3082 # This condition should be only triggered once, so
3083 # reset the flag
3084 render_kw_only_separator = False
3085
3086 result.append(formatted)
3087
Yury Selivanov2393dca2014-01-27 15:07:58 -05003088 if render_pos_only_separator:
3089 # There were only positional-only parameters, hence the
3090 # flag was not reset to 'False'
3091 result.append('/')
3092
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003093 rendered = '({})'.format(', '.join(result))
3094
3095 if self.return_annotation is not _empty:
3096 anno = formatannotation(self.return_annotation)
3097 rendered += ' -> {}'.format(anno)
3098
3099 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003100
Yury Selivanovda396452014-03-27 12:09:24 -04003101
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003102def signature(obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003103 """Get a signature object for the passed callable."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003104 return Signature.from_callable(obj, follow_wrapped=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04003105
3106
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003107def _main():
3108 """ Logic for inspecting an object given at command line """
3109 import argparse
3110 import importlib
3111
3112 parser = argparse.ArgumentParser()
3113 parser.add_argument(
3114 'object',
3115 help="The object to be analysed. "
3116 "It supports the 'module:qualname' syntax")
3117 parser.add_argument(
3118 '-d', '--details', action='store_true',
3119 help='Display info about the module rather than its source code')
3120
3121 args = parser.parse_args()
3122
3123 target = args.object
3124 mod_name, has_attrs, attrs = target.partition(":")
3125 try:
3126 obj = module = importlib.import_module(mod_name)
3127 except Exception as exc:
3128 msg = "Failed to import {} ({}: {})".format(mod_name,
3129 type(exc).__name__,
3130 exc)
3131 print(msg, file=sys.stderr)
3132 exit(2)
3133
3134 if has_attrs:
3135 parts = attrs.split(".")
3136 obj = module
3137 for part in parts:
3138 obj = getattr(obj, part)
3139
3140 if module.__name__ in sys.builtin_module_names:
3141 print("Can't get info for builtin modules.", file=sys.stderr)
3142 exit(1)
3143
3144 if args.details:
3145 print('Target: {}'.format(target))
3146 print('Origin: {}'.format(getsourcefile(module)))
3147 print('Cached: {}'.format(module.__cached__))
3148 if obj is module:
3149 print('Loader: {}'.format(repr(module.__loader__)))
3150 if hasattr(module, '__path__'):
3151 print('Submodule search path: {}'.format(module.__path__))
3152 else:
3153 try:
3154 __, lineno = findsource(obj)
3155 except Exception:
3156 pass
3157 else:
3158 print('Line: {}'.format(lineno))
3159
3160 print('\n')
3161 else:
3162 print(getsource(obj))
3163
3164
3165if __name__ == "__main__":
3166 _main()