blob: 9a843d6420e2e09133c270296df8fc38bc4cc1e9 [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
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000021 formatargspec(), formatargvalues() - format an argument spec
22 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
Larry Hastings44e2eaa2013-11-23 15:37:55 -080035import ast
Antoine Pitroua8723a02015-04-15 00:41:29 +020036import dis
Yury Selivanov75445082015-05-11 22:57:16 -040037import collections.abc
Yury Selivanov21e83a52014-03-27 11:23:13 -040038import enum
Brett Cannoncb66eb02012-05-11 12:58:42 -040039import importlib.machinery
40import itertools
Christian Heimes7131fd92008-02-19 14:21:46 +000041import linecache
Brett Cannoncb66eb02012-05-11 12:58:42 -040042import os
43import re
44import sys
45import tokenize
Larry Hastings2623c8c2014-02-08 22:15:29 -080046import token
Brett Cannoncb66eb02012-05-11 12:58:42 -040047import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040048import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070049import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100050import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000051from operator import attrgetter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070052from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000053
54# Create constants for the compiler flags in Include/code.h
Antoine Pitroua8723a02015-04-15 00:41:29 +020055# We try to get them from dis to avoid duplication
56mod_dict = globals()
57for k, v in dis.COMPILER_FLAG_NAMES.items():
58 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000059
Christian Heimesbe5b30b2008-03-03 19:18:51 +000060# See Include/object.h
61TPFLAGS_IS_ABSTRACT = 1 << 20
62
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000063# ----------------------------------------------------------- type-checking
64def ismodule(object):
65 """Return true if the object is a module.
66
67 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000068 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000069 __doc__ documentation string
70 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000071 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000072
73def isclass(object):
74 """Return true if the object is a class.
75
76 Class objects provide these attributes:
77 __doc__ documentation string
78 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000079 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000080
81def ismethod(object):
82 """Return true if the object is an instance method.
83
84 Instance method objects provide these attributes:
85 __doc__ documentation string
86 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000087 __func__ function object containing implementation of method
88 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000089 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000090
Tim Peters536d2262001-09-20 05:13:38 +000091def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000092 """Return true if the object is a method descriptor.
93
94 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +000095
96 This is new in Python 2.2, and, for example, is true of int.__add__.
97 An object passing this test has a __get__ attribute but not a __set__
98 attribute, but beyond that the set of attributes varies. __name__ is
99 usually sensible, and __doc__ often is.
100
Tim Petersf1d90b92001-09-20 05:47:55 +0000101 Methods implemented via descriptors that also pass one of the other
102 tests return false from the ismethoddescriptor() test, simply because
103 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000104 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100105 if isclass(object) or ismethod(object) or isfunction(object):
106 # mutual exclusion
107 return False
108 tp = type(object)
109 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000110
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000111def isdatadescriptor(object):
112 """Return true if the object is a data descriptor.
113
114 Data descriptors have both a __get__ and a __set__ attribute. Examples are
115 properties (defined in Python) and getsets and members (defined in C).
116 Typically, data descriptors will also have __name__ and __doc__ attributes
117 (properties, getsets, and members have both of these attributes), but this
118 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100119 if isclass(object) or ismethod(object) or isfunction(object):
120 # mutual exclusion
121 return False
122 tp = type(object)
123 return hasattr(tp, "__set__") and hasattr(tp, "__get__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000124
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000125if hasattr(types, 'MemberDescriptorType'):
126 # CPython and equivalent
127 def ismemberdescriptor(object):
128 """Return true if the object is a member descriptor.
129
130 Member descriptors are specialized descriptors defined in extension
131 modules."""
132 return isinstance(object, types.MemberDescriptorType)
133else:
134 # Other implementations
135 def ismemberdescriptor(object):
136 """Return true if the object is a member descriptor.
137
138 Member descriptors are specialized descriptors defined in extension
139 modules."""
140 return False
141
142if hasattr(types, 'GetSetDescriptorType'):
143 # CPython and equivalent
144 def isgetsetdescriptor(object):
145 """Return true if the object is a getset descriptor.
146
147 getset descriptors are specialized descriptors defined in extension
148 modules."""
149 return isinstance(object, types.GetSetDescriptorType)
150else:
151 # Other implementations
152 def isgetsetdescriptor(object):
153 """Return true if the object is a getset descriptor.
154
155 getset descriptors are specialized descriptors defined in extension
156 modules."""
157 return False
158
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000159def isfunction(object):
160 """Return true if the object is a user-defined function.
161
162 Function objects provide these attributes:
163 __doc__ documentation string
164 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000165 __code__ code object containing compiled function bytecode
166 __defaults__ tuple of any default values for arguments
167 __globals__ global namespace in which this function was defined
168 __annotations__ dict of parameter annotations
169 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000170 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000171
Christian Heimes7131fd92008-02-19 14:21:46 +0000172def isgeneratorfunction(object):
173 """Return true if the object is a user-defined generator function.
174
Martin Panter0f0eac42016-09-07 11:04:41 +0000175 Generator function objects provide the same attributes as functions.
176 See help(isfunction) for a list of attributes."""
Georg Brandlb1441c72009-01-03 22:33:39 +0000177 return bool((isfunction(object) or ismethod(object)) and
Yury Selivanov5376ba92015-06-22 12:19:30 -0400178 object.__code__.co_flags & CO_GENERATOR)
Yury Selivanov75445082015-05-11 22:57:16 -0400179
180def iscoroutinefunction(object):
181 """Return true if the object is a coroutine function.
182
Yury Selivanov4778e132016-11-08 12:23:09 -0500183 Coroutine functions are defined with "async def" syntax.
Yury Selivanov75445082015-05-11 22:57:16 -0400184 """
185 return bool((isfunction(object) or ismethod(object)) and
Yury Selivanov5376ba92015-06-22 12:19:30 -0400186 object.__code__.co_flags & CO_COROUTINE)
Yury Selivanov75445082015-05-11 22:57:16 -0400187
Yury Selivanoveb636452016-09-08 22:01:51 -0700188def isasyncgenfunction(object):
Yury Selivanov4778e132016-11-08 12:23:09 -0500189 """Return true if the object is an asynchronous generator function.
190
191 Asynchronous generator functions are defined with "async def"
192 syntax and have "yield" expressions in their body.
193 """
Yury Selivanoveb636452016-09-08 22:01:51 -0700194 return bool((isfunction(object) or ismethod(object)) and
195 object.__code__.co_flags & CO_ASYNC_GENERATOR)
196
197def isasyncgen(object):
Yury Selivanov4778e132016-11-08 12:23:09 -0500198 """Return true if the object is an asynchronous generator."""
Yury Selivanoveb636452016-09-08 22:01:51 -0700199 return isinstance(object, types.AsyncGeneratorType)
200
Christian Heimes7131fd92008-02-19 14:21:46 +0000201def isgenerator(object):
202 """Return true if the object is a generator.
203
204 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300205 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000206 close raises a new GeneratorExit exception inside the
207 generator to terminate the iteration
208 gi_code code object
209 gi_frame frame object or possibly None once the generator has
210 been exhausted
211 gi_running set to 1 when generator is executing, 0 otherwise
212 next return the next item from the container
213 send resumes the generator and "sends" a value that becomes
214 the result of the current yield-expression
215 throw used to raise an exception inside the generator"""
Yury Selivanov5376ba92015-06-22 12:19:30 -0400216 return isinstance(object, types.GeneratorType)
Yury Selivanov75445082015-05-11 22:57:16 -0400217
218def iscoroutine(object):
219 """Return true if the object is a coroutine."""
Yury Selivanov5376ba92015-06-22 12:19:30 -0400220 return isinstance(object, types.CoroutineType)
Christian Heimes7131fd92008-02-19 14:21:46 +0000221
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400222def isawaitable(object):
Yury Selivanovc0215df2016-11-08 19:57:44 -0500223 """Return true if object can be passed to an ``await`` expression."""
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400224 return (isinstance(object, types.CoroutineType) or
225 isinstance(object, types.GeneratorType) and
Yury Selivanovc0215df2016-11-08 19:57:44 -0500226 bool(object.gi_code.co_flags & CO_ITERABLE_COROUTINE) or
Yury Selivanovfdbeb2b2015-07-03 13:11:35 -0400227 isinstance(object, collections.abc.Awaitable))
228
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000229def istraceback(object):
230 """Return true if the object is a traceback.
231
232 Traceback objects provide these attributes:
233 tb_frame frame object at this level
234 tb_lasti index of last attempted instruction in bytecode
235 tb_lineno current line number in Python source code
236 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000237 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000238
239def isframe(object):
240 """Return true if the object is a frame object.
241
242 Frame objects provide these attributes:
243 f_back next outer frame object (this frame's caller)
244 f_builtins built-in namespace seen by this frame
245 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000246 f_globals global namespace seen by this frame
247 f_lasti index of last attempted instruction in bytecode
248 f_lineno current line number in Python source code
249 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000250 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000251 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000252
253def iscode(object):
254 """Return true if the object is a code object.
255
256 Code objects provide these attributes:
Xiang Zhanga6902e62017-04-13 10:38:28 +0800257 co_argcount number of arguments (not including *, ** args
258 or keyword only arguments)
259 co_code string of raw compiled bytecode
260 co_cellvars tuple of names of cell variables
261 co_consts tuple of constants used in the bytecode
262 co_filename name of file in which this code object was created
263 co_firstlineno number of first line in Python source code
264 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
265 | 16=nested | 32=generator | 64=nofree | 128=coroutine
266 | 256=iterable_coroutine | 512=async_generator
267 co_freevars tuple of names of free variables
268 co_kwonlyargcount number of keyword only arguments (not including ** arg)
269 co_lnotab encoded mapping of line numbers to bytecode indices
270 co_name name with which this code object was defined
271 co_names tuple of names of local variables
272 co_nlocals number of local variables
273 co_stacksize virtual machine stack space required
274 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000275 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000276
277def isbuiltin(object):
278 """Return true if the object is a built-in function or method.
279
280 Built-in functions and methods provide these attributes:
281 __doc__ documentation string
282 __name__ original name of this function or method
283 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000284 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000285
286def isroutine(object):
287 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000288 return (isbuiltin(object)
289 or isfunction(object)
290 or ismethod(object)
291 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000292
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000293def isabstract(object):
294 """Return true if the object is an abstract base class (ABC)."""
Natefcfe80e2017-04-24 10:06:15 -0700295 if not isinstance(object, type):
296 return False
297 if object.__flags__ & TPFLAGS_IS_ABSTRACT:
298 return True
299 if not issubclass(type(object), abc.ABCMeta):
300 return False
301 if hasattr(object, '__abstractmethods__'):
302 # It looks like ABCMeta.__new__ has finished running;
303 # TPFLAGS_IS_ABSTRACT should have been accurate.
304 return False
305 # It looks like ABCMeta.__new__ has not finished running yet; we're
306 # probably in __init_subclass__. We'll look for abstractmethods manually.
307 for name, value in object.__dict__.items():
308 if getattr(value, "__isabstractmethod__", False):
309 return True
310 for base in object.__bases__:
311 for name in getattr(base, "__abstractmethods__", ()):
312 value = getattr(object, name, None)
313 if getattr(value, "__isabstractmethod__", False):
314 return True
315 return False
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000316
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000317def getmembers(object, predicate=None):
318 """Return all members of an object as (name, value) pairs sorted by name.
319 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100320 if isclass(object):
321 mro = (object,) + getmro(object)
322 else:
323 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000324 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700325 processed = set()
326 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700327 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700328 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700329 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700330 try:
331 for base in object.__bases__:
332 for k, v in base.__dict__.items():
333 if isinstance(v, types.DynamicClassAttribute):
334 names.append(k)
335 except AttributeError:
336 pass
337 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700338 # First try to get the value via getattr. Some descriptors don't
339 # like calling their __get__ (see bug #1785), so fall back to
340 # looking in the __dict__.
341 try:
342 value = getattr(object, key)
343 # handle the duplicate key
344 if key in processed:
345 raise AttributeError
346 except AttributeError:
347 for base in mro:
348 if key in base.__dict__:
349 value = base.__dict__[key]
350 break
351 else:
352 # could be a (currently) missing slot member, or a buggy
353 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100354 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000355 if not predicate or predicate(value):
356 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700357 processed.add(key)
358 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000359 return results
360
Christian Heimes25bb7832008-01-11 16:17:00 +0000361Attribute = namedtuple('Attribute', 'name kind defining_class object')
362
Tim Peters13b49d32001-09-23 02:00:29 +0000363def classify_class_attrs(cls):
364 """Return list of attribute-descriptor tuples.
365
366 For each name in dir(cls), the return list contains a 4-tuple
367 with these elements:
368
369 0. The name (a string).
370
371 1. The kind of attribute this is, one of these strings:
372 'class method' created via classmethod()
373 'static method' created via staticmethod()
374 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700375 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000376 'data' not a method
377
378 2. The class which defined this attribute (a class).
379
Ethan Furmane03ea372013-09-25 07:14:41 -0700380 3. The object as obtained by calling getattr; if this fails, or if the
381 resulting object does not live anywhere in the class' mro (including
382 metaclasses) then the object is looked up in the defining class's
383 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700384
385 If one of the items in dir(cls) is stored in the metaclass it will now
386 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700387 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000388 """
389
390 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700391 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Jon Dufresne39726282017-05-18 07:35:54 -0700392 metamro = tuple(cls for cls in metamro if cls not in (type, object))
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700393 class_bases = (cls,) + mro
394 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000395 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700396 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700397 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700398 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700399 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700400 for k, v in base.__dict__.items():
401 if isinstance(v, types.DynamicClassAttribute):
402 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000403 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700404 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700405
Tim Peters13b49d32001-09-23 02:00:29 +0000406 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100407 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700408 # Normal objects will be looked up with both getattr and directly in
409 # its class' dict (in case getattr fails [bug #1785], and also to look
410 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700411 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700412 # class's dict.
413 #
Tim Peters13b49d32001-09-23 02:00:29 +0000414 # Getting an obj from the __dict__ sometimes reveals more than
415 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100416 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700417 get_obj = None
418 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700419 if name not in processed:
420 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700421 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700422 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700423 get_obj = getattr(cls, name)
424 except Exception as exc:
425 pass
426 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700427 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700428 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700429 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700430 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700431 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700432 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700433 # first look in the classes
434 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700435 srch_obj = getattr(srch_cls, name, None)
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400436 if srch_obj is get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700437 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700438 # then check the metaclasses
439 for srch_cls in metamro:
440 try:
441 srch_obj = srch_cls.__getattr__(cls, name)
442 except AttributeError:
443 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400444 if srch_obj is get_obj:
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700445 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700446 if last_cls is not None:
447 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700448 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700449 if name in base.__dict__:
450 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700451 if homecls not in metamro:
452 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700453 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700454 if homecls is None:
455 # unable to locate the attribute anywhere, most likely due to
456 # buggy custom __dir__; discard and move on
457 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400458 obj = get_obj if get_obj is not None else dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700459 # Classify the object or its descriptor.
Ethan Furman63c141c2013-10-18 00:27:39 -0700460 if isinstance(dict_obj, staticmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000461 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700462 obj = dict_obj
Ethan Furman63c141c2013-10-18 00:27:39 -0700463 elif isinstance(dict_obj, classmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000464 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700465 obj = dict_obj
466 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000467 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700468 obj = dict_obj
Yury Selivanov0860a0b2014-01-31 14:28:44 -0500469 elif isroutine(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000470 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100471 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700472 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000473 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700474 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000475 return result
476
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000477# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000478
479def getmro(cls):
480 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000481 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000482
Nick Coghlane8c45d62013-07-28 20:00:01 +1000483# -------------------------------------------------------- function helpers
484
485def unwrap(func, *, stop=None):
486 """Get the object wrapped by *func*.
487
488 Follows the chain of :attr:`__wrapped__` attributes returning the last
489 object in the chain.
490
491 *stop* is an optional callback accepting an object in the wrapper chain
492 as its sole argument that allows the unwrapping to be terminated early if
493 the callback returns a true value. If the callback never returns a true
494 value, the last object in the chain is returned as usual. For example,
495 :func:`signature` uses this to stop unwrapping if any object in the
496 chain has a ``__signature__`` attribute defined.
497
498 :exc:`ValueError` is raised if a cycle is encountered.
499
500 """
501 if stop is None:
502 def _is_wrapper(f):
503 return hasattr(f, '__wrapped__')
504 else:
505 def _is_wrapper(f):
506 return hasattr(f, '__wrapped__') and not stop(f)
507 f = func # remember the original func for error reporting
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100508 # Memoise by id to tolerate non-hashable objects, but store objects to
509 # ensure they aren't destroyed, which would allow their IDs to be reused.
510 memo = {id(f): f}
511 recursion_limit = sys.getrecursionlimit()
Nick Coghlane8c45d62013-07-28 20:00:01 +1000512 while _is_wrapper(func):
513 func = func.__wrapped__
514 id_func = id(func)
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100515 if (id_func in memo) or (len(memo) >= recursion_limit):
Nick Coghlane8c45d62013-07-28 20:00:01 +1000516 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
Thomas Kluyverf9169ce2017-05-23 04:27:52 +0100517 memo[id_func] = func
Nick Coghlane8c45d62013-07-28 20:00:01 +1000518 return func
519
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000520# -------------------------------------------------- source code extraction
521def indentsize(line):
522 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000523 expline = line.expandtabs()
524 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000525
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300526def _findclass(func):
527 cls = sys.modules.get(func.__module__)
528 if cls is None:
529 return None
530 for name in func.__qualname__.split('.')[:-1]:
531 cls = getattr(cls, name)
532 if not isclass(cls):
533 return None
534 return cls
535
536def _finddoc(obj):
537 if isclass(obj):
538 for base in obj.__mro__:
539 if base is not object:
540 try:
541 doc = base.__doc__
542 except AttributeError:
543 continue
544 if doc is not None:
545 return doc
546 return None
547
548 if ismethod(obj):
549 name = obj.__func__.__name__
550 self = obj.__self__
551 if (isclass(self) and
552 getattr(getattr(self, name, None), '__func__') is obj.__func__):
553 # classmethod
554 cls = self
555 else:
556 cls = self.__class__
557 elif isfunction(obj):
558 name = obj.__name__
559 cls = _findclass(obj)
560 if cls is None or getattr(cls, name) is not obj:
561 return None
562 elif isbuiltin(obj):
563 name = obj.__name__
564 self = obj.__self__
565 if (isclass(self) and
566 self.__qualname__ + '.' + name == obj.__qualname__):
567 # classmethod
568 cls = self
569 else:
570 cls = self.__class__
Serhiy Storchakaac4bdcc2015-10-29 08:15:50 +0200571 # Should be tested before isdatadescriptor().
572 elif isinstance(obj, property):
573 func = obj.fget
574 name = func.__name__
575 cls = _findclass(func)
576 if cls is None or getattr(cls, name) is not obj:
577 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300578 elif ismethoddescriptor(obj) or isdatadescriptor(obj):
579 name = obj.__name__
580 cls = obj.__objclass__
581 if getattr(cls, name) is not obj:
582 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300583 else:
584 return None
585
586 for base in cls.__mro__:
587 try:
588 doc = getattr(base, name).__doc__
589 except AttributeError:
590 continue
591 if doc is not None:
592 return doc
593 return None
594
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000595def getdoc(object):
596 """Get the documentation string for an object.
597
598 All tabs are expanded to spaces. To clean up docstrings that are
599 indented to line up with blocks of code, any whitespace than can be
600 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000601 try:
602 doc = object.__doc__
603 except AttributeError:
604 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300605 if doc is None:
606 try:
607 doc = _finddoc(object)
608 except (AttributeError, TypeError):
609 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000610 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000611 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000612 return cleandoc(doc)
613
614def cleandoc(doc):
615 """Clean up indentation from docstrings.
616
617 Any whitespace that can be uniformly removed from the second line
618 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000619 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000620 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000621 except UnicodeError:
622 return None
623 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000624 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000625 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000626 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000627 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000628 if content:
629 indent = len(line) - content
630 margin = min(margin, indent)
631 # Remove indentation.
632 if lines:
633 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000634 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000635 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000636 # Remove any trailing or leading blank lines.
637 while lines and not lines[-1]:
638 lines.pop()
639 while lines and not lines[0]:
640 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000641 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000642
643def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000644 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000645 if ismodule(object):
646 if hasattr(object, '__file__'):
647 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000648 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000649 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500650 if hasattr(object, '__module__'):
651 object = sys.modules.get(object.__module__)
652 if hasattr(object, '__file__'):
653 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000654 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000655 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000656 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000657 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000658 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000659 if istraceback(object):
660 object = object.tb_frame
661 if isframe(object):
662 object = object.f_code
663 if iscode(object):
664 return object.co_filename
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000665 raise TypeError('{!r} is not a module, class, method, '
666 'function, traceback, frame, or code object'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000667
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000668def getmodulename(path):
669 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000670 fname = os.path.basename(path)
671 # Check for paths that look like an actual module file
672 suffixes = [(-len(suffix), suffix)
673 for suffix in importlib.machinery.all_suffixes()]
674 suffixes.sort() # try longest suffixes first, in case they overlap
675 for neglen, suffix in suffixes:
676 if fname.endswith(suffix):
677 return fname[:neglen]
678 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000679
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000680def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000681 """Return the filename that can be used to locate an object's source.
682 Return None if no way can be identified to get the source.
683 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000684 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400685 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
686 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
687 if any(filename.endswith(s) for s in all_bytecode_suffixes):
688 filename = (os.path.splitext(filename)[0] +
689 importlib.machinery.SOURCE_SUFFIXES[0])
690 elif any(filename.endswith(s) for s in
691 importlib.machinery.EXTENSION_SUFFIXES):
692 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000693 if os.path.exists(filename):
694 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000695 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400696 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000697 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000698 # or it is in the linecache
699 if filename in linecache.cache:
700 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000701
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000702def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000703 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000704
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000705 The idea is for each object to have a unique origin, so this routine
706 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000707 if _filename is None:
708 _filename = getsourcefile(object) or getfile(object)
709 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000710
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000711modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000712_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000713
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000714def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000715 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000716 if ismodule(object):
717 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000718 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000719 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000720 # Try the filename to modulename cache
721 if _filename is not None and _filename in modulesbyfile:
722 return sys.modules.get(modulesbyfile[_filename])
723 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000724 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000725 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000726 except TypeError:
727 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000728 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000729 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000730 # Update the filename to module name cache and check yet again
731 # Copy sys.modules in order to cope with changes while iterating
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100732 for modname, module in list(sys.modules.items()):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000733 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000734 f = module.__file__
735 if f == _filesbymodname.get(modname, None):
736 # Have already mapped this module, so skip it
737 continue
738 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000739 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000740 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000741 modulesbyfile[f] = modulesbyfile[
742 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000743 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000744 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000745 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000746 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000747 if not hasattr(object, '__name__'):
748 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000749 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000750 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000751 if mainobject is object:
752 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000753 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000754 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000755 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000756 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000757 if builtinobject is object:
758 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000759
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000760def findsource(object):
761 """Return the entire source file and starting line number for an object.
762
763 The argument may be a module, class, method, function, traceback, frame,
764 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200765 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000766 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500767
Yury Selivanovef1e7502014-12-08 16:05:34 -0500768 file = getsourcefile(object)
769 if file:
770 # Invalidate cache if needed.
771 linecache.checkcache(file)
772 else:
773 file = getfile(object)
774 # Allow filenames in form of "<something>" to pass through.
775 # `doctest` monkeypatches `linecache` module to enable
776 # inspection, so let `linecache.getlines` to be called.
777 if not (file.startswith('<') and file.endswith('>')):
778 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500779
Thomas Wouters89f507f2006-12-13 04:49:30 +0000780 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000781 if module:
782 lines = linecache.getlines(file, module.__dict__)
783 else:
784 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000785 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200786 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000787
788 if ismodule(object):
789 return lines, 0
790
791 if isclass(object):
792 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000793 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
794 # make some effort to find the best matching class definition:
795 # use the one with the least indentation, which is the one
796 # that's most probably not inside a function definition.
797 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000798 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000799 match = pat.match(lines[i])
800 if match:
801 # if it's at toplevel, it's already the best one
802 if lines[i][0] == 'c':
803 return lines, i
804 # else add whitespace to candidate list
805 candidates.append((match.group(1), i))
806 if candidates:
807 # this will sort by whitespace, and by line number,
808 # less whitespace first
809 candidates.sort()
810 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000811 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200812 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000813
814 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000815 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000816 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000817 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000818 if istraceback(object):
819 object = object.tb_frame
820 if isframe(object):
821 object = object.f_code
822 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000823 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200824 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000825 lnum = object.co_firstlineno - 1
Yury Selivanove4e811d2015-07-21 19:01:52 +0300826 pat = re.compile(r'^(\s*def\s)|(\s*async\s+def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000827 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000828 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000829 lnum = lnum - 1
830 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200831 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000832
833def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000834 """Get lines of comments immediately preceding an object's source code.
835
836 Returns None when source can't be found.
837 """
838 try:
839 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200840 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000841 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000842
843 if ismodule(object):
844 # Look for a comment block at the top of the file.
845 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000846 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000847 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000848 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000849 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000850 comments = []
851 end = start
852 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000853 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000854 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000855 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000856
857 # Look for a preceding block of comments at the same indentation.
858 elif lnum > 0:
859 indent = indentsize(lines[lnum])
860 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000861 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000862 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000863 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000864 if end > 0:
865 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000866 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000867 while comment[:1] == '#' and indentsize(lines[end]) == indent:
868 comments[:0] = [comment]
869 end = end - 1
870 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000871 comment = lines[end].expandtabs().lstrip()
872 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000873 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000874 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000875 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000876 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000877
Tim Peters4efb6e92001-06-29 23:51:08 +0000878class EndOfBlock(Exception): pass
879
880class BlockFinder:
881 """Provide a tokeneater() method to detect the end of a code block."""
882 def __init__(self):
883 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000884 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000885 self.started = False
886 self.passline = False
Meador Inge5b718d72015-07-23 22:49:37 -0500887 self.indecorator = False
888 self.decoratorhasargs = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000889 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000890
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000891 def tokeneater(self, type, token, srowcol, erowcol, line):
Meador Inge5b718d72015-07-23 22:49:37 -0500892 if not self.started and not self.indecorator:
893 # skip any decorators
894 if token == "@":
895 self.indecorator = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000896 # look for the first "def", "class" or "lambda"
Meador Inge5b718d72015-07-23 22:49:37 -0500897 elif token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000898 if token == "lambda":
899 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000900 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000901 self.passline = True # skip to the end of the line
Meador Inge5b718d72015-07-23 22:49:37 -0500902 elif token == "(":
903 if self.indecorator:
904 self.decoratorhasargs = True
905 elif token == ")":
906 if self.indecorator:
907 self.indecorator = False
908 self.decoratorhasargs = False
Tim Peters4efb6e92001-06-29 23:51:08 +0000909 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000910 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000911 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000912 if self.islambda: # lambdas always end at the first NEWLINE
913 raise EndOfBlock
Meador Inge5b718d72015-07-23 22:49:37 -0500914 # hitting a NEWLINE when in a decorator without args
915 # ends the decorator
916 if self.indecorator and not self.decoratorhasargs:
917 self.indecorator = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000918 elif self.passline:
919 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000920 elif type == tokenize.INDENT:
921 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000922 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000923 elif type == tokenize.DEDENT:
924 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000925 # the end of matching indent/dedent pairs end a block
926 # (note that this only works for "def"/"class" blocks,
927 # not e.g. for "if: else:" or "try: finally:" blocks)
928 if self.indent <= 0:
929 raise EndOfBlock
930 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
931 # any other token on the same indentation level end the previous
932 # block as well, except the pseudo-tokens COMMENT and NL.
933 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000934
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000935def getblock(lines):
936 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000937 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000938 try:
Trent Nelson428de652008-03-18 22:41:35 +0000939 tokens = tokenize.generate_tokens(iter(lines).__next__)
940 for _token in tokens:
941 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000942 except (EndOfBlock, IndentationError):
943 pass
944 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000945
946def getsourcelines(object):
947 """Return a list of source lines and starting line number for an object.
948
949 The argument may be a module, class, method, function, traceback, frame,
950 or code object. The source code is returned as a list of the lines
951 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200952 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000953 raised if the source code cannot be retrieved."""
Yury Selivanov081bbf62014-09-26 17:34:54 -0400954 object = unwrap(object)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000955 lines, lnum = findsource(object)
956
Meador Inge5b718d72015-07-23 22:49:37 -0500957 if ismodule(object):
958 return lines, 0
959 else:
960 return getblock(lines[lnum:]), lnum + 1
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000961
962def getsource(object):
963 """Return the text of the source code for an object.
964
965 The argument may be a module, class, method, function, traceback, frame,
966 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200967 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000968 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000969 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000970
971# --------------------------------------------------- class tree extraction
972def walktree(classes, children, parent):
973 """Recursive helper function for getclasstree()."""
974 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000975 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000976 for c in classes:
977 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000978 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000979 results.append(walktree(children[c], children, c))
980 return results
981
Georg Brandl5ce83a02009-06-01 17:23:51 +0000982def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000983 """Arrange the given list of classes into a hierarchy of nested lists.
984
985 Where a nested list appears, it contains classes derived from the class
986 whose entry immediately precedes the list. Each entry is a 2-tuple
987 containing a class and a tuple of its base classes. If the 'unique'
988 argument is true, exactly one entry appears in the returned structure
989 for each class in the given list. Otherwise, classes using multiple
990 inheritance and their descendants will appear multiple times."""
991 children = {}
992 roots = []
993 for c in classes:
994 if c.__bases__:
995 for parent in c.__bases__:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000996 if not parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000997 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +0300998 if c not in children[parent]:
999 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001000 if unique and parent in classes: break
1001 elif c not in roots:
1002 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +00001003 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001004 if parent not in classes:
1005 roots.append(parent)
1006 return walktree(roots, children, None)
1007
1008# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001009Arguments = namedtuple('Arguments', 'args, varargs, varkw')
1010
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001011def getargs(co):
1012 """Get information about the arguments accepted by a code object.
1013
Guido van Rossum2e65f892007-02-28 22:03:49 +00001014 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001015 'args' is the list of argument names. Keyword-only arguments are
1016 appended. 'varargs' and 'varkw' are the names of the * and **
1017 arguments or None."""
Guido van Rossum2e65f892007-02-28 22:03:49 +00001018 args, varargs, kwonlyargs, varkw = _getfullargs(co)
Christian Heimes25bb7832008-01-11 16:17:00 +00001019 return Arguments(args + kwonlyargs, varargs, varkw)
Guido van Rossum2e65f892007-02-28 22:03:49 +00001020
1021def _getfullargs(co):
1022 """Get information about the arguments accepted by a code object.
1023
1024 Four things are returned: (args, varargs, kwonlyargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001025 'args' and 'kwonlyargs' are lists of argument names, and 'varargs'
1026 and 'varkw' are the names of the * and ** arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +00001027
1028 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001029 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001030
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001031 nargs = co.co_argcount
1032 names = co.co_varnames
Guido van Rossum2e65f892007-02-28 22:03:49 +00001033 nkwargs = co.co_kwonlyargcount
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001034 args = list(names[:nargs])
Guido van Rossum2e65f892007-02-28 22:03:49 +00001035 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001036 step = 0
1037
Guido van Rossum2e65f892007-02-28 22:03:49 +00001038 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001039 varargs = None
1040 if co.co_flags & CO_VARARGS:
1041 varargs = co.co_varnames[nargs]
1042 nargs = nargs + 1
1043 varkw = None
1044 if co.co_flags & CO_VARKEYWORDS:
1045 varkw = co.co_varnames[nargs]
Guido van Rossum2e65f892007-02-28 22:03:49 +00001046 return args, varargs, kwonlyargs, varkw
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001047
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001048
1049ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
1050
1051def getargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001052 """Get the names and default values of a function's parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001053
1054 A tuple of four things is returned: (args, varargs, keywords, defaults).
1055 'args' is a list of the argument names, including keyword-only argument names.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001056 'varargs' and 'keywords' are the names of the * and ** parameters or None.
1057 'defaults' is an n-tuple of the default values of the last n parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001058
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001059 This function is deprecated, as it does not support annotations or
1060 keyword-only parameters and will raise ValueError if either is present
1061 on the supplied callable.
1062
1063 For a more structured introspection API, use inspect.signature() instead.
1064
1065 Alternatively, use getfullargspec() for an API with a similar namedtuple
1066 based interface, but full support for annotations and keyword-only
1067 parameters.
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001068 """
1069 warnings.warn("inspect.getargspec() is deprecated, "
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001070 "use inspect.signature() or inspect.getfullargspec()",
1071 DeprecationWarning, stacklevel=2)
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001072 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
1073 getfullargspec(func)
1074 if kwonlyargs or ann:
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001075 raise ValueError("Function has keyword-only parameters or annotations"
Yury Selivanov37dc2b22016-01-11 15:15:01 -05001076 ", use getfullargspec() API which can support them")
1077 return ArgSpec(args, varargs, varkw, defaults)
1078
Christian Heimes25bb7832008-01-11 16:17:00 +00001079FullArgSpec = namedtuple('FullArgSpec',
Benjamin Peterson3d4ca742008-11-12 21:39:01 +00001080 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001081
1082def getfullargspec(func):
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001083 """Get the names and default values of a callable object's parameters.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001084
Brett Cannon504d8852007-09-07 02:12:14 +00001085 A tuple of seven things is returned:
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001086 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations).
1087 'args' is a list of the parameter names.
1088 'varargs' and 'varkw' are the names of the * and ** parameters or None.
1089 'defaults' is an n-tuple of the default values of the last n parameters.
1090 'kwonlyargs' is a list of keyword-only parameter names.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001091 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001092 'annotations' is a dictionary mapping parameter names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001093
Nick Coghlan3c35fdb2016-12-02 20:29:57 +10001094 Notable differences from inspect.signature():
1095 - the "self" parameter is always reported, even for bound methods
1096 - wrapper chains defined by __wrapped__ *not* unwrapped automatically
Jeremy Hylton64967882003-06-27 18:14:39 +00001097 """
1098
Yury Selivanov57d240e2014-02-19 16:27:23 -05001099 try:
1100 # Re: `skip_bound_arg=False`
1101 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001102 # There is a notable difference in behaviour between getfullargspec
1103 # and Signature: the former always returns 'self' parameter for bound
1104 # methods, whereas the Signature always shows the actual calling
1105 # signature of the passed object.
1106 #
1107 # To simulate this behaviour, we "unbind" bound methods, to trick
1108 # inspect.signature to always return their first parameter ("self",
1109 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001110
Yury Selivanov57d240e2014-02-19 16:27:23 -05001111 # Re: `follow_wrapper_chains=False`
1112 #
1113 # getfullargspec() historically ignored __wrapped__ attributes,
1114 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001115
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001116 sig = _signature_from_callable(func,
1117 follow_wrapper_chains=False,
1118 skip_bound_arg=False,
1119 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001120 except Exception as ex:
1121 # Most of the times 'signature' will raise ValueError.
1122 # But, it can also raise AttributeError, and, maybe something
1123 # else. So to be fully backwards compatible, we catch all
1124 # possible exceptions here, and reraise a TypeError.
1125 raise TypeError('unsupported callable') from ex
1126
1127 args = []
1128 varargs = None
1129 varkw = None
1130 kwonlyargs = []
1131 defaults = ()
1132 annotations = {}
1133 defaults = ()
1134 kwdefaults = {}
1135
1136 if sig.return_annotation is not sig.empty:
1137 annotations['return'] = sig.return_annotation
1138
1139 for param in sig.parameters.values():
1140 kind = param.kind
1141 name = param.name
1142
1143 if kind is _POSITIONAL_ONLY:
1144 args.append(name)
1145 elif kind is _POSITIONAL_OR_KEYWORD:
1146 args.append(name)
1147 if param.default is not param.empty:
1148 defaults += (param.default,)
1149 elif kind is _VAR_POSITIONAL:
1150 varargs = name
1151 elif kind is _KEYWORD_ONLY:
1152 kwonlyargs.append(name)
1153 if param.default is not param.empty:
1154 kwdefaults[name] = param.default
1155 elif kind is _VAR_KEYWORD:
1156 varkw = name
1157
1158 if param.annotation is not param.empty:
1159 annotations[name] = param.annotation
1160
1161 if not kwdefaults:
1162 # compatibility with 'func.__kwdefaults__'
1163 kwdefaults = None
1164
1165 if not defaults:
1166 # compatibility with 'func.__defaults__'
1167 defaults = None
1168
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001169 return FullArgSpec(args, varargs, varkw, defaults,
1170 kwonlyargs, kwdefaults, annotations)
1171
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001172
Christian Heimes25bb7832008-01-11 16:17:00 +00001173ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1174
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001175def getargvalues(frame):
1176 """Get information about arguments passed into a particular frame.
1177
1178 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001179 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001180 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1181 'locals' is the locals dictionary of the given frame."""
1182 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001183 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001184
Guido van Rossum2e65f892007-02-28 22:03:49 +00001185def formatannotation(annotation, base_module=None):
Guido van Rossum52e50042016-10-22 07:55:18 -07001186 if getattr(annotation, '__module__', None) == 'typing':
1187 return repr(annotation).replace('typing.', '')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001188 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001189 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001190 return annotation.__qualname__
1191 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001192 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001193
Guido van Rossum2e65f892007-02-28 22:03:49 +00001194def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001195 module = getattr(object, '__module__', None)
1196 def _formatannotation(annotation):
1197 return formatannotation(annotation, module)
1198 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001199
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001200def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +00001201 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001202 formatarg=str,
1203 formatvarargs=lambda name: '*' + name,
1204 formatvarkw=lambda name: '**' + name,
1205 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001206 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001207 formatannotation=formatannotation):
Berker Peksagfa3922c2015-07-31 04:11:29 +03001208 """Format an argument spec from the values returned by getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001209
Guido van Rossum2e65f892007-02-28 22:03:49 +00001210 The first seven arguments are (args, varargs, varkw, defaults,
1211 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1212 are the corresponding optional formatting functions that are called to
1213 turn names and values into strings. The last argument is an optional
1214 function to format the sequence of arguments."""
1215 def formatargandannotation(arg):
1216 result = formatarg(arg)
1217 if arg in annotations:
1218 result += ': ' + formatannotation(annotations[arg])
1219 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001220 specs = []
1221 if defaults:
1222 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001223 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001224 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001225 if defaults and i >= firstdefault:
1226 spec = spec + formatvalue(defaults[i - firstdefault])
1227 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001228 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001229 specs.append(formatvarargs(formatargandannotation(varargs)))
1230 else:
1231 if kwonlyargs:
1232 specs.append('*')
1233 if kwonlyargs:
1234 for kwonlyarg in kwonlyargs:
1235 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001236 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001237 spec += formatvalue(kwonlydefaults[kwonlyarg])
1238 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001239 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001240 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001241 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001242 if 'return' in annotations:
1243 result += formatreturns(formatannotation(annotations['return']))
1244 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001245
1246def formatargvalues(args, varargs, varkw, locals,
1247 formatarg=str,
1248 formatvarargs=lambda name: '*' + name,
1249 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001250 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001251 """Format an argument spec from the 4 values returned by getargvalues.
1252
1253 The first four arguments are (args, varargs, varkw, locals). The
1254 next four arguments are the corresponding optional formatting functions
1255 that are called to turn names and values into strings. The ninth
1256 argument is an optional function to format the sequence of arguments."""
1257 def convert(name, locals=locals,
1258 formatarg=formatarg, formatvalue=formatvalue):
1259 return formatarg(name) + formatvalue(locals[name])
1260 specs = []
1261 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001262 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001263 if varargs:
1264 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1265 if varkw:
1266 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001267 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001268
Benjamin Petersone109c702011-06-24 09:37:26 -05001269def _missing_arguments(f_name, argnames, pos, values):
1270 names = [repr(name) for name in argnames if name not in values]
1271 missing = len(names)
1272 if missing == 1:
1273 s = names[0]
1274 elif missing == 2:
1275 s = "{} and {}".format(*names)
1276 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001277 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001278 del names[-2:]
1279 s = ", ".join(names) + tail
1280 raise TypeError("%s() missing %i required %s argument%s: %s" %
1281 (f_name, missing,
1282 "positional" if pos else "keyword-only",
1283 "" if missing == 1 else "s", s))
1284
1285def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001286 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001287 kwonly_given = len([arg for arg in kwonly if arg in values])
1288 if varargs:
1289 plural = atleast != 1
1290 sig = "at least %d" % (atleast,)
1291 elif defcount:
1292 plural = True
1293 sig = "from %d to %d" % (atleast, len(args))
1294 else:
1295 plural = len(args) != 1
1296 sig = str(len(args))
1297 kwonly_sig = ""
1298 if kwonly_given:
1299 msg = " positional argument%s (and %d keyword-only argument%s)"
1300 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1301 "s" if kwonly_given != 1 else ""))
1302 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1303 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1304 "was" if given == 1 and not kwonly_given else "were"))
1305
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001306def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001307 """Get the mapping of arguments to values.
1308
1309 A dict is returned, with keys the function argument names (including the
1310 names of the * and ** arguments, if any), and values the respective bound
1311 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001312 func = func_and_positional[0]
1313 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001314 spec = getfullargspec(func)
1315 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1316 f_name = func.__name__
1317 arg2value = {}
1318
Benjamin Petersonb204a422011-06-05 22:04:07 -05001319
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001320 if ismethod(func) and func.__self__ is not None:
1321 # implicit 'self' (or 'cls' for classmethods) argument
1322 positional = (func.__self__,) + positional
1323 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001324 num_args = len(args)
1325 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001326
Benjamin Petersonb204a422011-06-05 22:04:07 -05001327 n = min(num_pos, num_args)
1328 for i in range(n):
1329 arg2value[args[i]] = positional[i]
1330 if varargs:
1331 arg2value[varargs] = tuple(positional[n:])
1332 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001333 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001334 arg2value[varkw] = {}
1335 for kw, value in named.items():
1336 if kw not in possible_kwargs:
1337 if not varkw:
1338 raise TypeError("%s() got an unexpected keyword argument %r" %
1339 (f_name, kw))
1340 arg2value[varkw][kw] = value
1341 continue
1342 if kw in arg2value:
1343 raise TypeError("%s() got multiple values for argument %r" %
1344 (f_name, kw))
1345 arg2value[kw] = value
1346 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001347 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1348 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001349 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001350 req = args[:num_args - num_defaults]
1351 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001352 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001353 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001354 for i, arg in enumerate(args[num_args - num_defaults:]):
1355 if arg not in arg2value:
1356 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001357 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001358 for kwarg in kwonlyargs:
1359 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001360 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001361 arg2value[kwarg] = kwonlydefaults[kwarg]
1362 else:
1363 missing += 1
1364 if missing:
1365 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001366 return arg2value
1367
Nick Coghlan2f92e542012-06-23 19:39:55 +10001368ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1369
1370def getclosurevars(func):
1371 """
1372 Get the mapping of free variables to their current values.
1373
Meador Inge8fda3592012-07-19 21:33:21 -05001374 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001375 and builtin references as seen by the body of the function. A final
1376 set of unbound names that could not be resolved is also provided.
1377 """
1378
1379 if ismethod(func):
1380 func = func.__func__
1381
1382 if not isfunction(func):
1383 raise TypeError("'{!r}' is not a Python function".format(func))
1384
1385 code = func.__code__
1386 # Nonlocal references are named in co_freevars and resolved
1387 # by looking them up in __closure__ by positional index
1388 if func.__closure__ is None:
1389 nonlocal_vars = {}
1390 else:
1391 nonlocal_vars = {
1392 var : cell.cell_contents
1393 for var, cell in zip(code.co_freevars, func.__closure__)
1394 }
1395
1396 # Global and builtin references are named in co_names and resolved
1397 # by looking them up in __globals__ or __builtins__
1398 global_ns = func.__globals__
1399 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1400 if ismodule(builtin_ns):
1401 builtin_ns = builtin_ns.__dict__
1402 global_vars = {}
1403 builtin_vars = {}
1404 unbound_names = set()
1405 for name in code.co_names:
1406 if name in ("None", "True", "False"):
1407 # Because these used to be builtins instead of keywords, they
1408 # may still show up as name references. We ignore them.
1409 continue
1410 try:
1411 global_vars[name] = global_ns[name]
1412 except KeyError:
1413 try:
1414 builtin_vars[name] = builtin_ns[name]
1415 except KeyError:
1416 unbound_names.add(name)
1417
1418 return ClosureVars(nonlocal_vars, global_vars,
1419 builtin_vars, unbound_names)
1420
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001421# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001422
1423Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1424
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001425def getframeinfo(frame, context=1):
1426 """Get information about a frame or traceback object.
1427
1428 A tuple of five things is returned: the filename, the line number of
1429 the current line, the function name, a list of lines of context from
1430 the source code, and the index of the current line within that list.
1431 The optional second argument specifies the number of lines of context
1432 to return, which are centered around the current line."""
1433 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001434 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001435 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001436 else:
1437 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001438 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001439 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001440
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001441 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001442 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001443 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001444 try:
1445 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001446 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001447 lines = index = None
1448 else:
Raymond Hettingera0501712004-06-15 11:22:53 +00001449 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001450 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001451 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001452 else:
1453 lines = index = None
1454
Christian Heimes25bb7832008-01-11 16:17:00 +00001455 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001456
1457def getlineno(frame):
1458 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001459 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1460 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001461
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001462FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1463
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001464def getouterframes(frame, context=1):
1465 """Get a list of records for a frame and all higher (calling) frames.
1466
1467 Each record contains a frame object, filename, line number, function
1468 name, a list of lines of context, and index within the context."""
1469 framelist = []
1470 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001471 frameinfo = (frame,) + getframeinfo(frame, context)
1472 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001473 frame = frame.f_back
1474 return framelist
1475
1476def getinnerframes(tb, context=1):
1477 """Get a list of records for a traceback's frame and all lower frames.
1478
1479 Each record contains a frame object, filename, line number, function
1480 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001481 framelist = []
1482 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001483 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1484 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001485 tb = tb.tb_next
1486 return framelist
1487
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001488def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001489 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001490 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001491
1492def stack(context=1):
1493 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001494 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001495
1496def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001497 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001498 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001499
1500
1501# ------------------------------------------------ static version of getattr
1502
1503_sentinel = object()
1504
Michael Foorde5162652010-11-20 16:40:44 +00001505def _static_getmro(klass):
1506 return type.__dict__['__mro__'].__get__(klass)
1507
Michael Foord95fc51d2010-11-20 15:07:30 +00001508def _check_instance(obj, attr):
1509 instance_dict = {}
1510 try:
1511 instance_dict = object.__getattribute__(obj, "__dict__")
1512 except AttributeError:
1513 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001514 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001515
1516
1517def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001518 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001519 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001520 try:
1521 return entry.__dict__[attr]
1522 except KeyError:
1523 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001524 return _sentinel
1525
Michael Foord35184ed2010-11-20 16:58:30 +00001526def _is_type(obj):
1527 try:
1528 _static_getmro(obj)
1529 except TypeError:
1530 return False
1531 return True
1532
Michael Foorddcebe0f2011-03-15 19:20:44 -04001533def _shadowed_dict(klass):
1534 dict_attr = type.__dict__["__dict__"]
1535 for entry in _static_getmro(klass):
1536 try:
1537 class_dict = dict_attr.__get__(entry)["__dict__"]
1538 except KeyError:
1539 pass
1540 else:
1541 if not (type(class_dict) is types.GetSetDescriptorType and
1542 class_dict.__name__ == "__dict__" and
1543 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001544 return class_dict
1545 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001546
1547def getattr_static(obj, attr, default=_sentinel):
1548 """Retrieve attributes without triggering dynamic lookup via the
1549 descriptor protocol, __getattr__ or __getattribute__.
1550
1551 Note: this function may not be able to retrieve all attributes
1552 that getattr can fetch (like dynamically created attributes)
1553 and may find attributes that getattr can't (like descriptors
1554 that raise AttributeError). It can also return descriptor objects
1555 instead of instance members in some cases. See the
1556 documentation for details.
1557 """
1558 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001559 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001560 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001561 dict_attr = _shadowed_dict(klass)
1562 if (dict_attr is _sentinel or
1563 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001564 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001565 else:
1566 klass = obj
1567
1568 klass_result = _check_class(klass, attr)
1569
1570 if instance_result is not _sentinel and klass_result is not _sentinel:
1571 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1572 _check_class(type(klass_result), '__set__') is not _sentinel):
1573 return klass_result
1574
1575 if instance_result is not _sentinel:
1576 return instance_result
1577 if klass_result is not _sentinel:
1578 return klass_result
1579
1580 if obj is klass:
1581 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001582 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001583 if _shadowed_dict(type(entry)) is _sentinel:
1584 try:
1585 return entry.__dict__[attr]
1586 except KeyError:
1587 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001588 if default is not _sentinel:
1589 return default
1590 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001591
1592
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001593# ------------------------------------------------ generator introspection
1594
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001595GEN_CREATED = 'GEN_CREATED'
1596GEN_RUNNING = 'GEN_RUNNING'
1597GEN_SUSPENDED = 'GEN_SUSPENDED'
1598GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001599
1600def getgeneratorstate(generator):
1601 """Get current state of a generator-iterator.
1602
1603 Possible states are:
1604 GEN_CREATED: Waiting to start execution.
1605 GEN_RUNNING: Currently being executed by the interpreter.
1606 GEN_SUSPENDED: Currently suspended at a yield expression.
1607 GEN_CLOSED: Execution has completed.
1608 """
1609 if generator.gi_running:
1610 return GEN_RUNNING
1611 if generator.gi_frame is None:
1612 return GEN_CLOSED
1613 if generator.gi_frame.f_lasti == -1:
1614 return GEN_CREATED
1615 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001616
1617
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001618def getgeneratorlocals(generator):
1619 """
1620 Get the mapping of generator local variables to their current values.
1621
1622 A dict is returned, with the keys the local variable names and values the
1623 bound values."""
1624
1625 if not isgenerator(generator):
1626 raise TypeError("'{!r}' is not a Python generator".format(generator))
1627
1628 frame = getattr(generator, "gi_frame", None)
1629 if frame is not None:
1630 return generator.gi_frame.f_locals
1631 else:
1632 return {}
1633
Yury Selivanov5376ba92015-06-22 12:19:30 -04001634
1635# ------------------------------------------------ coroutine introspection
1636
1637CORO_CREATED = 'CORO_CREATED'
1638CORO_RUNNING = 'CORO_RUNNING'
1639CORO_SUSPENDED = 'CORO_SUSPENDED'
1640CORO_CLOSED = 'CORO_CLOSED'
1641
1642def getcoroutinestate(coroutine):
1643 """Get current state of a coroutine object.
1644
1645 Possible states are:
1646 CORO_CREATED: Waiting to start execution.
1647 CORO_RUNNING: Currently being executed by the interpreter.
1648 CORO_SUSPENDED: Currently suspended at an await expression.
1649 CORO_CLOSED: Execution has completed.
1650 """
1651 if coroutine.cr_running:
1652 return CORO_RUNNING
1653 if coroutine.cr_frame is None:
1654 return CORO_CLOSED
1655 if coroutine.cr_frame.f_lasti == -1:
1656 return CORO_CREATED
1657 return CORO_SUSPENDED
1658
1659
1660def getcoroutinelocals(coroutine):
1661 """
1662 Get the mapping of coroutine local variables to their current values.
1663
1664 A dict is returned, with the keys the local variable names and values the
1665 bound values."""
1666 frame = getattr(coroutine, "cr_frame", None)
1667 if frame is not None:
1668 return frame.f_locals
1669 else:
1670 return {}
1671
1672
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001673###############################################################################
1674### Function Signature Object (PEP 362)
1675###############################################################################
1676
1677
1678_WrapperDescriptor = type(type.__call__)
1679_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001680_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001681
1682_NonUserDefinedCallables = (_WrapperDescriptor,
1683 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001684 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001685 types.BuiltinFunctionType)
1686
1687
Yury Selivanov421f0c72014-01-29 12:05:40 -05001688def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001689 """Private helper. Checks if ``cls`` has an attribute
1690 named ``method_name`` and returns it only if it is a
1691 pure python function.
1692 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001693 try:
1694 meth = getattr(cls, method_name)
1695 except AttributeError:
1696 return
1697 else:
1698 if not isinstance(meth, _NonUserDefinedCallables):
1699 # Once '__signature__' will be added to 'C'-level
1700 # callables, this check won't be necessary
1701 return meth
1702
1703
Yury Selivanov62560fb2014-01-28 12:26:24 -05001704def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001705 """Private helper to calculate how 'wrapped_sig' signature will
1706 look like after applying a 'functools.partial' object (or alike)
1707 on it.
1708 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001709
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001710 old_params = wrapped_sig.parameters
1711 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001712
1713 partial_args = partial.args or ()
1714 partial_keywords = partial.keywords or {}
1715
1716 if extra_args:
1717 partial_args = extra_args + partial_args
1718
1719 try:
1720 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1721 except TypeError as ex:
1722 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1723 raise ValueError(msg) from ex
1724
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001725
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001726 transform_to_kwonly = False
1727 for param_name, param in old_params.items():
1728 try:
1729 arg_value = ba.arguments[param_name]
1730 except KeyError:
1731 pass
1732 else:
1733 if param.kind is _POSITIONAL_ONLY:
1734 # If positional-only parameter is bound by partial,
1735 # it effectively disappears from the signature
1736 new_params.pop(param_name)
1737 continue
1738
1739 if param.kind is _POSITIONAL_OR_KEYWORD:
1740 if param_name in partial_keywords:
1741 # This means that this parameter, and all parameters
1742 # after it should be keyword-only (and var-positional
1743 # should be removed). Here's why. Consider the following
1744 # function:
1745 # foo(a, b, *args, c):
1746 # pass
1747 #
1748 # "partial(foo, a='spam')" will have the following
1749 # signature: "(*, a='spam', b, c)". Because attempting
1750 # to call that partial with "(10, 20)" arguments will
1751 # raise a TypeError, saying that "a" argument received
1752 # multiple values.
1753 transform_to_kwonly = True
1754 # Set the new default value
1755 new_params[param_name] = param.replace(default=arg_value)
1756 else:
1757 # was passed as a positional argument
1758 new_params.pop(param.name)
1759 continue
1760
1761 if param.kind is _KEYWORD_ONLY:
1762 # Set the new default value
1763 new_params[param_name] = param.replace(default=arg_value)
1764
1765 if transform_to_kwonly:
1766 assert param.kind is not _POSITIONAL_ONLY
1767
1768 if param.kind is _POSITIONAL_OR_KEYWORD:
1769 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1770 new_params[param_name] = new_param
1771 new_params.move_to_end(param_name)
1772 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
1773 new_params.move_to_end(param_name)
1774 elif param.kind is _VAR_POSITIONAL:
1775 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001776
1777 return wrapped_sig.replace(parameters=new_params.values())
1778
1779
Yury Selivanov62560fb2014-01-28 12:26:24 -05001780def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001781 """Private helper to transform signatures for unbound
1782 functions to bound methods.
1783 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001784
1785 params = tuple(sig.parameters.values())
1786
1787 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1788 raise ValueError('invalid method signature')
1789
1790 kind = params[0].kind
1791 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1792 # Drop first parameter:
1793 # '(p1, p2[, ...])' -> '(p2[, ...])'
1794 params = params[1:]
1795 else:
1796 if kind is not _VAR_POSITIONAL:
1797 # Unless we add a new parameter type we never
1798 # get here
1799 raise ValueError('invalid argument type')
1800 # It's a var-positional parameter.
1801 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1802
1803 return sig.replace(parameters=params)
1804
1805
Yury Selivanovb77511d2014-01-29 10:46:14 -05001806def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001807 """Private helper to test if `obj` is a callable that might
1808 support Argument Clinic's __text_signature__ protocol.
1809 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001810 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001811 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001812 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001813 # Can't test 'isinstance(type)' here, as it would
1814 # also be True for regular python classes
1815 obj in (type, object))
1816
1817
Yury Selivanov63da7c72014-01-31 14:48:37 -05001818def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001819 """Private helper to test if `obj` is a duck type of FunctionType.
1820 A good example of such objects are functions compiled with
1821 Cython, which have all attributes that a pure Python function
1822 would have, but have their code statically compiled.
1823 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001824
1825 if not callable(obj) or isclass(obj):
1826 # All function-like objects are obviously callables,
1827 # and not classes.
1828 return False
1829
1830 name = getattr(obj, '__name__', None)
1831 code = getattr(obj, '__code__', None)
1832 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1833 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1834 annotations = getattr(obj, '__annotations__', None)
1835
1836 return (isinstance(code, types.CodeType) and
1837 isinstance(name, str) and
1838 (defaults is None or isinstance(defaults, tuple)) and
1839 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1840 isinstance(annotations, dict))
1841
1842
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001843def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001844 """ Private helper to get first parameter name from a
1845 __text_signature__ of a builtin method, which should
1846 be in the following format: '($param1, ...)'.
1847 Assumptions are that the first argument won't have
1848 a default value or an annotation.
1849 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001850
1851 assert spec.startswith('($')
1852
1853 pos = spec.find(',')
1854 if pos == -1:
1855 pos = spec.find(')')
1856
1857 cpos = spec.find(':')
1858 assert cpos == -1 or cpos > pos
1859
1860 cpos = spec.find('=')
1861 assert cpos == -1 or cpos > pos
1862
1863 return spec[2:pos]
1864
1865
Larry Hastings2623c8c2014-02-08 22:15:29 -08001866def _signature_strip_non_python_syntax(signature):
1867 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001868 Private helper function. Takes a signature in Argument Clinic's
1869 extended signature format.
1870
Larry Hastings2623c8c2014-02-08 22:15:29 -08001871 Returns a tuple of three things:
1872 * that signature re-rendered in standard Python syntax,
1873 * the index of the "self" parameter (generally 0), or None if
1874 the function does not have a "self" parameter, and
1875 * the index of the last "positional only" parameter,
1876 or None if the signature has no positional-only parameters.
1877 """
1878
1879 if not signature:
1880 return signature, None, None
1881
1882 self_parameter = None
1883 last_positional_only = None
1884
1885 lines = [l.encode('ascii') for l in signature.split('\n')]
1886 generator = iter(lines).__next__
1887 token_stream = tokenize.tokenize(generator)
1888
1889 delayed_comma = False
1890 skip_next_comma = False
1891 text = []
1892 add = text.append
1893
1894 current_parameter = 0
1895 OP = token.OP
1896 ERRORTOKEN = token.ERRORTOKEN
1897
1898 # token stream always starts with ENCODING token, skip it
1899 t = next(token_stream)
1900 assert t.type == tokenize.ENCODING
1901
1902 for t in token_stream:
1903 type, string = t.type, t.string
1904
1905 if type == OP:
1906 if string == ',':
1907 if skip_next_comma:
1908 skip_next_comma = False
1909 else:
1910 assert not delayed_comma
1911 delayed_comma = True
1912 current_parameter += 1
1913 continue
1914
1915 if string == '/':
1916 assert not skip_next_comma
1917 assert last_positional_only is None
1918 skip_next_comma = True
1919 last_positional_only = current_parameter - 1
1920 continue
1921
1922 if (type == ERRORTOKEN) and (string == '$'):
1923 assert self_parameter is None
1924 self_parameter = current_parameter
1925 continue
1926
1927 if delayed_comma:
1928 delayed_comma = False
1929 if not ((type == OP) and (string == ')')):
1930 add(', ')
1931 add(string)
1932 if (string == ','):
1933 add(' ')
1934 clean_signature = ''.join(text)
1935 return clean_signature, self_parameter, last_positional_only
1936
1937
Yury Selivanov57d240e2014-02-19 16:27:23 -05001938def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001939 """Private helper to parse content of '__text_signature__'
1940 and return a Signature based on it.
1941 """
1942
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001943 Parameter = cls._parameter_cls
1944
Larry Hastings2623c8c2014-02-08 22:15:29 -08001945 clean_signature, self_parameter, last_positional_only = \
1946 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001947
Larry Hastings2623c8c2014-02-08 22:15:29 -08001948 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001949
1950 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001951 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001952 except SyntaxError:
1953 module = None
1954
1955 if not isinstance(module, ast.Module):
1956 raise ValueError("{!r} builtin has invalid signature".format(obj))
1957
1958 f = module.body[0]
1959
1960 parameters = []
1961 empty = Parameter.empty
1962 invalid = object()
1963
1964 module = None
1965 module_dict = {}
1966 module_name = getattr(obj, '__module__', None)
1967 if module_name:
1968 module = sys.modules.get(module_name, None)
1969 if module:
1970 module_dict = module.__dict__
1971 sys_module_dict = sys.modules
1972
1973 def parse_name(node):
1974 assert isinstance(node, ast.arg)
1975 if node.annotation != None:
1976 raise ValueError("Annotations are not currently supported")
1977 return node.arg
1978
1979 def wrap_value(s):
1980 try:
1981 value = eval(s, module_dict)
1982 except NameError:
1983 try:
1984 value = eval(s, sys_module_dict)
1985 except NameError:
1986 raise RuntimeError()
1987
1988 if isinstance(value, str):
1989 return ast.Str(value)
1990 if isinstance(value, (int, float)):
1991 return ast.Num(value)
1992 if isinstance(value, bytes):
1993 return ast.Bytes(value)
1994 if value in (True, False, None):
1995 return ast.NameConstant(value)
1996 raise RuntimeError()
1997
1998 class RewriteSymbolics(ast.NodeTransformer):
1999 def visit_Attribute(self, node):
2000 a = []
2001 n = node
2002 while isinstance(n, ast.Attribute):
2003 a.append(n.attr)
2004 n = n.value
2005 if not isinstance(n, ast.Name):
2006 raise RuntimeError()
2007 a.append(n.id)
2008 value = ".".join(reversed(a))
2009 return wrap_value(value)
2010
2011 def visit_Name(self, node):
2012 if not isinstance(node.ctx, ast.Load):
2013 raise ValueError()
2014 return wrap_value(node.id)
2015
2016 def p(name_node, default_node, default=empty):
2017 name = parse_name(name_node)
2018 if name is invalid:
2019 return None
2020 if default_node and default_node is not _empty:
2021 try:
2022 default_node = RewriteSymbolics().visit(default_node)
2023 o = ast.literal_eval(default_node)
2024 except ValueError:
2025 o = invalid
2026 if o is invalid:
2027 return None
2028 default = o if o is not invalid else default
2029 parameters.append(Parameter(name, kind, default=default, annotation=empty))
2030
2031 # non-keyword-only parameters
2032 args = reversed(f.args.args)
2033 defaults = reversed(f.args.defaults)
2034 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002035 if last_positional_only is not None:
2036 kind = Parameter.POSITIONAL_ONLY
2037 else:
2038 kind = Parameter.POSITIONAL_OR_KEYWORD
2039 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002040 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002041 if i == last_positional_only:
2042 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002043
2044 # *args
2045 if f.args.vararg:
2046 kind = Parameter.VAR_POSITIONAL
2047 p(f.args.vararg, empty)
2048
2049 # keyword-only arguments
2050 kind = Parameter.KEYWORD_ONLY
2051 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
2052 p(name, default)
2053
2054 # **kwargs
2055 if f.args.kwarg:
2056 kind = Parameter.VAR_KEYWORD
2057 p(f.args.kwarg, empty)
2058
Larry Hastings2623c8c2014-02-08 22:15:29 -08002059 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002060 # Possibly strip the bound argument:
2061 # - We *always* strip first bound argument if
2062 # it is a module.
2063 # - We don't strip first bound argument if
2064 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002065 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05002066 _self = getattr(obj, '__self__', None)
2067 self_isbound = _self is not None
2068 self_ismodule = ismodule(_self)
2069 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002070 parameters.pop(0)
2071 else:
2072 # for builtins, self parameter is always positional-only!
2073 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2074 parameters[0] = p
2075
2076 return cls(parameters, return_annotation=cls.empty)
2077
2078
Yury Selivanov57d240e2014-02-19 16:27:23 -05002079def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002080 """Private helper function to get signature for
2081 builtin callables.
2082 """
2083
Yury Selivanov57d240e2014-02-19 16:27:23 -05002084 if not _signature_is_builtin(func):
2085 raise TypeError("{!r} is not a Python builtin "
2086 "function".format(func))
2087
2088 s = getattr(func, "__text_signature__", None)
2089 if not s:
2090 raise ValueError("no signature found for builtin {!r}".format(func))
2091
2092 return _signature_fromstr(cls, func, s, skip_bound_arg)
2093
2094
Yury Selivanovcf45f022015-05-20 14:38:50 -04002095def _signature_from_function(cls, func):
2096 """Private helper: constructs Signature for the given python function."""
2097
2098 is_duck_function = False
2099 if not isfunction(func):
2100 if _signature_is_functionlike(func):
2101 is_duck_function = True
2102 else:
2103 # If it's not a pure Python function, and not a duck type
2104 # of pure function:
2105 raise TypeError('{!r} is not a Python function'.format(func))
2106
2107 Parameter = cls._parameter_cls
2108
2109 # Parameter information.
2110 func_code = func.__code__
2111 pos_count = func_code.co_argcount
2112 arg_names = func_code.co_varnames
2113 positional = tuple(arg_names[:pos_count])
2114 keyword_only_count = func_code.co_kwonlyargcount
2115 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
2116 annotations = func.__annotations__
2117 defaults = func.__defaults__
2118 kwdefaults = func.__kwdefaults__
2119
2120 if defaults:
2121 pos_default_count = len(defaults)
2122 else:
2123 pos_default_count = 0
2124
2125 parameters = []
2126
2127 # Non-keyword-only parameters w/o defaults.
2128 non_default_count = pos_count - pos_default_count
2129 for name in positional[:non_default_count]:
2130 annotation = annotations.get(name, _empty)
2131 parameters.append(Parameter(name, annotation=annotation,
2132 kind=_POSITIONAL_OR_KEYWORD))
2133
2134 # ... w/ defaults.
2135 for offset, name in enumerate(positional[non_default_count:]):
2136 annotation = annotations.get(name, _empty)
2137 parameters.append(Parameter(name, annotation=annotation,
2138 kind=_POSITIONAL_OR_KEYWORD,
2139 default=defaults[offset]))
2140
2141 # *args
2142 if func_code.co_flags & CO_VARARGS:
2143 name = arg_names[pos_count + keyword_only_count]
2144 annotation = annotations.get(name, _empty)
2145 parameters.append(Parameter(name, annotation=annotation,
2146 kind=_VAR_POSITIONAL))
2147
2148 # Keyword-only parameters.
2149 for name in keyword_only:
2150 default = _empty
2151 if kwdefaults is not None:
2152 default = kwdefaults.get(name, _empty)
2153
2154 annotation = annotations.get(name, _empty)
2155 parameters.append(Parameter(name, annotation=annotation,
2156 kind=_KEYWORD_ONLY,
2157 default=default))
2158 # **kwargs
2159 if func_code.co_flags & CO_VARKEYWORDS:
2160 index = pos_count + keyword_only_count
2161 if func_code.co_flags & CO_VARARGS:
2162 index += 1
2163
2164 name = arg_names[index]
2165 annotation = annotations.get(name, _empty)
2166 parameters.append(Parameter(name, annotation=annotation,
2167 kind=_VAR_KEYWORD))
2168
2169 # Is 'func' is a pure Python function - don't validate the
2170 # parameters list (for correct order and defaults), it should be OK.
2171 return cls(parameters,
2172 return_annotation=annotations.get('return', _empty),
2173 __validate_parameters__=is_duck_function)
2174
2175
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002176def _signature_from_callable(obj, *,
2177 follow_wrapper_chains=True,
2178 skip_bound_arg=True,
2179 sigcls):
2180
2181 """Private helper function to get signature for arbitrary
2182 callable objects.
2183 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002184
2185 if not callable(obj):
2186 raise TypeError('{!r} is not a callable object'.format(obj))
2187
2188 if isinstance(obj, types.MethodType):
2189 # In this case we skip the first parameter of the underlying
2190 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002191 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002192 obj.__func__,
2193 follow_wrapper_chains=follow_wrapper_chains,
2194 skip_bound_arg=skip_bound_arg,
2195 sigcls=sigcls)
2196
Yury Selivanov57d240e2014-02-19 16:27:23 -05002197 if skip_bound_arg:
2198 return _signature_bound_method(sig)
2199 else:
2200 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002201
Nick Coghlane8c45d62013-07-28 20:00:01 +10002202 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05002203 if follow_wrapper_chains:
2204 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Yury Selivanov46c759d2015-05-27 21:56:53 -04002205 if isinstance(obj, types.MethodType):
2206 # If the unwrapped object is a *method*, we might want to
2207 # skip its first parameter (self).
2208 # See test_signature_wrapped_bound_method for details.
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002209 return _signature_from_callable(
Yury Selivanov46c759d2015-05-27 21:56:53 -04002210 obj,
2211 follow_wrapper_chains=follow_wrapper_chains,
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002212 skip_bound_arg=skip_bound_arg,
2213 sigcls=sigcls)
Nick Coghlane8c45d62013-07-28 20:00:01 +10002214
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002215 try:
2216 sig = obj.__signature__
2217 except AttributeError:
2218 pass
2219 else:
2220 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07002221 if not isinstance(sig, Signature):
2222 raise TypeError(
2223 'unexpected object {!r} in __signature__ '
2224 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002225 return sig
2226
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002227 try:
2228 partialmethod = obj._partialmethod
2229 except AttributeError:
2230 pass
2231 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05002232 if isinstance(partialmethod, functools.partialmethod):
2233 # Unbound partialmethod (see functools.partialmethod)
2234 # This means, that we need to calculate the signature
2235 # as if it's a regular partial object, but taking into
2236 # account that the first positional argument
2237 # (usually `self`, or `cls`) will not be passed
2238 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002239
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002240 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002241 partialmethod.func,
2242 follow_wrapper_chains=follow_wrapper_chains,
2243 skip_bound_arg=skip_bound_arg,
2244 sigcls=sigcls)
2245
Yury Selivanov0486f812014-01-29 12:18:59 -05002246 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanov0486f812014-01-29 12:18:59 -05002247 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
Dong-hee Na378d7062017-05-18 04:00:51 +09002248 if first_wrapped_param.kind is Parameter.VAR_POSITIONAL:
2249 # First argument of the wrapped callable is `*args`, as in
2250 # `partialmethod(lambda *args)`.
2251 return sig
2252 else:
2253 sig_params = tuple(sig.parameters.values())
2254 assert first_wrapped_param is not sig_params[0]
2255 new_params = (first_wrapped_param,) + sig_params
2256 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002257
Yury Selivanov63da7c72014-01-31 14:48:37 -05002258 if isfunction(obj) or _signature_is_functionlike(obj):
2259 # If it's a pure Python function, or an object that is duck type
2260 # of a Python function (Cython functions, for instance), then:
Yury Selivanovcf45f022015-05-20 14:38:50 -04002261 return _signature_from_function(sigcls, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002262
Yury Selivanova773de02014-02-21 18:30:53 -05002263 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04002264 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05002265 skip_bound_arg=skip_bound_arg)
2266
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002267 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002268 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002269 obj.func,
2270 follow_wrapper_chains=follow_wrapper_chains,
2271 skip_bound_arg=skip_bound_arg,
2272 sigcls=sigcls)
Yury Selivanov62560fb2014-01-28 12:26:24 -05002273 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002274
2275 sig = None
2276 if isinstance(obj, type):
2277 # obj is a class or a metaclass
2278
2279 # First, let's see if it has an overloaded __call__ defined
2280 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002281 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002282 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002283 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002284 call,
2285 follow_wrapper_chains=follow_wrapper_chains,
2286 skip_bound_arg=skip_bound_arg,
2287 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002288 else:
2289 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002290 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002291 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002292 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002293 new,
2294 follow_wrapper_chains=follow_wrapper_chains,
2295 skip_bound_arg=skip_bound_arg,
2296 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002297 else:
2298 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002299 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002300 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002301 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002302 init,
2303 follow_wrapper_chains=follow_wrapper_chains,
2304 skip_bound_arg=skip_bound_arg,
2305 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002306
2307 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002308 # At this point we know, that `obj` is a class, with no user-
2309 # defined '__init__', '__new__', or class-level '__call__'
2310
Larry Hastings2623c8c2014-02-08 22:15:29 -08002311 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002312 # Since '__text_signature__' is implemented as a
2313 # descriptor that extracts text signature from the
2314 # class docstring, if 'obj' is derived from a builtin
2315 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002316 # Therefore, we go through the MRO (except the last
2317 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002318 # class with non-empty text signature.
2319 try:
2320 text_sig = base.__text_signature__
2321 except AttributeError:
2322 pass
2323 else:
2324 if text_sig:
2325 # If 'obj' class has a __text_signature__ attribute:
2326 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002327 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002328
2329 # No '__text_signature__' was found for the 'obj' class.
2330 # Last option is to check if its '__init__' is
2331 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002332 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002333 # We have a class (not metaclass), but no user-defined
2334 # __init__ or __new__ for it
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002335 if (obj.__init__ is object.__init__ and
2336 obj.__new__ is object.__new__):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002337 # Return a signature of 'object' builtin.
2338 return signature(object)
Yury Selivanovbf304fc2015-05-30 17:08:36 -04002339 else:
2340 raise ValueError(
2341 'no signature found for builtin type {!r}'.format(obj))
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002342
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002343 elif not isinstance(obj, _NonUserDefinedCallables):
2344 # An object with __call__
2345 # We also check that the 'obj' is not an instance of
2346 # _WrapperDescriptor or _MethodWrapper to avoid
2347 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002348 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002349 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002350 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002351 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002352 call,
2353 follow_wrapper_chains=follow_wrapper_chains,
2354 skip_bound_arg=skip_bound_arg,
2355 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002356 except ValueError as ex:
2357 msg = 'no signature found for {!r}'.format(obj)
2358 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002359
2360 if sig is not None:
2361 # For classes and objects we skip the first parameter of their
2362 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002363 if skip_bound_arg:
2364 return _signature_bound_method(sig)
2365 else:
2366 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002367
2368 if isinstance(obj, types.BuiltinFunctionType):
2369 # Raise a nicer error message for builtins
2370 msg = 'no signature found for builtin function {!r}'.format(obj)
2371 raise ValueError(msg)
2372
2373 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2374
2375
2376class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002377 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002378
2379
2380class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002381 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002382
2383
Yury Selivanov21e83a52014-03-27 11:23:13 -04002384class _ParameterKind(enum.IntEnum):
2385 POSITIONAL_ONLY = 0
2386 POSITIONAL_OR_KEYWORD = 1
2387 VAR_POSITIONAL = 2
2388 KEYWORD_ONLY = 3
2389 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002390
2391 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002392 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002393
2394
Yury Selivanov21e83a52014-03-27 11:23:13 -04002395_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2396_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2397_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2398_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2399_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002400
2401
2402class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002403 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002404
2405 Has the following public attributes:
2406
2407 * name : str
2408 The name of the parameter as a string.
2409 * default : object
2410 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002411 parameter has no default value, this attribute is set to
2412 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002413 * annotation
2414 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002415 parameter has no annotation, this attribute is set to
2416 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002417 * kind : str
2418 Describes how argument values are bound to the parameter.
2419 Possible values: `Parameter.POSITIONAL_ONLY`,
2420 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2421 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002422 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002423
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002424 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002425
2426 POSITIONAL_ONLY = _POSITIONAL_ONLY
2427 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2428 VAR_POSITIONAL = _VAR_POSITIONAL
2429 KEYWORD_ONLY = _KEYWORD_ONLY
2430 VAR_KEYWORD = _VAR_KEYWORD
2431
2432 empty = _empty
2433
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002434 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002435
2436 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
2437 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
2438 raise ValueError("invalid value for 'Parameter.kind' attribute")
2439 self._kind = kind
2440
2441 if default is not _empty:
2442 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2443 msg = '{} parameters cannot have default values'.format(kind)
2444 raise ValueError(msg)
2445 self._default = default
2446 self._annotation = annotation
2447
Yury Selivanov2393dca2014-01-27 15:07:58 -05002448 if name is _empty:
2449 raise ValueError('name is a required attribute for Parameter')
2450
2451 if not isinstance(name, str):
2452 raise TypeError("name must be a str, not a {!r}".format(name))
2453
Nick Coghlanb4b966e2016-06-04 14:40:03 -07002454 if name[0] == '.' and name[1:].isdigit():
2455 # These are implicit arguments generated by comprehensions. In
2456 # order to provide a friendlier interface to users, we recast
2457 # their name as "implicitN" and treat them as positional-only.
2458 # See issue 19611.
2459 if kind != _POSITIONAL_OR_KEYWORD:
2460 raise ValueError(
2461 'implicit arguments must be passed in as {}'.format(
2462 _POSITIONAL_OR_KEYWORD
2463 )
2464 )
2465 self._kind = _POSITIONAL_ONLY
2466 name = 'implicit{}'.format(name[1:])
2467
Yury Selivanov2393dca2014-01-27 15:07:58 -05002468 if not name.isidentifier():
2469 raise ValueError('{!r} is not a valid parameter name'.format(name))
2470
2471 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002472
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002473 def __reduce__(self):
2474 return (type(self),
2475 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002476 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002477 '_annotation': self._annotation})
2478
2479 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002480 self._default = state['_default']
2481 self._annotation = state['_annotation']
2482
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002483 @property
2484 def name(self):
2485 return self._name
2486
2487 @property
2488 def default(self):
2489 return self._default
2490
2491 @property
2492 def annotation(self):
2493 return self._annotation
2494
2495 @property
2496 def kind(self):
2497 return self._kind
2498
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002499 def replace(self, *, name=_void, kind=_void,
2500 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002501 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002502
2503 if name is _void:
2504 name = self._name
2505
2506 if kind is _void:
2507 kind = self._kind
2508
2509 if annotation is _void:
2510 annotation = self._annotation
2511
2512 if default is _void:
2513 default = self._default
2514
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002515 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002516
2517 def __str__(self):
2518 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002519 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002520
2521 # Add annotation and default value
2522 if self._annotation is not _empty:
2523 formatted = '{}:{}'.format(formatted,
2524 formatannotation(self._annotation))
2525
2526 if self._default is not _empty:
2527 formatted = '{}={}'.format(formatted, repr(self._default))
2528
2529 if kind == _VAR_POSITIONAL:
2530 formatted = '*' + formatted
2531 elif kind == _VAR_KEYWORD:
2532 formatted = '**' + formatted
2533
2534 return formatted
2535
2536 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002537 return '<{} "{}">'.format(self.__class__.__name__, self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002538
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002539 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002540 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002541
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002542 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002543 if self is other:
2544 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002545 if not isinstance(other, Parameter):
2546 return NotImplemented
2547 return (self._name == other._name and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002548 self._kind == other._kind and
2549 self._default == other._default and
2550 self._annotation == other._annotation)
2551
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002552
2553class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002554 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002555 to the function's parameters.
2556
2557 Has the following public attributes:
2558
2559 * arguments : OrderedDict
2560 An ordered mutable mapping of parameters' names to arguments' values.
2561 Does not contain arguments' default values.
2562 * signature : Signature
2563 The Signature object that created this instance.
2564 * args : tuple
2565 Tuple of positional arguments values.
2566 * kwargs : dict
2567 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002568 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002569
Yury Selivanov6abe0322015-05-13 17:18:41 -04002570 __slots__ = ('arguments', '_signature', '__weakref__')
2571
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002572 def __init__(self, signature, arguments):
2573 self.arguments = arguments
2574 self._signature = signature
2575
2576 @property
2577 def signature(self):
2578 return self._signature
2579
2580 @property
2581 def args(self):
2582 args = []
2583 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002584 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002585 break
2586
2587 try:
2588 arg = self.arguments[param_name]
2589 except KeyError:
2590 # We're done here. Other arguments
2591 # will be mapped in 'BoundArguments.kwargs'
2592 break
2593 else:
2594 if param.kind == _VAR_POSITIONAL:
2595 # *args
2596 args.extend(arg)
2597 else:
2598 # plain argument
2599 args.append(arg)
2600
2601 return tuple(args)
2602
2603 @property
2604 def kwargs(self):
2605 kwargs = {}
2606 kwargs_started = False
2607 for param_name, param in self._signature.parameters.items():
2608 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002609 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002610 kwargs_started = True
2611 else:
2612 if param_name not in self.arguments:
2613 kwargs_started = True
2614 continue
2615
2616 if not kwargs_started:
2617 continue
2618
2619 try:
2620 arg = self.arguments[param_name]
2621 except KeyError:
2622 pass
2623 else:
2624 if param.kind == _VAR_KEYWORD:
2625 # **kwargs
2626 kwargs.update(arg)
2627 else:
2628 # plain keyword argument
2629 kwargs[param_name] = arg
2630
2631 return kwargs
2632
Yury Selivanovb907a512015-05-16 13:45:09 -04002633 def apply_defaults(self):
2634 """Set default values for missing arguments.
2635
2636 For variable-positional arguments (*args) the default is an
2637 empty tuple.
2638
2639 For variable-keyword arguments (**kwargs) the default is an
2640 empty dict.
2641 """
2642 arguments = self.arguments
Yury Selivanovb907a512015-05-16 13:45:09 -04002643 new_arguments = []
2644 for name, param in self._signature.parameters.items():
2645 try:
2646 new_arguments.append((name, arguments[name]))
2647 except KeyError:
2648 if param.default is not _empty:
2649 val = param.default
2650 elif param.kind is _VAR_POSITIONAL:
2651 val = ()
2652 elif param.kind is _VAR_KEYWORD:
2653 val = {}
2654 else:
2655 # This BoundArguments was likely produced by
2656 # Signature.bind_partial().
2657 continue
2658 new_arguments.append((name, val))
2659 self.arguments = OrderedDict(new_arguments)
2660
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002661 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002662 if self is other:
2663 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002664 if not isinstance(other, BoundArguments):
2665 return NotImplemented
2666 return (self.signature == other.signature and
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002667 self.arguments == other.arguments)
2668
Yury Selivanov6abe0322015-05-13 17:18:41 -04002669 def __setstate__(self, state):
2670 self._signature = state['_signature']
2671 self.arguments = state['arguments']
2672
2673 def __getstate__(self):
2674 return {'_signature': self._signature, 'arguments': self.arguments}
2675
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002676 def __repr__(self):
2677 args = []
2678 for arg, value in self.arguments.items():
2679 args.append('{}={!r}'.format(arg, value))
Yury Selivanovf229bc52015-05-15 12:53:56 -04002680 return '<{} ({})>'.format(self.__class__.__name__, ', '.join(args))
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002681
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002682
2683class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002684 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002685 It stores a Parameter object for each parameter accepted by the
2686 function, as well as information specific to the function itself.
2687
2688 A Signature object has the following public attributes and methods:
2689
2690 * parameters : OrderedDict
2691 An ordered mapping of parameters' names to the corresponding
2692 Parameter objects (keyword-only arguments are in the same order
2693 as listed in `code.co_varnames`).
2694 * return_annotation : object
2695 The annotation for the return type of the function if specified.
2696 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002697 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002698 * bind(*args, **kwargs) -> BoundArguments
2699 Creates a mapping from positional and keyword arguments to
2700 parameters.
2701 * bind_partial(*args, **kwargs) -> BoundArguments
2702 Creates a partial mapping from positional and keyword arguments
2703 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002704 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002705
2706 __slots__ = ('_return_annotation', '_parameters')
2707
2708 _parameter_cls = Parameter
2709 _bound_arguments_cls = BoundArguments
2710
2711 empty = _empty
2712
2713 def __init__(self, parameters=None, *, return_annotation=_empty,
2714 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002715 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002716 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002717 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002718
2719 if parameters is None:
2720 params = OrderedDict()
2721 else:
2722 if __validate_parameters__:
2723 params = OrderedDict()
2724 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002725 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002726
2727 for idx, param in enumerate(parameters):
2728 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002729 name = param.name
2730
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002731 if kind < top_kind:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002732 msg = 'wrong parameter order: {!r} before {!r}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05002733 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002734 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002735 elif kind > top_kind:
2736 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002737 top_kind = kind
2738
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002739 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002740 if param.default is _empty:
2741 if kind_defaults:
2742 # No default for this parameter, but the
2743 # previous parameter of the same kind had
2744 # a default
2745 msg = 'non-default argument follows default ' \
2746 'argument'
2747 raise ValueError(msg)
2748 else:
2749 # There is a default for this parameter.
2750 kind_defaults = True
2751
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002752 if name in params:
2753 msg = 'duplicate parameter name: {!r}'.format(name)
2754 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002755
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002756 params[name] = param
2757 else:
2758 params = OrderedDict(((param.name, param)
2759 for param in parameters))
2760
2761 self._parameters = types.MappingProxyType(params)
2762 self._return_annotation = return_annotation
2763
2764 @classmethod
2765 def from_function(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002766 """Constructs Signature for the given python function."""
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002767
2768 warnings.warn("inspect.Signature.from_function() is deprecated, "
Berker Peksagb5601582015-05-21 23:40:54 +03002769 "use Signature.from_callable()",
2770 DeprecationWarning, stacklevel=2)
Yury Selivanovcf45f022015-05-20 14:38:50 -04002771 return _signature_from_function(cls, func)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002772
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002773 @classmethod
2774 def from_builtin(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002775 """Constructs Signature for the given builtin function."""
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002776
2777 warnings.warn("inspect.Signature.from_builtin() is deprecated, "
Berker Peksagb5601582015-05-21 23:40:54 +03002778 "use Signature.from_callable()",
2779 DeprecationWarning, stacklevel=2)
Yury Selivanov57d240e2014-02-19 16:27:23 -05002780 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002781
Yury Selivanovda396452014-03-27 12:09:24 -04002782 @classmethod
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002783 def from_callable(cls, obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002784 """Constructs Signature for the given callable object."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002785 return _signature_from_callable(obj, sigcls=cls,
2786 follow_wrapper_chains=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002787
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002788 @property
2789 def parameters(self):
2790 return self._parameters
2791
2792 @property
2793 def return_annotation(self):
2794 return self._return_annotation
2795
2796 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002797 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002798 Pass 'parameters' and/or 'return_annotation' arguments
2799 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002800 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002801
2802 if parameters is _void:
2803 parameters = self.parameters.values()
2804
2805 if return_annotation is _void:
2806 return_annotation = self._return_annotation
2807
2808 return type(self)(parameters,
2809 return_annotation=return_annotation)
2810
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002811 def _hash_basis(self):
2812 params = tuple(param for param in self.parameters.values()
2813 if param.kind != _KEYWORD_ONLY)
2814
2815 kwo_params = {param.name: param for param in self.parameters.values()
2816 if param.kind == _KEYWORD_ONLY}
2817
2818 return params, kwo_params, self.return_annotation
2819
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002820 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002821 params, kwo_params, return_annotation = self._hash_basis()
2822 kwo_params = frozenset(kwo_params.values())
2823 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002824
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002825 def __eq__(self, other):
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002826 if self is other:
2827 return True
Serhiy Storchaka3018cc42015-07-18 23:19:05 +03002828 if not isinstance(other, Signature):
2829 return NotImplemented
Serhiy Storchaka2489bd52015-07-18 23:20:50 +03002830 return self._hash_basis() == other._hash_basis()
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002831
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002832 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002833 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002834
2835 arguments = OrderedDict()
2836
2837 parameters = iter(self.parameters.values())
2838 parameters_ex = ()
2839 arg_vals = iter(args)
2840
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002841 while True:
2842 # Let's iterate through the positional arguments and corresponding
2843 # parameters
2844 try:
2845 arg_val = next(arg_vals)
2846 except StopIteration:
2847 # No more positional arguments
2848 try:
2849 param = next(parameters)
2850 except StopIteration:
2851 # No more parameters. That's it. Just need to check that
2852 # we have no `kwargs` after this while loop
2853 break
2854 else:
2855 if param.kind == _VAR_POSITIONAL:
2856 # That's OK, just empty *args. Let's start parsing
2857 # kwargs
2858 break
2859 elif param.name in kwargs:
2860 if param.kind == _POSITIONAL_ONLY:
2861 msg = '{arg!r} parameter is positional only, ' \
2862 'but was passed as a keyword'
2863 msg = msg.format(arg=param.name)
2864 raise TypeError(msg) from None
2865 parameters_ex = (param,)
2866 break
2867 elif (param.kind == _VAR_KEYWORD or
2868 param.default is not _empty):
2869 # That's fine too - we have a default value for this
2870 # parameter. So, lets start parsing `kwargs`, starting
2871 # with the current parameter
2872 parameters_ex = (param,)
2873 break
2874 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002875 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2876 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002877 if partial:
2878 parameters_ex = (param,)
2879 break
2880 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002881 msg = 'missing a required argument: {arg!r}'
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002882 msg = msg.format(arg=param.name)
2883 raise TypeError(msg) from None
2884 else:
2885 # We have a positional argument to process
2886 try:
2887 param = next(parameters)
2888 except StopIteration:
2889 raise TypeError('too many positional arguments') from None
2890 else:
2891 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2892 # Looks like we have no parameter for this positional
2893 # argument
Yury Selivanov86872752015-05-19 00:27:49 -04002894 raise TypeError(
2895 'too many positional arguments') from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002896
2897 if param.kind == _VAR_POSITIONAL:
2898 # We have an '*args'-like argument, let's fill it with
2899 # all positional arguments we have left and move on to
2900 # the next phase
2901 values = [arg_val]
2902 values.extend(arg_vals)
2903 arguments[param.name] = tuple(values)
2904 break
2905
2906 if param.name in kwargs:
Yury Selivanov86872752015-05-19 00:27:49 -04002907 raise TypeError(
2908 'multiple values for argument {arg!r}'.format(
2909 arg=param.name)) from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002910
2911 arguments[param.name] = arg_val
2912
2913 # Now, we iterate through the remaining parameters to process
2914 # keyword arguments
2915 kwargs_param = None
2916 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002917 if param.kind == _VAR_KEYWORD:
2918 # Memorize that we have a '**kwargs'-like parameter
2919 kwargs_param = param
2920 continue
2921
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002922 if param.kind == _VAR_POSITIONAL:
2923 # Named arguments don't refer to '*args'-like parameters.
2924 # We only arrive here if the positional arguments ended
2925 # before reaching the last parameter before *args.
2926 continue
2927
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002928 param_name = param.name
2929 try:
2930 arg_val = kwargs.pop(param_name)
2931 except KeyError:
2932 # We have no value for this parameter. It's fine though,
2933 # if it has a default value, or it is an '*args'-like
2934 # parameter, left alone by the processing of positional
2935 # arguments.
2936 if (not partial and param.kind != _VAR_POSITIONAL and
2937 param.default is _empty):
Yury Selivanov86872752015-05-19 00:27:49 -04002938 raise TypeError('missing a required argument: {arg!r}'. \
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002939 format(arg=param_name)) from None
2940
2941 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002942 if param.kind == _POSITIONAL_ONLY:
2943 # This should never happen in case of a properly built
2944 # Signature object (but let's have this check here
2945 # to ensure correct behaviour just in case)
2946 raise TypeError('{arg!r} parameter is positional only, '
2947 'but was passed as a keyword'. \
2948 format(arg=param.name))
2949
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002950 arguments[param_name] = arg_val
2951
2952 if kwargs:
2953 if kwargs_param is not None:
2954 # Process our '**kwargs'-like parameter
2955 arguments[kwargs_param.name] = kwargs
2956 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002957 raise TypeError(
2958 'got an unexpected keyword argument {arg!r}'.format(
2959 arg=next(iter(kwargs))))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002960
2961 return self._bound_arguments_cls(self, arguments)
2962
Yury Selivanovc45873e2014-01-29 12:10:27 -05002963 def bind(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002964 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002965 and `kwargs` to the function's signature. Raises `TypeError`
2966 if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002967 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002968 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002969
Yury Selivanovc45873e2014-01-29 12:10:27 -05002970 def bind_partial(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002971 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002972 passed `args` and `kwargs` to the function's signature.
2973 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002974 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002975 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002976
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002977 def __reduce__(self):
2978 return (type(self),
2979 (tuple(self._parameters.values()),),
2980 {'_return_annotation': self._return_annotation})
2981
2982 def __setstate__(self, state):
2983 self._return_annotation = state['_return_annotation']
2984
Yury Selivanov374375d2014-03-27 12:41:53 -04002985 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002986 return '<{} {}>'.format(self.__class__.__name__, self)
Yury Selivanov374375d2014-03-27 12:41:53 -04002987
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002988 def __str__(self):
2989 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002990 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002991 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002992 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002993 formatted = str(param)
2994
2995 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002996
2997 if kind == _POSITIONAL_ONLY:
2998 render_pos_only_separator = True
2999 elif render_pos_only_separator:
3000 # It's not a positional-only parameter, and the flag
3001 # is set to 'True' (there were pos-only params before.)
3002 result.append('/')
3003 render_pos_only_separator = False
3004
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003005 if kind == _VAR_POSITIONAL:
3006 # OK, we have an '*args'-like parameter, so we won't need
3007 # a '*' to separate keyword-only arguments
3008 render_kw_only_separator = False
3009 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
3010 # We have a keyword-only parameter to render and we haven't
3011 # rendered an '*args'-like parameter before, so add a '*'
3012 # separator to the parameters list ("foo(arg1, *, arg2)" case)
3013 result.append('*')
3014 # This condition should be only triggered once, so
3015 # reset the flag
3016 render_kw_only_separator = False
3017
3018 result.append(formatted)
3019
Yury Selivanov2393dca2014-01-27 15:07:58 -05003020 if render_pos_only_separator:
3021 # There were only positional-only parameters, hence the
3022 # flag was not reset to 'False'
3023 result.append('/')
3024
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07003025 rendered = '({})'.format(', '.join(result))
3026
3027 if self.return_annotation is not _empty:
3028 anno = formatannotation(self.return_annotation)
3029 rendered += ' -> {}'.format(anno)
3030
3031 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003032
Yury Selivanovda396452014-03-27 12:09:24 -04003033
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003034def signature(obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04003035 """Get a signature object for the passed callable."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04003036 return Signature.from_callable(obj, follow_wrapped=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04003037
3038
Nick Coghlanf94a16b2013-09-22 22:46:49 +10003039def _main():
3040 """ Logic for inspecting an object given at command line """
3041 import argparse
3042 import importlib
3043
3044 parser = argparse.ArgumentParser()
3045 parser.add_argument(
3046 'object',
3047 help="The object to be analysed. "
3048 "It supports the 'module:qualname' syntax")
3049 parser.add_argument(
3050 '-d', '--details', action='store_true',
3051 help='Display info about the module rather than its source code')
3052
3053 args = parser.parse_args()
3054
3055 target = args.object
3056 mod_name, has_attrs, attrs = target.partition(":")
3057 try:
3058 obj = module = importlib.import_module(mod_name)
3059 except Exception as exc:
3060 msg = "Failed to import {} ({}: {})".format(mod_name,
3061 type(exc).__name__,
3062 exc)
3063 print(msg, file=sys.stderr)
3064 exit(2)
3065
3066 if has_attrs:
3067 parts = attrs.split(".")
3068 obj = module
3069 for part in parts:
3070 obj = getattr(obj, part)
3071
3072 if module.__name__ in sys.builtin_module_names:
3073 print("Can't get info for builtin modules.", file=sys.stderr)
3074 exit(1)
3075
3076 if args.details:
3077 print('Target: {}'.format(target))
3078 print('Origin: {}'.format(getsourcefile(module)))
3079 print('Cached: {}'.format(module.__cached__))
3080 if obj is module:
3081 print('Loader: {}'.format(repr(module.__loader__)))
3082 if hasattr(module, '__path__'):
3083 print('Submodule search path: {}'.format(module.__path__))
3084 else:
3085 try:
3086 __, lineno = findsource(obj)
3087 except Exception:
3088 pass
3089 else:
3090 print('Line: {}'.format(lineno))
3091
3092 print('\n')
3093 else:
3094 print(getsource(obj))
3095
3096
3097if __name__ == "__main__":
3098 _main()