blob: 3201e794fb37f778cf5722d762552aa0d0559e12 [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 Galindo8c77b8c2019-04-29 13:36:57 +01001084 args, varargs, varkw, defaults, posonlyargs, kwonlyargs, \
1085 kwonlydefaults, ann = getfullargspec(func)
1086 if posonlyargs or kwonlyargs or ann:
1087 raise ValueError("Function has positional-only, keyword-only parameters"
1088 " or annotations, use getfullargspec() API which can"
1089 " support them")
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001090 return ArgSpec(args, varargs, varkw, defaults)
1091
Christian Heimes25bb7832008-01-11 16:17:00 +00001092FullArgSpec = namedtuple('FullArgSpec',
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001093 'args, varargs, varkw, defaults, posonlyargs, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001094
1095def getfullargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001096 """Get the names and default values of a callable object's parameters.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001097
Brett Cannon504d8852007-09-07 02:12:14 +00001098 A tuple of seven things is returned:
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001099 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).
1100 'args' is a list of the parameter names.
1101 'varargs' and 'varkw' are the names of the * and ** parameters or None.
1102 'defaults' is an n-tuple of the default values of the last n parameters.
1103 'kwonlyargs' is a list of keyword-only parameter names.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001104 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001105 'annotations' is a dictionary mapping parameter names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001106
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001107 Notable differences from inspect.signature():
1108 - the "self" parameter is always reported, even for bound methods
1109 - wrapper chains defined by __wrapped__ *not* unwrapped automatically
Jeremy Hylton64967882003-06-27 18:14:39 +00001110 """
1111
Yury Selivanov57d240e2014-02-19 16:27:23 -05001112 try:
1113 # Re: `skip_bound_arg=False`
1114 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001115 # There is a notable difference in behaviour between getfullargspec
1116 # and Signature: the former always returns 'self' parameter for bound
1117 # methods, whereas the Signature always shows the actual calling
1118 # signature of the passed object.
1119 #
1120 # To simulate this behaviour, we "unbind" bound methods, to trick
1121 # inspect.signature to always return their first parameter ("self",
1122 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001123
Yury Selivanov57d240e2014-02-19 16:27:23 -05001124 # Re: `follow_wrapper_chains=False`
1125 #
1126 # getfullargspec() historically ignored __wrapped__ attributes,
1127 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001128
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001129 sig = _signature_from_callable(func,
1130 follow_wrapper_chains=False,
1131 skip_bound_arg=False,
1132 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001133 except Exception as ex:
1134 # Most of the times 'signature' will raise ValueError.
1135 # But, it can also raise AttributeError, and, maybe something
1136 # else. So to be fully backwards compatible, we catch all
1137 # possible exceptions here, and reraise a TypeError.
1138 raise TypeError('unsupported callable') from ex
1139
1140 args = []
1141 varargs = None
1142 varkw = None
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001143 posonlyargs = []
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001144 kwonlyargs = []
1145 defaults = ()
1146 annotations = {}
1147 defaults = ()
1148 kwdefaults = {}
1149
1150 if sig.return_annotation is not sig.empty:
1151 annotations['return'] = sig.return_annotation
1152
1153 for param in sig.parameters.values():
1154 kind = param.kind
1155 name = param.name
1156
1157 if kind is _POSITIONAL_ONLY:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001158 posonlyargs.append(name)
1159 if param.default is not param.empty:
1160 defaults += (param.default,)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001161 elif kind is _POSITIONAL_OR_KEYWORD:
1162 args.append(name)
1163 if param.default is not param.empty:
1164 defaults += (param.default,)
1165 elif kind is _VAR_POSITIONAL:
1166 varargs = name
1167 elif kind is _KEYWORD_ONLY:
1168 kwonlyargs.append(name)
1169 if param.default is not param.empty:
1170 kwdefaults[name] = param.default
1171 elif kind is _VAR_KEYWORD:
1172 varkw = name
1173
1174 if param.annotation is not param.empty:
1175 annotations[name] = param.annotation
1176
1177 if not kwdefaults:
1178 # compatibility with 'func.__kwdefaults__'
1179 kwdefaults = None
1180
1181 if not defaults:
1182 # compatibility with 'func.__defaults__'
1183 defaults = None
1184
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001185 return FullArgSpec(args, varargs, varkw, defaults,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001186 posonlyargs, kwonlyargs, kwdefaults, annotations)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001187
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001188
Christian Heimes25bb7832008-01-11 16:17:00 +00001189ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1190
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001191def getargvalues(frame):
1192 """Get information about arguments passed into a particular frame.
1193
1194 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001195 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001196 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1197 'locals' is the locals dictionary of the given frame."""
1198 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001199 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001200
Guido van Rossum2e65f892007-02-28 22:03:49 +00001201def formatannotation(annotation, base_module=None):
Guido van Rossum52e50042016-10-22 07:55:18 -07001202 if getattr(annotation, '__module__', None) == 'typing':
1203 return repr(annotation).replace('typing.', '')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001204 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001205 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001206 return annotation.__qualname__
1207 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001208 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001209
Guido van Rossum2e65f892007-02-28 22:03:49 +00001210def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001211 module = getattr(object, '__module__', None)
1212 def _formatannotation(annotation):
1213 return formatannotation(annotation, module)
1214 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001215
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001216def formatargspec(args, varargs=None, varkw=None, defaults=None,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001217 posonlyargs=(), kwonlyargs=(), kwonlydefaults={},
1218 annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001219 formatarg=str,
1220 formatvarargs=lambda name: '*' + name,
1221 formatvarkw=lambda name: '**' + name,
1222 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001223 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001224 formatannotation=formatannotation):
Berker Peksagfa3922c2015-07-31 04:11:29 +03001225 """Format an argument spec from the values returned by getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001226
Guido van Rossum2e65f892007-02-28 22:03:49 +00001227 The first seven arguments are (args, varargs, varkw, defaults,
1228 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1229 are the corresponding optional formatting functions that are called to
1230 turn names and values into strings. The last argument is an optional
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001231 function to format the sequence of arguments.
1232
1233 Deprecated since Python 3.5: use the `signature` function and `Signature`
1234 objects.
1235 """
1236
1237 from warnings import warn
1238
1239 warn("`formatargspec` is deprecated since Python 3.5. Use `signature` and "
Zackery Spytz41254eb2018-06-11 21:16:18 -06001240 "the `Signature` object directly",
Matthias Bussonnier46c5cd02018-06-11 22:08:16 +02001241 DeprecationWarning,
1242 stacklevel=2)
1243
Guido van Rossum2e65f892007-02-28 22:03:49 +00001244 def formatargandannotation(arg):
1245 result = formatarg(arg)
1246 if arg in annotations:
1247 result += ': ' + formatannotation(annotations[arg])
1248 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001249 specs = []
1250 if defaults:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001251 firstdefault = len(posonlyargs) + len(args) - len(defaults)
1252 posonly_left = len(posonlyargs)
1253 for i, arg in enumerate([*posonlyargs, *args]):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001254 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001255 if defaults and i >= firstdefault:
1256 spec = spec + formatvalue(defaults[i - firstdefault])
1257 specs.append(spec)
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001258 posonly_left -= 1
1259 if posonlyargs and posonly_left == 0:
1260 specs.append('/')
1261
Raymond Hettinger936654b2002-06-01 03:06:31 +00001262 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001263 specs.append(formatvarargs(formatargandannotation(varargs)))
1264 else:
1265 if kwonlyargs:
1266 specs.append('*')
1267 if kwonlyargs:
1268 for kwonlyarg in kwonlyargs:
1269 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001270 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001271 spec += formatvalue(kwonlydefaults[kwonlyarg])
1272 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001273 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001274 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001275 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001276 if 'return' in annotations:
1277 result += formatreturns(formatannotation(annotations['return']))
1278 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001279
1280def formatargvalues(args, varargs, varkw, locals,
1281 formatarg=str,
1282 formatvarargs=lambda name: '*' + name,
1283 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001284 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001285 """Format an argument spec from the 4 values returned by getargvalues.
1286
1287 The first four arguments are (args, varargs, varkw, locals). The
1288 next four arguments are the corresponding optional formatting functions
1289 that are called to turn names and values into strings. The ninth
1290 argument is an optional function to format the sequence of arguments."""
1291 def convert(name, locals=locals,
1292 formatarg=formatarg, formatvalue=formatvalue):
1293 return formatarg(name) + formatvalue(locals[name])
1294 specs = []
1295 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001296 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001297 if varargs:
1298 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1299 if varkw:
1300 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001301 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001302
Benjamin Petersone109c702011-06-24 09:37:26 -05001303def _missing_arguments(f_name, argnames, pos, values):
1304 names = [repr(name) for name in argnames if name not in values]
1305 missing = len(names)
1306 if missing == 1:
1307 s = names[0]
1308 elif missing == 2:
1309 s = "{} and {}".format(*names)
1310 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001311 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001312 del names[-2:]
1313 s = ", ".join(names) + tail
1314 raise TypeError("%s() missing %i required %s argument%s: %s" %
1315 (f_name, missing,
1316 "positional" if pos else "keyword-only",
1317 "" if missing == 1 else "s", s))
1318
1319def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001320 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001321 kwonly_given = len([arg for arg in kwonly if arg in values])
1322 if varargs:
1323 plural = atleast != 1
1324 sig = "at least %d" % (atleast,)
1325 elif defcount:
1326 plural = True
1327 sig = "from %d to %d" % (atleast, len(args))
1328 else:
1329 plural = len(args) != 1
1330 sig = str(len(args))
1331 kwonly_sig = ""
1332 if kwonly_given:
1333 msg = " positional argument%s (and %d keyword-only argument%s)"
1334 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1335 "s" if kwonly_given != 1 else ""))
1336 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1337 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1338 "was" if given == 1 and not kwonly_given else "were"))
1339
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001340def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001341 """Get the mapping of arguments to values.
1342
1343 A dict is returned, with keys the function argument names (including the
1344 names of the * and ** arguments, if any), and values the respective bound
1345 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001346 func = func_and_positional[0]
1347 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001348 spec = getfullargspec(func)
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001349 (args, varargs, varkw, defaults, posonlyargs,
1350 kwonlyargs, kwonlydefaults, ann) = spec
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001351 f_name = func.__name__
1352 arg2value = {}
1353
Benjamin Petersonb204a422011-06-05 22:04:07 -05001354
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001355 if ismethod(func) and func.__self__ is not None:
1356 # implicit 'self' (or 'cls' for classmethods) argument
1357 positional = (func.__self__,) + positional
1358 num_pos = len(positional)
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001359 num_posonlyargs = len(posonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001360 num_args = len(args)
1361 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001362
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001363 n = min(num_pos, num_posonlyargs)
1364 for i in range(num_posonlyargs):
1365 arg2value[posonlyargs[i]] = positional[i]
Benjamin Petersonb204a422011-06-05 22:04:07 -05001366 n = min(num_pos, num_args)
1367 for i in range(n):
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01001368 arg2value[args[i]] = positional[num_posonlyargs+i]
Benjamin Petersonb204a422011-06-05 22:04:07 -05001369 if varargs:
1370 arg2value[varargs] = tuple(positional[n:])
1371 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001372 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001373 arg2value[varkw] = {}
1374 for kw, value in named.items():
1375 if kw not in possible_kwargs:
1376 if not varkw:
1377 raise TypeError("%s() got an unexpected keyword argument %r" %
1378 (f_name, kw))
1379 arg2value[varkw][kw] = value
1380 continue
1381 if kw in arg2value:
1382 raise TypeError("%s() got multiple values for argument %r" %
1383 (f_name, kw))
1384 arg2value[kw] = value
1385 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001386 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1387 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001388 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001389 req = args[:num_args - num_defaults]
1390 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001391 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001392 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001393 for i, arg in enumerate(args[num_args - num_defaults:]):
1394 if arg not in arg2value:
1395 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001396 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001397 for kwarg in kwonlyargs:
1398 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001399 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001400 arg2value[kwarg] = kwonlydefaults[kwarg]
1401 else:
1402 missing += 1
1403 if missing:
1404 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001405 return arg2value
1406
Nick Coghlan2f92e542012-06-23 19:39:55 +10001407ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1408
1409def getclosurevars(func):
1410 """
1411 Get the mapping of free variables to their current values.
1412
Meador Inge8fda3592012-07-19 21:33:21 -05001413 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001414 and builtin references as seen by the body of the function. A final
1415 set of unbound names that could not be resolved is also provided.
1416 """
1417
1418 if ismethod(func):
1419 func = func.__func__
1420
1421 if not isfunction(func):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001422 raise TypeError("{!r} is not a Python function".format(func))
Nick Coghlan2f92e542012-06-23 19:39:55 +10001423
1424 code = func.__code__
1425 # Nonlocal references are named in co_freevars and resolved
1426 # by looking them up in __closure__ by positional index
1427 if func.__closure__ is None:
1428 nonlocal_vars = {}
1429 else:
1430 nonlocal_vars = {
1431 var : cell.cell_contents
1432 for var, cell in zip(code.co_freevars, func.__closure__)
1433 }
1434
1435 # Global and builtin references are named in co_names and resolved
1436 # by looking them up in __globals__ or __builtins__
1437 global_ns = func.__globals__
1438 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1439 if ismodule(builtin_ns):
1440 builtin_ns = builtin_ns.__dict__
1441 global_vars = {}
1442 builtin_vars = {}
1443 unbound_names = set()
1444 for name in code.co_names:
1445 if name in ("None", "True", "False"):
1446 # Because these used to be builtins instead of keywords, they
1447 # may still show up as name references. We ignore them.
1448 continue
1449 try:
1450 global_vars[name] = global_ns[name]
1451 except KeyError:
1452 try:
1453 builtin_vars[name] = builtin_ns[name]
1454 except KeyError:
1455 unbound_names.add(name)
1456
1457 return ClosureVars(nonlocal_vars, global_vars,
1458 builtin_vars, unbound_names)
1459
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001460# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001461
1462Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1463
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001464def getframeinfo(frame, context=1):
1465 """Get information about a frame or traceback object.
1466
1467 A tuple of five things is returned: the filename, the line number of
1468 the current line, the function name, a list of lines of context from
1469 the source code, and the index of the current line within that list.
1470 The optional second argument specifies the number of lines of context
1471 to return, which are centered around the current line."""
1472 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001473 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001474 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001475 else:
1476 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001477 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001478 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001479
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001480 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001481 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001482 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001483 try:
1484 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001485 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001486 lines = index = None
1487 else:
Raymond Hettingera0501712004-06-15 11:22:53 +00001488 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001489 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001490 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001491 else:
1492 lines = index = None
1493
Christian Heimes25bb7832008-01-11 16:17:00 +00001494 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001495
1496def getlineno(frame):
1497 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001498 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1499 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001500
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001501FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1502
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001503def getouterframes(frame, context=1):
1504 """Get a list of records for a frame and all higher (calling) frames.
1505
1506 Each record contains a frame object, filename, line number, function
1507 name, a list of lines of context, and index within the context."""
1508 framelist = []
1509 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001510 frameinfo = (frame,) + getframeinfo(frame, context)
1511 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001512 frame = frame.f_back
1513 return framelist
1514
1515def getinnerframes(tb, context=1):
1516 """Get a list of records for a traceback's frame and all lower frames.
1517
1518 Each record contains a frame object, filename, line number, function
1519 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001520 framelist = []
1521 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001522 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1523 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001524 tb = tb.tb_next
1525 return framelist
1526
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001527def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001528 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001529 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001530
1531def stack(context=1):
1532 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001533 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001534
1535def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001536 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001537 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001538
1539
1540# ------------------------------------------------ static version of getattr
1541
1542_sentinel = object()
1543
Michael Foorde5162652010-11-20 16:40:44 +00001544def _static_getmro(klass):
1545 return type.__dict__['__mro__'].__get__(klass)
1546
Michael Foord95fc51d2010-11-20 15:07:30 +00001547def _check_instance(obj, attr):
1548 instance_dict = {}
1549 try:
1550 instance_dict = object.__getattribute__(obj, "__dict__")
1551 except AttributeError:
1552 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001553 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001554
1555
1556def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001557 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001558 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001559 try:
1560 return entry.__dict__[attr]
1561 except KeyError:
1562 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001563 return _sentinel
1564
Michael Foord35184ed2010-11-20 16:58:30 +00001565def _is_type(obj):
1566 try:
1567 _static_getmro(obj)
1568 except TypeError:
1569 return False
1570 return True
1571
Michael Foorddcebe0f2011-03-15 19:20:44 -04001572def _shadowed_dict(klass):
1573 dict_attr = type.__dict__["__dict__"]
1574 for entry in _static_getmro(klass):
1575 try:
1576 class_dict = dict_attr.__get__(entry)["__dict__"]
1577 except KeyError:
1578 pass
1579 else:
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301580 if not (isinstance(class_dict, types.GetSetDescriptorType) and
Michael Foorddcebe0f2011-03-15 19:20:44 -04001581 class_dict.__name__ == "__dict__" and
1582 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001583 return class_dict
1584 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001585
1586def getattr_static(obj, attr, default=_sentinel):
1587 """Retrieve attributes without triggering dynamic lookup via the
1588 descriptor protocol, __getattr__ or __getattribute__.
1589
1590 Note: this function may not be able to retrieve all attributes
1591 that getattr can fetch (like dynamically created attributes)
1592 and may find attributes that getattr can't (like descriptors
1593 that raise AttributeError). It can also return descriptor objects
1594 instead of instance members in some cases. See the
1595 documentation for details.
1596 """
1597 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001598 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001599 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001600 dict_attr = _shadowed_dict(klass)
1601 if (dict_attr is _sentinel or
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05301602 isinstance(dict_attr, types.MemberDescriptorType)):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001603 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001604 else:
1605 klass = obj
1606
1607 klass_result = _check_class(klass, attr)
1608
1609 if instance_result is not _sentinel and klass_result is not _sentinel:
1610 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1611 _check_class(type(klass_result), '__set__') is not _sentinel):
1612 return klass_result
1613
1614 if instance_result is not _sentinel:
1615 return instance_result
1616 if klass_result is not _sentinel:
1617 return klass_result
1618
1619 if obj is klass:
1620 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001621 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001622 if _shadowed_dict(type(entry)) is _sentinel:
1623 try:
1624 return entry.__dict__[attr]
1625 except KeyError:
1626 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001627 if default is not _sentinel:
1628 return default
1629 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001630
1631
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001632# ------------------------------------------------ generator introspection
1633
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001634GEN_CREATED = 'GEN_CREATED'
1635GEN_RUNNING = 'GEN_RUNNING'
1636GEN_SUSPENDED = 'GEN_SUSPENDED'
1637GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001638
1639def getgeneratorstate(generator):
1640 """Get current state of a generator-iterator.
1641
1642 Possible states are:
1643 GEN_CREATED: Waiting to start execution.
1644 GEN_RUNNING: Currently being executed by the interpreter.
1645 GEN_SUSPENDED: Currently suspended at a yield expression.
1646 GEN_CLOSED: Execution has completed.
1647 """
1648 if generator.gi_running:
1649 return GEN_RUNNING
1650 if generator.gi_frame is None:
1651 return GEN_CLOSED
1652 if generator.gi_frame.f_lasti == -1:
1653 return GEN_CREATED
1654 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001655
1656
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001657def getgeneratorlocals(generator):
1658 """
1659 Get the mapping of generator local variables to their current values.
1660
1661 A dict is returned, with the keys the local variable names and values the
1662 bound values."""
1663
1664 if not isgenerator(generator):
Serhiy Storchakaa4a30202017-11-28 22:54:42 +02001665 raise TypeError("{!r} is not a Python generator".format(generator))
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001666
1667 frame = getattr(generator, "gi_frame", None)
1668 if frame is not None:
1669 return generator.gi_frame.f_locals
1670 else:
1671 return {}
1672
Yury Selivanov5376ba92015-06-22 12:19:30 -04001673
1674# ------------------------------------------------ coroutine introspection
1675
1676CORO_CREATED = 'CORO_CREATED'
1677CORO_RUNNING = 'CORO_RUNNING'
1678CORO_SUSPENDED = 'CORO_SUSPENDED'
1679CORO_CLOSED = 'CORO_CLOSED'
1680
1681def getcoroutinestate(coroutine):
1682 """Get current state of a coroutine object.
1683
1684 Possible states are:
1685 CORO_CREATED: Waiting to start execution.
1686 CORO_RUNNING: Currently being executed by the interpreter.
1687 CORO_SUSPENDED: Currently suspended at an await expression.
1688 CORO_CLOSED: Execution has completed.
1689 """
1690 if coroutine.cr_running:
1691 return CORO_RUNNING
1692 if coroutine.cr_frame is None:
1693 return CORO_CLOSED
1694 if coroutine.cr_frame.f_lasti == -1:
1695 return CORO_CREATED
1696 return CORO_SUSPENDED
1697
1698
1699def getcoroutinelocals(coroutine):
1700 """
1701 Get the mapping of coroutine local variables to their current values.
1702
1703 A dict is returned, with the keys the local variable names and values the
1704 bound values."""
1705 frame = getattr(coroutine, "cr_frame", None)
1706 if frame is not None:
1707 return frame.f_locals
1708 else:
1709 return {}
1710
1711
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001712###############################################################################
1713### Function Signature Object (PEP 362)
1714###############################################################################
1715
1716
1717_WrapperDescriptor = type(type.__call__)
1718_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001719_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001720
1721_NonUserDefinedCallables = (_WrapperDescriptor,
1722 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001723 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001724 types.BuiltinFunctionType)
1725
1726
Yury Selivanov421f0c72014-01-29 12:05:40 -05001727def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001728 """Private helper. Checks if ``cls`` has an attribute
1729 named ``method_name`` and returns it only if it is a
1730 pure python function.
1731 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001732 try:
1733 meth = getattr(cls, method_name)
1734 except AttributeError:
1735 return
1736 else:
1737 if not isinstance(meth, _NonUserDefinedCallables):
1738 # Once '__signature__' will be added to 'C'-level
1739 # callables, this check won't be necessary
1740 return meth
1741
1742
Yury Selivanov62560fb2014-01-28 12:26:24 -05001743def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001744 """Private helper to calculate how 'wrapped_sig' signature will
1745 look like after applying a 'functools.partial' object (or alike)
1746 on it.
1747 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001748
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001749 old_params = wrapped_sig.parameters
1750 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001751
1752 partial_args = partial.args or ()
1753 partial_keywords = partial.keywords or {}
1754
1755 if extra_args:
1756 partial_args = extra_args + partial_args
1757
1758 try:
1759 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1760 except TypeError as ex:
1761 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1762 raise ValueError(msg) from ex
1763
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001764
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001765 transform_to_kwonly = False
1766 for param_name, param in old_params.items():
1767 try:
1768 arg_value = ba.arguments[param_name]
1769 except KeyError:
1770 pass
1771 else:
1772 if param.kind is _POSITIONAL_ONLY:
1773 # If positional-only parameter is bound by partial,
1774 # it effectively disappears from the signature
1775 new_params.pop(param_name)
1776 continue
1777
1778 if param.kind is _POSITIONAL_OR_KEYWORD:
1779 if param_name in partial_keywords:
1780 # This means that this parameter, and all parameters
1781 # after it should be keyword-only (and var-positional
1782 # should be removed). Here's why. Consider the following
1783 # function:
1784 # foo(a, b, *args, c):
1785 # pass
1786 #
1787 # "partial(foo, a='spam')" will have the following
1788 # signature: "(*, a='spam', b, c)". Because attempting
1789 # to call that partial with "(10, 20)" arguments will
1790 # raise a TypeError, saying that "a" argument received
1791 # multiple values.
1792 transform_to_kwonly = True
1793 # Set the new default value
1794 new_params[param_name] = param.replace(default=arg_value)
1795 else:
1796 # was passed as a positional argument
1797 new_params.pop(param.name)
1798 continue
1799
1800 if param.kind is _KEYWORD_ONLY:
1801 # Set the new default value
1802 new_params[param_name] = param.replace(default=arg_value)
1803
1804 if transform_to_kwonly:
1805 assert param.kind is not _POSITIONAL_ONLY
1806
1807 if param.kind is _POSITIONAL_OR_KEYWORD:
1808 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1809 new_params[param_name] = new_param
1810 new_params.move_to_end(param_name)
1811 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
1812 new_params.move_to_end(param_name)
1813 elif param.kind is _VAR_POSITIONAL:
1814 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001815
1816 return wrapped_sig.replace(parameters=new_params.values())
1817
1818
Yury Selivanov62560fb2014-01-28 12:26:24 -05001819def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001820 """Private helper to transform signatures for unbound
1821 functions to bound methods.
1822 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001823
1824 params = tuple(sig.parameters.values())
1825
1826 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1827 raise ValueError('invalid method signature')
1828
1829 kind = params[0].kind
1830 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1831 # Drop first parameter:
1832 # '(p1, p2[, ...])' -> '(p2[, ...])'
1833 params = params[1:]
1834 else:
1835 if kind is not _VAR_POSITIONAL:
1836 # Unless we add a new parameter type we never
1837 # get here
1838 raise ValueError('invalid argument type')
1839 # It's a var-positional parameter.
1840 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1841
1842 return sig.replace(parameters=params)
1843
1844
Yury Selivanovb77511d2014-01-29 10:46:14 -05001845def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001846 """Private helper to test if `obj` is a callable that might
1847 support Argument Clinic's __text_signature__ protocol.
1848 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001849 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001850 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001851 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001852 # Can't test 'isinstance(type)' here, as it would
1853 # also be True for regular python classes
1854 obj in (type, object))
1855
1856
Yury Selivanov63da7c72014-01-31 14:48:37 -05001857def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001858 """Private helper to test if `obj` is a duck type of FunctionType.
1859 A good example of such objects are functions compiled with
1860 Cython, which have all attributes that a pure Python function
1861 would have, but have their code statically compiled.
1862 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001863
1864 if not callable(obj) or isclass(obj):
1865 # All function-like objects are obviously callables,
1866 # and not classes.
1867 return False
1868
1869 name = getattr(obj, '__name__', None)
1870 code = getattr(obj, '__code__', None)
1871 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1872 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1873 annotations = getattr(obj, '__annotations__', None)
1874
1875 return (isinstance(code, types.CodeType) and
1876 isinstance(name, str) and
1877 (defaults is None or isinstance(defaults, tuple)) and
1878 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1879 isinstance(annotations, dict))
1880
1881
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001882def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001883 """ Private helper to get first parameter name from a
1884 __text_signature__ of a builtin method, which should
1885 be in the following format: '($param1, ...)'.
1886 Assumptions are that the first argument won't have
1887 a default value or an annotation.
1888 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001889
1890 assert spec.startswith('($')
1891
1892 pos = spec.find(',')
1893 if pos == -1:
1894 pos = spec.find(')')
1895
1896 cpos = spec.find(':')
1897 assert cpos == -1 or cpos > pos
1898
1899 cpos = spec.find('=')
1900 assert cpos == -1 or cpos > pos
1901
1902 return spec[2:pos]
1903
1904
Larry Hastings2623c8c2014-02-08 22:15:29 -08001905def _signature_strip_non_python_syntax(signature):
1906 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001907 Private helper function. Takes a signature in Argument Clinic's
1908 extended signature format.
1909
Larry Hastings2623c8c2014-02-08 22:15:29 -08001910 Returns a tuple of three things:
1911 * that signature re-rendered in standard Python syntax,
1912 * the index of the "self" parameter (generally 0), or None if
1913 the function does not have a "self" parameter, and
1914 * the index of the last "positional only" parameter,
1915 or None if the signature has no positional-only parameters.
1916 """
1917
1918 if not signature:
1919 return signature, None, None
1920
1921 self_parameter = None
1922 last_positional_only = None
1923
1924 lines = [l.encode('ascii') for l in signature.split('\n')]
1925 generator = iter(lines).__next__
1926 token_stream = tokenize.tokenize(generator)
1927
1928 delayed_comma = False
1929 skip_next_comma = False
1930 text = []
1931 add = text.append
1932
1933 current_parameter = 0
1934 OP = token.OP
1935 ERRORTOKEN = token.ERRORTOKEN
1936
1937 # token stream always starts with ENCODING token, skip it
1938 t = next(token_stream)
1939 assert t.type == tokenize.ENCODING
1940
1941 for t in token_stream:
1942 type, string = t.type, t.string
1943
1944 if type == OP:
1945 if string == ',':
1946 if skip_next_comma:
1947 skip_next_comma = False
1948 else:
1949 assert not delayed_comma
1950 delayed_comma = True
1951 current_parameter += 1
1952 continue
1953
1954 if string == '/':
1955 assert not skip_next_comma
1956 assert last_positional_only is None
1957 skip_next_comma = True
1958 last_positional_only = current_parameter - 1
1959 continue
1960
1961 if (type == ERRORTOKEN) and (string == '$'):
1962 assert self_parameter is None
1963 self_parameter = current_parameter
1964 continue
1965
1966 if delayed_comma:
1967 delayed_comma = False
1968 if not ((type == OP) and (string == ')')):
1969 add(', ')
1970 add(string)
1971 if (string == ','):
1972 add(' ')
1973 clean_signature = ''.join(text)
1974 return clean_signature, self_parameter, last_positional_only
1975
1976
Yury Selivanov57d240e2014-02-19 16:27:23 -05001977def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001978 """Private helper to parse content of '__text_signature__'
1979 and return a Signature based on it.
1980 """
INADA Naoki37420de2018-01-27 10:10:06 +09001981 # Lazy import ast because it's relatively heavy and
1982 # it's not used for other than this function.
1983 import ast
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001984
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001985 Parameter = cls._parameter_cls
1986
Larry Hastings2623c8c2014-02-08 22:15:29 -08001987 clean_signature, self_parameter, last_positional_only = \
1988 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001989
Larry Hastings2623c8c2014-02-08 22:15:29 -08001990 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001991
1992 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001993 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001994 except SyntaxError:
1995 module = None
1996
1997 if not isinstance(module, ast.Module):
1998 raise ValueError("{!r} builtin has invalid signature".format(obj))
1999
2000 f = module.body[0]
2001
2002 parameters = []
2003 empty = Parameter.empty
2004 invalid = object()
2005
2006 module = None
2007 module_dict = {}
2008 module_name = getattr(obj, '__module__', None)
2009 if module_name:
2010 module = sys.modules.get(module_name, None)
2011 if module:
2012 module_dict = module.__dict__
INADA Naoki6f85b822018-10-05 01:47:09 +09002013 sys_module_dict = sys.modules.copy()
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002014
2015 def parse_name(node):
2016 assert isinstance(node, ast.arg)
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)feaefc72018-02-09 15:29:19 +05302017 if node.annotation is not None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002018 raise ValueError("Annotations are not currently supported")
2019 return node.arg
2020
2021 def wrap_value(s):
2022 try:
2023 value = eval(s, module_dict)
2024 except NameError:
2025 try:
2026 value = eval(s, sys_module_dict)
2027 except NameError:
2028 raise RuntimeError()
2029
Serhiy Storchaka3f228112018-09-27 17:42:37 +03002030 if isinstance(value, (str, int, float, bytes, bool, type(None))):
2031 return ast.Constant(value)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002032 raise RuntimeError()
2033
2034 class RewriteSymbolics(ast.NodeTransformer):
2035 def visit_Attribute(self, node):
2036 a = []
2037 n = node
2038 while isinstance(n, ast.Attribute):
2039 a.append(n.attr)
2040 n = n.value
2041 if not isinstance(n, ast.Name):
2042 raise RuntimeError()
2043 a.append(n.id)
2044 value = ".".join(reversed(a))
2045 return wrap_value(value)
2046
2047 def visit_Name(self, node):
2048 if not isinstance(node.ctx, ast.Load):
2049 raise ValueError()
2050 return wrap_value(node.id)
2051
2052 def p(name_node, default_node, default=empty):
2053 name = parse_name(name_node)
2054 if name is invalid:
2055 return None
2056 if default_node and default_node is not _empty:
2057 try:
2058 default_node = RewriteSymbolics().visit(default_node)
2059 o = ast.literal_eval(default_node)
2060 except ValueError:
2061 o = invalid
2062 if o is invalid:
2063 return None
2064 default = o if o is not invalid else default
2065 parameters.append(Parameter(name, kind, default=default, annotation=empty))
2066
2067 # non-keyword-only parameters
2068 args = reversed(f.args.args)
2069 defaults = reversed(f.args.defaults)
2070 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002071 if last_positional_only is not None:
2072 kind = Parameter.POSITIONAL_ONLY
2073 else:
2074 kind = Parameter.POSITIONAL_OR_KEYWORD
2075 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002076 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002077 if i == last_positional_only:
2078 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002079
2080 # *args
2081 if f.args.vararg:
2082 kind = Parameter.VAR_POSITIONAL
2083 p(f.args.vararg, empty)
2084
2085 # keyword-only arguments
2086 kind = Parameter.KEYWORD_ONLY
2087 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
2088 p(name, default)
2089
2090 # **kwargs
2091 if f.args.kwarg:
2092 kind = Parameter.VAR_KEYWORD
2093 p(f.args.kwarg, empty)
2094
Larry Hastings2623c8c2014-02-08 22:15:29 -08002095 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002096 # Possibly strip the bound argument:
2097 # - We *always* strip first bound argument if
2098 # it is a module.
2099 # - We don't strip first bound argument if
2100 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002101 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002102 _self = getattr(obj, '__self__', None)
2103 self_isbound = _self is not None
2104 self_ismodule = ismodule(_self)
2105 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002106 parameters.pop(0)
2107 else:
2108 # for builtins, self parameter is always positional-only!
2109 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2110 parameters[0] = p
2111
2112 return cls(parameters, return_annotation=cls.empty)
2113
2114
Yury Selivanov57d240e2014-02-19 16:27:23 -05002115def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002116 """Private helper function to get signature for
2117 builtin callables.
2118 """
2119
Yury Selivanov57d240e2014-02-19 16:27:23 -05002120 if not _signature_is_builtin(func):
2121 raise TypeError("{!r} is not a Python builtin "
2122 "function".format(func))
2123
2124 s = getattr(func, "__text_signature__", None)
2125 if not s:
2126 raise ValueError("no signature found for builtin {!r}".format(func))
2127
2128 return _signature_fromstr(cls, func, s, skip_bound_arg)
2129
2130
Yury Selivanovcf45f022015-05-20 14:38:50 -04002131def _signature_from_function(cls, func):
2132 """Private helper: constructs Signature for the given python function."""
2133
2134 is_duck_function = False
2135 if not isfunction(func):
2136 if _signature_is_functionlike(func):
2137 is_duck_function = True
2138 else:
2139 # If it's not a pure Python function, and not a duck type
2140 # of pure function:
2141 raise TypeError('{!r} is not a Python function'.format(func))
2142
2143 Parameter = cls._parameter_cls
2144
2145 # Parameter information.
2146 func_code = func.__code__
2147 pos_count = func_code.co_argcount
2148 arg_names = func_code.co_varnames
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002149 posonly_count = func_code.co_posonlyargcount
2150 positional_count = posonly_count + pos_count
2151 positional_only = tuple(arg_names[:posonly_count])
2152 positional = tuple(arg_names[posonly_count:positional_count])
Yury Selivanovcf45f022015-05-20 14:38:50 -04002153 keyword_only_count = func_code.co_kwonlyargcount
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002154 keyword_only = arg_names[positional_count:(positional_count + keyword_only_count)]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002155 annotations = func.__annotations__
2156 defaults = func.__defaults__
2157 kwdefaults = func.__kwdefaults__
2158
2159 if defaults:
2160 pos_default_count = len(defaults)
2161 else:
2162 pos_default_count = 0
2163
2164 parameters = []
2165
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002166 non_default_count = positional_count - pos_default_count
2167 all_positional = positional_only + positional
2168
2169 posonly_left = posonly_count
2170
Yury Selivanovcf45f022015-05-20 14:38:50 -04002171 # Non-keyword-only parameters w/o defaults.
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002172 for name in all_positional[:non_default_count]:
2173 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002174 annotation = annotations.get(name, _empty)
2175 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002176 kind=kind))
2177 if posonly_left:
2178 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002179
2180 # ... w/ defaults.
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002181 for offset, name in enumerate(all_positional[non_default_count:]):
2182 kind = _POSITIONAL_ONLY if posonly_left else _POSITIONAL_OR_KEYWORD
Yury Selivanovcf45f022015-05-20 14:38:50 -04002183 annotation = annotations.get(name, _empty)
2184 parameters.append(Parameter(name, annotation=annotation,
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002185 kind=kind,
Yury Selivanovcf45f022015-05-20 14:38:50 -04002186 default=defaults[offset]))
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002187 if posonly_left:
2188 posonly_left -= 1
Yury Selivanovcf45f022015-05-20 14:38:50 -04002189
2190 # *args
2191 if func_code.co_flags & CO_VARARGS:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002192 name = arg_names[positional_count + keyword_only_count]
Yury Selivanovcf45f022015-05-20 14:38:50 -04002193 annotation = annotations.get(name, _empty)
2194 parameters.append(Parameter(name, annotation=annotation,
2195 kind=_VAR_POSITIONAL))
2196
2197 # Keyword-only parameters.
2198 for name in keyword_only:
2199 default = _empty
2200 if kwdefaults is not None:
2201 default = kwdefaults.get(name, _empty)
2202
2203 annotation = annotations.get(name, _empty)
2204 parameters.append(Parameter(name, annotation=annotation,
2205 kind=_KEYWORD_ONLY,
2206 default=default))
2207 # **kwargs
2208 if func_code.co_flags & CO_VARKEYWORDS:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +01002209 index = positional_count + keyword_only_count
Yury Selivanovcf45f022015-05-20 14:38:50 -04002210 if func_code.co_flags & CO_VARARGS:
2211 index += 1
2212
2213 name = arg_names[index]
2214 annotation = annotations.get(name, _empty)
2215 parameters.append(Parameter(name, annotation=annotation,
2216 kind=_VAR_KEYWORD))
2217
2218 # Is 'func' is a pure Python function - don't validate the
2219 # parameters list (for correct order and defaults), it should be OK.
2220 return cls(parameters,
2221 return_annotation=annotations.get('return', _empty),
2222 __validate_parameters__=is_duck_function)
2223
2224
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002225def _signature_from_callable(obj, *,
2226 follow_wrapper_chains=True,
2227 skip_bound_arg=True,
2228 sigcls):
2229
2230 """Private helper function to get signature for arbitrary
2231 callable objects.
2232 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002233
2234 if not callable(obj):
2235 raise TypeError('{!r} is not a callable object'.format(obj))
2236
2237 if isinstance(obj, types.MethodType):
2238 # In this case we skip the first parameter of the underlying
2239 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002240 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002241 obj.__func__,
2242 follow_wrapper_chains=follow_wrapper_chains,
2243 skip_bound_arg=skip_bound_arg,
2244 sigcls=sigcls)
2245
Yury Selivanov57d240e2014-02-19 16:27:23 -05002246 if skip_bound_arg:
2247 return _signature_bound_method(sig)
2248 else:
2249 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002250
Nick Coghlane8c45d62013-07-28 20:00:01 +10002251 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05002252 if follow_wrapper_chains:
2253 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Yury Selivanov46c759d2015-05-27 21:56:53 -04002254 if isinstance(obj, types.MethodType):
2255 # If the unwrapped object is a *method*, we might want to
2256 # skip its first parameter (self).
2257 # See test_signature_wrapped_bound_method for details.
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002258 return _signature_from_callable(
Yury Selivanov46c759d2015-05-27 21:56:53 -04002259 obj,
2260 follow_wrapper_chains=follow_wrapper_chains,
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002261 skip_bound_arg=skip_bound_arg,
2262 sigcls=sigcls)
Nick Coghlane8c45d62013-07-28 20:00:01 +10002263
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002264 try:
2265 sig = obj.__signature__
2266 except AttributeError:
2267 pass
2268 else:
2269 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07002270 if not isinstance(sig, Signature):
2271 raise TypeError(
2272 'unexpected object {!r} in __signature__ '
2273 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002274 return sig
2275
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002276 try:
2277 partialmethod = obj._partialmethod
2278 except AttributeError:
2279 pass
2280 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05002281 if isinstance(partialmethod, functools.partialmethod):
2282 # Unbound partialmethod (see functools.partialmethod)
2283 # This means, that we need to calculate the signature
2284 # as if it's a regular partial object, but taking into
2285 # account that the first positional argument
2286 # (usually `self`, or `cls`) will not be passed
2287 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002288
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002289 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002290 partialmethod.func,
2291 follow_wrapper_chains=follow_wrapper_chains,
2292 skip_bound_arg=skip_bound_arg,
2293 sigcls=sigcls)
2294
Yury Selivanov0486f812014-01-29 12:18:59 -05002295 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanov0486f812014-01-29 12:18:59 -05002296 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
Dong-hee Na378d7062017-05-18 04:00:51 +09002297 if first_wrapped_param.kind is Parameter.VAR_POSITIONAL:
2298 # First argument of the wrapped callable is `*args`, as in
2299 # `partialmethod(lambda *args)`.
2300 return sig
2301 else:
2302 sig_params = tuple(sig.parameters.values())
Yury Selivanov8a387212018-03-06 12:59:45 -05002303 assert (not sig_params or
2304 first_wrapped_param is not sig_params[0])
Dong-hee Na378d7062017-05-18 04:00:51 +09002305 new_params = (first_wrapped_param,) + sig_params
2306 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002307
Yury Selivanov63da7c72014-01-31 14:48:37 -05002308 if isfunction(obj) or _signature_is_functionlike(obj):
2309 # If it's a pure Python function, or an object that is duck type
2310 # of a Python function (Cython functions, for instance), then:
Yury Selivanovcf45f022015-05-20 14:38:50 -04002311 return _signature_from_function(sigcls, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002312
Yury Selivanova773de02014-02-21 18:30:53 -05002313 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04002314 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05002315 skip_bound_arg=skip_bound_arg)
2316
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002317 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002318 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002319 obj.func,
2320 follow_wrapper_chains=follow_wrapper_chains,
2321 skip_bound_arg=skip_bound_arg,
2322 sigcls=sigcls)
Yury Selivanov62560fb2014-01-28 12:26:24 -05002323 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002324
2325 sig = None
2326 if isinstance(obj, type):
2327 # obj is a class or a metaclass
2328
2329 # First, let's see if it has an overloaded __call__ defined
2330 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002331 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002332 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002333 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002334 call,
2335 follow_wrapper_chains=follow_wrapper_chains,
2336 skip_bound_arg=skip_bound_arg,
2337 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002338 else:
2339 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002340 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002341 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002342 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002343 new,
2344 follow_wrapper_chains=follow_wrapper_chains,
2345 skip_bound_arg=skip_bound_arg,
2346 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002347 else:
2348 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002349 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002350 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002351 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002352 init,
2353 follow_wrapper_chains=follow_wrapper_chains,
2354 skip_bound_arg=skip_bound_arg,
2355 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002356
2357 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002358 # At this point we know, that `obj` is a class, with no user-
2359 # defined '__init__', '__new__', or class-level '__call__'
2360
Larry Hastings2623c8c2014-02-08 22:15:29 -08002361 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002362 # Since '__text_signature__' is implemented as a
2363 # descriptor that extracts text signature from the
2364 # class docstring, if 'obj' is derived from a builtin
2365 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002366 # Therefore, we go through the MRO (except the last
2367 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002368 # class with non-empty text signature.
2369 try:
2370 text_sig = base.__text_signature__
2371 except AttributeError:
2372 pass
2373 else:
2374 if text_sig:
2375 # If 'obj' class has a __text_signature__ attribute:
2376 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002377 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002378
2379 # No '__text_signature__' was found for the 'obj' class.
2380 # Last option is to check if its '__init__' is
2381 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002382 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002383 # We have a class (not metaclass), but no user-defined
2384 # __init__ or __new__ for it
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002385 if (obj.__init__ is object.__init__ and
2386 obj.__new__ is object.__new__):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002387 # Return a signature of 'object' builtin.
2388 return signature(object)
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002389 else:
2390 raise ValueError(
2391 'no signature found for builtin type {!r}'.format(obj))
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002392
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002393 elif not isinstance(obj, _NonUserDefinedCallables):
2394 # An object with __call__
2395 # We also check that the 'obj' is not an instance of
2396 # _WrapperDescriptor or _MethodWrapper to avoid
2397 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002398 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002399 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002400 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002401 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002402 call,
2403 follow_wrapper_chains=follow_wrapper_chains,
2404 skip_bound_arg=skip_bound_arg,
2405 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002406 except ValueError as ex:
2407 msg = 'no signature found for {!r}'.format(obj)
2408 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002409
2410 if sig is not None:
2411 # For classes and objects we skip the first parameter of their
2412 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002413 if skip_bound_arg:
2414 return _signature_bound_method(sig)
2415 else:
2416 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002417
2418 if isinstance(obj, types.BuiltinFunctionType):
2419 # Raise a nicer error message for builtins
2420 msg = 'no signature found for builtin function {!r}'.format(obj)
2421 raise ValueError(msg)
2422
2423 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2424
2425
2426class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002427 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002428
2429
2430class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002431 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002432
2433
Yury Selivanov21e83a52014-03-27 11:23:13 -04002434class _ParameterKind(enum.IntEnum):
2435 POSITIONAL_ONLY = 0
2436 POSITIONAL_OR_KEYWORD = 1
2437 VAR_POSITIONAL = 2
2438 KEYWORD_ONLY = 3
2439 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002440
2441 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002442 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002443
Dong-hee Na4aa30062018-06-08 12:46:31 +09002444 @property
2445 def description(self):
2446 return _PARAM_NAME_MAPPING[self]
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002447
Yury Selivanov21e83a52014-03-27 11:23:13 -04002448_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2449_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2450_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2451_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2452_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002453
Dong-hee Naa9cab432018-05-30 00:04:08 +09002454_PARAM_NAME_MAPPING = {
2455 _POSITIONAL_ONLY: 'positional-only',
2456 _POSITIONAL_OR_KEYWORD: 'positional or keyword',
2457 _VAR_POSITIONAL: 'variadic positional',
2458 _KEYWORD_ONLY: 'keyword-only',
2459 _VAR_KEYWORD: 'variadic keyword'
2460}
2461
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002462
2463class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002464 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002465
2466 Has the following public attributes:
2467
2468 * name : str
2469 The name of the parameter as a string.
2470 * default : object
2471 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002472 parameter has no default value, this attribute is set to
2473 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002474 * annotation
2475 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002476 parameter has no annotation, this attribute is set to
2477 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002478 * kind : str
2479 Describes how argument values are bound to the parameter.
2480 Possible values: `Parameter.POSITIONAL_ONLY`,
2481 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2482 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002483 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002484
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002485 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002486
2487 POSITIONAL_ONLY = _POSITIONAL_ONLY
2488 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2489 VAR_POSITIONAL = _VAR_POSITIONAL
2490 KEYWORD_ONLY = _KEYWORD_ONLY
2491 VAR_KEYWORD = _VAR_KEYWORD
2492
2493 empty = _empty
2494
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002495 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002496 try:
2497 self._kind = _ParameterKind(kind)
2498 except ValueError:
2499 raise ValueError(f'value {kind!r} is not a valid Parameter.kind')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002500 if default is not _empty:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002501 if self._kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2502 msg = '{} parameters cannot have default values'
Dong-hee Na4aa30062018-06-08 12:46:31 +09002503 msg = msg.format(self._kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002504 raise ValueError(msg)
2505 self._default = default
2506 self._annotation = annotation
2507
Yury Selivanov2393dca2014-01-27 15:07:58 -05002508 if name is _empty:
2509 raise ValueError('name is a required attribute for Parameter')
2510
2511 if not isinstance(name, str):
Dong-hee Naa9cab432018-05-30 00:04:08 +09002512 msg = 'name must be a str, not a {}'.format(type(name).__name__)
2513 raise TypeError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002514
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002515 if name[0] == '.' and name[1:].isdigit():
2516 # These are implicit arguments generated by comprehensions. In
2517 # order to provide a friendlier interface to users, we recast
2518 # their name as "implicitN" and treat them as positional-only.
2519 # See issue 19611.
Dong-hee Naa9cab432018-05-30 00:04:08 +09002520 if self._kind != _POSITIONAL_OR_KEYWORD:
2521 msg = (
2522 'implicit arguments must be passed as '
2523 'positional or keyword arguments, not {}'
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002524 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002525 msg = msg.format(self._kind.description)
Dong-hee Naa9cab432018-05-30 00:04:08 +09002526 raise ValueError(msg)
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002527 self._kind = _POSITIONAL_ONLY
2528 name = 'implicit{}'.format(name[1:])
2529
Yury Selivanov2393dca2014-01-27 15:07:58 -05002530 if not name.isidentifier():
2531 raise ValueError('{!r} is not a valid parameter name'.format(name))
2532
2533 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002534
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002535 def __reduce__(self):
2536 return (type(self),
2537 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002538 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002539 '_annotation': self._annotation})
2540
2541 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002542 self._default = state['_default']
2543 self._annotation = state['_annotation']
2544
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002545 @property
2546 def name(self):
2547 return self._name
2548
2549 @property
2550 def default(self):
2551 return self._default
2552
2553 @property
2554 def annotation(self):
2555 return self._annotation
2556
2557 @property
2558 def kind(self):
2559 return self._kind
2560
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002561 def replace(self, *, name=_void, kind=_void,
2562 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002563 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002564
2565 if name is _void:
2566 name = self._name
2567
2568 if kind is _void:
2569 kind = self._kind
2570
2571 if annotation is _void:
2572 annotation = self._annotation
2573
2574 if default is _void:
2575 default = self._default
2576
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002577 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002578
2579 def __str__(self):
2580 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002581 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002582
2583 # Add annotation and default value
2584 if self._annotation is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002585 formatted = '{}: {}'.format(formatted,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002586 formatannotation(self._annotation))
2587
2588 if self._default is not _empty:
Dong-hee Na762b9572017-11-16 03:30:59 +09002589 if self._annotation is not _empty:
2590 formatted = '{} = {}'.format(formatted, repr(self._default))
2591 else:
2592 formatted = '{}={}'.format(formatted, repr(self._default))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002593
2594 if kind == _VAR_POSITIONAL:
2595 formatted = '*' + formatted
2596 elif kind == _VAR_KEYWORD:
2597 formatted = '**' + formatted
2598
2599 return formatted
2600
2601 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002602 return '<{} "{}">'.format(self.__class__.__name__, self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002603
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002604 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002605 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002606
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002607 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002608 if self is other:
2609 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002610 if not isinstance(other, Parameter):
2611 return NotImplemented
2612 return (self._name == other._name and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002613 self._kind == other._kind and
2614 self._default == other._default and
2615 self._annotation == other._annotation)
2616
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002617
2618class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002619 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002620 to the function's parameters.
2621
2622 Has the following public attributes:
2623
2624 * arguments : OrderedDict
2625 An ordered mutable mapping of parameters' names to arguments' values.
2626 Does not contain arguments' default values.
2627 * signature : Signature
2628 The Signature object that created this instance.
2629 * args : tuple
2630 Tuple of positional arguments values.
2631 * kwargs : dict
2632 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002633 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002634
Yury Selivanov6abe0322015-05-13 17:18:41 -04002635 __slots__ = ('arguments', '_signature', '__weakref__')
2636
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002637 def __init__(self, signature, arguments):
2638 self.arguments = arguments
2639 self._signature = signature
2640
2641 @property
2642 def signature(self):
2643 return self._signature
2644
2645 @property
2646 def args(self):
2647 args = []
2648 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002649 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002650 break
2651
2652 try:
2653 arg = self.arguments[param_name]
2654 except KeyError:
2655 # We're done here. Other arguments
2656 # will be mapped in 'BoundArguments.kwargs'
2657 break
2658 else:
2659 if param.kind == _VAR_POSITIONAL:
2660 # *args
2661 args.extend(arg)
2662 else:
2663 # plain argument
2664 args.append(arg)
2665
2666 return tuple(args)
2667
2668 @property
2669 def kwargs(self):
2670 kwargs = {}
2671 kwargs_started = False
2672 for param_name, param in self._signature.parameters.items():
2673 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002674 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002675 kwargs_started = True
2676 else:
2677 if param_name not in self.arguments:
2678 kwargs_started = True
2679 continue
2680
2681 if not kwargs_started:
2682 continue
2683
2684 try:
2685 arg = self.arguments[param_name]
2686 except KeyError:
2687 pass
2688 else:
2689 if param.kind == _VAR_KEYWORD:
2690 # **kwargs
2691 kwargs.update(arg)
2692 else:
2693 # plain keyword argument
2694 kwargs[param_name] = arg
2695
2696 return kwargs
2697
Yury Selivanovb907a512015-05-16 13:45:09 -04002698 def apply_defaults(self):
2699 """Set default values for missing arguments.
2700
2701 For variable-positional arguments (*args) the default is an
2702 empty tuple.
2703
2704 For variable-keyword arguments (**kwargs) the default is an
2705 empty dict.
2706 """
2707 arguments = self.arguments
Yury Selivanovb907a512015-05-16 13:45:09 -04002708 new_arguments = []
2709 for name, param in self._signature.parameters.items():
2710 try:
2711 new_arguments.append((name, arguments[name]))
2712 except KeyError:
2713 if param.default is not _empty:
2714 val = param.default
2715 elif param.kind is _VAR_POSITIONAL:
2716 val = ()
2717 elif param.kind is _VAR_KEYWORD:
2718 val = {}
2719 else:
2720 # This BoundArguments was likely produced by
2721 # Signature.bind_partial().
2722 continue
2723 new_arguments.append((name, val))
2724 self.arguments = OrderedDict(new_arguments)
2725
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002726 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002727 if self is other:
2728 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002729 if not isinstance(other, BoundArguments):
2730 return NotImplemented
2731 return (self.signature == other.signature and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002732 self.arguments == other.arguments)
2733
Yury Selivanov6abe0322015-05-13 17:18:41 -04002734 def __setstate__(self, state):
2735 self._signature = state['_signature']
2736 self.arguments = state['arguments']
2737
2738 def __getstate__(self):
2739 return {'_signature': self._signature, 'arguments': self.arguments}
2740
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002741 def __repr__(self):
2742 args = []
2743 for arg, value in self.arguments.items():
2744 args.append('{}={!r}'.format(arg, value))
Yury Selivanovf229bc52015-05-15 12:53:56 -04002745 return '<{} ({})>'.format(self.__class__.__name__, ', '.join(args))
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002746
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002747
2748class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002749 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002750 It stores a Parameter object for each parameter accepted by the
2751 function, as well as information specific to the function itself.
2752
2753 A Signature object has the following public attributes and methods:
2754
2755 * parameters : OrderedDict
2756 An ordered mapping of parameters' names to the corresponding
2757 Parameter objects (keyword-only arguments are in the same order
2758 as listed in `code.co_varnames`).
2759 * return_annotation : object
2760 The annotation for the return type of the function if specified.
2761 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002762 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002763 * bind(*args, **kwargs) -> BoundArguments
2764 Creates a mapping from positional and keyword arguments to
2765 parameters.
2766 * bind_partial(*args, **kwargs) -> BoundArguments
2767 Creates a partial mapping from positional and keyword arguments
2768 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002769 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002770
2771 __slots__ = ('_return_annotation', '_parameters')
2772
2773 _parameter_cls = Parameter
2774 _bound_arguments_cls = BoundArguments
2775
2776 empty = _empty
2777
2778 def __init__(self, parameters=None, *, return_annotation=_empty,
2779 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002780 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002781 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002782 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002783
2784 if parameters is None:
2785 params = OrderedDict()
2786 else:
2787 if __validate_parameters__:
2788 params = OrderedDict()
2789 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002790 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002791
2792 for idx, param in enumerate(parameters):
2793 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002794 name = param.name
2795
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002796 if kind < top_kind:
Dong-hee Naa9cab432018-05-30 00:04:08 +09002797 msg = (
2798 'wrong parameter order: {} parameter before {} '
2799 'parameter'
2800 )
Dong-hee Na4aa30062018-06-08 12:46:31 +09002801 msg = msg.format(top_kind.description,
2802 kind.description)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002803 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002804 elif kind > top_kind:
2805 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002806 top_kind = kind
2807
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002808 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002809 if param.default is _empty:
2810 if kind_defaults:
2811 # No default for this parameter, but the
2812 # previous parameter of the same kind had
2813 # a default
2814 msg = 'non-default argument follows default ' \
2815 'argument'
2816 raise ValueError(msg)
2817 else:
2818 # There is a default for this parameter.
2819 kind_defaults = True
2820
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002821 if name in params:
2822 msg = 'duplicate parameter name: {!r}'.format(name)
2823 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002824
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002825 params[name] = param
2826 else:
2827 params = OrderedDict(((param.name, param)
2828 for param in parameters))
2829
2830 self._parameters = types.MappingProxyType(params)
2831 self._return_annotation = return_annotation
2832
2833 @classmethod
2834 def from_function(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002835 """Constructs Signature for the given python function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002836
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002837 Deprecated since Python 3.5, use `Signature.from_callable()`.
2838 """
2839
2840 warnings.warn("inspect.Signature.from_function() is deprecated since "
2841 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002842 DeprecationWarning, stacklevel=2)
Yury Selivanovcf45f022015-05-20 14:38:50 -04002843 return _signature_from_function(cls, func)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002844
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002845 @classmethod
2846 def from_builtin(cls, func):
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002847 """Constructs Signature for the given builtin function.
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002848
Matthias Bussonnierded87d82018-10-19 16:40:45 -07002849 Deprecated since Python 3.5, use `Signature.from_callable()`.
2850 """
2851
2852 warnings.warn("inspect.Signature.from_builtin() is deprecated since "
2853 "Python 3.5, use Signature.from_callable()",
Berker Peksagb5601582015-05-21 23:40:54 +03002854 DeprecationWarning, stacklevel=2)
Yury Selivanov57d240e2014-02-19 16:27:23 -05002855 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002856
Yury Selivanovda396452014-03-27 12:09:24 -04002857 @classmethod
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002858 def from_callable(cls, obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002859 """Constructs Signature for the given callable object."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002860 return _signature_from_callable(obj, sigcls=cls,
2861 follow_wrapper_chains=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002862
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002863 @property
2864 def parameters(self):
2865 return self._parameters
2866
2867 @property
2868 def return_annotation(self):
2869 return self._return_annotation
2870
2871 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002872 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002873 Pass 'parameters' and/or 'return_annotation' arguments
2874 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002875 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002876
2877 if parameters is _void:
2878 parameters = self.parameters.values()
2879
2880 if return_annotation is _void:
2881 return_annotation = self._return_annotation
2882
2883 return type(self)(parameters,
2884 return_annotation=return_annotation)
2885
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002886 def _hash_basis(self):
2887 params = tuple(param for param in self.parameters.values()
2888 if param.kind != _KEYWORD_ONLY)
2889
2890 kwo_params = {param.name: param for param in self.parameters.values()
2891 if param.kind == _KEYWORD_ONLY}
2892
2893 return params, kwo_params, self.return_annotation
2894
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002895 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002896 params, kwo_params, return_annotation = self._hash_basis()
2897 kwo_params = frozenset(kwo_params.values())
2898 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002899
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002900 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002901 if self is other:
2902 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002903 if not isinstance(other, Signature):
2904 return NotImplemented
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002905 return self._hash_basis() == other._hash_basis()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002906
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002907 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002908 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002909
2910 arguments = OrderedDict()
2911
2912 parameters = iter(self.parameters.values())
2913 parameters_ex = ()
2914 arg_vals = iter(args)
2915
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002916 while True:
2917 # Let's iterate through the positional arguments and corresponding
2918 # parameters
2919 try:
2920 arg_val = next(arg_vals)
2921 except StopIteration:
2922 # No more positional arguments
2923 try:
2924 param = next(parameters)
2925 except StopIteration:
2926 # No more parameters. That's it. Just need to check that
2927 # we have no `kwargs` after this while loop
2928 break
2929 else:
2930 if param.kind == _VAR_POSITIONAL:
2931 # That's OK, just empty *args. Let's start parsing
2932 # kwargs
2933 break
2934 elif param.name in kwargs:
2935 if param.kind == _POSITIONAL_ONLY:
2936 msg = '{arg!r} parameter is positional only, ' \
2937 'but was passed as a keyword'
2938 msg = msg.format(arg=param.name)
2939 raise TypeError(msg) from None
2940 parameters_ex = (param,)
2941 break
2942 elif (param.kind == _VAR_KEYWORD or
2943 param.default is not _empty):
2944 # That's fine too - we have a default value for this
2945 # parameter. So, lets start parsing `kwargs`, starting
2946 # with the current parameter
2947 parameters_ex = (param,)
2948 break
2949 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002950 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2951 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002952 if partial:
2953 parameters_ex = (param,)
2954 break
2955 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002956 msg = 'missing a required argument: {arg!r}'
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002957 msg = msg.format(arg=param.name)
2958 raise TypeError(msg) from None
2959 else:
2960 # We have a positional argument to process
2961 try:
2962 param = next(parameters)
2963 except StopIteration:
2964 raise TypeError('too many positional arguments') from None
2965 else:
2966 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2967 # Looks like we have no parameter for this positional
2968 # argument
Yury Selivanov86872752015-05-19 00:27:49 -04002969 raise TypeError(
2970 'too many positional arguments') from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002971
2972 if param.kind == _VAR_POSITIONAL:
2973 # We have an '*args'-like argument, let's fill it with
2974 # all positional arguments we have left and move on to
2975 # the next phase
2976 values = [arg_val]
2977 values.extend(arg_vals)
2978 arguments[param.name] = tuple(values)
2979 break
2980
2981 if param.name in kwargs:
Yury Selivanov86872752015-05-19 00:27:49 -04002982 raise TypeError(
2983 'multiple values for argument {arg!r}'.format(
2984 arg=param.name)) from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002985
2986 arguments[param.name] = arg_val
2987
2988 # Now, we iterate through the remaining parameters to process
2989 # keyword arguments
2990 kwargs_param = None
2991 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002992 if param.kind == _VAR_KEYWORD:
2993 # Memorize that we have a '**kwargs'-like parameter
2994 kwargs_param = param
2995 continue
2996
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002997 if param.kind == _VAR_POSITIONAL:
2998 # Named arguments don't refer to '*args'-like parameters.
2999 # We only arrive here if the positional arguments ended
3000 # before reaching the last parameter before *args.
3001 continue
3002
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003003 param_name = param.name
3004 try:
3005 arg_val = kwargs.pop(param_name)
3006 except KeyError:
3007 # We have no value for this parameter. It's fine though,
3008 # if it has a default value, or it is an '*args'-like
3009 # parameter, left alone by the processing of positional
3010 # arguments.
3011 if (not partial and param.kind != _VAR_POSITIONAL and
3012 param.default is _empty):
Yury Selivanov86872752015-05-19 00:27:49 -04003013 raise TypeError('missing a required argument: {arg!r}'. \
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003014 format(arg=param_name)) from None
3015
3016 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05003017 if param.kind == _POSITIONAL_ONLY:
3018 # This should never happen in case of a properly built
3019 # Signature object (but let's have this check here
3020 # to ensure correct behaviour just in case)
3021 raise TypeError('{arg!r} parameter is positional only, '
3022 'but was passed as a keyword'. \
3023 format(arg=param.name))
3024
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003025 arguments[param_name] = arg_val
3026
3027 if kwargs:
3028 if kwargs_param is not None:
3029 # Process our '**kwargs'-like parameter
3030 arguments[kwargs_param.name] = kwargs
3031 else:
Yury Selivanov86872752015-05-19 00:27:49 -04003032 raise TypeError(
3033 'got an unexpected keyword argument {arg!r}'.format(
3034 arg=next(iter(kwargs))))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003035
3036 return self._bound_arguments_cls(self, arguments)
3037
Yury Selivanovc45873e2014-01-29 12:10:27 -05003038 def bind(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003039 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003040 and `kwargs` to the function's signature. Raises `TypeError`
3041 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)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003044
Yury Selivanovc45873e2014-01-29 12:10:27 -05003045 def bind_partial(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003046 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003047 passed `args` and `kwargs` to the function's signature.
3048 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003049 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05003050 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003051
Yury Selivanova5d63dd2014-03-27 11:31:43 -04003052 def __reduce__(self):
3053 return (type(self),
3054 (tuple(self._parameters.values()),),
3055 {'_return_annotation': self._return_annotation})
3056
3057 def __setstate__(self, state):
3058 self._return_annotation = state['_return_annotation']
3059
Yury Selivanov374375d2014-03-27 12:41:53 -04003060 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04003061 return '<{} {}>'.format(self.__class__.__name__, self)
Yury Selivanov374375d2014-03-27 12:41:53 -04003062
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003063 def __str__(self):
3064 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05003065 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003066 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05003067 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003068 formatted = str(param)
3069
3070 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05003071
3072 if kind == _POSITIONAL_ONLY:
3073 render_pos_only_separator = True
3074 elif render_pos_only_separator:
3075 # It's not a positional-only parameter, and the flag
3076 # is set to 'True' (there were pos-only params before.)
3077 result.append('/')
3078 render_pos_only_separator = False
3079
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003080 if kind == _VAR_POSITIONAL:
3081 # OK, we have an '*args'-like parameter, so we won't need
3082 # a '*' to separate keyword-only arguments
3083 render_kw_only_separator = False
3084 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
3085 # We have a keyword-only parameter to render and we haven't
3086 # rendered an '*args'-like parameter before, so add a '*'
3087 # separator to the parameters list ("foo(arg1, *, arg2)" case)
3088 result.append('*')
3089 # This condition should be only triggered once, so
3090 # reset the flag
3091 render_kw_only_separator = False
3092
3093 result.append(formatted)
3094
Yury Selivanov2393dca2014-01-27 15:07:58 -05003095 if render_pos_only_separator:
3096 # There were only positional-only parameters, hence the
3097 # flag was not reset to 'False'
3098 result.append('/')
3099
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003100 rendered = '({})'.format(', '.join(result))
3101
3102 if self.return_annotation is not _empty:
3103 anno = formatannotation(self.return_annotation)
3104 rendered += ' -> {}'.format(anno)
3105
3106 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003107
Yury Selivanovda396452014-03-27 12:09:24 -04003108
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003109def signature(obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003110 """Get a signature object for the passed callable."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003111 return Signature.from_callable(obj, follow_wrapped=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04003112
3113
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003114def _main():
3115 """ Logic for inspecting an object given at command line """
3116 import argparse
3117 import importlib
3118
3119 parser = argparse.ArgumentParser()
3120 parser.add_argument(
3121 'object',
3122 help="The object to be analysed. "
3123 "It supports the 'module:qualname' syntax")
3124 parser.add_argument(
3125 '-d', '--details', action='store_true',
3126 help='Display info about the module rather than its source code')
3127
3128 args = parser.parse_args()
3129
3130 target = args.object
3131 mod_name, has_attrs, attrs = target.partition(":")
3132 try:
3133 obj = module = importlib.import_module(mod_name)
3134 except Exception as exc:
3135 msg = "Failed to import {} ({}: {})".format(mod_name,
3136 type(exc).__name__,
3137 exc)
3138 print(msg, file=sys.stderr)
3139 exit(2)
3140
3141 if has_attrs:
3142 parts = attrs.split(".")
3143 obj = module
3144 for part in parts:
3145 obj = getattr(obj, part)
3146
3147 if module.__name__ in sys.builtin_module_names:
3148 print("Can't get info for builtin modules.", file=sys.stderr)
3149 exit(1)
3150
3151 if args.details:
3152 print('Target: {}'.format(target))
3153 print('Origin: {}'.format(getsourcefile(module)))
3154 print('Cached: {}'.format(module.__cached__))
3155 if obj is module:
3156 print('Loader: {}'.format(repr(module.__loader__)))
3157 if hasattr(module, '__path__'):
3158 print('Submodule search path: {}'.format(module.__path__))
3159 else:
3160 try:
3161 __, lineno = findsource(obj)
3162 except Exception:
3163 pass
3164 else:
3165 print('Line: {}'.format(lineno))
3166
3167 print('\n')
3168 else:
3169 print(getsource(obj))
3170
3171
3172if __name__ == "__main__":
3173 _main()