blob: c7a2cf8833f00bf4f5642d6e6224aa71502333e5 [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
Guido van Rossum2e65f892007-02-28 22:03:49 +000020 getfullargspec() - same, with support for Python-3000 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
Brett Cannoncb66eb02012-05-11 12:58:42 -040035import importlib.machinery
36import itertools
Christian Heimes7131fd92008-02-19 14:21:46 +000037import linecache
Brett Cannoncb66eb02012-05-11 12:58:42 -040038import os
39import re
40import sys
41import tokenize
Larry Hastings2623c8c2014-02-08 22:15:29 -080042import token
Brett Cannoncb66eb02012-05-11 12:58:42 -040043import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040044import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070045import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100046import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000047from operator import attrgetter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070048from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000049
50# Create constants for the compiler flags in Include/code.h
51# We try to get them from dis to avoid duplication, but fall
Ezio Melotti30b9d5d2013-08-17 15:50:46 +030052# back to hardcoding so the dependency is optional
Nick Coghlan09c81232010-08-17 10:18:16 +000053try:
54 from dis import COMPILER_FLAG_NAMES as _flag_names
Brett Cannoncd171c82013-07-04 17:43:24 -040055except ImportError:
Nick Coghlan09c81232010-08-17 10:18:16 +000056 CO_OPTIMIZED, CO_NEWLOCALS = 0x1, 0x2
57 CO_VARARGS, CO_VARKEYWORDS = 0x4, 0x8
58 CO_NESTED, CO_GENERATOR, CO_NOFREE = 0x10, 0x20, 0x40
59else:
60 mod_dict = globals()
61 for k, v in _flag_names.items():
62 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000063
Christian Heimesbe5b30b2008-03-03 19:18:51 +000064# See Include/object.h
65TPFLAGS_IS_ABSTRACT = 1 << 20
66
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000067# ----------------------------------------------------------- type-checking
68def ismodule(object):
69 """Return true if the object is a module.
70
71 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000072 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000073 __doc__ documentation string
74 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000075 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000076
77def isclass(object):
78 """Return true if the object is a class.
79
80 Class objects provide these attributes:
81 __doc__ documentation string
82 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000083 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000084
85def ismethod(object):
86 """Return true if the object is an instance method.
87
88 Instance method objects provide these attributes:
89 __doc__ documentation string
90 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000091 __func__ function object containing implementation of method
92 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000093 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000094
Tim Peters536d2262001-09-20 05:13:38 +000095def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000096 """Return true if the object is a method descriptor.
97
98 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +000099
100 This is new in Python 2.2, and, for example, is true of int.__add__.
101 An object passing this test has a __get__ attribute but not a __set__
102 attribute, but beyond that the set of attributes varies. __name__ is
103 usually sensible, and __doc__ often is.
104
Tim Petersf1d90b92001-09-20 05:47:55 +0000105 Methods implemented via descriptors that also pass one of the other
106 tests return false from the ismethoddescriptor() test, simply because
107 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000108 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100109 if isclass(object) or ismethod(object) or isfunction(object):
110 # mutual exclusion
111 return False
112 tp = type(object)
113 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000114
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000115def isdatadescriptor(object):
116 """Return true if the object is a data descriptor.
117
118 Data descriptors have both a __get__ and a __set__ attribute. Examples are
119 properties (defined in Python) and getsets and members (defined in C).
120 Typically, data descriptors will also have __name__ and __doc__ attributes
121 (properties, getsets, and members have both of these attributes), but this
122 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100123 if isclass(object) or ismethod(object) or isfunction(object):
124 # mutual exclusion
125 return False
126 tp = type(object)
127 return hasattr(tp, "__set__") and hasattr(tp, "__get__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000128
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000129if hasattr(types, 'MemberDescriptorType'):
130 # CPython and equivalent
131 def ismemberdescriptor(object):
132 """Return true if the object is a member descriptor.
133
134 Member descriptors are specialized descriptors defined in extension
135 modules."""
136 return isinstance(object, types.MemberDescriptorType)
137else:
138 # Other implementations
139 def ismemberdescriptor(object):
140 """Return true if the object is a member descriptor.
141
142 Member descriptors are specialized descriptors defined in extension
143 modules."""
144 return False
145
146if hasattr(types, 'GetSetDescriptorType'):
147 # CPython and equivalent
148 def isgetsetdescriptor(object):
149 """Return true if the object is a getset descriptor.
150
151 getset descriptors are specialized descriptors defined in extension
152 modules."""
153 return isinstance(object, types.GetSetDescriptorType)
154else:
155 # Other implementations
156 def isgetsetdescriptor(object):
157 """Return true if the object is a getset descriptor.
158
159 getset descriptors are specialized descriptors defined in extension
160 modules."""
161 return False
162
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000163def isfunction(object):
164 """Return true if the object is a user-defined function.
165
166 Function objects provide these attributes:
167 __doc__ documentation string
168 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000169 __code__ code object containing compiled function bytecode
170 __defaults__ tuple of any default values for arguments
171 __globals__ global namespace in which this function was defined
172 __annotations__ dict of parameter annotations
173 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000174 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000175
Christian Heimes7131fd92008-02-19 14:21:46 +0000176def isgeneratorfunction(object):
177 """Return true if the object is a user-defined generator function.
178
179 Generator function objects provides same attributes as functions.
180
Alexander Belopolsky977a6842010-08-16 20:17:07 +0000181 See help(isfunction) for attributes listing."""
Georg Brandlb1441c72009-01-03 22:33:39 +0000182 return bool((isfunction(object) or ismethod(object)) and
183 object.__code__.co_flags & CO_GENERATOR)
Christian Heimes7131fd92008-02-19 14:21:46 +0000184
185def isgenerator(object):
186 """Return true if the object is a generator.
187
188 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300189 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000190 close raises a new GeneratorExit exception inside the
191 generator to terminate the iteration
192 gi_code code object
193 gi_frame frame object or possibly None once the generator has
194 been exhausted
195 gi_running set to 1 when generator is executing, 0 otherwise
196 next return the next item from the container
197 send resumes the generator and "sends" a value that becomes
198 the result of the current yield-expression
199 throw used to raise an exception inside the generator"""
200 return isinstance(object, types.GeneratorType)
201
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000202def istraceback(object):
203 """Return true if the object is a traceback.
204
205 Traceback objects provide these attributes:
206 tb_frame frame object at this level
207 tb_lasti index of last attempted instruction in bytecode
208 tb_lineno current line number in Python source code
209 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000210 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000211
212def isframe(object):
213 """Return true if the object is a frame object.
214
215 Frame objects provide these attributes:
216 f_back next outer frame object (this frame's caller)
217 f_builtins built-in namespace seen by this frame
218 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000219 f_globals global namespace seen by this frame
220 f_lasti index of last attempted instruction in bytecode
221 f_lineno current line number in Python source code
222 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000223 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000224 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000225
226def iscode(object):
227 """Return true if the object is a code object.
228
229 Code objects provide these attributes:
230 co_argcount number of arguments (not including * or ** args)
231 co_code string of raw compiled bytecode
232 co_consts tuple of constants used in the bytecode
233 co_filename name of file in which this code object was created
234 co_firstlineno number of first line in Python source code
235 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
236 co_lnotab encoded mapping of line numbers to bytecode indices
237 co_name name with which this code object was defined
238 co_names tuple of names of local variables
239 co_nlocals number of local variables
240 co_stacksize virtual machine stack space required
241 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000242 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000243
244def isbuiltin(object):
245 """Return true if the object is a built-in function or method.
246
247 Built-in functions and methods provide these attributes:
248 __doc__ documentation string
249 __name__ original name of this function or method
250 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000251 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000252
253def isroutine(object):
254 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000255 return (isbuiltin(object)
256 or isfunction(object)
257 or ismethod(object)
258 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000259
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000260def isabstract(object):
261 """Return true if the object is an abstract base class (ABC)."""
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000262 return bool(isinstance(object, type) and object.__flags__ & TPFLAGS_IS_ABSTRACT)
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000263
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000264def getmembers(object, predicate=None):
265 """Return all members of an object as (name, value) pairs sorted by name.
266 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100267 if isclass(object):
268 mro = (object,) + getmro(object)
269 else:
270 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000271 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700272 processed = set()
273 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700274 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700275 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700276 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700277 try:
278 for base in object.__bases__:
279 for k, v in base.__dict__.items():
280 if isinstance(v, types.DynamicClassAttribute):
281 names.append(k)
282 except AttributeError:
283 pass
284 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700285 # First try to get the value via getattr. Some descriptors don't
286 # like calling their __get__ (see bug #1785), so fall back to
287 # looking in the __dict__.
288 try:
289 value = getattr(object, key)
290 # handle the duplicate key
291 if key in processed:
292 raise AttributeError
293 except AttributeError:
294 for base in mro:
295 if key in base.__dict__:
296 value = base.__dict__[key]
297 break
298 else:
299 # could be a (currently) missing slot member, or a buggy
300 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100301 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000302 if not predicate or predicate(value):
303 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700304 processed.add(key)
305 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000306 return results
307
Christian Heimes25bb7832008-01-11 16:17:00 +0000308Attribute = namedtuple('Attribute', 'name kind defining_class object')
309
Tim Peters13b49d32001-09-23 02:00:29 +0000310def classify_class_attrs(cls):
311 """Return list of attribute-descriptor tuples.
312
313 For each name in dir(cls), the return list contains a 4-tuple
314 with these elements:
315
316 0. The name (a string).
317
318 1. The kind of attribute this is, one of these strings:
319 'class method' created via classmethod()
320 'static method' created via staticmethod()
321 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700322 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000323 'data' not a method
324
325 2. The class which defined this attribute (a class).
326
Ethan Furmane03ea372013-09-25 07:14:41 -0700327 3. The object as obtained by calling getattr; if this fails, or if the
328 resulting object does not live anywhere in the class' mro (including
329 metaclasses) then the object is looked up in the defining class's
330 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700331
332 If one of the items in dir(cls) is stored in the metaclass it will now
333 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700334 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000335 """
336
337 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700338 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Ethan Furmane03ea372013-09-25 07:14:41 -0700339 metamro = tuple([cls for cls in metamro if cls not in (type, object)])
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700340 class_bases = (cls,) + mro
341 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000342 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700343 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700344 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700345 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700346 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700347 for k, v in base.__dict__.items():
348 if isinstance(v, types.DynamicClassAttribute):
349 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000350 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700351 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700352
Tim Peters13b49d32001-09-23 02:00:29 +0000353 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100354 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700355 # Normal objects will be looked up with both getattr and directly in
356 # its class' dict (in case getattr fails [bug #1785], and also to look
357 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700358 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700359 # class's dict.
360 #
Tim Peters13b49d32001-09-23 02:00:29 +0000361 # Getting an obj from the __dict__ sometimes reveals more than
362 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100363 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700364 get_obj = None
365 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700366 if name not in processed:
367 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700368 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700369 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700370 get_obj = getattr(cls, name)
371 except Exception as exc:
372 pass
373 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700374 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700375 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700376 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700377 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700378 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700379 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700380 # first look in the classes
381 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700382 srch_obj = getattr(srch_cls, name, None)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700383 if srch_obj == get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700384 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700385 # then check the metaclasses
386 for srch_cls in metamro:
387 try:
388 srch_obj = srch_cls.__getattr__(cls, name)
389 except AttributeError:
390 continue
391 if srch_obj == get_obj:
392 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700393 if last_cls is not None:
394 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700395 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700396 if name in base.__dict__:
397 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700398 if homecls not in metamro:
399 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700400 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700401 if homecls is None:
402 # unable to locate the attribute anywhere, most likely due to
403 # buggy custom __dir__; discard and move on
404 continue
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700405 obj = get_obj or dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700406 # Classify the object or its descriptor.
Ethan Furman63c141c2013-10-18 00:27:39 -0700407 if isinstance(dict_obj, staticmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000408 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700409 obj = dict_obj
Ethan Furman63c141c2013-10-18 00:27:39 -0700410 elif isinstance(dict_obj, classmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000411 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700412 obj = dict_obj
413 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000414 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700415 obj = dict_obj
Yury Selivanov0860a0b2014-01-31 14:28:44 -0500416 elif isroutine(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000417 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100418 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700419 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000420 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700421 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000422 return result
423
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000424# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000425
426def getmro(cls):
427 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000428 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000429
Nick Coghlane8c45d62013-07-28 20:00:01 +1000430# -------------------------------------------------------- function helpers
431
432def unwrap(func, *, stop=None):
433 """Get the object wrapped by *func*.
434
435 Follows the chain of :attr:`__wrapped__` attributes returning the last
436 object in the chain.
437
438 *stop* is an optional callback accepting an object in the wrapper chain
439 as its sole argument that allows the unwrapping to be terminated early if
440 the callback returns a true value. If the callback never returns a true
441 value, the last object in the chain is returned as usual. For example,
442 :func:`signature` uses this to stop unwrapping if any object in the
443 chain has a ``__signature__`` attribute defined.
444
445 :exc:`ValueError` is raised if a cycle is encountered.
446
447 """
448 if stop is None:
449 def _is_wrapper(f):
450 return hasattr(f, '__wrapped__')
451 else:
452 def _is_wrapper(f):
453 return hasattr(f, '__wrapped__') and not stop(f)
454 f = func # remember the original func for error reporting
455 memo = {id(f)} # Memoise by id to tolerate non-hashable objects
456 while _is_wrapper(func):
457 func = func.__wrapped__
458 id_func = id(func)
459 if id_func in memo:
460 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
461 memo.add(id_func)
462 return func
463
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000464# -------------------------------------------------- source code extraction
465def indentsize(line):
466 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000467 expline = line.expandtabs()
468 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000469
470def getdoc(object):
471 """Get the documentation string for an object.
472
473 All tabs are expanded to spaces. To clean up docstrings that are
474 indented to line up with blocks of code, any whitespace than can be
475 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000476 try:
477 doc = object.__doc__
478 except AttributeError:
479 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000480 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000481 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000482 return cleandoc(doc)
483
484def cleandoc(doc):
485 """Clean up indentation from docstrings.
486
487 Any whitespace that can be uniformly removed from the second line
488 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000489 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000490 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000491 except UnicodeError:
492 return None
493 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000494 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000495 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000496 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000497 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000498 if content:
499 indent = len(line) - content
500 margin = min(margin, indent)
501 # Remove indentation.
502 if lines:
503 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000504 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000505 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000506 # Remove any trailing or leading blank lines.
507 while lines and not lines[-1]:
508 lines.pop()
509 while lines and not lines[0]:
510 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000511 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000512
513def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000514 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000515 if ismodule(object):
516 if hasattr(object, '__file__'):
517 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000518 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000519 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500520 if hasattr(object, '__module__'):
521 object = sys.modules.get(object.__module__)
522 if hasattr(object, '__file__'):
523 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000524 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000525 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000526 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000527 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000528 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000529 if istraceback(object):
530 object = object.tb_frame
531 if isframe(object):
532 object = object.f_code
533 if iscode(object):
534 return object.co_filename
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000535 raise TypeError('{!r} is not a module, class, method, '
536 'function, traceback, frame, or code object'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000537
Christian Heimes25bb7832008-01-11 16:17:00 +0000538ModuleInfo = namedtuple('ModuleInfo', 'name suffix mode module_type')
539
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000540def getmoduleinfo(path):
541 """Get the module name, suffix, mode, and module type for a given file."""
Brett Cannoncb66eb02012-05-11 12:58:42 -0400542 warnings.warn('inspect.getmoduleinfo() is deprecated', DeprecationWarning,
543 2)
Brett Cannone4f41de2013-06-16 13:13:40 -0400544 with warnings.catch_warnings():
545 warnings.simplefilter('ignore', PendingDeprecationWarning)
546 import imp
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000547 filename = os.path.basename(path)
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000548 suffixes = [(-len(suffix), suffix, mode, mtype)
549 for suffix, mode, mtype in imp.get_suffixes()]
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000550 suffixes.sort() # try longest suffixes first, in case they overlap
551 for neglen, suffix, mode, mtype in suffixes:
552 if filename[neglen:] == suffix:
Christian Heimes25bb7832008-01-11 16:17:00 +0000553 return ModuleInfo(filename[:neglen], suffix, mode, mtype)
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000554
555def getmodulename(path):
556 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000557 fname = os.path.basename(path)
558 # Check for paths that look like an actual module file
559 suffixes = [(-len(suffix), suffix)
560 for suffix in importlib.machinery.all_suffixes()]
561 suffixes.sort() # try longest suffixes first, in case they overlap
562 for neglen, suffix in suffixes:
563 if fname.endswith(suffix):
564 return fname[:neglen]
565 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000566
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000567def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000568 """Return the filename that can be used to locate an object's source.
569 Return None if no way can be identified to get the source.
570 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000571 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400572 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
573 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
574 if any(filename.endswith(s) for s in all_bytecode_suffixes):
575 filename = (os.path.splitext(filename)[0] +
576 importlib.machinery.SOURCE_SUFFIXES[0])
577 elif any(filename.endswith(s) for s in
578 importlib.machinery.EXTENSION_SUFFIXES):
579 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000580 if os.path.exists(filename):
581 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000582 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400583 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000584 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000585 # or it is in the linecache
586 if filename in linecache.cache:
587 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000588
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000589def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000590 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000591
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000592 The idea is for each object to have a unique origin, so this routine
593 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000594 if _filename is None:
595 _filename = getsourcefile(object) or getfile(object)
596 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000597
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000598modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000599_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000600
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000601def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000602 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000603 if ismodule(object):
604 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000605 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000606 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000607 # Try the filename to modulename cache
608 if _filename is not None and _filename in modulesbyfile:
609 return sys.modules.get(modulesbyfile[_filename])
610 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000611 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000612 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000613 except TypeError:
614 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000615 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000616 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000617 # Update the filename to module name cache and check yet again
618 # Copy sys.modules in order to cope with changes while iterating
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100619 for modname, module in list(sys.modules.items()):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000620 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000621 f = module.__file__
622 if f == _filesbymodname.get(modname, None):
623 # Have already mapped this module, so skip it
624 continue
625 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000626 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000627 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000628 modulesbyfile[f] = modulesbyfile[
629 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000630 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000631 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000632 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000633 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000634 if not hasattr(object, '__name__'):
635 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000636 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000637 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000638 if mainobject is object:
639 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000640 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000641 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000642 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000643 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000644 if builtinobject is object:
645 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000646
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000647def findsource(object):
648 """Return the entire source file and starting line number for an object.
649
650 The argument may be a module, class, method, function, traceback, frame,
651 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200652 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000653 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500654
655 file = getfile(object)
656 sourcefile = getsourcefile(object)
Ezio Melotti1b145922013-03-30 05:17:24 +0200657 if not sourcefile and file[:1] + file[-1:] != '<>':
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200658 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500659 file = sourcefile if sourcefile else file
660
Thomas Wouters89f507f2006-12-13 04:49:30 +0000661 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000662 if module:
663 lines = linecache.getlines(file, module.__dict__)
664 else:
665 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000666 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200667 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000668
669 if ismodule(object):
670 return lines, 0
671
672 if isclass(object):
673 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000674 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
675 # make some effort to find the best matching class definition:
676 # use the one with the least indentation, which is the one
677 # that's most probably not inside a function definition.
678 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000679 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000680 match = pat.match(lines[i])
681 if match:
682 # if it's at toplevel, it's already the best one
683 if lines[i][0] == 'c':
684 return lines, i
685 # else add whitespace to candidate list
686 candidates.append((match.group(1), i))
687 if candidates:
688 # this will sort by whitespace, and by line number,
689 # less whitespace first
690 candidates.sort()
691 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000692 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200693 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000694
695 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000696 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000697 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000698 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000699 if istraceback(object):
700 object = object.tb_frame
701 if isframe(object):
702 object = object.f_code
703 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000704 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200705 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000706 lnum = object.co_firstlineno - 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000707 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000708 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000709 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000710 lnum = lnum - 1
711 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200712 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000713
714def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000715 """Get lines of comments immediately preceding an object's source code.
716
717 Returns None when source can't be found.
718 """
719 try:
720 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200721 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000722 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000723
724 if ismodule(object):
725 # Look for a comment block at the top of the file.
726 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000727 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000728 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000729 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000730 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000731 comments = []
732 end = start
733 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000734 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000735 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000736 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000737
738 # Look for a preceding block of comments at the same indentation.
739 elif lnum > 0:
740 indent = indentsize(lines[lnum])
741 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000742 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000743 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000744 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000745 if end > 0:
746 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000747 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000748 while comment[:1] == '#' and indentsize(lines[end]) == indent:
749 comments[:0] = [comment]
750 end = end - 1
751 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000752 comment = lines[end].expandtabs().lstrip()
753 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000754 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000755 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000756 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000757 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000758
Tim Peters4efb6e92001-06-29 23:51:08 +0000759class EndOfBlock(Exception): pass
760
761class BlockFinder:
762 """Provide a tokeneater() method to detect the end of a code block."""
763 def __init__(self):
764 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000765 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000766 self.started = False
767 self.passline = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000768 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000769
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000770 def tokeneater(self, type, token, srowcol, erowcol, line):
Tim Peters4efb6e92001-06-29 23:51:08 +0000771 if not self.started:
Armin Rigodd5c0232005-09-25 11:45:45 +0000772 # look for the first "def", "class" or "lambda"
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000773 if token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000774 if token == "lambda":
775 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000776 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000777 self.passline = True # skip to the end of the line
Tim Peters4efb6e92001-06-29 23:51:08 +0000778 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000779 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000780 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000781 if self.islambda: # lambdas always end at the first NEWLINE
782 raise EndOfBlock
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000783 elif self.passline:
784 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000785 elif type == tokenize.INDENT:
786 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000787 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000788 elif type == tokenize.DEDENT:
789 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000790 # the end of matching indent/dedent pairs end a block
791 # (note that this only works for "def"/"class" blocks,
792 # not e.g. for "if: else:" or "try: finally:" blocks)
793 if self.indent <= 0:
794 raise EndOfBlock
795 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
796 # any other token on the same indentation level end the previous
797 # block as well, except the pseudo-tokens COMMENT and NL.
798 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000799
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000800def getblock(lines):
801 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000802 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000803 try:
Trent Nelson428de652008-03-18 22:41:35 +0000804 tokens = tokenize.generate_tokens(iter(lines).__next__)
805 for _token in tokens:
806 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000807 except (EndOfBlock, IndentationError):
808 pass
809 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000810
811def getsourcelines(object):
812 """Return a list of source lines and starting line number for an object.
813
814 The argument may be a module, class, method, function, traceback, frame,
815 or code object. The source code is returned as a list of the lines
816 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200817 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000818 raised if the source code cannot be retrieved."""
819 lines, lnum = findsource(object)
820
821 if ismodule(object): return lines, 0
822 else: return getblock(lines[lnum:]), lnum + 1
823
824def getsource(object):
825 """Return the text of the source code for an object.
826
827 The argument may be a module, class, method, function, traceback, frame,
828 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200829 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000830 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000831 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000832
833# --------------------------------------------------- class tree extraction
834def walktree(classes, children, parent):
835 """Recursive helper function for getclasstree()."""
836 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000837 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000838 for c in classes:
839 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000840 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000841 results.append(walktree(children[c], children, c))
842 return results
843
Georg Brandl5ce83a02009-06-01 17:23:51 +0000844def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000845 """Arrange the given list of classes into a hierarchy of nested lists.
846
847 Where a nested list appears, it contains classes derived from the class
848 whose entry immediately precedes the list. Each entry is a 2-tuple
849 containing a class and a tuple of its base classes. If the 'unique'
850 argument is true, exactly one entry appears in the returned structure
851 for each class in the given list. Otherwise, classes using multiple
852 inheritance and their descendants will appear multiple times."""
853 children = {}
854 roots = []
855 for c in classes:
856 if c.__bases__:
857 for parent in c.__bases__:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000858 if not parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000859 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +0300860 if c not in children[parent]:
861 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000862 if unique and parent in classes: break
863 elif c not in roots:
864 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +0000865 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000866 if parent not in classes:
867 roots.append(parent)
868 return walktree(roots, children, None)
869
870# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +0000871Arguments = namedtuple('Arguments', 'args, varargs, varkw')
872
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000873def getargs(co):
874 """Get information about the arguments accepted by a code object.
875
Guido van Rossum2e65f892007-02-28 22:03:49 +0000876 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000877 'args' is the list of argument names. Keyword-only arguments are
878 appended. 'varargs' and 'varkw' are the names of the * and **
879 arguments or None."""
Guido van Rossum2e65f892007-02-28 22:03:49 +0000880 args, varargs, kwonlyargs, varkw = _getfullargs(co)
Christian Heimes25bb7832008-01-11 16:17:00 +0000881 return Arguments(args + kwonlyargs, varargs, varkw)
Guido van Rossum2e65f892007-02-28 22:03:49 +0000882
883def _getfullargs(co):
884 """Get information about the arguments accepted by a code object.
885
886 Four things are returned: (args, varargs, kwonlyargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000887 'args' and 'kwonlyargs' are lists of argument names, and 'varargs'
888 and 'varkw' are the names of the * and ** arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +0000889
890 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000891 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000892
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000893 nargs = co.co_argcount
894 names = co.co_varnames
Guido van Rossum2e65f892007-02-28 22:03:49 +0000895 nkwargs = co.co_kwonlyargcount
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000896 args = list(names[:nargs])
Guido van Rossum2e65f892007-02-28 22:03:49 +0000897 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000898 step = 0
899
Guido van Rossum2e65f892007-02-28 22:03:49 +0000900 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000901 varargs = None
902 if co.co_flags & CO_VARARGS:
903 varargs = co.co_varnames[nargs]
904 nargs = nargs + 1
905 varkw = None
906 if co.co_flags & CO_VARKEYWORDS:
907 varkw = co.co_varnames[nargs]
Guido van Rossum2e65f892007-02-28 22:03:49 +0000908 return args, varargs, kwonlyargs, varkw
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000909
Christian Heimes25bb7832008-01-11 16:17:00 +0000910
911ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
912
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000913def getargspec(func):
914 """Get the names and default values of a function's arguments.
915
916 A tuple of four things is returned: (args, varargs, varkw, defaults).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000917 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000918 'args' will include keyword-only argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000919 'varargs' and 'varkw' are the names of the * and ** arguments or None.
Jeremy Hylton64967882003-06-27 18:14:39 +0000920 'defaults' is an n-tuple of the default values of the last n arguments.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000921
Guido van Rossum2e65f892007-02-28 22:03:49 +0000922 Use the getfullargspec() API for Python-3000 code, as annotations
923 and keyword arguments are supported. getargspec() will raise ValueError
924 if the func has either annotations or keyword arguments.
925 """
926
927 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
928 getfullargspec(func)
929 if kwonlyargs or ann:
Collin Winterce36ad82007-08-30 01:19:48 +0000930 raise ValueError("Function has keyword-only arguments or annotations"
931 ", use getfullargspec() API which can support them")
Christian Heimes25bb7832008-01-11 16:17:00 +0000932 return ArgSpec(args, varargs, varkw, defaults)
933
934FullArgSpec = namedtuple('FullArgSpec',
Benjamin Peterson3d4ca742008-11-12 21:39:01 +0000935 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +0000936
937def getfullargspec(func):
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500938 """Get the names and default values of a callable object's arguments.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000939
Brett Cannon504d8852007-09-07 02:12:14 +0000940 A tuple of seven things is returned:
941 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults annotations).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000942 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000943 'varargs' and 'varkw' are the names of the * and ** arguments or None.
944 'defaults' is an n-tuple of the default values of the last n arguments.
945 'kwonlyargs' is a list of keyword-only argument names.
946 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
947 'annotations' is a dictionary mapping argument names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000948
Guido van Rossum2e65f892007-02-28 22:03:49 +0000949 The first four items in the tuple correspond to getargspec().
Jeremy Hylton64967882003-06-27 18:14:39 +0000950 """
951
Yury Selivanovff385b82014-02-19 16:27:23 -0500952 try:
953 # Re: `skip_bound_arg=False`
954 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500955 # There is a notable difference in behaviour between getfullargspec
956 # and Signature: the former always returns 'self' parameter for bound
957 # methods, whereas the Signature always shows the actual calling
958 # signature of the passed object.
959 #
960 # To simulate this behaviour, we "unbind" bound methods, to trick
961 # inspect.signature to always return their first parameter ("self",
962 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500963
Yury Selivanovff385b82014-02-19 16:27:23 -0500964 # Re: `follow_wrapper_chains=False`
965 #
966 # getfullargspec() historically ignored __wrapped__ attributes,
967 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500968
Yury Selivanovff385b82014-02-19 16:27:23 -0500969 sig = _signature_internal(func,
970 follow_wrapper_chains=False,
971 skip_bound_arg=False)
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500972 except Exception as ex:
973 # Most of the times 'signature' will raise ValueError.
974 # But, it can also raise AttributeError, and, maybe something
975 # else. So to be fully backwards compatible, we catch all
976 # possible exceptions here, and reraise a TypeError.
977 raise TypeError('unsupported callable') from ex
978
979 args = []
980 varargs = None
981 varkw = None
982 kwonlyargs = []
983 defaults = ()
984 annotations = {}
985 defaults = ()
986 kwdefaults = {}
987
988 if sig.return_annotation is not sig.empty:
989 annotations['return'] = sig.return_annotation
990
991 for param in sig.parameters.values():
992 kind = param.kind
993 name = param.name
994
995 if kind is _POSITIONAL_ONLY:
996 args.append(name)
997 elif kind is _POSITIONAL_OR_KEYWORD:
998 args.append(name)
999 if param.default is not param.empty:
1000 defaults += (param.default,)
1001 elif kind is _VAR_POSITIONAL:
1002 varargs = name
1003 elif kind is _KEYWORD_ONLY:
1004 kwonlyargs.append(name)
1005 if param.default is not param.empty:
1006 kwdefaults[name] = param.default
1007 elif kind is _VAR_KEYWORD:
1008 varkw = name
1009
1010 if param.annotation is not param.empty:
1011 annotations[name] = param.annotation
1012
1013 if not kwdefaults:
1014 # compatibility with 'func.__kwdefaults__'
1015 kwdefaults = None
1016
1017 if not defaults:
1018 # compatibility with 'func.__defaults__'
1019 defaults = None
1020
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001021 return FullArgSpec(args, varargs, varkw, defaults,
1022 kwonlyargs, kwdefaults, annotations)
1023
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001024
Christian Heimes25bb7832008-01-11 16:17:00 +00001025ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1026
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001027def getargvalues(frame):
1028 """Get information about arguments passed into a particular frame.
1029
1030 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001031 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001032 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1033 'locals' is the locals dictionary of the given frame."""
1034 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001035 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001036
Guido van Rossum2e65f892007-02-28 22:03:49 +00001037def formatannotation(annotation, base_module=None):
1038 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001039 if annotation.__module__ in ('builtins', base_module):
Guido van Rossum2e65f892007-02-28 22:03:49 +00001040 return annotation.__name__
1041 return annotation.__module__+'.'+annotation.__name__
1042 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001043
Guido van Rossum2e65f892007-02-28 22:03:49 +00001044def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001045 module = getattr(object, '__module__', None)
1046 def _formatannotation(annotation):
1047 return formatannotation(annotation, module)
1048 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001049
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001050def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +00001051 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001052 formatarg=str,
1053 formatvarargs=lambda name: '*' + name,
1054 formatvarkw=lambda name: '**' + name,
1055 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001056 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001057 formatannotation=formatannotation):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001058 """Format an argument spec from the values returned by getargspec
Guido van Rossum2e65f892007-02-28 22:03:49 +00001059 or getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001060
Guido van Rossum2e65f892007-02-28 22:03:49 +00001061 The first seven arguments are (args, varargs, varkw, defaults,
1062 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1063 are the corresponding optional formatting functions that are called to
1064 turn names and values into strings. The last argument is an optional
1065 function to format the sequence of arguments."""
1066 def formatargandannotation(arg):
1067 result = formatarg(arg)
1068 if arg in annotations:
1069 result += ': ' + formatannotation(annotations[arg])
1070 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001071 specs = []
1072 if defaults:
1073 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001074 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001075 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001076 if defaults and i >= firstdefault:
1077 spec = spec + formatvalue(defaults[i - firstdefault])
1078 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001079 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001080 specs.append(formatvarargs(formatargandannotation(varargs)))
1081 else:
1082 if kwonlyargs:
1083 specs.append('*')
1084 if kwonlyargs:
1085 for kwonlyarg in kwonlyargs:
1086 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001087 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001088 spec += formatvalue(kwonlydefaults[kwonlyarg])
1089 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001090 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001091 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001092 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001093 if 'return' in annotations:
1094 result += formatreturns(formatannotation(annotations['return']))
1095 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001096
1097def formatargvalues(args, varargs, varkw, locals,
1098 formatarg=str,
1099 formatvarargs=lambda name: '*' + name,
1100 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001101 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001102 """Format an argument spec from the 4 values returned by getargvalues.
1103
1104 The first four arguments are (args, varargs, varkw, locals). The
1105 next four arguments are the corresponding optional formatting functions
1106 that are called to turn names and values into strings. The ninth
1107 argument is an optional function to format the sequence of arguments."""
1108 def convert(name, locals=locals,
1109 formatarg=formatarg, formatvalue=formatvalue):
1110 return formatarg(name) + formatvalue(locals[name])
1111 specs = []
1112 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001113 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001114 if varargs:
1115 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1116 if varkw:
1117 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001118 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001119
Benjamin Petersone109c702011-06-24 09:37:26 -05001120def _missing_arguments(f_name, argnames, pos, values):
1121 names = [repr(name) for name in argnames if name not in values]
1122 missing = len(names)
1123 if missing == 1:
1124 s = names[0]
1125 elif missing == 2:
1126 s = "{} and {}".format(*names)
1127 else:
1128 tail = ", {} and {}".format(names[-2:])
1129 del names[-2:]
1130 s = ", ".join(names) + tail
1131 raise TypeError("%s() missing %i required %s argument%s: %s" %
1132 (f_name, missing,
1133 "positional" if pos else "keyword-only",
1134 "" if missing == 1 else "s", s))
1135
1136def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001137 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001138 kwonly_given = len([arg for arg in kwonly if arg in values])
1139 if varargs:
1140 plural = atleast != 1
1141 sig = "at least %d" % (atleast,)
1142 elif defcount:
1143 plural = True
1144 sig = "from %d to %d" % (atleast, len(args))
1145 else:
1146 plural = len(args) != 1
1147 sig = str(len(args))
1148 kwonly_sig = ""
1149 if kwonly_given:
1150 msg = " positional argument%s (and %d keyword-only argument%s)"
1151 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1152 "s" if kwonly_given != 1 else ""))
1153 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1154 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1155 "was" if given == 1 and not kwonly_given else "were"))
1156
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001157def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001158 """Get the mapping of arguments to values.
1159
1160 A dict is returned, with keys the function argument names (including the
1161 names of the * and ** arguments, if any), and values the respective bound
1162 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001163 func = func_and_positional[0]
1164 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001165 spec = getfullargspec(func)
1166 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1167 f_name = func.__name__
1168 arg2value = {}
1169
Benjamin Petersonb204a422011-06-05 22:04:07 -05001170
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001171 if ismethod(func) and func.__self__ is not None:
1172 # implicit 'self' (or 'cls' for classmethods) argument
1173 positional = (func.__self__,) + positional
1174 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001175 num_args = len(args)
1176 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001177
Benjamin Petersonb204a422011-06-05 22:04:07 -05001178 n = min(num_pos, num_args)
1179 for i in range(n):
1180 arg2value[args[i]] = positional[i]
1181 if varargs:
1182 arg2value[varargs] = tuple(positional[n:])
1183 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001184 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001185 arg2value[varkw] = {}
1186 for kw, value in named.items():
1187 if kw not in possible_kwargs:
1188 if not varkw:
1189 raise TypeError("%s() got an unexpected keyword argument %r" %
1190 (f_name, kw))
1191 arg2value[varkw][kw] = value
1192 continue
1193 if kw in arg2value:
1194 raise TypeError("%s() got multiple values for argument %r" %
1195 (f_name, kw))
1196 arg2value[kw] = value
1197 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001198 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1199 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001200 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001201 req = args[:num_args - num_defaults]
1202 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001203 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001204 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001205 for i, arg in enumerate(args[num_args - num_defaults:]):
1206 if arg not in arg2value:
1207 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001208 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001209 for kwarg in kwonlyargs:
1210 if kwarg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001211 if kwarg in kwonlydefaults:
1212 arg2value[kwarg] = kwonlydefaults[kwarg]
1213 else:
1214 missing += 1
1215 if missing:
1216 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001217 return arg2value
1218
Nick Coghlan2f92e542012-06-23 19:39:55 +10001219ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1220
1221def getclosurevars(func):
1222 """
1223 Get the mapping of free variables to their current values.
1224
Meador Inge8fda3592012-07-19 21:33:21 -05001225 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001226 and builtin references as seen by the body of the function. A final
1227 set of unbound names that could not be resolved is also provided.
1228 """
1229
1230 if ismethod(func):
1231 func = func.__func__
1232
1233 if not isfunction(func):
1234 raise TypeError("'{!r}' is not a Python function".format(func))
1235
1236 code = func.__code__
1237 # Nonlocal references are named in co_freevars and resolved
1238 # by looking them up in __closure__ by positional index
1239 if func.__closure__ is None:
1240 nonlocal_vars = {}
1241 else:
1242 nonlocal_vars = {
1243 var : cell.cell_contents
1244 for var, cell in zip(code.co_freevars, func.__closure__)
1245 }
1246
1247 # Global and builtin references are named in co_names and resolved
1248 # by looking them up in __globals__ or __builtins__
1249 global_ns = func.__globals__
1250 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1251 if ismodule(builtin_ns):
1252 builtin_ns = builtin_ns.__dict__
1253 global_vars = {}
1254 builtin_vars = {}
1255 unbound_names = set()
1256 for name in code.co_names:
1257 if name in ("None", "True", "False"):
1258 # Because these used to be builtins instead of keywords, they
1259 # may still show up as name references. We ignore them.
1260 continue
1261 try:
1262 global_vars[name] = global_ns[name]
1263 except KeyError:
1264 try:
1265 builtin_vars[name] = builtin_ns[name]
1266 except KeyError:
1267 unbound_names.add(name)
1268
1269 return ClosureVars(nonlocal_vars, global_vars,
1270 builtin_vars, unbound_names)
1271
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001272# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001273
1274Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1275
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001276def getframeinfo(frame, context=1):
1277 """Get information about a frame or traceback object.
1278
1279 A tuple of five things is returned: the filename, the line number of
1280 the current line, the function name, a list of lines of context from
1281 the source code, and the index of the current line within that list.
1282 The optional second argument specifies the number of lines of context
1283 to return, which are centered around the current line."""
1284 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001285 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001286 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001287 else:
1288 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001289 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001290 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001291
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001292 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001293 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001294 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001295 try:
1296 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001297 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001298 lines = index = None
1299 else:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001300 start = max(start, 1)
Raymond Hettingera0501712004-06-15 11:22:53 +00001301 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001302 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001303 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001304 else:
1305 lines = index = None
1306
Christian Heimes25bb7832008-01-11 16:17:00 +00001307 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001308
1309def getlineno(frame):
1310 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001311 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1312 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001313
1314def getouterframes(frame, context=1):
1315 """Get a list of records for a frame and all higher (calling) frames.
1316
1317 Each record contains a frame object, filename, line number, function
1318 name, a list of lines of context, and index within the context."""
1319 framelist = []
1320 while frame:
1321 framelist.append((frame,) + getframeinfo(frame, context))
1322 frame = frame.f_back
1323 return framelist
1324
1325def getinnerframes(tb, context=1):
1326 """Get a list of records for a traceback's frame and all lower frames.
1327
1328 Each record contains a frame object, filename, line number, function
1329 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001330 framelist = []
1331 while tb:
1332 framelist.append((tb.tb_frame,) + getframeinfo(tb, context))
1333 tb = tb.tb_next
1334 return framelist
1335
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001336def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001337 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001338 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001339
1340def stack(context=1):
1341 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001342 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001343
1344def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001345 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001346 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001347
1348
1349# ------------------------------------------------ static version of getattr
1350
1351_sentinel = object()
1352
Michael Foorde5162652010-11-20 16:40:44 +00001353def _static_getmro(klass):
1354 return type.__dict__['__mro__'].__get__(klass)
1355
Michael Foord95fc51d2010-11-20 15:07:30 +00001356def _check_instance(obj, attr):
1357 instance_dict = {}
1358 try:
1359 instance_dict = object.__getattribute__(obj, "__dict__")
1360 except AttributeError:
1361 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001362 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001363
1364
1365def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001366 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001367 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001368 try:
1369 return entry.__dict__[attr]
1370 except KeyError:
1371 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001372 return _sentinel
1373
Michael Foord35184ed2010-11-20 16:58:30 +00001374def _is_type(obj):
1375 try:
1376 _static_getmro(obj)
1377 except TypeError:
1378 return False
1379 return True
1380
Michael Foorddcebe0f2011-03-15 19:20:44 -04001381def _shadowed_dict(klass):
1382 dict_attr = type.__dict__["__dict__"]
1383 for entry in _static_getmro(klass):
1384 try:
1385 class_dict = dict_attr.__get__(entry)["__dict__"]
1386 except KeyError:
1387 pass
1388 else:
1389 if not (type(class_dict) is types.GetSetDescriptorType and
1390 class_dict.__name__ == "__dict__" and
1391 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001392 return class_dict
1393 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001394
1395def getattr_static(obj, attr, default=_sentinel):
1396 """Retrieve attributes without triggering dynamic lookup via the
1397 descriptor protocol, __getattr__ or __getattribute__.
1398
1399 Note: this function may not be able to retrieve all attributes
1400 that getattr can fetch (like dynamically created attributes)
1401 and may find attributes that getattr can't (like descriptors
1402 that raise AttributeError). It can also return descriptor objects
1403 instead of instance members in some cases. See the
1404 documentation for details.
1405 """
1406 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001407 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001408 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001409 dict_attr = _shadowed_dict(klass)
1410 if (dict_attr is _sentinel or
1411 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001412 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001413 else:
1414 klass = obj
1415
1416 klass_result = _check_class(klass, attr)
1417
1418 if instance_result is not _sentinel and klass_result is not _sentinel:
1419 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1420 _check_class(type(klass_result), '__set__') is not _sentinel):
1421 return klass_result
1422
1423 if instance_result is not _sentinel:
1424 return instance_result
1425 if klass_result is not _sentinel:
1426 return klass_result
1427
1428 if obj is klass:
1429 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001430 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001431 if _shadowed_dict(type(entry)) is _sentinel:
1432 try:
1433 return entry.__dict__[attr]
1434 except KeyError:
1435 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001436 if default is not _sentinel:
1437 return default
1438 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001439
1440
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001441# ------------------------------------------------ generator introspection
1442
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001443GEN_CREATED = 'GEN_CREATED'
1444GEN_RUNNING = 'GEN_RUNNING'
1445GEN_SUSPENDED = 'GEN_SUSPENDED'
1446GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001447
1448def getgeneratorstate(generator):
1449 """Get current state of a generator-iterator.
1450
1451 Possible states are:
1452 GEN_CREATED: Waiting to start execution.
1453 GEN_RUNNING: Currently being executed by the interpreter.
1454 GEN_SUSPENDED: Currently suspended at a yield expression.
1455 GEN_CLOSED: Execution has completed.
1456 """
1457 if generator.gi_running:
1458 return GEN_RUNNING
1459 if generator.gi_frame is None:
1460 return GEN_CLOSED
1461 if generator.gi_frame.f_lasti == -1:
1462 return GEN_CREATED
1463 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001464
1465
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001466def getgeneratorlocals(generator):
1467 """
1468 Get the mapping of generator local variables to their current values.
1469
1470 A dict is returned, with the keys the local variable names and values the
1471 bound values."""
1472
1473 if not isgenerator(generator):
1474 raise TypeError("'{!r}' is not a Python generator".format(generator))
1475
1476 frame = getattr(generator, "gi_frame", None)
1477 if frame is not None:
1478 return generator.gi_frame.f_locals
1479 else:
1480 return {}
1481
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001482###############################################################################
1483### Function Signature Object (PEP 362)
1484###############################################################################
1485
1486
1487_WrapperDescriptor = type(type.__call__)
1488_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001489_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001490
1491_NonUserDefinedCallables = (_WrapperDescriptor,
1492 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001493 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001494 types.BuiltinFunctionType)
1495
1496
Yury Selivanov421f0c72014-01-29 12:05:40 -05001497def _signature_get_user_defined_method(cls, method_name):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001498 try:
1499 meth = getattr(cls, method_name)
1500 except AttributeError:
1501 return
1502 else:
1503 if not isinstance(meth, _NonUserDefinedCallables):
1504 # Once '__signature__' will be added to 'C'-level
1505 # callables, this check won't be necessary
1506 return meth
1507
1508
Yury Selivanov62560fb2014-01-28 12:26:24 -05001509def _signature_get_partial(wrapped_sig, partial, extra_args=()):
1510 # Internal helper to calculate how 'wrapped_sig' signature will
1511 # look like after applying a 'functools.partial' object (or alike)
1512 # on it.
1513
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001514 new_params = OrderedDict(wrapped_sig.parameters.items())
1515
1516 partial_args = partial.args or ()
1517 partial_keywords = partial.keywords or {}
1518
1519 if extra_args:
1520 partial_args = extra_args + partial_args
1521
1522 try:
1523 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1524 except TypeError as ex:
1525 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1526 raise ValueError(msg) from ex
1527
1528 for arg_name, arg_value in ba.arguments.items():
1529 param = new_params[arg_name]
1530 if arg_name in partial_keywords:
1531 # We set a new default value, because the following code
1532 # is correct:
1533 #
1534 # >>> def foo(a): print(a)
1535 # >>> print(partial(partial(foo, a=10), a=20)())
1536 # 20
1537 # >>> print(partial(partial(foo, a=10), a=20)(a=30))
1538 # 30
1539 #
1540 # So, with 'partial' objects, passing a keyword argument is
1541 # like setting a new default value for the corresponding
1542 # parameter
1543 #
1544 # We also mark this parameter with '_partial_kwarg'
1545 # flag. Later, in '_bind', the 'default' value of this
1546 # parameter will be added to 'kwargs', to simulate
1547 # the 'functools.partial' real call.
1548 new_params[arg_name] = param.replace(default=arg_value,
1549 _partial_kwarg=True)
1550
1551 elif (param.kind not in (_VAR_KEYWORD, _VAR_POSITIONAL) and
1552 not param._partial_kwarg):
1553 new_params.pop(arg_name)
1554
1555 return wrapped_sig.replace(parameters=new_params.values())
1556
1557
Yury Selivanov62560fb2014-01-28 12:26:24 -05001558def _signature_bound_method(sig):
1559 # Internal helper to transform signatures for unbound
1560 # functions to bound methods
1561
1562 params = tuple(sig.parameters.values())
1563
1564 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1565 raise ValueError('invalid method signature')
1566
1567 kind = params[0].kind
1568 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1569 # Drop first parameter:
1570 # '(p1, p2[, ...])' -> '(p2[, ...])'
1571 params = params[1:]
1572 else:
1573 if kind is not _VAR_POSITIONAL:
1574 # Unless we add a new parameter type we never
1575 # get here
1576 raise ValueError('invalid argument type')
1577 # It's a var-positional parameter.
1578 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1579
1580 return sig.replace(parameters=params)
1581
1582
Yury Selivanovb77511d2014-01-29 10:46:14 -05001583def _signature_is_builtin(obj):
1584 # Internal helper to test if `obj` is a callable that might
1585 # support Argument Clinic's __text_signature__ protocol.
Yury Selivanov1d241832014-02-02 12:51:20 -05001586 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001587 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001588 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001589 # Can't test 'isinstance(type)' here, as it would
1590 # also be True for regular python classes
1591 obj in (type, object))
1592
1593
Yury Selivanov63da7c72014-01-31 14:48:37 -05001594def _signature_is_functionlike(obj):
1595 # Internal helper to test if `obj` is a duck type of FunctionType.
1596 # A good example of such objects are functions compiled with
1597 # Cython, which have all attributes that a pure Python function
1598 # would have, but have their code statically compiled.
1599
1600 if not callable(obj) or isclass(obj):
1601 # All function-like objects are obviously callables,
1602 # and not classes.
1603 return False
1604
1605 name = getattr(obj, '__name__', None)
1606 code = getattr(obj, '__code__', None)
1607 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1608 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1609 annotations = getattr(obj, '__annotations__', None)
1610
1611 return (isinstance(code, types.CodeType) and
1612 isinstance(name, str) and
1613 (defaults is None or isinstance(defaults, tuple)) and
1614 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1615 isinstance(annotations, dict))
1616
1617
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001618def _signature_get_bound_param(spec):
1619 # Internal helper to get first parameter name from a
1620 # __text_signature__ of a builtin method, which should
1621 # be in the following format: '($param1, ...)'.
1622 # Assumptions are that the first argument won't have
1623 # a default value or an annotation.
1624
1625 assert spec.startswith('($')
1626
1627 pos = spec.find(',')
1628 if pos == -1:
1629 pos = spec.find(')')
1630
1631 cpos = spec.find(':')
1632 assert cpos == -1 or cpos > pos
1633
1634 cpos = spec.find('=')
1635 assert cpos == -1 or cpos > pos
1636
1637 return spec[2:pos]
1638
1639
Larry Hastings2623c8c2014-02-08 22:15:29 -08001640def _signature_strip_non_python_syntax(signature):
1641 """
1642 Takes a signature in Argument Clinic's extended signature format.
1643 Returns a tuple of three things:
1644 * that signature re-rendered in standard Python syntax,
1645 * the index of the "self" parameter (generally 0), or None if
1646 the function does not have a "self" parameter, and
1647 * the index of the last "positional only" parameter,
1648 or None if the signature has no positional-only parameters.
1649 """
1650
1651 if not signature:
1652 return signature, None, None
1653
1654 self_parameter = None
1655 last_positional_only = None
1656
1657 lines = [l.encode('ascii') for l in signature.split('\n')]
1658 generator = iter(lines).__next__
1659 token_stream = tokenize.tokenize(generator)
1660
1661 delayed_comma = False
1662 skip_next_comma = False
1663 text = []
1664 add = text.append
1665
1666 current_parameter = 0
1667 OP = token.OP
1668 ERRORTOKEN = token.ERRORTOKEN
1669
1670 # token stream always starts with ENCODING token, skip it
1671 t = next(token_stream)
1672 assert t.type == tokenize.ENCODING
1673
1674 for t in token_stream:
1675 type, string = t.type, t.string
1676
1677 if type == OP:
1678 if string == ',':
1679 if skip_next_comma:
1680 skip_next_comma = False
1681 else:
1682 assert not delayed_comma
1683 delayed_comma = True
1684 current_parameter += 1
1685 continue
1686
1687 if string == '/':
1688 assert not skip_next_comma
1689 assert last_positional_only is None
1690 skip_next_comma = True
1691 last_positional_only = current_parameter - 1
1692 continue
1693
1694 if (type == ERRORTOKEN) and (string == '$'):
1695 assert self_parameter is None
1696 self_parameter = current_parameter
1697 continue
1698
1699 if delayed_comma:
1700 delayed_comma = False
1701 if not ((type == OP) and (string == ')')):
1702 add(', ')
1703 add(string)
1704 if (string == ','):
1705 add(' ')
1706 clean_signature = ''.join(text)
1707 return clean_signature, self_parameter, last_positional_only
1708
1709
Yury Selivanovff385b82014-02-19 16:27:23 -05001710def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001711 # Internal helper to parse content of '__text_signature__'
1712 # and return a Signature based on it
1713 Parameter = cls._parameter_cls
1714
Larry Hastings2623c8c2014-02-08 22:15:29 -08001715 clean_signature, self_parameter, last_positional_only = \
1716 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001717
Larry Hastings2623c8c2014-02-08 22:15:29 -08001718 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001719
1720 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001721 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001722 except SyntaxError:
1723 module = None
1724
1725 if not isinstance(module, ast.Module):
1726 raise ValueError("{!r} builtin has invalid signature".format(obj))
1727
1728 f = module.body[0]
1729
1730 parameters = []
1731 empty = Parameter.empty
1732 invalid = object()
1733
1734 module = None
1735 module_dict = {}
1736 module_name = getattr(obj, '__module__', None)
1737 if module_name:
1738 module = sys.modules.get(module_name, None)
1739 if module:
1740 module_dict = module.__dict__
1741 sys_module_dict = sys.modules
1742
1743 def parse_name(node):
1744 assert isinstance(node, ast.arg)
1745 if node.annotation != None:
1746 raise ValueError("Annotations are not currently supported")
1747 return node.arg
1748
1749 def wrap_value(s):
1750 try:
1751 value = eval(s, module_dict)
1752 except NameError:
1753 try:
1754 value = eval(s, sys_module_dict)
1755 except NameError:
1756 raise RuntimeError()
1757
1758 if isinstance(value, str):
1759 return ast.Str(value)
1760 if isinstance(value, (int, float)):
1761 return ast.Num(value)
1762 if isinstance(value, bytes):
1763 return ast.Bytes(value)
1764 if value in (True, False, None):
1765 return ast.NameConstant(value)
1766 raise RuntimeError()
1767
1768 class RewriteSymbolics(ast.NodeTransformer):
1769 def visit_Attribute(self, node):
1770 a = []
1771 n = node
1772 while isinstance(n, ast.Attribute):
1773 a.append(n.attr)
1774 n = n.value
1775 if not isinstance(n, ast.Name):
1776 raise RuntimeError()
1777 a.append(n.id)
1778 value = ".".join(reversed(a))
1779 return wrap_value(value)
1780
1781 def visit_Name(self, node):
1782 if not isinstance(node.ctx, ast.Load):
1783 raise ValueError()
1784 return wrap_value(node.id)
1785
1786 def p(name_node, default_node, default=empty):
1787 name = parse_name(name_node)
1788 if name is invalid:
1789 return None
1790 if default_node and default_node is not _empty:
1791 try:
1792 default_node = RewriteSymbolics().visit(default_node)
1793 o = ast.literal_eval(default_node)
1794 except ValueError:
1795 o = invalid
1796 if o is invalid:
1797 return None
1798 default = o if o is not invalid else default
1799 parameters.append(Parameter(name, kind, default=default, annotation=empty))
1800
1801 # non-keyword-only parameters
1802 args = reversed(f.args.args)
1803 defaults = reversed(f.args.defaults)
1804 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001805 if last_positional_only is not None:
1806 kind = Parameter.POSITIONAL_ONLY
1807 else:
1808 kind = Parameter.POSITIONAL_OR_KEYWORD
1809 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001810 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001811 if i == last_positional_only:
1812 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001813
1814 # *args
1815 if f.args.vararg:
1816 kind = Parameter.VAR_POSITIONAL
1817 p(f.args.vararg, empty)
1818
1819 # keyword-only arguments
1820 kind = Parameter.KEYWORD_ONLY
1821 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
1822 p(name, default)
1823
1824 # **kwargs
1825 if f.args.kwarg:
1826 kind = Parameter.VAR_KEYWORD
1827 p(f.args.kwarg, empty)
1828
Larry Hastings2623c8c2014-02-08 22:15:29 -08001829 if self_parameter is not None:
Yury Selivanovd224b6a2014-02-21 01:32:42 -05001830 # Possibly strip the bound argument:
1831 # - We *always* strip first bound argument if
1832 # it is a module.
1833 # - We don't strip first bound argument if
1834 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001835 assert parameters
Yury Selivanovd224b6a2014-02-21 01:32:42 -05001836 _self = getattr(obj, '__self__', None)
1837 self_isbound = _self is not None
1838 self_ismodule = ismodule(_self)
1839 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001840 parameters.pop(0)
1841 else:
1842 # for builtins, self parameter is always positional-only!
1843 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
1844 parameters[0] = p
1845
1846 return cls(parameters, return_annotation=cls.empty)
1847
1848
Yury Selivanovff385b82014-02-19 16:27:23 -05001849def _signature_from_builtin(cls, func, skip_bound_arg=True):
1850 # Internal helper function to get signature for
1851 # builtin callables
1852 if not _signature_is_builtin(func):
1853 raise TypeError("{!r} is not a Python builtin "
1854 "function".format(func))
1855
1856 s = getattr(func, "__text_signature__", None)
1857 if not s:
1858 raise ValueError("no signature found for builtin {!r}".format(func))
1859
1860 return _signature_fromstr(cls, func, s, skip_bound_arg)
1861
1862
1863def _signature_internal(obj, follow_wrapper_chains=True, skip_bound_arg=True):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001864
1865 if not callable(obj):
1866 raise TypeError('{!r} is not a callable object'.format(obj))
1867
1868 if isinstance(obj, types.MethodType):
1869 # In this case we skip the first parameter of the underlying
1870 # function (usually `self` or `cls`).
Yury Selivanovff385b82014-02-19 16:27:23 -05001871 sig = _signature_internal(obj.__func__,
1872 follow_wrapper_chains,
1873 skip_bound_arg)
1874 if skip_bound_arg:
1875 return _signature_bound_method(sig)
1876 else:
1877 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001878
Nick Coghlane8c45d62013-07-28 20:00:01 +10001879 # Was this function wrapped by a decorator?
Yury Selivanovff385b82014-02-19 16:27:23 -05001880 if follow_wrapper_chains:
1881 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Nick Coghlane8c45d62013-07-28 20:00:01 +10001882
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001883 try:
1884 sig = obj.__signature__
1885 except AttributeError:
1886 pass
1887 else:
1888 if sig is not None:
1889 return sig
1890
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001891 try:
1892 partialmethod = obj._partialmethod
1893 except AttributeError:
1894 pass
1895 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05001896 if isinstance(partialmethod, functools.partialmethod):
1897 # Unbound partialmethod (see functools.partialmethod)
1898 # This means, that we need to calculate the signature
1899 # as if it's a regular partial object, but taking into
1900 # account that the first positional argument
1901 # (usually `self`, or `cls`) will not be passed
1902 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001903
Yury Selivanovff385b82014-02-19 16:27:23 -05001904 wrapped_sig = _signature_internal(partialmethod.func,
1905 follow_wrapper_chains,
1906 skip_bound_arg)
Yury Selivanov0486f812014-01-29 12:18:59 -05001907 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001908
Yury Selivanov0486f812014-01-29 12:18:59 -05001909 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
1910 new_params = (first_wrapped_param,) + tuple(sig.parameters.values())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001911
Yury Selivanov0486f812014-01-29 12:18:59 -05001912 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001913
Yury Selivanov63da7c72014-01-31 14:48:37 -05001914 if isfunction(obj) or _signature_is_functionlike(obj):
1915 # If it's a pure Python function, or an object that is duck type
1916 # of a Python function (Cython functions, for instance), then:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001917 return Signature.from_function(obj)
1918
Yury Selivanov8dfb4572014-02-21 18:30:53 -05001919 if _signature_is_builtin(obj):
1920 return _signature_from_builtin(Signature, obj,
1921 skip_bound_arg=skip_bound_arg)
1922
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001923 if isinstance(obj, functools.partial):
Yury Selivanovff385b82014-02-19 16:27:23 -05001924 wrapped_sig = _signature_internal(obj.func,
1925 follow_wrapper_chains,
1926 skip_bound_arg)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001927 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001928
1929 sig = None
1930 if isinstance(obj, type):
1931 # obj is a class or a metaclass
1932
1933 # First, let's see if it has an overloaded __call__ defined
1934 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05001935 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001936 if call is not None:
Yury Selivanovff385b82014-02-19 16:27:23 -05001937 sig = _signature_internal(call,
1938 follow_wrapper_chains,
1939 skip_bound_arg)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001940 else:
1941 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05001942 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001943 if new is not None:
Yury Selivanovff385b82014-02-19 16:27:23 -05001944 sig = _signature_internal(new,
1945 follow_wrapper_chains,
1946 skip_bound_arg)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001947 else:
1948 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05001949 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001950 if init is not None:
Yury Selivanovff385b82014-02-19 16:27:23 -05001951 sig = _signature_internal(init,
1952 follow_wrapper_chains,
1953 skip_bound_arg)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001954
1955 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001956 # At this point we know, that `obj` is a class, with no user-
1957 # defined '__init__', '__new__', or class-level '__call__'
1958
Larry Hastings2623c8c2014-02-08 22:15:29 -08001959 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001960 # Since '__text_signature__' is implemented as a
1961 # descriptor that extracts text signature from the
1962 # class docstring, if 'obj' is derived from a builtin
1963 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08001964 # Therefore, we go through the MRO (except the last
1965 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001966 # class with non-empty text signature.
1967 try:
1968 text_sig = base.__text_signature__
1969 except AttributeError:
1970 pass
1971 else:
1972 if text_sig:
1973 # If 'obj' class has a __text_signature__ attribute:
1974 # return a signature based on it
1975 return _signature_fromstr(Signature, obj, text_sig)
1976
1977 # No '__text_signature__' was found for the 'obj' class.
1978 # Last option is to check if its '__init__' is
1979 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08001980 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001981 # We have a class (not metaclass), but no user-defined
1982 # __init__ or __new__ for it
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001983 if obj.__init__ is object.__init__:
1984 # Return a signature of 'object' builtin.
1985 return signature(object)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001986
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001987 elif not isinstance(obj, _NonUserDefinedCallables):
1988 # An object with __call__
1989 # We also check that the 'obj' is not an instance of
1990 # _WrapperDescriptor or _MethodWrapper to avoid
1991 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05001992 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001993 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001994 try:
Yury Selivanovff385b82014-02-19 16:27:23 -05001995 sig = _signature_internal(call,
1996 follow_wrapper_chains,
1997 skip_bound_arg)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001998 except ValueError as ex:
1999 msg = 'no signature found for {!r}'.format(obj)
2000 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002001
2002 if sig is not None:
2003 # For classes and objects we skip the first parameter of their
2004 # __call__, __new__, or __init__ methods
Yury Selivanovff385b82014-02-19 16:27:23 -05002005 if skip_bound_arg:
2006 return _signature_bound_method(sig)
2007 else:
2008 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002009
2010 if isinstance(obj, types.BuiltinFunctionType):
2011 # Raise a nicer error message for builtins
2012 msg = 'no signature found for builtin function {!r}'.format(obj)
2013 raise ValueError(msg)
2014
2015 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2016
Yury Selivanovff385b82014-02-19 16:27:23 -05002017def signature(obj):
2018 '''Get a signature object for the passed callable.'''
2019 return _signature_internal(obj)
2020
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002021
2022class _void:
2023 '''A private marker - used in Parameter & Signature'''
2024
2025
2026class _empty:
2027 pass
2028
2029
2030class _ParameterKind(int):
2031 def __new__(self, *args, name):
2032 obj = int.__new__(self, *args)
2033 obj._name = name
2034 return obj
2035
2036 def __str__(self):
2037 return self._name
2038
2039 def __repr__(self):
2040 return '<_ParameterKind: {!r}>'.format(self._name)
2041
2042
2043_POSITIONAL_ONLY = _ParameterKind(0, name='POSITIONAL_ONLY')
2044_POSITIONAL_OR_KEYWORD = _ParameterKind(1, name='POSITIONAL_OR_KEYWORD')
2045_VAR_POSITIONAL = _ParameterKind(2, name='VAR_POSITIONAL')
2046_KEYWORD_ONLY = _ParameterKind(3, name='KEYWORD_ONLY')
2047_VAR_KEYWORD = _ParameterKind(4, name='VAR_KEYWORD')
2048
2049
2050class Parameter:
2051 '''Represents a parameter in a function signature.
2052
2053 Has the following public attributes:
2054
2055 * name : str
2056 The name of the parameter as a string.
2057 * default : object
2058 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002059 parameter has no default value, this attribute is set to
2060 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002061 * annotation
2062 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002063 parameter has no annotation, this attribute is set to
2064 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002065 * kind : str
2066 Describes how argument values are bound to the parameter.
2067 Possible values: `Parameter.POSITIONAL_ONLY`,
2068 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2069 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
2070 '''
2071
2072 __slots__ = ('_name', '_kind', '_default', '_annotation', '_partial_kwarg')
2073
2074 POSITIONAL_ONLY = _POSITIONAL_ONLY
2075 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2076 VAR_POSITIONAL = _VAR_POSITIONAL
2077 KEYWORD_ONLY = _KEYWORD_ONLY
2078 VAR_KEYWORD = _VAR_KEYWORD
2079
2080 empty = _empty
2081
2082 def __init__(self, name, kind, *, default=_empty, annotation=_empty,
2083 _partial_kwarg=False):
2084
2085 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
2086 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
2087 raise ValueError("invalid value for 'Parameter.kind' attribute")
2088 self._kind = kind
2089
2090 if default is not _empty:
2091 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2092 msg = '{} parameters cannot have default values'.format(kind)
2093 raise ValueError(msg)
2094 self._default = default
2095 self._annotation = annotation
2096
Yury Selivanov2393dca2014-01-27 15:07:58 -05002097 if name is _empty:
2098 raise ValueError('name is a required attribute for Parameter')
2099
2100 if not isinstance(name, str):
2101 raise TypeError("name must be a str, not a {!r}".format(name))
2102
2103 if not name.isidentifier():
2104 raise ValueError('{!r} is not a valid parameter name'.format(name))
2105
2106 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002107
2108 self._partial_kwarg = _partial_kwarg
2109
2110 @property
2111 def name(self):
2112 return self._name
2113
2114 @property
2115 def default(self):
2116 return self._default
2117
2118 @property
2119 def annotation(self):
2120 return self._annotation
2121
2122 @property
2123 def kind(self):
2124 return self._kind
2125
2126 def replace(self, *, name=_void, kind=_void, annotation=_void,
2127 default=_void, _partial_kwarg=_void):
2128 '''Creates a customized copy of the Parameter.'''
2129
2130 if name is _void:
2131 name = self._name
2132
2133 if kind is _void:
2134 kind = self._kind
2135
2136 if annotation is _void:
2137 annotation = self._annotation
2138
2139 if default is _void:
2140 default = self._default
2141
2142 if _partial_kwarg is _void:
2143 _partial_kwarg = self._partial_kwarg
2144
2145 return type(self)(name, kind, default=default, annotation=annotation,
2146 _partial_kwarg=_partial_kwarg)
2147
2148 def __str__(self):
2149 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002150 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002151
2152 # Add annotation and default value
2153 if self._annotation is not _empty:
2154 formatted = '{}:{}'.format(formatted,
2155 formatannotation(self._annotation))
2156
2157 if self._default is not _empty:
2158 formatted = '{}={}'.format(formatted, repr(self._default))
2159
2160 if kind == _VAR_POSITIONAL:
2161 formatted = '*' + formatted
2162 elif kind == _VAR_KEYWORD:
2163 formatted = '**' + formatted
2164
2165 return formatted
2166
2167 def __repr__(self):
2168 return '<{} at {:#x} {!r}>'.format(self.__class__.__name__,
2169 id(self), self.name)
2170
2171 def __eq__(self, other):
Yury Selivanov0ba5f0d2014-01-31 15:30:30 -05002172 # NB: We deliberately do not compare '_partial_kwarg' attributes
2173 # here. Imagine we have a following situation:
2174 #
2175 # def foo(a, b=1): pass
2176 # def bar(a, b): pass
2177 # bar2 = functools.partial(bar, b=1)
2178 #
2179 # For the above scenario, signatures for `foo` and `bar2` should
2180 # be equal. '_partial_kwarg' attribute is an internal flag, to
2181 # distinguish between keyword parameters with defaults and
2182 # keyword parameters which got their defaults from functools.partial
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002183 return (issubclass(other.__class__, Parameter) and
2184 self._name == other._name and
2185 self._kind == other._kind and
2186 self._default == other._default and
2187 self._annotation == other._annotation)
2188
2189 def __ne__(self, other):
2190 return not self.__eq__(other)
2191
2192
2193class BoundArguments:
2194 '''Result of `Signature.bind` call. Holds the mapping of arguments
2195 to the function's parameters.
2196
2197 Has the following public attributes:
2198
2199 * arguments : OrderedDict
2200 An ordered mutable mapping of parameters' names to arguments' values.
2201 Does not contain arguments' default values.
2202 * signature : Signature
2203 The Signature object that created this instance.
2204 * args : tuple
2205 Tuple of positional arguments values.
2206 * kwargs : dict
2207 Dict of keyword arguments values.
2208 '''
2209
2210 def __init__(self, signature, arguments):
2211 self.arguments = arguments
2212 self._signature = signature
2213
2214 @property
2215 def signature(self):
2216 return self._signature
2217
2218 @property
2219 def args(self):
2220 args = []
2221 for param_name, param in self._signature.parameters.items():
2222 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
2223 param._partial_kwarg):
2224 # Keyword arguments mapped by 'functools.partial'
2225 # (Parameter._partial_kwarg is True) are mapped
2226 # in 'BoundArguments.kwargs', along with VAR_KEYWORD &
2227 # KEYWORD_ONLY
2228 break
2229
2230 try:
2231 arg = self.arguments[param_name]
2232 except KeyError:
2233 # We're done here. Other arguments
2234 # will be mapped in 'BoundArguments.kwargs'
2235 break
2236 else:
2237 if param.kind == _VAR_POSITIONAL:
2238 # *args
2239 args.extend(arg)
2240 else:
2241 # plain argument
2242 args.append(arg)
2243
2244 return tuple(args)
2245
2246 @property
2247 def kwargs(self):
2248 kwargs = {}
2249 kwargs_started = False
2250 for param_name, param in self._signature.parameters.items():
2251 if not kwargs_started:
2252 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
2253 param._partial_kwarg):
2254 kwargs_started = True
2255 else:
2256 if param_name not in self.arguments:
2257 kwargs_started = True
2258 continue
2259
2260 if not kwargs_started:
2261 continue
2262
2263 try:
2264 arg = self.arguments[param_name]
2265 except KeyError:
2266 pass
2267 else:
2268 if param.kind == _VAR_KEYWORD:
2269 # **kwargs
2270 kwargs.update(arg)
2271 else:
2272 # plain keyword argument
2273 kwargs[param_name] = arg
2274
2275 return kwargs
2276
2277 def __eq__(self, other):
2278 return (issubclass(other.__class__, BoundArguments) and
2279 self.signature == other.signature and
2280 self.arguments == other.arguments)
2281
2282 def __ne__(self, other):
2283 return not self.__eq__(other)
2284
2285
2286class Signature:
2287 '''A Signature object represents the overall signature of a function.
2288 It stores a Parameter object for each parameter accepted by the
2289 function, as well as information specific to the function itself.
2290
2291 A Signature object has the following public attributes and methods:
2292
2293 * parameters : OrderedDict
2294 An ordered mapping of parameters' names to the corresponding
2295 Parameter objects (keyword-only arguments are in the same order
2296 as listed in `code.co_varnames`).
2297 * return_annotation : object
2298 The annotation for the return type of the function if specified.
2299 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002300 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002301 * bind(*args, **kwargs) -> BoundArguments
2302 Creates a mapping from positional and keyword arguments to
2303 parameters.
2304 * bind_partial(*args, **kwargs) -> BoundArguments
2305 Creates a partial mapping from positional and keyword arguments
2306 to parameters (simulating 'functools.partial' behavior.)
2307 '''
2308
2309 __slots__ = ('_return_annotation', '_parameters')
2310
2311 _parameter_cls = Parameter
2312 _bound_arguments_cls = BoundArguments
2313
2314 empty = _empty
2315
2316 def __init__(self, parameters=None, *, return_annotation=_empty,
2317 __validate_parameters__=True):
2318 '''Constructs Signature from the given list of Parameter
2319 objects and 'return_annotation'. All arguments are optional.
2320 '''
2321
2322 if parameters is None:
2323 params = OrderedDict()
2324 else:
2325 if __validate_parameters__:
2326 params = OrderedDict()
2327 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002328 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002329
2330 for idx, param in enumerate(parameters):
2331 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002332 name = param.name
2333
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002334 if kind < top_kind:
2335 msg = 'wrong parameter order: {} before {}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05002336 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002337 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002338 elif kind > top_kind:
2339 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002340 top_kind = kind
2341
Yury Selivanov07a9e452014-01-29 10:58:16 -05002342 if (kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD) and
2343 not param._partial_kwarg):
2344 # If we have a positional-only or positional-or-keyword
2345 # parameter, that does not have its default value set
2346 # by 'functools.partial' or other "partial" signature:
2347 if param.default is _empty:
2348 if kind_defaults:
2349 # No default for this parameter, but the
2350 # previous parameter of the same kind had
2351 # a default
2352 msg = 'non-default argument follows default ' \
2353 'argument'
2354 raise ValueError(msg)
2355 else:
2356 # There is a default for this parameter.
2357 kind_defaults = True
2358
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002359 if name in params:
2360 msg = 'duplicate parameter name: {!r}'.format(name)
2361 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002362
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002363 params[name] = param
2364 else:
2365 params = OrderedDict(((param.name, param)
2366 for param in parameters))
2367
2368 self._parameters = types.MappingProxyType(params)
2369 self._return_annotation = return_annotation
2370
2371 @classmethod
2372 def from_function(cls, func):
2373 '''Constructs Signature for the given python function'''
2374
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002375 is_duck_function = False
2376 if not isfunction(func):
2377 if _signature_is_functionlike(func):
2378 is_duck_function = True
2379 else:
2380 # If it's not a pure Python function, and not a duck type
2381 # of pure function:
2382 raise TypeError('{!r} is not a Python function'.format(func))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002383
2384 Parameter = cls._parameter_cls
2385
2386 # Parameter information.
2387 func_code = func.__code__
2388 pos_count = func_code.co_argcount
2389 arg_names = func_code.co_varnames
2390 positional = tuple(arg_names[:pos_count])
2391 keyword_only_count = func_code.co_kwonlyargcount
2392 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
2393 annotations = func.__annotations__
2394 defaults = func.__defaults__
2395 kwdefaults = func.__kwdefaults__
2396
2397 if defaults:
2398 pos_default_count = len(defaults)
2399 else:
2400 pos_default_count = 0
2401
2402 parameters = []
2403
2404 # Non-keyword-only parameters w/o defaults.
2405 non_default_count = pos_count - pos_default_count
2406 for name in positional[:non_default_count]:
2407 annotation = annotations.get(name, _empty)
2408 parameters.append(Parameter(name, annotation=annotation,
2409 kind=_POSITIONAL_OR_KEYWORD))
2410
2411 # ... w/ defaults.
2412 for offset, name in enumerate(positional[non_default_count:]):
2413 annotation = annotations.get(name, _empty)
2414 parameters.append(Parameter(name, annotation=annotation,
2415 kind=_POSITIONAL_OR_KEYWORD,
2416 default=defaults[offset]))
2417
2418 # *args
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002419 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002420 name = arg_names[pos_count + keyword_only_count]
2421 annotation = annotations.get(name, _empty)
2422 parameters.append(Parameter(name, annotation=annotation,
2423 kind=_VAR_POSITIONAL))
2424
2425 # Keyword-only parameters.
2426 for name in keyword_only:
2427 default = _empty
2428 if kwdefaults is not None:
2429 default = kwdefaults.get(name, _empty)
2430
2431 annotation = annotations.get(name, _empty)
2432 parameters.append(Parameter(name, annotation=annotation,
2433 kind=_KEYWORD_ONLY,
2434 default=default))
2435 # **kwargs
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002436 if func_code.co_flags & CO_VARKEYWORDS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002437 index = pos_count + keyword_only_count
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002438 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002439 index += 1
2440
2441 name = arg_names[index]
2442 annotation = annotations.get(name, _empty)
2443 parameters.append(Parameter(name, annotation=annotation,
2444 kind=_VAR_KEYWORD))
2445
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002446 # Is 'func' is a pure Python function - don't validate the
2447 # parameters list (for correct order and defaults), it should be OK.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002448 return cls(parameters,
2449 return_annotation=annotations.get('return', _empty),
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002450 __validate_parameters__=is_duck_function)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002451
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002452 @classmethod
2453 def from_builtin(cls, func):
Yury Selivanovff385b82014-02-19 16:27:23 -05002454 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002455
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002456 @property
2457 def parameters(self):
2458 return self._parameters
2459
2460 @property
2461 def return_annotation(self):
2462 return self._return_annotation
2463
2464 def replace(self, *, parameters=_void, return_annotation=_void):
2465 '''Creates a customized copy of the Signature.
2466 Pass 'parameters' and/or 'return_annotation' arguments
2467 to override them in the new copy.
2468 '''
2469
2470 if parameters is _void:
2471 parameters = self.parameters.values()
2472
2473 if return_annotation is _void:
2474 return_annotation = self._return_annotation
2475
2476 return type(self)(parameters,
2477 return_annotation=return_annotation)
2478
2479 def __eq__(self, other):
2480 if (not issubclass(type(other), Signature) or
2481 self.return_annotation != other.return_annotation or
2482 len(self.parameters) != len(other.parameters)):
2483 return False
2484
2485 other_positions = {param: idx
2486 for idx, param in enumerate(other.parameters.keys())}
2487
2488 for idx, (param_name, param) in enumerate(self.parameters.items()):
2489 if param.kind == _KEYWORD_ONLY:
2490 try:
2491 other_param = other.parameters[param_name]
2492 except KeyError:
2493 return False
2494 else:
2495 if param != other_param:
2496 return False
2497 else:
2498 try:
2499 other_idx = other_positions[param_name]
2500 except KeyError:
2501 return False
2502 else:
2503 if (idx != other_idx or
2504 param != other.parameters[param_name]):
2505 return False
2506
2507 return True
2508
2509 def __ne__(self, other):
2510 return not self.__eq__(other)
2511
2512 def _bind(self, args, kwargs, *, partial=False):
2513 '''Private method. Don't use directly.'''
2514
2515 arguments = OrderedDict()
2516
2517 parameters = iter(self.parameters.values())
2518 parameters_ex = ()
2519 arg_vals = iter(args)
2520
2521 if partial:
2522 # Support for binding arguments to 'functools.partial' objects.
2523 # See 'functools.partial' case in 'signature()' implementation
2524 # for details.
2525 for param_name, param in self.parameters.items():
2526 if (param._partial_kwarg and param_name not in kwargs):
2527 # Simulating 'functools.partial' behavior
2528 kwargs[param_name] = param.default
2529
2530 while True:
2531 # Let's iterate through the positional arguments and corresponding
2532 # parameters
2533 try:
2534 arg_val = next(arg_vals)
2535 except StopIteration:
2536 # No more positional arguments
2537 try:
2538 param = next(parameters)
2539 except StopIteration:
2540 # No more parameters. That's it. Just need to check that
2541 # we have no `kwargs` after this while loop
2542 break
2543 else:
2544 if param.kind == _VAR_POSITIONAL:
2545 # That's OK, just empty *args. Let's start parsing
2546 # kwargs
2547 break
2548 elif param.name in kwargs:
2549 if param.kind == _POSITIONAL_ONLY:
2550 msg = '{arg!r} parameter is positional only, ' \
2551 'but was passed as a keyword'
2552 msg = msg.format(arg=param.name)
2553 raise TypeError(msg) from None
2554 parameters_ex = (param,)
2555 break
2556 elif (param.kind == _VAR_KEYWORD or
2557 param.default is not _empty):
2558 # That's fine too - we have a default value for this
2559 # parameter. So, lets start parsing `kwargs`, starting
2560 # with the current parameter
2561 parameters_ex = (param,)
2562 break
2563 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002564 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2565 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002566 if partial:
2567 parameters_ex = (param,)
2568 break
2569 else:
2570 msg = '{arg!r} parameter lacking default value'
2571 msg = msg.format(arg=param.name)
2572 raise TypeError(msg) from None
2573 else:
2574 # We have a positional argument to process
2575 try:
2576 param = next(parameters)
2577 except StopIteration:
2578 raise TypeError('too many positional arguments') from None
2579 else:
2580 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2581 # Looks like we have no parameter for this positional
2582 # argument
2583 raise TypeError('too many positional arguments')
2584
2585 if param.kind == _VAR_POSITIONAL:
2586 # We have an '*args'-like argument, let's fill it with
2587 # all positional arguments we have left and move on to
2588 # the next phase
2589 values = [arg_val]
2590 values.extend(arg_vals)
2591 arguments[param.name] = tuple(values)
2592 break
2593
2594 if param.name in kwargs:
2595 raise TypeError('multiple values for argument '
2596 '{arg!r}'.format(arg=param.name))
2597
2598 arguments[param.name] = arg_val
2599
2600 # Now, we iterate through the remaining parameters to process
2601 # keyword arguments
2602 kwargs_param = None
2603 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002604 if param.kind == _VAR_KEYWORD:
2605 # Memorize that we have a '**kwargs'-like parameter
2606 kwargs_param = param
2607 continue
2608
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002609 if param.kind == _VAR_POSITIONAL:
2610 # Named arguments don't refer to '*args'-like parameters.
2611 # We only arrive here if the positional arguments ended
2612 # before reaching the last parameter before *args.
2613 continue
2614
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002615 param_name = param.name
2616 try:
2617 arg_val = kwargs.pop(param_name)
2618 except KeyError:
2619 # We have no value for this parameter. It's fine though,
2620 # if it has a default value, or it is an '*args'-like
2621 # parameter, left alone by the processing of positional
2622 # arguments.
2623 if (not partial and param.kind != _VAR_POSITIONAL and
2624 param.default is _empty):
2625 raise TypeError('{arg!r} parameter lacking default value'. \
2626 format(arg=param_name)) from None
2627
2628 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002629 if param.kind == _POSITIONAL_ONLY:
2630 # This should never happen in case of a properly built
2631 # Signature object (but let's have this check here
2632 # to ensure correct behaviour just in case)
2633 raise TypeError('{arg!r} parameter is positional only, '
2634 'but was passed as a keyword'. \
2635 format(arg=param.name))
2636
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002637 arguments[param_name] = arg_val
2638
2639 if kwargs:
2640 if kwargs_param is not None:
2641 # Process our '**kwargs'-like parameter
2642 arguments[kwargs_param.name] = kwargs
2643 else:
2644 raise TypeError('too many keyword arguments')
2645
2646 return self._bound_arguments_cls(self, arguments)
2647
Yury Selivanovc45873e2014-01-29 12:10:27 -05002648 def bind(*args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002649 '''Get a BoundArguments object, that maps the passed `args`
2650 and `kwargs` to the function's signature. Raises `TypeError`
2651 if the passed arguments can not be bound.
2652 '''
Yury Selivanovc45873e2014-01-29 12:10:27 -05002653 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002654
Yury Selivanovc45873e2014-01-29 12:10:27 -05002655 def bind_partial(*args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002656 '''Get a BoundArguments object, that partially maps the
2657 passed `args` and `kwargs` to the function's signature.
2658 Raises `TypeError` if the passed arguments can not be bound.
2659 '''
Yury Selivanovc45873e2014-01-29 12:10:27 -05002660 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002661
2662 def __str__(self):
2663 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002664 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002665 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002666 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002667 formatted = str(param)
2668
2669 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002670
2671 if kind == _POSITIONAL_ONLY:
2672 render_pos_only_separator = True
2673 elif render_pos_only_separator:
2674 # It's not a positional-only parameter, and the flag
2675 # is set to 'True' (there were pos-only params before.)
2676 result.append('/')
2677 render_pos_only_separator = False
2678
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002679 if kind == _VAR_POSITIONAL:
2680 # OK, we have an '*args'-like parameter, so we won't need
2681 # a '*' to separate keyword-only arguments
2682 render_kw_only_separator = False
2683 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
2684 # We have a keyword-only parameter to render and we haven't
2685 # rendered an '*args'-like parameter before, so add a '*'
2686 # separator to the parameters list ("foo(arg1, *, arg2)" case)
2687 result.append('*')
2688 # This condition should be only triggered once, so
2689 # reset the flag
2690 render_kw_only_separator = False
2691
2692 result.append(formatted)
2693
Yury Selivanov2393dca2014-01-27 15:07:58 -05002694 if render_pos_only_separator:
2695 # There were only positional-only parameters, hence the
2696 # flag was not reset to 'False'
2697 result.append('/')
2698
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002699 rendered = '({})'.format(', '.join(result))
2700
2701 if self.return_annotation is not _empty:
2702 anno = formatannotation(self.return_annotation)
2703 rendered += ' -> {}'.format(anno)
2704
2705 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002706
2707def _main():
2708 """ Logic for inspecting an object given at command line """
2709 import argparse
2710 import importlib
2711
2712 parser = argparse.ArgumentParser()
2713 parser.add_argument(
2714 'object',
2715 help="The object to be analysed. "
2716 "It supports the 'module:qualname' syntax")
2717 parser.add_argument(
2718 '-d', '--details', action='store_true',
2719 help='Display info about the module rather than its source code')
2720
2721 args = parser.parse_args()
2722
2723 target = args.object
2724 mod_name, has_attrs, attrs = target.partition(":")
2725 try:
2726 obj = module = importlib.import_module(mod_name)
2727 except Exception as exc:
2728 msg = "Failed to import {} ({}: {})".format(mod_name,
2729 type(exc).__name__,
2730 exc)
2731 print(msg, file=sys.stderr)
2732 exit(2)
2733
2734 if has_attrs:
2735 parts = attrs.split(".")
2736 obj = module
2737 for part in parts:
2738 obj = getattr(obj, part)
2739
2740 if module.__name__ in sys.builtin_module_names:
2741 print("Can't get info for builtin modules.", file=sys.stderr)
2742 exit(1)
2743
2744 if args.details:
2745 print('Target: {}'.format(target))
2746 print('Origin: {}'.format(getsourcefile(module)))
2747 print('Cached: {}'.format(module.__cached__))
2748 if obj is module:
2749 print('Loader: {}'.format(repr(module.__loader__)))
2750 if hasattr(module, '__path__'):
2751 print('Submodule search path: {}'.format(module.__path__))
2752 else:
2753 try:
2754 __, lineno = findsource(obj)
2755 except Exception:
2756 pass
2757 else:
2758 print('Line: {}'.format(lineno))
2759
2760 print('\n')
2761 else:
2762 print(getsource(obj))
2763
2764
2765if __name__ == "__main__":
2766 _main()