blob: 57cb3dc0ac1f8e0599b499f206e6d980a22e5ce3 [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
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +000019 getargspec(), 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
Larry Hastings44e2eaa2013-11-23 15:37:55 -080034import ast
Antoine Pitroua8723a02015-04-15 00:41:29 +020035import dis
Yury Selivanov75445082015-05-11 22:57:16 -040036import collections.abc
Yury Selivanov21e83a52014-03-27 11:23:13 -040037import enum
Brett Cannoncb66eb02012-05-11 12:58:42 -040038import importlib.machinery
39import itertools
Christian Heimes7131fd92008-02-19 14:21:46 +000040import linecache
Brett Cannoncb66eb02012-05-11 12:58:42 -040041import os
42import re
43import sys
44import tokenize
Larry Hastings2623c8c2014-02-08 22:15:29 -080045import token
Brett Cannoncb66eb02012-05-11 12:58:42 -040046import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040047import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070048import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100049import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000050from operator import attrgetter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070051from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000052
53# Create constants for the compiler flags in Include/code.h
Antoine Pitroua8723a02015-04-15 00:41:29 +020054# We try to get them from dis to avoid duplication
55mod_dict = globals()
56for k, v in dis.COMPILER_FLAG_NAMES.items():
57 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000058
Christian Heimesbe5b30b2008-03-03 19:18:51 +000059# See Include/object.h
60TPFLAGS_IS_ABSTRACT = 1 << 20
61
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000062# ----------------------------------------------------------- type-checking
63def ismodule(object):
64 """Return true if the object is a module.
65
66 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000067 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000068 __doc__ documentation string
69 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000070 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000071
72def isclass(object):
73 """Return true if the object is a class.
74
75 Class objects provide these attributes:
76 __doc__ documentation string
77 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000078 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000079
80def ismethod(object):
81 """Return true if the object is an instance method.
82
83 Instance method objects provide these attributes:
84 __doc__ documentation string
85 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000086 __func__ function object containing implementation of method
87 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000088 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000089
Tim Peters536d2262001-09-20 05:13:38 +000090def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000091 """Return true if the object is a method descriptor.
92
93 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +000094
95 This is new in Python 2.2, and, for example, is true of int.__add__.
96 An object passing this test has a __get__ attribute but not a __set__
97 attribute, but beyond that the set of attributes varies. __name__ is
98 usually sensible, and __doc__ often is.
99
Tim Petersf1d90b92001-09-20 05:47:55 +0000100 Methods implemented via descriptors that also pass one of the other
101 tests return false from the ismethoddescriptor() test, simply because
102 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000103 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100104 if isclass(object) or ismethod(object) or isfunction(object):
105 # mutual exclusion
106 return False
107 tp = type(object)
108 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000109
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000110def isdatadescriptor(object):
111 """Return true if the object is a data descriptor.
112
113 Data descriptors have both a __get__ and a __set__ attribute. Examples are
114 properties (defined in Python) and getsets and members (defined in C).
115 Typically, data descriptors will also have __name__ and __doc__ attributes
116 (properties, getsets, and members have both of these attributes), but this
117 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100118 if isclass(object) or ismethod(object) or isfunction(object):
119 # mutual exclusion
120 return False
121 tp = type(object)
122 return hasattr(tp, "__set__") and hasattr(tp, "__get__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000123
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000124if hasattr(types, 'MemberDescriptorType'):
125 # CPython and equivalent
126 def ismemberdescriptor(object):
127 """Return true if the object is a member descriptor.
128
129 Member descriptors are specialized descriptors defined in extension
130 modules."""
131 return isinstance(object, types.MemberDescriptorType)
132else:
133 # Other implementations
134 def ismemberdescriptor(object):
135 """Return true if the object is a member descriptor.
136
137 Member descriptors are specialized descriptors defined in extension
138 modules."""
139 return False
140
141if hasattr(types, 'GetSetDescriptorType'):
142 # CPython and equivalent
143 def isgetsetdescriptor(object):
144 """Return true if the object is a getset descriptor.
145
146 getset descriptors are specialized descriptors defined in extension
147 modules."""
148 return isinstance(object, types.GetSetDescriptorType)
149else:
150 # Other implementations
151 def isgetsetdescriptor(object):
152 """Return true if the object is a getset descriptor.
153
154 getset descriptors are specialized descriptors defined in extension
155 modules."""
156 return False
157
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000158def isfunction(object):
159 """Return true if the object is a user-defined function.
160
161 Function objects provide these attributes:
162 __doc__ documentation string
163 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000164 __code__ code object containing compiled function bytecode
165 __defaults__ tuple of any default values for arguments
166 __globals__ global namespace in which this function was defined
167 __annotations__ dict of parameter annotations
168 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000169 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000170
Christian Heimes7131fd92008-02-19 14:21:46 +0000171def isgeneratorfunction(object):
172 """Return true if the object is a user-defined generator function.
173
174 Generator function objects provides same attributes as functions.
175
Alexander Belopolsky977a6842010-08-16 20:17:07 +0000176 See help(isfunction) for attributes listing."""
Georg Brandlb1441c72009-01-03 22:33:39 +0000177 return bool((isfunction(object) or ismethod(object)) and
Yury Selivanov75445082015-05-11 22:57:16 -0400178 object.__code__.co_flags & CO_GENERATOR and
179 not object.__code__.co_flags & CO_COROUTINE)
180
181def iscoroutinefunction(object):
182 """Return true if the object is a coroutine function.
183
184 Coroutine functions are defined with "async def" syntax,
185 or generators decorated with "types.coroutine".
186 """
187 return bool((isfunction(object) or ismethod(object)) and
188 object.__code__.co_flags & (CO_ITERABLE_COROUTINE |
189 CO_COROUTINE))
190
191def isawaitable(object):
192 """Return true if the object can be used in "await" expression."""
193 return isinstance(object, collections.abc.Awaitable)
Christian Heimes7131fd92008-02-19 14:21:46 +0000194
195def isgenerator(object):
196 """Return true if the object is a generator.
197
198 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300199 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000200 close raises a new GeneratorExit exception inside the
201 generator to terminate the iteration
202 gi_code code object
203 gi_frame frame object or possibly None once the generator has
204 been exhausted
205 gi_running set to 1 when generator is executing, 0 otherwise
206 next return the next item from the container
207 send resumes the generator and "sends" a value that becomes
208 the result of the current yield-expression
209 throw used to raise an exception inside the generator"""
Yury Selivanov75445082015-05-11 22:57:16 -0400210 return (isinstance(object, types.GeneratorType) and
211 not object.gi_code.co_flags & CO_COROUTINE)
212
213def iscoroutine(object):
214 """Return true if the object is a coroutine."""
Yury Selivanovff542232015-05-21 12:03:21 -0400215 return isinstance(object, collections.abc.Coroutine)
Christian Heimes7131fd92008-02-19 14:21:46 +0000216
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000217def istraceback(object):
218 """Return true if the object is a traceback.
219
220 Traceback objects provide these attributes:
221 tb_frame frame object at this level
222 tb_lasti index of last attempted instruction in bytecode
223 tb_lineno current line number in Python source code
224 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000225 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000226
227def isframe(object):
228 """Return true if the object is a frame object.
229
230 Frame objects provide these attributes:
231 f_back next outer frame object (this frame's caller)
232 f_builtins built-in namespace seen by this frame
233 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000234 f_globals global namespace seen by this frame
235 f_lasti index of last attempted instruction in bytecode
236 f_lineno current line number in Python source code
237 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000238 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000239 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000240
241def iscode(object):
242 """Return true if the object is a code object.
243
244 Code objects provide these attributes:
245 co_argcount number of arguments (not including * or ** args)
246 co_code string of raw compiled bytecode
247 co_consts tuple of constants used in the bytecode
248 co_filename name of file in which this code object was created
249 co_firstlineno number of first line in Python source code
250 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
251 co_lnotab encoded mapping of line numbers to bytecode indices
252 co_name name with which this code object was defined
253 co_names tuple of names of local variables
254 co_nlocals number of local variables
255 co_stacksize virtual machine stack space required
256 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000257 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000258
259def isbuiltin(object):
260 """Return true if the object is a built-in function or method.
261
262 Built-in functions and methods provide these attributes:
263 __doc__ documentation string
264 __name__ original name of this function or method
265 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000266 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000267
268def isroutine(object):
269 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000270 return (isbuiltin(object)
271 or isfunction(object)
272 or ismethod(object)
273 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000274
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000275def isabstract(object):
276 """Return true if the object is an abstract base class (ABC)."""
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000277 return bool(isinstance(object, type) and object.__flags__ & TPFLAGS_IS_ABSTRACT)
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000278
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000279def getmembers(object, predicate=None):
280 """Return all members of an object as (name, value) pairs sorted by name.
281 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100282 if isclass(object):
283 mro = (object,) + getmro(object)
284 else:
285 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000286 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700287 processed = set()
288 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700289 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700290 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700291 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700292 try:
293 for base in object.__bases__:
294 for k, v in base.__dict__.items():
295 if isinstance(v, types.DynamicClassAttribute):
296 names.append(k)
297 except AttributeError:
298 pass
299 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700300 # First try to get the value via getattr. Some descriptors don't
301 # like calling their __get__ (see bug #1785), so fall back to
302 # looking in the __dict__.
303 try:
304 value = getattr(object, key)
305 # handle the duplicate key
306 if key in processed:
307 raise AttributeError
308 except AttributeError:
309 for base in mro:
310 if key in base.__dict__:
311 value = base.__dict__[key]
312 break
313 else:
314 # could be a (currently) missing slot member, or a buggy
315 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100316 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000317 if not predicate or predicate(value):
318 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700319 processed.add(key)
320 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000321 return results
322
Christian Heimes25bb7832008-01-11 16:17:00 +0000323Attribute = namedtuple('Attribute', 'name kind defining_class object')
324
Tim Peters13b49d32001-09-23 02:00:29 +0000325def classify_class_attrs(cls):
326 """Return list of attribute-descriptor tuples.
327
328 For each name in dir(cls), the return list contains a 4-tuple
329 with these elements:
330
331 0. The name (a string).
332
333 1. The kind of attribute this is, one of these strings:
334 'class method' created via classmethod()
335 'static method' created via staticmethod()
336 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700337 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000338 'data' not a method
339
340 2. The class which defined this attribute (a class).
341
Ethan Furmane03ea372013-09-25 07:14:41 -0700342 3. The object as obtained by calling getattr; if this fails, or if the
343 resulting object does not live anywhere in the class' mro (including
344 metaclasses) then the object is looked up in the defining class's
345 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700346
347 If one of the items in dir(cls) is stored in the metaclass it will now
348 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700349 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000350 """
351
352 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700353 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Ethan Furmane03ea372013-09-25 07:14:41 -0700354 metamro = tuple([cls for cls in metamro if cls not in (type, object)])
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700355 class_bases = (cls,) + mro
356 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000357 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700358 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700359 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700360 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700361 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700362 for k, v in base.__dict__.items():
363 if isinstance(v, types.DynamicClassAttribute):
364 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000365 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700366 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700367
Tim Peters13b49d32001-09-23 02:00:29 +0000368 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100369 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700370 # Normal objects will be looked up with both getattr and directly in
371 # its class' dict (in case getattr fails [bug #1785], and also to look
372 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700373 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700374 # class's dict.
375 #
Tim Peters13b49d32001-09-23 02:00:29 +0000376 # Getting an obj from the __dict__ sometimes reveals more than
377 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100378 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700379 get_obj = None
380 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700381 if name not in processed:
382 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700383 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700384 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700385 get_obj = getattr(cls, name)
386 except Exception as exc:
387 pass
388 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700389 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700390 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700391 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700392 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700393 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700394 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700395 # first look in the classes
396 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700397 srch_obj = getattr(srch_cls, name, None)
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400398 if srch_obj is get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700399 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700400 # then check the metaclasses
401 for srch_cls in metamro:
402 try:
403 srch_obj = srch_cls.__getattr__(cls, name)
404 except AttributeError:
405 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400406 if srch_obj is get_obj:
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700407 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700408 if last_cls is not None:
409 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700410 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700411 if name in base.__dict__:
412 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700413 if homecls not in metamro:
414 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700415 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700416 if homecls is None:
417 # unable to locate the attribute anywhere, most likely due to
418 # buggy custom __dir__; discard and move on
419 continue
Yury Selivanovbf341fb2015-05-21 15:41:57 -0400420 obj = get_obj if get_obj is not None else dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700421 # Classify the object or its descriptor.
Ethan Furman63c141c2013-10-18 00:27:39 -0700422 if isinstance(dict_obj, staticmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000423 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700424 obj = dict_obj
Ethan Furman63c141c2013-10-18 00:27:39 -0700425 elif isinstance(dict_obj, classmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000426 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700427 obj = dict_obj
428 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000429 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700430 obj = dict_obj
Yury Selivanov0860a0b2014-01-31 14:28:44 -0500431 elif isroutine(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000432 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100433 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700434 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000435 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700436 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000437 return result
438
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000439# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000440
441def getmro(cls):
442 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000443 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000444
Nick Coghlane8c45d62013-07-28 20:00:01 +1000445# -------------------------------------------------------- function helpers
446
447def unwrap(func, *, stop=None):
448 """Get the object wrapped by *func*.
449
450 Follows the chain of :attr:`__wrapped__` attributes returning the last
451 object in the chain.
452
453 *stop* is an optional callback accepting an object in the wrapper chain
454 as its sole argument that allows the unwrapping to be terminated early if
455 the callback returns a true value. If the callback never returns a true
456 value, the last object in the chain is returned as usual. For example,
457 :func:`signature` uses this to stop unwrapping if any object in the
458 chain has a ``__signature__`` attribute defined.
459
460 :exc:`ValueError` is raised if a cycle is encountered.
461
462 """
463 if stop is None:
464 def _is_wrapper(f):
465 return hasattr(f, '__wrapped__')
466 else:
467 def _is_wrapper(f):
468 return hasattr(f, '__wrapped__') and not stop(f)
469 f = func # remember the original func for error reporting
470 memo = {id(f)} # Memoise by id to tolerate non-hashable objects
471 while _is_wrapper(func):
472 func = func.__wrapped__
473 id_func = id(func)
474 if id_func in memo:
475 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
476 memo.add(id_func)
477 return func
478
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000479# -------------------------------------------------- source code extraction
480def indentsize(line):
481 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000482 expline = line.expandtabs()
483 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000484
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300485def _findclass(func):
486 cls = sys.modules.get(func.__module__)
487 if cls is None:
488 return None
489 for name in func.__qualname__.split('.')[:-1]:
490 cls = getattr(cls, name)
491 if not isclass(cls):
492 return None
493 return cls
494
495def _finddoc(obj):
496 if isclass(obj):
497 for base in obj.__mro__:
498 if base is not object:
499 try:
500 doc = base.__doc__
501 except AttributeError:
502 continue
503 if doc is not None:
504 return doc
505 return None
506
507 if ismethod(obj):
508 name = obj.__func__.__name__
509 self = obj.__self__
510 if (isclass(self) and
511 getattr(getattr(self, name, None), '__func__') is obj.__func__):
512 # classmethod
513 cls = self
514 else:
515 cls = self.__class__
516 elif isfunction(obj):
517 name = obj.__name__
518 cls = _findclass(obj)
519 if cls is None or getattr(cls, name) is not obj:
520 return None
521 elif isbuiltin(obj):
522 name = obj.__name__
523 self = obj.__self__
524 if (isclass(self) and
525 self.__qualname__ + '.' + name == obj.__qualname__):
526 # classmethod
527 cls = self
528 else:
529 cls = self.__class__
530 elif ismethoddescriptor(obj) or isdatadescriptor(obj):
531 name = obj.__name__
532 cls = obj.__objclass__
533 if getattr(cls, name) is not obj:
534 return None
535 elif isinstance(obj, property):
536 func = f.fget
537 name = func.__name__
538 cls = _findclass(func)
539 if cls is None or getattr(cls, name) is not obj:
540 return None
541 else:
542 return None
543
544 for base in cls.__mro__:
545 try:
546 doc = getattr(base, name).__doc__
547 except AttributeError:
548 continue
549 if doc is not None:
550 return doc
551 return None
552
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000553def getdoc(object):
554 """Get the documentation string for an object.
555
556 All tabs are expanded to spaces. To clean up docstrings that are
557 indented to line up with blocks of code, any whitespace than can be
558 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000559 try:
560 doc = object.__doc__
561 except AttributeError:
562 return None
Serhiy Storchaka5cf2b722015-04-03 22:38:53 +0300563 if doc is None:
564 try:
565 doc = _finddoc(object)
566 except (AttributeError, TypeError):
567 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000568 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000569 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000570 return cleandoc(doc)
571
572def cleandoc(doc):
573 """Clean up indentation from docstrings.
574
575 Any whitespace that can be uniformly removed from the second line
576 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000577 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000578 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000579 except UnicodeError:
580 return None
581 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000582 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000583 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000584 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000585 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000586 if content:
587 indent = len(line) - content
588 margin = min(margin, indent)
589 # Remove indentation.
590 if lines:
591 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000592 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000593 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000594 # Remove any trailing or leading blank lines.
595 while lines and not lines[-1]:
596 lines.pop()
597 while lines and not lines[0]:
598 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000599 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000600
601def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000602 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000603 if ismodule(object):
604 if hasattr(object, '__file__'):
605 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000606 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000607 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500608 if hasattr(object, '__module__'):
609 object = sys.modules.get(object.__module__)
610 if hasattr(object, '__file__'):
611 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000612 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000613 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000614 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000615 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000616 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000617 if istraceback(object):
618 object = object.tb_frame
619 if isframe(object):
620 object = object.f_code
621 if iscode(object):
622 return object.co_filename
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000623 raise TypeError('{!r} is not a module, class, method, '
624 'function, traceback, frame, or code object'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000625
Christian Heimes25bb7832008-01-11 16:17:00 +0000626ModuleInfo = namedtuple('ModuleInfo', 'name suffix mode module_type')
627
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000628def getmoduleinfo(path):
629 """Get the module name, suffix, mode, and module type for a given file."""
Brett Cannoncb66eb02012-05-11 12:58:42 -0400630 warnings.warn('inspect.getmoduleinfo() is deprecated', DeprecationWarning,
631 2)
Brett Cannone4f41de2013-06-16 13:13:40 -0400632 with warnings.catch_warnings():
633 warnings.simplefilter('ignore', PendingDeprecationWarning)
634 import imp
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000635 filename = os.path.basename(path)
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000636 suffixes = [(-len(suffix), suffix, mode, mtype)
637 for suffix, mode, mtype in imp.get_suffixes()]
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000638 suffixes.sort() # try longest suffixes first, in case they overlap
639 for neglen, suffix, mode, mtype in suffixes:
640 if filename[neglen:] == suffix:
Christian Heimes25bb7832008-01-11 16:17:00 +0000641 return ModuleInfo(filename[:neglen], suffix, mode, mtype)
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000642
643def getmodulename(path):
644 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000645 fname = os.path.basename(path)
646 # Check for paths that look like an actual module file
647 suffixes = [(-len(suffix), suffix)
648 for suffix in importlib.machinery.all_suffixes()]
649 suffixes.sort() # try longest suffixes first, in case they overlap
650 for neglen, suffix in suffixes:
651 if fname.endswith(suffix):
652 return fname[:neglen]
653 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000654
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000655def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000656 """Return the filename that can be used to locate an object's source.
657 Return None if no way can be identified to get the source.
658 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000659 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400660 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
661 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
662 if any(filename.endswith(s) for s in all_bytecode_suffixes):
663 filename = (os.path.splitext(filename)[0] +
664 importlib.machinery.SOURCE_SUFFIXES[0])
665 elif any(filename.endswith(s) for s in
666 importlib.machinery.EXTENSION_SUFFIXES):
667 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000668 if os.path.exists(filename):
669 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000670 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400671 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000672 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000673 # or it is in the linecache
674 if filename in linecache.cache:
675 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000676
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000677def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000678 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000679
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000680 The idea is for each object to have a unique origin, so this routine
681 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000682 if _filename is None:
683 _filename = getsourcefile(object) or getfile(object)
684 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000685
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000686modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000687_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000688
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000689def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000690 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000691 if ismodule(object):
692 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000693 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000694 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000695 # Try the filename to modulename cache
696 if _filename is not None and _filename in modulesbyfile:
697 return sys.modules.get(modulesbyfile[_filename])
698 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000699 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000700 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000701 except TypeError:
702 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000703 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000704 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000705 # Update the filename to module name cache and check yet again
706 # Copy sys.modules in order to cope with changes while iterating
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100707 for modname, module in list(sys.modules.items()):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000708 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000709 f = module.__file__
710 if f == _filesbymodname.get(modname, None):
711 # Have already mapped this module, so skip it
712 continue
713 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000714 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000715 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000716 modulesbyfile[f] = modulesbyfile[
717 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000718 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000719 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000720 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000721 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000722 if not hasattr(object, '__name__'):
723 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000724 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000725 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000726 if mainobject is object:
727 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000728 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000729 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000730 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000731 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000732 if builtinobject is object:
733 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000734
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000735def findsource(object):
736 """Return the entire source file and starting line number for an object.
737
738 The argument may be a module, class, method, function, traceback, frame,
739 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200740 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000741 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500742
Yury Selivanovef1e7502014-12-08 16:05:34 -0500743 file = getsourcefile(object)
744 if file:
745 # Invalidate cache if needed.
746 linecache.checkcache(file)
747 else:
748 file = getfile(object)
749 # Allow filenames in form of "<something>" to pass through.
750 # `doctest` monkeypatches `linecache` module to enable
751 # inspection, so let `linecache.getlines` to be called.
752 if not (file.startswith('<') and file.endswith('>')):
753 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500754
Thomas Wouters89f507f2006-12-13 04:49:30 +0000755 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000756 if module:
757 lines = linecache.getlines(file, module.__dict__)
758 else:
759 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000760 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200761 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000762
763 if ismodule(object):
764 return lines, 0
765
766 if isclass(object):
767 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000768 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
769 # make some effort to find the best matching class definition:
770 # use the one with the least indentation, which is the one
771 # that's most probably not inside a function definition.
772 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000773 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000774 match = pat.match(lines[i])
775 if match:
776 # if it's at toplevel, it's already the best one
777 if lines[i][0] == 'c':
778 return lines, i
779 # else add whitespace to candidate list
780 candidates.append((match.group(1), i))
781 if candidates:
782 # this will sort by whitespace, and by line number,
783 # less whitespace first
784 candidates.sort()
785 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000786 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200787 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000788
789 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000790 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000791 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000792 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000793 if istraceback(object):
794 object = object.tb_frame
795 if isframe(object):
796 object = object.f_code
797 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000798 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200799 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000800 lnum = object.co_firstlineno - 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000801 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000802 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000803 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000804 lnum = lnum - 1
805 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200806 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000807
808def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000809 """Get lines of comments immediately preceding an object's source code.
810
811 Returns None when source can't be found.
812 """
813 try:
814 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200815 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000816 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000817
818 if ismodule(object):
819 # Look for a comment block at the top of the file.
820 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000821 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000822 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000823 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000824 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000825 comments = []
826 end = start
827 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000828 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000829 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000830 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000831
832 # Look for a preceding block of comments at the same indentation.
833 elif lnum > 0:
834 indent = indentsize(lines[lnum])
835 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000836 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000837 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000838 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000839 if end > 0:
840 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000841 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000842 while comment[:1] == '#' and indentsize(lines[end]) == indent:
843 comments[:0] = [comment]
844 end = end - 1
845 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000846 comment = lines[end].expandtabs().lstrip()
847 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000848 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000849 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000850 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000851 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000852
Tim Peters4efb6e92001-06-29 23:51:08 +0000853class EndOfBlock(Exception): pass
854
855class BlockFinder:
856 """Provide a tokeneater() method to detect the end of a code block."""
857 def __init__(self):
858 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000859 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000860 self.started = False
861 self.passline = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000862 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000863
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000864 def tokeneater(self, type, token, srowcol, erowcol, line):
Tim Peters4efb6e92001-06-29 23:51:08 +0000865 if not self.started:
Armin Rigodd5c0232005-09-25 11:45:45 +0000866 # look for the first "def", "class" or "lambda"
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000867 if token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000868 if token == "lambda":
869 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000870 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000871 self.passline = True # skip to the end of the line
Tim Peters4efb6e92001-06-29 23:51:08 +0000872 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000873 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000874 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000875 if self.islambda: # lambdas always end at the first NEWLINE
876 raise EndOfBlock
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000877 elif self.passline:
878 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000879 elif type == tokenize.INDENT:
880 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000881 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000882 elif type == tokenize.DEDENT:
883 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000884 # the end of matching indent/dedent pairs end a block
885 # (note that this only works for "def"/"class" blocks,
886 # not e.g. for "if: else:" or "try: finally:" blocks)
887 if self.indent <= 0:
888 raise EndOfBlock
889 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
890 # any other token on the same indentation level end the previous
891 # block as well, except the pseudo-tokens COMMENT and NL.
892 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000893
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000894def getblock(lines):
895 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000896 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000897 try:
Trent Nelson428de652008-03-18 22:41:35 +0000898 tokens = tokenize.generate_tokens(iter(lines).__next__)
899 for _token in tokens:
900 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000901 except (EndOfBlock, IndentationError):
902 pass
903 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000904
Antoine Pitroua8723a02015-04-15 00:41:29 +0200905def _line_number_helper(code_obj, lines, lnum):
906 """Return a list of source lines and starting line number for a code object.
907
908 The arguments must be a code object with lines and lnum from findsource.
909 """
910 _, end_line = list(dis.findlinestarts(code_obj))[-1]
911 return lines[lnum:end_line], lnum + 1
912
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000913def getsourcelines(object):
914 """Return a list of source lines and starting line number for an object.
915
916 The argument may be a module, class, method, function, traceback, frame,
917 or code object. The source code is returned as a list of the lines
918 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200919 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000920 raised if the source code cannot be retrieved."""
Yury Selivanov081bbf62014-09-26 17:34:54 -0400921 object = unwrap(object)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000922 lines, lnum = findsource(object)
923
Antoine Pitroua8723a02015-04-15 00:41:29 +0200924 if ismodule(object):
925 return lines, 0
926 elif iscode(object):
927 return _line_number_helper(object, lines, lnum)
928 elif isfunction(object):
929 return _line_number_helper(object.__code__, lines, lnum)
930 elif ismethod(object):
931 return _line_number_helper(object.__func__.__code__, lines, lnum)
932 else:
933 return getblock(lines[lnum:]), lnum + 1
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000934
935def getsource(object):
936 """Return the text of the source code for an object.
937
938 The argument may be a module, class, method, function, traceback, frame,
939 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200940 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000941 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000942 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000943
944# --------------------------------------------------- class tree extraction
945def walktree(classes, children, parent):
946 """Recursive helper function for getclasstree()."""
947 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000948 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000949 for c in classes:
950 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000951 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000952 results.append(walktree(children[c], children, c))
953 return results
954
Georg Brandl5ce83a02009-06-01 17:23:51 +0000955def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000956 """Arrange the given list of classes into a hierarchy of nested lists.
957
958 Where a nested list appears, it contains classes derived from the class
959 whose entry immediately precedes the list. Each entry is a 2-tuple
960 containing a class and a tuple of its base classes. If the 'unique'
961 argument is true, exactly one entry appears in the returned structure
962 for each class in the given list. Otherwise, classes using multiple
963 inheritance and their descendants will appear multiple times."""
964 children = {}
965 roots = []
966 for c in classes:
967 if c.__bases__:
968 for parent in c.__bases__:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000969 if not parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000970 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +0300971 if c not in children[parent]:
972 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000973 if unique and parent in classes: break
974 elif c not in roots:
975 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +0000976 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000977 if parent not in classes:
978 roots.append(parent)
979 return walktree(roots, children, None)
980
981# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +0000982Arguments = namedtuple('Arguments', 'args, varargs, varkw')
983
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000984def getargs(co):
985 """Get information about the arguments accepted by a code object.
986
Guido van Rossum2e65f892007-02-28 22:03:49 +0000987 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000988 'args' is the list of argument names. Keyword-only arguments are
989 appended. 'varargs' and 'varkw' are the names of the * and **
990 arguments or None."""
Guido van Rossum2e65f892007-02-28 22:03:49 +0000991 args, varargs, kwonlyargs, varkw = _getfullargs(co)
Christian Heimes25bb7832008-01-11 16:17:00 +0000992 return Arguments(args + kwonlyargs, varargs, varkw)
Guido van Rossum2e65f892007-02-28 22:03:49 +0000993
994def _getfullargs(co):
995 """Get information about the arguments accepted by a code object.
996
997 Four things are returned: (args, varargs, kwonlyargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000998 'args' and 'kwonlyargs' are lists of argument names, and 'varargs'
999 and 'varkw' are the names of the * and ** arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +00001000
1001 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001002 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001003
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001004 nargs = co.co_argcount
1005 names = co.co_varnames
Guido van Rossum2e65f892007-02-28 22:03:49 +00001006 nkwargs = co.co_kwonlyargcount
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001007 args = list(names[:nargs])
Guido van Rossum2e65f892007-02-28 22:03:49 +00001008 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001009 step = 0
1010
Guido van Rossum2e65f892007-02-28 22:03:49 +00001011 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001012 varargs = None
1013 if co.co_flags & CO_VARARGS:
1014 varargs = co.co_varnames[nargs]
1015 nargs = nargs + 1
1016 varkw = None
1017 if co.co_flags & CO_VARKEYWORDS:
1018 varkw = co.co_varnames[nargs]
Guido van Rossum2e65f892007-02-28 22:03:49 +00001019 return args, varargs, kwonlyargs, varkw
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001020
Christian Heimes25bb7832008-01-11 16:17:00 +00001021
1022ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
1023
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001024def getargspec(func):
1025 """Get the names and default values of a function's arguments.
1026
Guido van Rossume82881c2014-07-15 12:29:11 -07001027 A tuple of four things is returned: (args, varargs, keywords, defaults).
1028 'args' is a list of the argument names, including keyword-only argument names.
1029 'varargs' and 'keywords' are the names of the * and ** arguments or None.
Jeremy Hylton64967882003-06-27 18:14:39 +00001030 'defaults' is an n-tuple of the default values of the last n arguments.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001031
Yury Selivanov0cf3ed62014-04-01 10:17:08 -04001032 Use the getfullargspec() API for Python 3 code, as annotations
Guido van Rossum2e65f892007-02-28 22:03:49 +00001033 and keyword arguments are supported. getargspec() will raise ValueError
1034 if the func has either annotations or keyword arguments.
1035 """
Yury Selivanov3cfec2e2015-05-22 11:38:38 -04001036 warnings.warn("inspect.getargspec() is deprecated, "
Yury Selivanovc8386f72015-05-22 16:09:44 -04001037 "use inspect.signature() instead", DeprecationWarning,
1038 stacklevel=2)
Guido van Rossum2e65f892007-02-28 22:03:49 +00001039 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
1040 getfullargspec(func)
1041 if kwonlyargs or ann:
Collin Winterce36ad82007-08-30 01:19:48 +00001042 raise ValueError("Function has keyword-only arguments or annotations"
1043 ", use getfullargspec() API which can support them")
Christian Heimes25bb7832008-01-11 16:17:00 +00001044 return ArgSpec(args, varargs, varkw, defaults)
1045
1046FullArgSpec = namedtuple('FullArgSpec',
Benjamin Peterson3d4ca742008-11-12 21:39:01 +00001047 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +00001048
1049def getfullargspec(func):
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001050 """Get the names and default values of a callable object's arguments.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001051
Brett Cannon504d8852007-09-07 02:12:14 +00001052 A tuple of seven things is returned:
1053 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults annotations).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001054 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +00001055 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1056 'defaults' is an n-tuple of the default values of the last n arguments.
1057 'kwonlyargs' is a list of keyword-only argument names.
1058 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
1059 'annotations' is a dictionary mapping argument names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001060
Guido van Rossum2e65f892007-02-28 22:03:49 +00001061 The first four items in the tuple correspond to getargspec().
Yury Selivanov3cfec2e2015-05-22 11:38:38 -04001062
1063 This function is deprecated, use inspect.signature() instead.
Jeremy Hylton64967882003-06-27 18:14:39 +00001064 """
1065
Yury Selivanov57d240e2014-02-19 16:27:23 -05001066 try:
1067 # Re: `skip_bound_arg=False`
1068 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001069 # There is a notable difference in behaviour between getfullargspec
1070 # and Signature: the former always returns 'self' parameter for bound
1071 # methods, whereas the Signature always shows the actual calling
1072 # signature of the passed object.
1073 #
1074 # To simulate this behaviour, we "unbind" bound methods, to trick
1075 # inspect.signature to always return their first parameter ("self",
1076 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001077
Yury Selivanov57d240e2014-02-19 16:27:23 -05001078 # Re: `follow_wrapper_chains=False`
1079 #
1080 # getfullargspec() historically ignored __wrapped__ attributes,
1081 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001082
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001083 sig = _signature_from_callable(func,
1084 follow_wrapper_chains=False,
1085 skip_bound_arg=False,
1086 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001087 except Exception as ex:
1088 # Most of the times 'signature' will raise ValueError.
1089 # But, it can also raise AttributeError, and, maybe something
1090 # else. So to be fully backwards compatible, we catch all
1091 # possible exceptions here, and reraise a TypeError.
1092 raise TypeError('unsupported callable') from ex
1093
1094 args = []
1095 varargs = None
1096 varkw = None
1097 kwonlyargs = []
1098 defaults = ()
1099 annotations = {}
1100 defaults = ()
1101 kwdefaults = {}
1102
1103 if sig.return_annotation is not sig.empty:
1104 annotations['return'] = sig.return_annotation
1105
1106 for param in sig.parameters.values():
1107 kind = param.kind
1108 name = param.name
1109
1110 if kind is _POSITIONAL_ONLY:
1111 args.append(name)
1112 elif kind is _POSITIONAL_OR_KEYWORD:
1113 args.append(name)
1114 if param.default is not param.empty:
1115 defaults += (param.default,)
1116 elif kind is _VAR_POSITIONAL:
1117 varargs = name
1118 elif kind is _KEYWORD_ONLY:
1119 kwonlyargs.append(name)
1120 if param.default is not param.empty:
1121 kwdefaults[name] = param.default
1122 elif kind is _VAR_KEYWORD:
1123 varkw = name
1124
1125 if param.annotation is not param.empty:
1126 annotations[name] = param.annotation
1127
1128 if not kwdefaults:
1129 # compatibility with 'func.__kwdefaults__'
1130 kwdefaults = None
1131
1132 if not defaults:
1133 # compatibility with 'func.__defaults__'
1134 defaults = None
1135
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001136 return FullArgSpec(args, varargs, varkw, defaults,
1137 kwonlyargs, kwdefaults, annotations)
1138
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001139
Christian Heimes25bb7832008-01-11 16:17:00 +00001140ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1141
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001142def getargvalues(frame):
1143 """Get information about arguments passed into a particular frame.
1144
1145 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001146 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001147 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1148 'locals' is the locals dictionary of the given frame."""
1149 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001150 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001151
Guido van Rossum2e65f892007-02-28 22:03:49 +00001152def formatannotation(annotation, base_module=None):
1153 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001154 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001155 return annotation.__qualname__
1156 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001157 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001158
Guido van Rossum2e65f892007-02-28 22:03:49 +00001159def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001160 module = getattr(object, '__module__', None)
1161 def _formatannotation(annotation):
1162 return formatannotation(annotation, module)
1163 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001164
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001165def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +00001166 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001167 formatarg=str,
1168 formatvarargs=lambda name: '*' + name,
1169 formatvarkw=lambda name: '**' + name,
1170 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001171 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001172 formatannotation=formatannotation):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001173 """Format an argument spec from the values returned by getargspec
Guido van Rossum2e65f892007-02-28 22:03:49 +00001174 or getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001175
Guido van Rossum2e65f892007-02-28 22:03:49 +00001176 The first seven arguments are (args, varargs, varkw, defaults,
1177 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1178 are the corresponding optional formatting functions that are called to
1179 turn names and values into strings. The last argument is an optional
1180 function to format the sequence of arguments."""
1181 def formatargandannotation(arg):
1182 result = formatarg(arg)
1183 if arg in annotations:
1184 result += ': ' + formatannotation(annotations[arg])
1185 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001186 specs = []
1187 if defaults:
1188 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001189 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001190 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001191 if defaults and i >= firstdefault:
1192 spec = spec + formatvalue(defaults[i - firstdefault])
1193 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001194 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001195 specs.append(formatvarargs(formatargandannotation(varargs)))
1196 else:
1197 if kwonlyargs:
1198 specs.append('*')
1199 if kwonlyargs:
1200 for kwonlyarg in kwonlyargs:
1201 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001202 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001203 spec += formatvalue(kwonlydefaults[kwonlyarg])
1204 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001205 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001206 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001207 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001208 if 'return' in annotations:
1209 result += formatreturns(formatannotation(annotations['return']))
1210 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001211
1212def formatargvalues(args, varargs, varkw, locals,
1213 formatarg=str,
1214 formatvarargs=lambda name: '*' + name,
1215 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001216 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001217 """Format an argument spec from the 4 values returned by getargvalues.
1218
1219 The first four arguments are (args, varargs, varkw, locals). The
1220 next four arguments are the corresponding optional formatting functions
1221 that are called to turn names and values into strings. The ninth
1222 argument is an optional function to format the sequence of arguments."""
1223 def convert(name, locals=locals,
1224 formatarg=formatarg, formatvalue=formatvalue):
1225 return formatarg(name) + formatvalue(locals[name])
1226 specs = []
1227 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001228 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001229 if varargs:
1230 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1231 if varkw:
1232 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001233 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001234
Benjamin Petersone109c702011-06-24 09:37:26 -05001235def _missing_arguments(f_name, argnames, pos, values):
1236 names = [repr(name) for name in argnames if name not in values]
1237 missing = len(names)
1238 if missing == 1:
1239 s = names[0]
1240 elif missing == 2:
1241 s = "{} and {}".format(*names)
1242 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001243 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001244 del names[-2:]
1245 s = ", ".join(names) + tail
1246 raise TypeError("%s() missing %i required %s argument%s: %s" %
1247 (f_name, missing,
1248 "positional" if pos else "keyword-only",
1249 "" if missing == 1 else "s", s))
1250
1251def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001252 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001253 kwonly_given = len([arg for arg in kwonly if arg in values])
1254 if varargs:
1255 plural = atleast != 1
1256 sig = "at least %d" % (atleast,)
1257 elif defcount:
1258 plural = True
1259 sig = "from %d to %d" % (atleast, len(args))
1260 else:
1261 plural = len(args) != 1
1262 sig = str(len(args))
1263 kwonly_sig = ""
1264 if kwonly_given:
1265 msg = " positional argument%s (and %d keyword-only argument%s)"
1266 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1267 "s" if kwonly_given != 1 else ""))
1268 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1269 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1270 "was" if given == 1 and not kwonly_given else "were"))
1271
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001272def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001273 """Get the mapping of arguments to values.
1274
1275 A dict is returned, with keys the function argument names (including the
1276 names of the * and ** arguments, if any), and values the respective bound
1277 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001278 func = func_and_positional[0]
1279 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001280 spec = getfullargspec(func)
1281 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1282 f_name = func.__name__
1283 arg2value = {}
1284
Benjamin Petersonb204a422011-06-05 22:04:07 -05001285
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001286 if ismethod(func) and func.__self__ is not None:
1287 # implicit 'self' (or 'cls' for classmethods) argument
1288 positional = (func.__self__,) + positional
1289 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001290 num_args = len(args)
1291 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001292
Benjamin Petersonb204a422011-06-05 22:04:07 -05001293 n = min(num_pos, num_args)
1294 for i in range(n):
1295 arg2value[args[i]] = positional[i]
1296 if varargs:
1297 arg2value[varargs] = tuple(positional[n:])
1298 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001299 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001300 arg2value[varkw] = {}
1301 for kw, value in named.items():
1302 if kw not in possible_kwargs:
1303 if not varkw:
1304 raise TypeError("%s() got an unexpected keyword argument %r" %
1305 (f_name, kw))
1306 arg2value[varkw][kw] = value
1307 continue
1308 if kw in arg2value:
1309 raise TypeError("%s() got multiple values for argument %r" %
1310 (f_name, kw))
1311 arg2value[kw] = value
1312 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001313 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1314 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001315 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001316 req = args[:num_args - num_defaults]
1317 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001318 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001319 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001320 for i, arg in enumerate(args[num_args - num_defaults:]):
1321 if arg not in arg2value:
1322 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001323 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001324 for kwarg in kwonlyargs:
1325 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001326 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001327 arg2value[kwarg] = kwonlydefaults[kwarg]
1328 else:
1329 missing += 1
1330 if missing:
1331 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001332 return arg2value
1333
Nick Coghlan2f92e542012-06-23 19:39:55 +10001334ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1335
1336def getclosurevars(func):
1337 """
1338 Get the mapping of free variables to their current values.
1339
Meador Inge8fda3592012-07-19 21:33:21 -05001340 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001341 and builtin references as seen by the body of the function. A final
1342 set of unbound names that could not be resolved is also provided.
1343 """
1344
1345 if ismethod(func):
1346 func = func.__func__
1347
1348 if not isfunction(func):
1349 raise TypeError("'{!r}' is not a Python function".format(func))
1350
1351 code = func.__code__
1352 # Nonlocal references are named in co_freevars and resolved
1353 # by looking them up in __closure__ by positional index
1354 if func.__closure__ is None:
1355 nonlocal_vars = {}
1356 else:
1357 nonlocal_vars = {
1358 var : cell.cell_contents
1359 for var, cell in zip(code.co_freevars, func.__closure__)
1360 }
1361
1362 # Global and builtin references are named in co_names and resolved
1363 # by looking them up in __globals__ or __builtins__
1364 global_ns = func.__globals__
1365 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1366 if ismodule(builtin_ns):
1367 builtin_ns = builtin_ns.__dict__
1368 global_vars = {}
1369 builtin_vars = {}
1370 unbound_names = set()
1371 for name in code.co_names:
1372 if name in ("None", "True", "False"):
1373 # Because these used to be builtins instead of keywords, they
1374 # may still show up as name references. We ignore them.
1375 continue
1376 try:
1377 global_vars[name] = global_ns[name]
1378 except KeyError:
1379 try:
1380 builtin_vars[name] = builtin_ns[name]
1381 except KeyError:
1382 unbound_names.add(name)
1383
1384 return ClosureVars(nonlocal_vars, global_vars,
1385 builtin_vars, unbound_names)
1386
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001387# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001388
1389Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1390
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001391def getframeinfo(frame, context=1):
1392 """Get information about a frame or traceback object.
1393
1394 A tuple of five things is returned: the filename, the line number of
1395 the current line, the function name, a list of lines of context from
1396 the source code, and the index of the current line within that list.
1397 The optional second argument specifies the number of lines of context
1398 to return, which are centered around the current line."""
1399 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001400 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001401 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001402 else:
1403 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001404 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001405 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001406
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001407 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001408 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001409 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001410 try:
1411 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001412 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001413 lines = index = None
1414 else:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001415 start = max(start, 1)
Raymond Hettingera0501712004-06-15 11:22:53 +00001416 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001417 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001418 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001419 else:
1420 lines = index = None
1421
Christian Heimes25bb7832008-01-11 16:17:00 +00001422 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001423
1424def getlineno(frame):
1425 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001426 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1427 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001428
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001429FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1430
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001431def getouterframes(frame, context=1):
1432 """Get a list of records for a frame and all higher (calling) frames.
1433
1434 Each record contains a frame object, filename, line number, function
1435 name, a list of lines of context, and index within the context."""
1436 framelist = []
1437 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001438 frameinfo = (frame,) + getframeinfo(frame, context)
1439 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001440 frame = frame.f_back
1441 return framelist
1442
1443def getinnerframes(tb, context=1):
1444 """Get a list of records for a traceback's frame and all lower frames.
1445
1446 Each record contains a frame object, filename, line number, function
1447 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001448 framelist = []
1449 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001450 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1451 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001452 tb = tb.tb_next
1453 return framelist
1454
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001455def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001456 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001457 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001458
1459def stack(context=1):
1460 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001461 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001462
1463def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001464 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001465 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001466
1467
1468# ------------------------------------------------ static version of getattr
1469
1470_sentinel = object()
1471
Michael Foorde5162652010-11-20 16:40:44 +00001472def _static_getmro(klass):
1473 return type.__dict__['__mro__'].__get__(klass)
1474
Michael Foord95fc51d2010-11-20 15:07:30 +00001475def _check_instance(obj, attr):
1476 instance_dict = {}
1477 try:
1478 instance_dict = object.__getattribute__(obj, "__dict__")
1479 except AttributeError:
1480 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001481 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001482
1483
1484def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001485 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001486 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001487 try:
1488 return entry.__dict__[attr]
1489 except KeyError:
1490 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001491 return _sentinel
1492
Michael Foord35184ed2010-11-20 16:58:30 +00001493def _is_type(obj):
1494 try:
1495 _static_getmro(obj)
1496 except TypeError:
1497 return False
1498 return True
1499
Michael Foorddcebe0f2011-03-15 19:20:44 -04001500def _shadowed_dict(klass):
1501 dict_attr = type.__dict__["__dict__"]
1502 for entry in _static_getmro(klass):
1503 try:
1504 class_dict = dict_attr.__get__(entry)["__dict__"]
1505 except KeyError:
1506 pass
1507 else:
1508 if not (type(class_dict) is types.GetSetDescriptorType and
1509 class_dict.__name__ == "__dict__" and
1510 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001511 return class_dict
1512 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001513
1514def getattr_static(obj, attr, default=_sentinel):
1515 """Retrieve attributes without triggering dynamic lookup via the
1516 descriptor protocol, __getattr__ or __getattribute__.
1517
1518 Note: this function may not be able to retrieve all attributes
1519 that getattr can fetch (like dynamically created attributes)
1520 and may find attributes that getattr can't (like descriptors
1521 that raise AttributeError). It can also return descriptor objects
1522 instead of instance members in some cases. See the
1523 documentation for details.
1524 """
1525 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001526 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001527 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001528 dict_attr = _shadowed_dict(klass)
1529 if (dict_attr is _sentinel or
1530 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001531 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001532 else:
1533 klass = obj
1534
1535 klass_result = _check_class(klass, attr)
1536
1537 if instance_result is not _sentinel and klass_result is not _sentinel:
1538 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1539 _check_class(type(klass_result), '__set__') is not _sentinel):
1540 return klass_result
1541
1542 if instance_result is not _sentinel:
1543 return instance_result
1544 if klass_result is not _sentinel:
1545 return klass_result
1546
1547 if obj is klass:
1548 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001549 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001550 if _shadowed_dict(type(entry)) is _sentinel:
1551 try:
1552 return entry.__dict__[attr]
1553 except KeyError:
1554 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001555 if default is not _sentinel:
1556 return default
1557 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001558
1559
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001560# ------------------------------------------------ generator introspection
1561
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001562GEN_CREATED = 'GEN_CREATED'
1563GEN_RUNNING = 'GEN_RUNNING'
1564GEN_SUSPENDED = 'GEN_SUSPENDED'
1565GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001566
1567def getgeneratorstate(generator):
1568 """Get current state of a generator-iterator.
1569
1570 Possible states are:
1571 GEN_CREATED: Waiting to start execution.
1572 GEN_RUNNING: Currently being executed by the interpreter.
1573 GEN_SUSPENDED: Currently suspended at a yield expression.
1574 GEN_CLOSED: Execution has completed.
1575 """
1576 if generator.gi_running:
1577 return GEN_RUNNING
1578 if generator.gi_frame is None:
1579 return GEN_CLOSED
1580 if generator.gi_frame.f_lasti == -1:
1581 return GEN_CREATED
1582 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001583
1584
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001585def getgeneratorlocals(generator):
1586 """
1587 Get the mapping of generator local variables to their current values.
1588
1589 A dict is returned, with the keys the local variable names and values the
1590 bound values."""
1591
1592 if not isgenerator(generator):
1593 raise TypeError("'{!r}' is not a Python generator".format(generator))
1594
1595 frame = getattr(generator, "gi_frame", None)
1596 if frame is not None:
1597 return generator.gi_frame.f_locals
1598 else:
1599 return {}
1600
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001601###############################################################################
1602### Function Signature Object (PEP 362)
1603###############################################################################
1604
1605
1606_WrapperDescriptor = type(type.__call__)
1607_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001608_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001609
1610_NonUserDefinedCallables = (_WrapperDescriptor,
1611 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001612 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001613 types.BuiltinFunctionType)
1614
1615
Yury Selivanov421f0c72014-01-29 12:05:40 -05001616def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001617 """Private helper. Checks if ``cls`` has an attribute
1618 named ``method_name`` and returns it only if it is a
1619 pure python function.
1620 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001621 try:
1622 meth = getattr(cls, method_name)
1623 except AttributeError:
1624 return
1625 else:
1626 if not isinstance(meth, _NonUserDefinedCallables):
1627 # Once '__signature__' will be added to 'C'-level
1628 # callables, this check won't be necessary
1629 return meth
1630
1631
Yury Selivanov62560fb2014-01-28 12:26:24 -05001632def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001633 """Private helper to calculate how 'wrapped_sig' signature will
1634 look like after applying a 'functools.partial' object (or alike)
1635 on it.
1636 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001637
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001638 old_params = wrapped_sig.parameters
1639 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001640
1641 partial_args = partial.args or ()
1642 partial_keywords = partial.keywords or {}
1643
1644 if extra_args:
1645 partial_args = extra_args + partial_args
1646
1647 try:
1648 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1649 except TypeError as ex:
1650 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1651 raise ValueError(msg) from ex
1652
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001653
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001654 transform_to_kwonly = False
1655 for param_name, param in old_params.items():
1656 try:
1657 arg_value = ba.arguments[param_name]
1658 except KeyError:
1659 pass
1660 else:
1661 if param.kind is _POSITIONAL_ONLY:
1662 # If positional-only parameter is bound by partial,
1663 # it effectively disappears from the signature
1664 new_params.pop(param_name)
1665 continue
1666
1667 if param.kind is _POSITIONAL_OR_KEYWORD:
1668 if param_name in partial_keywords:
1669 # This means that this parameter, and all parameters
1670 # after it should be keyword-only (and var-positional
1671 # should be removed). Here's why. Consider the following
1672 # function:
1673 # foo(a, b, *args, c):
1674 # pass
1675 #
1676 # "partial(foo, a='spam')" will have the following
1677 # signature: "(*, a='spam', b, c)". Because attempting
1678 # to call that partial with "(10, 20)" arguments will
1679 # raise a TypeError, saying that "a" argument received
1680 # multiple values.
1681 transform_to_kwonly = True
1682 # Set the new default value
1683 new_params[param_name] = param.replace(default=arg_value)
1684 else:
1685 # was passed as a positional argument
1686 new_params.pop(param.name)
1687 continue
1688
1689 if param.kind is _KEYWORD_ONLY:
1690 # Set the new default value
1691 new_params[param_name] = param.replace(default=arg_value)
1692
1693 if transform_to_kwonly:
1694 assert param.kind is not _POSITIONAL_ONLY
1695
1696 if param.kind is _POSITIONAL_OR_KEYWORD:
1697 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1698 new_params[param_name] = new_param
1699 new_params.move_to_end(param_name)
1700 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
1701 new_params.move_to_end(param_name)
1702 elif param.kind is _VAR_POSITIONAL:
1703 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001704
1705 return wrapped_sig.replace(parameters=new_params.values())
1706
1707
Yury Selivanov62560fb2014-01-28 12:26:24 -05001708def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001709 """Private helper to transform signatures for unbound
1710 functions to bound methods.
1711 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001712
1713 params = tuple(sig.parameters.values())
1714
1715 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1716 raise ValueError('invalid method signature')
1717
1718 kind = params[0].kind
1719 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1720 # Drop first parameter:
1721 # '(p1, p2[, ...])' -> '(p2[, ...])'
1722 params = params[1:]
1723 else:
1724 if kind is not _VAR_POSITIONAL:
1725 # Unless we add a new parameter type we never
1726 # get here
1727 raise ValueError('invalid argument type')
1728 # It's a var-positional parameter.
1729 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1730
1731 return sig.replace(parameters=params)
1732
1733
Yury Selivanovb77511d2014-01-29 10:46:14 -05001734def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001735 """Private helper to test if `obj` is a callable that might
1736 support Argument Clinic's __text_signature__ protocol.
1737 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001738 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001739 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001740 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001741 # Can't test 'isinstance(type)' here, as it would
1742 # also be True for regular python classes
1743 obj in (type, object))
1744
1745
Yury Selivanov63da7c72014-01-31 14:48:37 -05001746def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001747 """Private helper to test if `obj` is a duck type of FunctionType.
1748 A good example of such objects are functions compiled with
1749 Cython, which have all attributes that a pure Python function
1750 would have, but have their code statically compiled.
1751 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001752
1753 if not callable(obj) or isclass(obj):
1754 # All function-like objects are obviously callables,
1755 # and not classes.
1756 return False
1757
1758 name = getattr(obj, '__name__', None)
1759 code = getattr(obj, '__code__', None)
1760 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1761 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1762 annotations = getattr(obj, '__annotations__', None)
1763
1764 return (isinstance(code, types.CodeType) and
1765 isinstance(name, str) and
1766 (defaults is None or isinstance(defaults, tuple)) and
1767 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1768 isinstance(annotations, dict))
1769
1770
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001771def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001772 """ Private helper to get first parameter name from a
1773 __text_signature__ of a builtin method, which should
1774 be in the following format: '($param1, ...)'.
1775 Assumptions are that the first argument won't have
1776 a default value or an annotation.
1777 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001778
1779 assert spec.startswith('($')
1780
1781 pos = spec.find(',')
1782 if pos == -1:
1783 pos = spec.find(')')
1784
1785 cpos = spec.find(':')
1786 assert cpos == -1 or cpos > pos
1787
1788 cpos = spec.find('=')
1789 assert cpos == -1 or cpos > pos
1790
1791 return spec[2:pos]
1792
1793
Larry Hastings2623c8c2014-02-08 22:15:29 -08001794def _signature_strip_non_python_syntax(signature):
1795 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001796 Private helper function. Takes a signature in Argument Clinic's
1797 extended signature format.
1798
Larry Hastings2623c8c2014-02-08 22:15:29 -08001799 Returns a tuple of three things:
1800 * that signature re-rendered in standard Python syntax,
1801 * the index of the "self" parameter (generally 0), or None if
1802 the function does not have a "self" parameter, and
1803 * the index of the last "positional only" parameter,
1804 or None if the signature has no positional-only parameters.
1805 """
1806
1807 if not signature:
1808 return signature, None, None
1809
1810 self_parameter = None
1811 last_positional_only = None
1812
1813 lines = [l.encode('ascii') for l in signature.split('\n')]
1814 generator = iter(lines).__next__
1815 token_stream = tokenize.tokenize(generator)
1816
1817 delayed_comma = False
1818 skip_next_comma = False
1819 text = []
1820 add = text.append
1821
1822 current_parameter = 0
1823 OP = token.OP
1824 ERRORTOKEN = token.ERRORTOKEN
1825
1826 # token stream always starts with ENCODING token, skip it
1827 t = next(token_stream)
1828 assert t.type == tokenize.ENCODING
1829
1830 for t in token_stream:
1831 type, string = t.type, t.string
1832
1833 if type == OP:
1834 if string == ',':
1835 if skip_next_comma:
1836 skip_next_comma = False
1837 else:
1838 assert not delayed_comma
1839 delayed_comma = True
1840 current_parameter += 1
1841 continue
1842
1843 if string == '/':
1844 assert not skip_next_comma
1845 assert last_positional_only is None
1846 skip_next_comma = True
1847 last_positional_only = current_parameter - 1
1848 continue
1849
1850 if (type == ERRORTOKEN) and (string == '$'):
1851 assert self_parameter is None
1852 self_parameter = current_parameter
1853 continue
1854
1855 if delayed_comma:
1856 delayed_comma = False
1857 if not ((type == OP) and (string == ')')):
1858 add(', ')
1859 add(string)
1860 if (string == ','):
1861 add(' ')
1862 clean_signature = ''.join(text)
1863 return clean_signature, self_parameter, last_positional_only
1864
1865
Yury Selivanov57d240e2014-02-19 16:27:23 -05001866def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001867 """Private helper to parse content of '__text_signature__'
1868 and return a Signature based on it.
1869 """
1870
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001871 Parameter = cls._parameter_cls
1872
Larry Hastings2623c8c2014-02-08 22:15:29 -08001873 clean_signature, self_parameter, last_positional_only = \
1874 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001875
Larry Hastings2623c8c2014-02-08 22:15:29 -08001876 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001877
1878 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001879 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001880 except SyntaxError:
1881 module = None
1882
1883 if not isinstance(module, ast.Module):
1884 raise ValueError("{!r} builtin has invalid signature".format(obj))
1885
1886 f = module.body[0]
1887
1888 parameters = []
1889 empty = Parameter.empty
1890 invalid = object()
1891
1892 module = None
1893 module_dict = {}
1894 module_name = getattr(obj, '__module__', None)
1895 if module_name:
1896 module = sys.modules.get(module_name, None)
1897 if module:
1898 module_dict = module.__dict__
1899 sys_module_dict = sys.modules
1900
1901 def parse_name(node):
1902 assert isinstance(node, ast.arg)
1903 if node.annotation != None:
1904 raise ValueError("Annotations are not currently supported")
1905 return node.arg
1906
1907 def wrap_value(s):
1908 try:
1909 value = eval(s, module_dict)
1910 except NameError:
1911 try:
1912 value = eval(s, sys_module_dict)
1913 except NameError:
1914 raise RuntimeError()
1915
1916 if isinstance(value, str):
1917 return ast.Str(value)
1918 if isinstance(value, (int, float)):
1919 return ast.Num(value)
1920 if isinstance(value, bytes):
1921 return ast.Bytes(value)
1922 if value in (True, False, None):
1923 return ast.NameConstant(value)
1924 raise RuntimeError()
1925
1926 class RewriteSymbolics(ast.NodeTransformer):
1927 def visit_Attribute(self, node):
1928 a = []
1929 n = node
1930 while isinstance(n, ast.Attribute):
1931 a.append(n.attr)
1932 n = n.value
1933 if not isinstance(n, ast.Name):
1934 raise RuntimeError()
1935 a.append(n.id)
1936 value = ".".join(reversed(a))
1937 return wrap_value(value)
1938
1939 def visit_Name(self, node):
1940 if not isinstance(node.ctx, ast.Load):
1941 raise ValueError()
1942 return wrap_value(node.id)
1943
1944 def p(name_node, default_node, default=empty):
1945 name = parse_name(name_node)
1946 if name is invalid:
1947 return None
1948 if default_node and default_node is not _empty:
1949 try:
1950 default_node = RewriteSymbolics().visit(default_node)
1951 o = ast.literal_eval(default_node)
1952 except ValueError:
1953 o = invalid
1954 if o is invalid:
1955 return None
1956 default = o if o is not invalid else default
1957 parameters.append(Parameter(name, kind, default=default, annotation=empty))
1958
1959 # non-keyword-only parameters
1960 args = reversed(f.args.args)
1961 defaults = reversed(f.args.defaults)
1962 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001963 if last_positional_only is not None:
1964 kind = Parameter.POSITIONAL_ONLY
1965 else:
1966 kind = Parameter.POSITIONAL_OR_KEYWORD
1967 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001968 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001969 if i == last_positional_only:
1970 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001971
1972 # *args
1973 if f.args.vararg:
1974 kind = Parameter.VAR_POSITIONAL
1975 p(f.args.vararg, empty)
1976
1977 # keyword-only arguments
1978 kind = Parameter.KEYWORD_ONLY
1979 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
1980 p(name, default)
1981
1982 # **kwargs
1983 if f.args.kwarg:
1984 kind = Parameter.VAR_KEYWORD
1985 p(f.args.kwarg, empty)
1986
Larry Hastings2623c8c2014-02-08 22:15:29 -08001987 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05001988 # Possibly strip the bound argument:
1989 # - We *always* strip first bound argument if
1990 # it is a module.
1991 # - We don't strip first bound argument if
1992 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001993 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05001994 _self = getattr(obj, '__self__', None)
1995 self_isbound = _self is not None
1996 self_ismodule = ismodule(_self)
1997 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001998 parameters.pop(0)
1999 else:
2000 # for builtins, self parameter is always positional-only!
2001 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2002 parameters[0] = p
2003
2004 return cls(parameters, return_annotation=cls.empty)
2005
2006
Yury Selivanov57d240e2014-02-19 16:27:23 -05002007def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002008 """Private helper function to get signature for
2009 builtin callables.
2010 """
2011
Yury Selivanov57d240e2014-02-19 16:27:23 -05002012 if not _signature_is_builtin(func):
2013 raise TypeError("{!r} is not a Python builtin "
2014 "function".format(func))
2015
2016 s = getattr(func, "__text_signature__", None)
2017 if not s:
2018 raise ValueError("no signature found for builtin {!r}".format(func))
2019
2020 return _signature_fromstr(cls, func, s, skip_bound_arg)
2021
2022
Yury Selivanovcf45f022015-05-20 14:38:50 -04002023def _signature_from_function(cls, func):
2024 """Private helper: constructs Signature for the given python function."""
2025
2026 is_duck_function = False
2027 if not isfunction(func):
2028 if _signature_is_functionlike(func):
2029 is_duck_function = True
2030 else:
2031 # If it's not a pure Python function, and not a duck type
2032 # of pure function:
2033 raise TypeError('{!r} is not a Python function'.format(func))
2034
2035 Parameter = cls._parameter_cls
2036
2037 # Parameter information.
2038 func_code = func.__code__
2039 pos_count = func_code.co_argcount
2040 arg_names = func_code.co_varnames
2041 positional = tuple(arg_names[:pos_count])
2042 keyword_only_count = func_code.co_kwonlyargcount
2043 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
2044 annotations = func.__annotations__
2045 defaults = func.__defaults__
2046 kwdefaults = func.__kwdefaults__
2047
2048 if defaults:
2049 pos_default_count = len(defaults)
2050 else:
2051 pos_default_count = 0
2052
2053 parameters = []
2054
2055 # Non-keyword-only parameters w/o defaults.
2056 non_default_count = pos_count - pos_default_count
2057 for name in positional[:non_default_count]:
2058 annotation = annotations.get(name, _empty)
2059 parameters.append(Parameter(name, annotation=annotation,
2060 kind=_POSITIONAL_OR_KEYWORD))
2061
2062 # ... w/ defaults.
2063 for offset, name in enumerate(positional[non_default_count:]):
2064 annotation = annotations.get(name, _empty)
2065 parameters.append(Parameter(name, annotation=annotation,
2066 kind=_POSITIONAL_OR_KEYWORD,
2067 default=defaults[offset]))
2068
2069 # *args
2070 if func_code.co_flags & CO_VARARGS:
2071 name = arg_names[pos_count + keyword_only_count]
2072 annotation = annotations.get(name, _empty)
2073 parameters.append(Parameter(name, annotation=annotation,
2074 kind=_VAR_POSITIONAL))
2075
2076 # Keyword-only parameters.
2077 for name in keyword_only:
2078 default = _empty
2079 if kwdefaults is not None:
2080 default = kwdefaults.get(name, _empty)
2081
2082 annotation = annotations.get(name, _empty)
2083 parameters.append(Parameter(name, annotation=annotation,
2084 kind=_KEYWORD_ONLY,
2085 default=default))
2086 # **kwargs
2087 if func_code.co_flags & CO_VARKEYWORDS:
2088 index = pos_count + keyword_only_count
2089 if func_code.co_flags & CO_VARARGS:
2090 index += 1
2091
2092 name = arg_names[index]
2093 annotation = annotations.get(name, _empty)
2094 parameters.append(Parameter(name, annotation=annotation,
2095 kind=_VAR_KEYWORD))
2096
2097 # Is 'func' is a pure Python function - don't validate the
2098 # parameters list (for correct order and defaults), it should be OK.
2099 return cls(parameters,
2100 return_annotation=annotations.get('return', _empty),
2101 __validate_parameters__=is_duck_function)
2102
2103
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002104def _signature_from_callable(obj, *,
2105 follow_wrapper_chains=True,
2106 skip_bound_arg=True,
2107 sigcls):
2108
2109 """Private helper function to get signature for arbitrary
2110 callable objects.
2111 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002112
2113 if not callable(obj):
2114 raise TypeError('{!r} is not a callable object'.format(obj))
2115
2116 if isinstance(obj, types.MethodType):
2117 # In this case we skip the first parameter of the underlying
2118 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002119 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002120 obj.__func__,
2121 follow_wrapper_chains=follow_wrapper_chains,
2122 skip_bound_arg=skip_bound_arg,
2123 sigcls=sigcls)
2124
Yury Selivanov57d240e2014-02-19 16:27:23 -05002125 if skip_bound_arg:
2126 return _signature_bound_method(sig)
2127 else:
2128 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002129
Nick Coghlane8c45d62013-07-28 20:00:01 +10002130 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05002131 if follow_wrapper_chains:
2132 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Yury Selivanov46c759d2015-05-27 21:56:53 -04002133 if isinstance(obj, types.MethodType):
2134 # If the unwrapped object is a *method*, we might want to
2135 # skip its first parameter (self).
2136 # See test_signature_wrapped_bound_method for details.
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002137 return _signature_from_callable(
Yury Selivanov46c759d2015-05-27 21:56:53 -04002138 obj,
2139 follow_wrapper_chains=follow_wrapper_chains,
Yury Selivanov507cd3c2015-05-27 21:59:03 -04002140 skip_bound_arg=skip_bound_arg,
2141 sigcls=sigcls)
Nick Coghlane8c45d62013-07-28 20:00:01 +10002142
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002143 try:
2144 sig = obj.__signature__
2145 except AttributeError:
2146 pass
2147 else:
2148 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07002149 if not isinstance(sig, Signature):
2150 raise TypeError(
2151 'unexpected object {!r} in __signature__ '
2152 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002153 return sig
2154
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002155 try:
2156 partialmethod = obj._partialmethod
2157 except AttributeError:
2158 pass
2159 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05002160 if isinstance(partialmethod, functools.partialmethod):
2161 # Unbound partialmethod (see functools.partialmethod)
2162 # This means, that we need to calculate the signature
2163 # as if it's a regular partial object, but taking into
2164 # account that the first positional argument
2165 # (usually `self`, or `cls`) will not be passed
2166 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002167
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002168 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002169 partialmethod.func,
2170 follow_wrapper_chains=follow_wrapper_chains,
2171 skip_bound_arg=skip_bound_arg,
2172 sigcls=sigcls)
2173
Yury Selivanov0486f812014-01-29 12:18:59 -05002174 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002175
Yury Selivanov0486f812014-01-29 12:18:59 -05002176 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
2177 new_params = (first_wrapped_param,) + tuple(sig.parameters.values())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002178
Yury Selivanov0486f812014-01-29 12:18:59 -05002179 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05002180
Yury Selivanov63da7c72014-01-31 14:48:37 -05002181 if isfunction(obj) or _signature_is_functionlike(obj):
2182 # If it's a pure Python function, or an object that is duck type
2183 # of a Python function (Cython functions, for instance), then:
Yury Selivanovcf45f022015-05-20 14:38:50 -04002184 return _signature_from_function(sigcls, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002185
Yury Selivanova773de02014-02-21 18:30:53 -05002186 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04002187 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05002188 skip_bound_arg=skip_bound_arg)
2189
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002190 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002191 wrapped_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)
Yury Selivanov62560fb2014-01-28 12:26:24 -05002196 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002197
2198 sig = None
2199 if isinstance(obj, type):
2200 # obj is a class or a metaclass
2201
2202 # First, let's see if it has an overloaded __call__ defined
2203 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002204 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002205 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002206 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002207 call,
2208 follow_wrapper_chains=follow_wrapper_chains,
2209 skip_bound_arg=skip_bound_arg,
2210 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002211 else:
2212 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002213 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002214 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002215 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002216 new,
2217 follow_wrapper_chains=follow_wrapper_chains,
2218 skip_bound_arg=skip_bound_arg,
2219 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002220 else:
2221 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002222 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002223 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002224 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002225 init,
2226 follow_wrapper_chains=follow_wrapper_chains,
2227 skip_bound_arg=skip_bound_arg,
2228 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002229
2230 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002231 # At this point we know, that `obj` is a class, with no user-
2232 # defined '__init__', '__new__', or class-level '__call__'
2233
Larry Hastings2623c8c2014-02-08 22:15:29 -08002234 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002235 # Since '__text_signature__' is implemented as a
2236 # descriptor that extracts text signature from the
2237 # class docstring, if 'obj' is derived from a builtin
2238 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002239 # Therefore, we go through the MRO (except the last
2240 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002241 # class with non-empty text signature.
2242 try:
2243 text_sig = base.__text_signature__
2244 except AttributeError:
2245 pass
2246 else:
2247 if text_sig:
2248 # If 'obj' class has a __text_signature__ attribute:
2249 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002250 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002251
2252 # No '__text_signature__' was found for the 'obj' class.
2253 # Last option is to check if its '__init__' is
2254 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002255 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002256 # We have a class (not metaclass), but no user-defined
2257 # __init__ or __new__ for it
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002258 if obj.__init__ is object.__init__:
2259 # Return a signature of 'object' builtin.
2260 return signature(object)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002261
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002262 elif not isinstance(obj, _NonUserDefinedCallables):
2263 # An object with __call__
2264 # We also check that the 'obj' is not an instance of
2265 # _WrapperDescriptor or _MethodWrapper to avoid
2266 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002267 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002268 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002269 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002270 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002271 call,
2272 follow_wrapper_chains=follow_wrapper_chains,
2273 skip_bound_arg=skip_bound_arg,
2274 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002275 except ValueError as ex:
2276 msg = 'no signature found for {!r}'.format(obj)
2277 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002278
2279 if sig is not None:
2280 # For classes and objects we skip the first parameter of their
2281 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002282 if skip_bound_arg:
2283 return _signature_bound_method(sig)
2284 else:
2285 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002286
2287 if isinstance(obj, types.BuiltinFunctionType):
2288 # Raise a nicer error message for builtins
2289 msg = 'no signature found for builtin function {!r}'.format(obj)
2290 raise ValueError(msg)
2291
2292 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2293
2294
2295class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002296 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002297
2298
2299class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002300 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002301
2302
Yury Selivanov21e83a52014-03-27 11:23:13 -04002303class _ParameterKind(enum.IntEnum):
2304 POSITIONAL_ONLY = 0
2305 POSITIONAL_OR_KEYWORD = 1
2306 VAR_POSITIONAL = 2
2307 KEYWORD_ONLY = 3
2308 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002309
2310 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002311 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002312
2313
Yury Selivanov21e83a52014-03-27 11:23:13 -04002314_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2315_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2316_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2317_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2318_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002319
2320
2321class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002322 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002323
2324 Has the following public attributes:
2325
2326 * name : str
2327 The name of the parameter as a string.
2328 * default : object
2329 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002330 parameter has no default value, this attribute is set to
2331 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002332 * annotation
2333 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002334 parameter has no annotation, this attribute is set to
2335 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002336 * kind : str
2337 Describes how argument values are bound to the parameter.
2338 Possible values: `Parameter.POSITIONAL_ONLY`,
2339 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2340 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002341 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002342
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002343 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002344
2345 POSITIONAL_ONLY = _POSITIONAL_ONLY
2346 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2347 VAR_POSITIONAL = _VAR_POSITIONAL
2348 KEYWORD_ONLY = _KEYWORD_ONLY
2349 VAR_KEYWORD = _VAR_KEYWORD
2350
2351 empty = _empty
2352
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002353 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002354
2355 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
2356 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
2357 raise ValueError("invalid value for 'Parameter.kind' attribute")
2358 self._kind = kind
2359
2360 if default is not _empty:
2361 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2362 msg = '{} parameters cannot have default values'.format(kind)
2363 raise ValueError(msg)
2364 self._default = default
2365 self._annotation = annotation
2366
Yury Selivanov2393dca2014-01-27 15:07:58 -05002367 if name is _empty:
2368 raise ValueError('name is a required attribute for Parameter')
2369
2370 if not isinstance(name, str):
2371 raise TypeError("name must be a str, not a {!r}".format(name))
2372
2373 if not name.isidentifier():
2374 raise ValueError('{!r} is not a valid parameter name'.format(name))
2375
2376 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002377
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002378 def __reduce__(self):
2379 return (type(self),
2380 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002381 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002382 '_annotation': self._annotation})
2383
2384 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002385 self._default = state['_default']
2386 self._annotation = state['_annotation']
2387
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002388 @property
2389 def name(self):
2390 return self._name
2391
2392 @property
2393 def default(self):
2394 return self._default
2395
2396 @property
2397 def annotation(self):
2398 return self._annotation
2399
2400 @property
2401 def kind(self):
2402 return self._kind
2403
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002404 def replace(self, *, name=_void, kind=_void,
2405 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002406 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002407
2408 if name is _void:
2409 name = self._name
2410
2411 if kind is _void:
2412 kind = self._kind
2413
2414 if annotation is _void:
2415 annotation = self._annotation
2416
2417 if default is _void:
2418 default = self._default
2419
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002420 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002421
2422 def __str__(self):
2423 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002424 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002425
2426 # Add annotation and default value
2427 if self._annotation is not _empty:
2428 formatted = '{}:{}'.format(formatted,
2429 formatannotation(self._annotation))
2430
2431 if self._default is not _empty:
2432 formatted = '{}={}'.format(formatted, repr(self._default))
2433
2434 if kind == _VAR_POSITIONAL:
2435 formatted = '*' + formatted
2436 elif kind == _VAR_KEYWORD:
2437 formatted = '**' + formatted
2438
2439 return formatted
2440
2441 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002442 return '<{} "{}">'.format(self.__class__.__name__, self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002443
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002444 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002445 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002446
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002447 def __eq__(self, other):
Yury Selivanov692b3402015-05-14 18:20:01 -04002448 return (self is other or
2449 (issubclass(other.__class__, Parameter) and
2450 self._name == other._name and
2451 self._kind == other._kind and
2452 self._default == other._default and
2453 self._annotation == other._annotation))
2454
2455 def __ne__(self, other):
2456 return not self.__eq__(other)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002457
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002458
2459class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002460 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002461 to the function's parameters.
2462
2463 Has the following public attributes:
2464
2465 * arguments : OrderedDict
2466 An ordered mutable mapping of parameters' names to arguments' values.
2467 Does not contain arguments' default values.
2468 * signature : Signature
2469 The Signature object that created this instance.
2470 * args : tuple
2471 Tuple of positional arguments values.
2472 * kwargs : dict
2473 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002474 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002475
Yury Selivanov6abe0322015-05-13 17:18:41 -04002476 __slots__ = ('arguments', '_signature', '__weakref__')
2477
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002478 def __init__(self, signature, arguments):
2479 self.arguments = arguments
2480 self._signature = signature
2481
2482 @property
2483 def signature(self):
2484 return self._signature
2485
2486 @property
2487 def args(self):
2488 args = []
2489 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002490 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002491 break
2492
2493 try:
2494 arg = self.arguments[param_name]
2495 except KeyError:
2496 # We're done here. Other arguments
2497 # will be mapped in 'BoundArguments.kwargs'
2498 break
2499 else:
2500 if param.kind == _VAR_POSITIONAL:
2501 # *args
2502 args.extend(arg)
2503 else:
2504 # plain argument
2505 args.append(arg)
2506
2507 return tuple(args)
2508
2509 @property
2510 def kwargs(self):
2511 kwargs = {}
2512 kwargs_started = False
2513 for param_name, param in self._signature.parameters.items():
2514 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002515 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002516 kwargs_started = True
2517 else:
2518 if param_name not in self.arguments:
2519 kwargs_started = True
2520 continue
2521
2522 if not kwargs_started:
2523 continue
2524
2525 try:
2526 arg = self.arguments[param_name]
2527 except KeyError:
2528 pass
2529 else:
2530 if param.kind == _VAR_KEYWORD:
2531 # **kwargs
2532 kwargs.update(arg)
2533 else:
2534 # plain keyword argument
2535 kwargs[param_name] = arg
2536
2537 return kwargs
2538
Yury Selivanovb907a512015-05-16 13:45:09 -04002539 def apply_defaults(self):
2540 """Set default values for missing arguments.
2541
2542 For variable-positional arguments (*args) the default is an
2543 empty tuple.
2544
2545 For variable-keyword arguments (**kwargs) the default is an
2546 empty dict.
2547 """
2548 arguments = self.arguments
2549 if not arguments:
2550 return
2551 new_arguments = []
2552 for name, param in self._signature.parameters.items():
2553 try:
2554 new_arguments.append((name, arguments[name]))
2555 except KeyError:
2556 if param.default is not _empty:
2557 val = param.default
2558 elif param.kind is _VAR_POSITIONAL:
2559 val = ()
2560 elif param.kind is _VAR_KEYWORD:
2561 val = {}
2562 else:
2563 # This BoundArguments was likely produced by
2564 # Signature.bind_partial().
2565 continue
2566 new_arguments.append((name, val))
2567 self.arguments = OrderedDict(new_arguments)
2568
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002569 def __eq__(self, other):
Yury Selivanov692b3402015-05-14 18:20:01 -04002570 return (self is other or
2571 (issubclass(other.__class__, BoundArguments) and
2572 self.signature == other.signature and
2573 self.arguments == other.arguments))
2574
2575 def __ne__(self, other):
2576 return not self.__eq__(other)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002577
Yury Selivanov6abe0322015-05-13 17:18:41 -04002578 def __setstate__(self, state):
2579 self._signature = state['_signature']
2580 self.arguments = state['arguments']
2581
2582 def __getstate__(self):
2583 return {'_signature': self._signature, 'arguments': self.arguments}
2584
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002585 def __repr__(self):
2586 args = []
2587 for arg, value in self.arguments.items():
2588 args.append('{}={!r}'.format(arg, value))
Yury Selivanovf229bc52015-05-15 12:53:56 -04002589 return '<{} ({})>'.format(self.__class__.__name__, ', '.join(args))
Yury Selivanov3f6538f2015-05-14 18:47:17 -04002590
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002591
2592class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002593 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002594 It stores a Parameter object for each parameter accepted by the
2595 function, as well as information specific to the function itself.
2596
2597 A Signature object has the following public attributes and methods:
2598
2599 * parameters : OrderedDict
2600 An ordered mapping of parameters' names to the corresponding
2601 Parameter objects (keyword-only arguments are in the same order
2602 as listed in `code.co_varnames`).
2603 * return_annotation : object
2604 The annotation for the return type of the function if specified.
2605 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002606 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002607 * bind(*args, **kwargs) -> BoundArguments
2608 Creates a mapping from positional and keyword arguments to
2609 parameters.
2610 * bind_partial(*args, **kwargs) -> BoundArguments
2611 Creates a partial mapping from positional and keyword arguments
2612 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002613 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002614
2615 __slots__ = ('_return_annotation', '_parameters')
2616
2617 _parameter_cls = Parameter
2618 _bound_arguments_cls = BoundArguments
2619
2620 empty = _empty
2621
2622 def __init__(self, parameters=None, *, return_annotation=_empty,
2623 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002624 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002625 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002626 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002627
2628 if parameters is None:
2629 params = OrderedDict()
2630 else:
2631 if __validate_parameters__:
2632 params = OrderedDict()
2633 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002634 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002635
2636 for idx, param in enumerate(parameters):
2637 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002638 name = param.name
2639
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002640 if kind < top_kind:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002641 msg = 'wrong parameter order: {!r} before {!r}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05002642 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002643 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002644 elif kind > top_kind:
2645 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002646 top_kind = kind
2647
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002648 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002649 if param.default is _empty:
2650 if kind_defaults:
2651 # No default for this parameter, but the
2652 # previous parameter of the same kind had
2653 # a default
2654 msg = 'non-default argument follows default ' \
2655 'argument'
2656 raise ValueError(msg)
2657 else:
2658 # There is a default for this parameter.
2659 kind_defaults = True
2660
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002661 if name in params:
2662 msg = 'duplicate parameter name: {!r}'.format(name)
2663 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002664
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002665 params[name] = param
2666 else:
2667 params = OrderedDict(((param.name, param)
2668 for param in parameters))
2669
2670 self._parameters = types.MappingProxyType(params)
2671 self._return_annotation = return_annotation
2672
2673 @classmethod
2674 def from_function(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002675 """Constructs Signature for the given python function."""
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002676
2677 warnings.warn("inspect.Signature.from_function() is deprecated, "
Berker Peksagb5601582015-05-21 23:40:54 +03002678 "use Signature.from_callable()",
2679 DeprecationWarning, stacklevel=2)
Yury Selivanovcf45f022015-05-20 14:38:50 -04002680 return _signature_from_function(cls, func)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002681
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002682 @classmethod
2683 def from_builtin(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002684 """Constructs Signature for the given builtin function."""
Yury Selivanov57c74fc2015-05-20 23:07:02 -04002685
2686 warnings.warn("inspect.Signature.from_builtin() is deprecated, "
Berker Peksagb5601582015-05-21 23:40:54 +03002687 "use Signature.from_callable()",
2688 DeprecationWarning, stacklevel=2)
Yury Selivanov57d240e2014-02-19 16:27:23 -05002689 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002690
Yury Selivanovda396452014-03-27 12:09:24 -04002691 @classmethod
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002692 def from_callable(cls, obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002693 """Constructs Signature for the given callable object."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002694 return _signature_from_callable(obj, sigcls=cls,
2695 follow_wrapper_chains=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002696
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002697 @property
2698 def parameters(self):
2699 return self._parameters
2700
2701 @property
2702 def return_annotation(self):
2703 return self._return_annotation
2704
2705 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002706 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002707 Pass 'parameters' and/or 'return_annotation' arguments
2708 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002709 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002710
2711 if parameters is _void:
2712 parameters = self.parameters.values()
2713
2714 if return_annotation is _void:
2715 return_annotation = self._return_annotation
2716
2717 return type(self)(parameters,
2718 return_annotation=return_annotation)
2719
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002720 def _hash_basis(self):
2721 params = tuple(param for param in self.parameters.values()
2722 if param.kind != _KEYWORD_ONLY)
2723
2724 kwo_params = {param.name: param for param in self.parameters.values()
2725 if param.kind == _KEYWORD_ONLY}
2726
2727 return params, kwo_params, self.return_annotation
2728
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002729 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002730 params, kwo_params, return_annotation = self._hash_basis()
2731 kwo_params = frozenset(kwo_params.values())
2732 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002733
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002734 def __eq__(self, other):
Yury Selivanov692b3402015-05-14 18:20:01 -04002735 return (self is other or
2736 (isinstance(other, Signature) and
2737 self._hash_basis() == other._hash_basis()))
2738
2739 def __ne__(self, other):
2740 return not self.__eq__(other)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002741
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002742 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002743 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002744
2745 arguments = OrderedDict()
2746
2747 parameters = iter(self.parameters.values())
2748 parameters_ex = ()
2749 arg_vals = iter(args)
2750
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002751 while True:
2752 # Let's iterate through the positional arguments and corresponding
2753 # parameters
2754 try:
2755 arg_val = next(arg_vals)
2756 except StopIteration:
2757 # No more positional arguments
2758 try:
2759 param = next(parameters)
2760 except StopIteration:
2761 # No more parameters. That's it. Just need to check that
2762 # we have no `kwargs` after this while loop
2763 break
2764 else:
2765 if param.kind == _VAR_POSITIONAL:
2766 # That's OK, just empty *args. Let's start parsing
2767 # kwargs
2768 break
2769 elif param.name in kwargs:
2770 if param.kind == _POSITIONAL_ONLY:
2771 msg = '{arg!r} parameter is positional only, ' \
2772 'but was passed as a keyword'
2773 msg = msg.format(arg=param.name)
2774 raise TypeError(msg) from None
2775 parameters_ex = (param,)
2776 break
2777 elif (param.kind == _VAR_KEYWORD or
2778 param.default is not _empty):
2779 # That's fine too - we have a default value for this
2780 # parameter. So, lets start parsing `kwargs`, starting
2781 # with the current parameter
2782 parameters_ex = (param,)
2783 break
2784 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002785 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2786 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002787 if partial:
2788 parameters_ex = (param,)
2789 break
2790 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002791 msg = 'missing a required argument: {arg!r}'
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002792 msg = msg.format(arg=param.name)
2793 raise TypeError(msg) from None
2794 else:
2795 # We have a positional argument to process
2796 try:
2797 param = next(parameters)
2798 except StopIteration:
2799 raise TypeError('too many positional arguments') from None
2800 else:
2801 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2802 # Looks like we have no parameter for this positional
2803 # argument
Yury Selivanov86872752015-05-19 00:27:49 -04002804 raise TypeError(
2805 'too many positional arguments') from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002806
2807 if param.kind == _VAR_POSITIONAL:
2808 # We have an '*args'-like argument, let's fill it with
2809 # all positional arguments we have left and move on to
2810 # the next phase
2811 values = [arg_val]
2812 values.extend(arg_vals)
2813 arguments[param.name] = tuple(values)
2814 break
2815
2816 if param.name in kwargs:
Yury Selivanov86872752015-05-19 00:27:49 -04002817 raise TypeError(
2818 'multiple values for argument {arg!r}'.format(
2819 arg=param.name)) from None
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002820
2821 arguments[param.name] = arg_val
2822
2823 # Now, we iterate through the remaining parameters to process
2824 # keyword arguments
2825 kwargs_param = None
2826 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002827 if param.kind == _VAR_KEYWORD:
2828 # Memorize that we have a '**kwargs'-like parameter
2829 kwargs_param = param
2830 continue
2831
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002832 if param.kind == _VAR_POSITIONAL:
2833 # Named arguments don't refer to '*args'-like parameters.
2834 # We only arrive here if the positional arguments ended
2835 # before reaching the last parameter before *args.
2836 continue
2837
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002838 param_name = param.name
2839 try:
2840 arg_val = kwargs.pop(param_name)
2841 except KeyError:
2842 # We have no value for this parameter. It's fine though,
2843 # if it has a default value, or it is an '*args'-like
2844 # parameter, left alone by the processing of positional
2845 # arguments.
2846 if (not partial and param.kind != _VAR_POSITIONAL and
2847 param.default is _empty):
Yury Selivanov86872752015-05-19 00:27:49 -04002848 raise TypeError('missing a required argument: {arg!r}'. \
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002849 format(arg=param_name)) from None
2850
2851 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002852 if param.kind == _POSITIONAL_ONLY:
2853 # This should never happen in case of a properly built
2854 # Signature object (but let's have this check here
2855 # to ensure correct behaviour just in case)
2856 raise TypeError('{arg!r} parameter is positional only, '
2857 'but was passed as a keyword'. \
2858 format(arg=param.name))
2859
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002860 arguments[param_name] = arg_val
2861
2862 if kwargs:
2863 if kwargs_param is not None:
2864 # Process our '**kwargs'-like parameter
2865 arguments[kwargs_param.name] = kwargs
2866 else:
Yury Selivanov86872752015-05-19 00:27:49 -04002867 raise TypeError(
2868 'got an unexpected keyword argument {arg!r}'.format(
2869 arg=next(iter(kwargs))))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002870
2871 return self._bound_arguments_cls(self, arguments)
2872
Yury Selivanovc45873e2014-01-29 12:10:27 -05002873 def bind(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002874 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002875 and `kwargs` to the function's signature. Raises `TypeError`
2876 if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002877 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002878 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002879
Yury Selivanovc45873e2014-01-29 12:10:27 -05002880 def bind_partial(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002881 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002882 passed `args` and `kwargs` to the function's signature.
2883 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002884 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002885 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002886
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002887 def __reduce__(self):
2888 return (type(self),
2889 (tuple(self._parameters.values()),),
2890 {'_return_annotation': self._return_annotation})
2891
2892 def __setstate__(self, state):
2893 self._return_annotation = state['_return_annotation']
2894
Yury Selivanov374375d2014-03-27 12:41:53 -04002895 def __repr__(self):
Yury Selivanovf229bc52015-05-15 12:53:56 -04002896 return '<{} {}>'.format(self.__class__.__name__, self)
Yury Selivanov374375d2014-03-27 12:41:53 -04002897
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002898 def __str__(self):
2899 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002900 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002901 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002902 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002903 formatted = str(param)
2904
2905 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002906
2907 if kind == _POSITIONAL_ONLY:
2908 render_pos_only_separator = True
2909 elif render_pos_only_separator:
2910 # It's not a positional-only parameter, and the flag
2911 # is set to 'True' (there were pos-only params before.)
2912 result.append('/')
2913 render_pos_only_separator = False
2914
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002915 if kind == _VAR_POSITIONAL:
2916 # OK, we have an '*args'-like parameter, so we won't need
2917 # a '*' to separate keyword-only arguments
2918 render_kw_only_separator = False
2919 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
2920 # We have a keyword-only parameter to render and we haven't
2921 # rendered an '*args'-like parameter before, so add a '*'
2922 # separator to the parameters list ("foo(arg1, *, arg2)" case)
2923 result.append('*')
2924 # This condition should be only triggered once, so
2925 # reset the flag
2926 render_kw_only_separator = False
2927
2928 result.append(formatted)
2929
Yury Selivanov2393dca2014-01-27 15:07:58 -05002930 if render_pos_only_separator:
2931 # There were only positional-only parameters, hence the
2932 # flag was not reset to 'False'
2933 result.append('/')
2934
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002935 rendered = '({})'.format(', '.join(result))
2936
2937 if self.return_annotation is not _empty:
2938 anno = formatannotation(self.return_annotation)
2939 rendered += ' -> {}'.format(anno)
2940
2941 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002942
Yury Selivanovda396452014-03-27 12:09:24 -04002943
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002944def signature(obj, *, follow_wrapped=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002945 """Get a signature object for the passed callable."""
Yury Selivanovbcd4fc12015-05-20 14:30:08 -04002946 return Signature.from_callable(obj, follow_wrapped=follow_wrapped)
Yury Selivanovda396452014-03-27 12:09:24 -04002947
2948
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002949def _main():
2950 """ Logic for inspecting an object given at command line """
2951 import argparse
2952 import importlib
2953
2954 parser = argparse.ArgumentParser()
2955 parser.add_argument(
2956 'object',
2957 help="The object to be analysed. "
2958 "It supports the 'module:qualname' syntax")
2959 parser.add_argument(
2960 '-d', '--details', action='store_true',
2961 help='Display info about the module rather than its source code')
2962
2963 args = parser.parse_args()
2964
2965 target = args.object
2966 mod_name, has_attrs, attrs = target.partition(":")
2967 try:
2968 obj = module = importlib.import_module(mod_name)
2969 except Exception as exc:
2970 msg = "Failed to import {} ({}: {})".format(mod_name,
2971 type(exc).__name__,
2972 exc)
2973 print(msg, file=sys.stderr)
2974 exit(2)
2975
2976 if has_attrs:
2977 parts = attrs.split(".")
2978 obj = module
2979 for part in parts:
2980 obj = getattr(obj, part)
2981
2982 if module.__name__ in sys.builtin_module_names:
2983 print("Can't get info for builtin modules.", file=sys.stderr)
2984 exit(1)
2985
2986 if args.details:
2987 print('Target: {}'.format(target))
2988 print('Origin: {}'.format(getsourcefile(module)))
2989 print('Cached: {}'.format(module.__cached__))
2990 if obj is module:
2991 print('Loader: {}'.format(repr(module.__loader__)))
2992 if hasattr(module, '__path__'):
2993 print('Submodule search path: {}'.format(module.__path__))
2994 else:
2995 try:
2996 __, lineno = findsource(obj)
2997 except Exception:
2998 pass
2999 else:
3000 print('Line: {}'.format(lineno))
3001
3002 print('\n')
3003 else:
3004 print(getsource(obj))
3005
3006
3007if __name__ == "__main__":
3008 _main()