blob: 017a7e85b5eebf7eee1a00f3b7579ddfcb51315b [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 Selivanovd82eddc2014-01-29 11:24:39 -0500952 builtin_method_param = None
953
Jeremy Hylton64967882003-06-27 18:14:39 +0000954 if ismethod(func):
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)
Christian Heimesff737952007-11-27 10:40:20 +0000963 func = func.__func__
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500964
965 elif isbuiltin(func):
966 # We have a builtin function or method. For that, we check the
967 # special '__text_signature__' attribute, provided by the
968 # Argument Clinic. If it's a method, we'll need to make sure
969 # that its first parameter (usually "self") is always returned
970 # (see the previous comment).
971 text_signature = getattr(func, '__text_signature__', None)
972 if text_signature and text_signature.startswith('($'):
973 builtin_method_param = _signature_get_bound_param(text_signature)
974
975 try:
976 sig = signature(func)
977 except Exception as ex:
978 # Most of the times 'signature' will raise ValueError.
979 # But, it can also raise AttributeError, and, maybe something
980 # else. So to be fully backwards compatible, we catch all
981 # possible exceptions here, and reraise a TypeError.
982 raise TypeError('unsupported callable') from ex
983
984 args = []
985 varargs = None
986 varkw = None
987 kwonlyargs = []
988 defaults = ()
989 annotations = {}
990 defaults = ()
991 kwdefaults = {}
992
993 if sig.return_annotation is not sig.empty:
994 annotations['return'] = sig.return_annotation
995
996 for param in sig.parameters.values():
997 kind = param.kind
998 name = param.name
999
1000 if kind is _POSITIONAL_ONLY:
1001 args.append(name)
1002 elif kind is _POSITIONAL_OR_KEYWORD:
1003 args.append(name)
1004 if param.default is not param.empty:
1005 defaults += (param.default,)
1006 elif kind is _VAR_POSITIONAL:
1007 varargs = name
1008 elif kind is _KEYWORD_ONLY:
1009 kwonlyargs.append(name)
1010 if param.default is not param.empty:
1011 kwdefaults[name] = param.default
1012 elif kind is _VAR_KEYWORD:
1013 varkw = name
1014
1015 if param.annotation is not param.empty:
1016 annotations[name] = param.annotation
1017
1018 if not kwdefaults:
1019 # compatibility with 'func.__kwdefaults__'
1020 kwdefaults = None
1021
1022 if not defaults:
1023 # compatibility with 'func.__defaults__'
1024 defaults = None
1025
1026 if builtin_method_param and (not args or args[0] != builtin_method_param):
1027 # `func` is a method, and we always need to return its
1028 # first parameter -- usually "self" (to be backwards
1029 # compatible with the previous implementation of
1030 # getfullargspec)
1031 args.insert(0, builtin_method_param)
1032
1033 return FullArgSpec(args, varargs, varkw, defaults,
1034 kwonlyargs, kwdefaults, annotations)
1035
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001036
Christian Heimes25bb7832008-01-11 16:17:00 +00001037ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1038
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001039def getargvalues(frame):
1040 """Get information about arguments passed into a particular frame.
1041
1042 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001043 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001044 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1045 'locals' is the locals dictionary of the given frame."""
1046 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001047 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001048
Guido van Rossum2e65f892007-02-28 22:03:49 +00001049def formatannotation(annotation, base_module=None):
1050 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001051 if annotation.__module__ in ('builtins', base_module):
Guido van Rossum2e65f892007-02-28 22:03:49 +00001052 return annotation.__name__
1053 return annotation.__module__+'.'+annotation.__name__
1054 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001055
Guido van Rossum2e65f892007-02-28 22:03:49 +00001056def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001057 module = getattr(object, '__module__', None)
1058 def _formatannotation(annotation):
1059 return formatannotation(annotation, module)
1060 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001061
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001062def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +00001063 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001064 formatarg=str,
1065 formatvarargs=lambda name: '*' + name,
1066 formatvarkw=lambda name: '**' + name,
1067 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001068 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001069 formatannotation=formatannotation):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001070 """Format an argument spec from the values returned by getargspec
Guido van Rossum2e65f892007-02-28 22:03:49 +00001071 or getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001072
Guido van Rossum2e65f892007-02-28 22:03:49 +00001073 The first seven arguments are (args, varargs, varkw, defaults,
1074 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1075 are the corresponding optional formatting functions that are called to
1076 turn names and values into strings. The last argument is an optional
1077 function to format the sequence of arguments."""
1078 def formatargandannotation(arg):
1079 result = formatarg(arg)
1080 if arg in annotations:
1081 result += ': ' + formatannotation(annotations[arg])
1082 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001083 specs = []
1084 if defaults:
1085 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001086 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001087 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001088 if defaults and i >= firstdefault:
1089 spec = spec + formatvalue(defaults[i - firstdefault])
1090 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001091 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001092 specs.append(formatvarargs(formatargandannotation(varargs)))
1093 else:
1094 if kwonlyargs:
1095 specs.append('*')
1096 if kwonlyargs:
1097 for kwonlyarg in kwonlyargs:
1098 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001099 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001100 spec += formatvalue(kwonlydefaults[kwonlyarg])
1101 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001102 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001103 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001104 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001105 if 'return' in annotations:
1106 result += formatreturns(formatannotation(annotations['return']))
1107 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001108
1109def formatargvalues(args, varargs, varkw, locals,
1110 formatarg=str,
1111 formatvarargs=lambda name: '*' + name,
1112 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001113 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001114 """Format an argument spec from the 4 values returned by getargvalues.
1115
1116 The first four arguments are (args, varargs, varkw, locals). The
1117 next four arguments are the corresponding optional formatting functions
1118 that are called to turn names and values into strings. The ninth
1119 argument is an optional function to format the sequence of arguments."""
1120 def convert(name, locals=locals,
1121 formatarg=formatarg, formatvalue=formatvalue):
1122 return formatarg(name) + formatvalue(locals[name])
1123 specs = []
1124 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001125 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001126 if varargs:
1127 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1128 if varkw:
1129 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001130 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001131
Benjamin Petersone109c702011-06-24 09:37:26 -05001132def _missing_arguments(f_name, argnames, pos, values):
1133 names = [repr(name) for name in argnames if name not in values]
1134 missing = len(names)
1135 if missing == 1:
1136 s = names[0]
1137 elif missing == 2:
1138 s = "{} and {}".format(*names)
1139 else:
1140 tail = ", {} and {}".format(names[-2:])
1141 del names[-2:]
1142 s = ", ".join(names) + tail
1143 raise TypeError("%s() missing %i required %s argument%s: %s" %
1144 (f_name, missing,
1145 "positional" if pos else "keyword-only",
1146 "" if missing == 1 else "s", s))
1147
1148def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001149 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001150 kwonly_given = len([arg for arg in kwonly if arg in values])
1151 if varargs:
1152 plural = atleast != 1
1153 sig = "at least %d" % (atleast,)
1154 elif defcount:
1155 plural = True
1156 sig = "from %d to %d" % (atleast, len(args))
1157 else:
1158 plural = len(args) != 1
1159 sig = str(len(args))
1160 kwonly_sig = ""
1161 if kwonly_given:
1162 msg = " positional argument%s (and %d keyword-only argument%s)"
1163 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1164 "s" if kwonly_given != 1 else ""))
1165 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1166 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1167 "was" if given == 1 and not kwonly_given else "were"))
1168
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001169def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001170 """Get the mapping of arguments to values.
1171
1172 A dict is returned, with keys the function argument names (including the
1173 names of the * and ** arguments, if any), and values the respective bound
1174 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001175 func = func_and_positional[0]
1176 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001177 spec = getfullargspec(func)
1178 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1179 f_name = func.__name__
1180 arg2value = {}
1181
Benjamin Petersonb204a422011-06-05 22:04:07 -05001182
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001183 if ismethod(func) and func.__self__ is not None:
1184 # implicit 'self' (or 'cls' for classmethods) argument
1185 positional = (func.__self__,) + positional
1186 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001187 num_args = len(args)
1188 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001189
Benjamin Petersonb204a422011-06-05 22:04:07 -05001190 n = min(num_pos, num_args)
1191 for i in range(n):
1192 arg2value[args[i]] = positional[i]
1193 if varargs:
1194 arg2value[varargs] = tuple(positional[n:])
1195 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001196 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001197 arg2value[varkw] = {}
1198 for kw, value in named.items():
1199 if kw not in possible_kwargs:
1200 if not varkw:
1201 raise TypeError("%s() got an unexpected keyword argument %r" %
1202 (f_name, kw))
1203 arg2value[varkw][kw] = value
1204 continue
1205 if kw in arg2value:
1206 raise TypeError("%s() got multiple values for argument %r" %
1207 (f_name, kw))
1208 arg2value[kw] = value
1209 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001210 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1211 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001212 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001213 req = args[:num_args - num_defaults]
1214 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001215 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001216 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001217 for i, arg in enumerate(args[num_args - num_defaults:]):
1218 if arg not in arg2value:
1219 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001220 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001221 for kwarg in kwonlyargs:
1222 if kwarg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001223 if kwarg in kwonlydefaults:
1224 arg2value[kwarg] = kwonlydefaults[kwarg]
1225 else:
1226 missing += 1
1227 if missing:
1228 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001229 return arg2value
1230
Nick Coghlan2f92e542012-06-23 19:39:55 +10001231ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1232
1233def getclosurevars(func):
1234 """
1235 Get the mapping of free variables to their current values.
1236
Meador Inge8fda3592012-07-19 21:33:21 -05001237 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001238 and builtin references as seen by the body of the function. A final
1239 set of unbound names that could not be resolved is also provided.
1240 """
1241
1242 if ismethod(func):
1243 func = func.__func__
1244
1245 if not isfunction(func):
1246 raise TypeError("'{!r}' is not a Python function".format(func))
1247
1248 code = func.__code__
1249 # Nonlocal references are named in co_freevars and resolved
1250 # by looking them up in __closure__ by positional index
1251 if func.__closure__ is None:
1252 nonlocal_vars = {}
1253 else:
1254 nonlocal_vars = {
1255 var : cell.cell_contents
1256 for var, cell in zip(code.co_freevars, func.__closure__)
1257 }
1258
1259 # Global and builtin references are named in co_names and resolved
1260 # by looking them up in __globals__ or __builtins__
1261 global_ns = func.__globals__
1262 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1263 if ismodule(builtin_ns):
1264 builtin_ns = builtin_ns.__dict__
1265 global_vars = {}
1266 builtin_vars = {}
1267 unbound_names = set()
1268 for name in code.co_names:
1269 if name in ("None", "True", "False"):
1270 # Because these used to be builtins instead of keywords, they
1271 # may still show up as name references. We ignore them.
1272 continue
1273 try:
1274 global_vars[name] = global_ns[name]
1275 except KeyError:
1276 try:
1277 builtin_vars[name] = builtin_ns[name]
1278 except KeyError:
1279 unbound_names.add(name)
1280
1281 return ClosureVars(nonlocal_vars, global_vars,
1282 builtin_vars, unbound_names)
1283
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001284# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001285
1286Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1287
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001288def getframeinfo(frame, context=1):
1289 """Get information about a frame or traceback object.
1290
1291 A tuple of five things is returned: the filename, the line number of
1292 the current line, the function name, a list of lines of context from
1293 the source code, and the index of the current line within that list.
1294 The optional second argument specifies the number of lines of context
1295 to return, which are centered around the current line."""
1296 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001297 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001298 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001299 else:
1300 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001301 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001302 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001303
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001304 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001305 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001306 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001307 try:
1308 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001309 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001310 lines = index = None
1311 else:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001312 start = max(start, 1)
Raymond Hettingera0501712004-06-15 11:22:53 +00001313 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001314 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001315 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001316 else:
1317 lines = index = None
1318
Christian Heimes25bb7832008-01-11 16:17:00 +00001319 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001320
1321def getlineno(frame):
1322 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001323 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1324 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001325
1326def getouterframes(frame, context=1):
1327 """Get a list of records for a frame and all higher (calling) frames.
1328
1329 Each record contains a frame object, filename, line number, function
1330 name, a list of lines of context, and index within the context."""
1331 framelist = []
1332 while frame:
1333 framelist.append((frame,) + getframeinfo(frame, context))
1334 frame = frame.f_back
1335 return framelist
1336
1337def getinnerframes(tb, context=1):
1338 """Get a list of records for a traceback's frame and all lower frames.
1339
1340 Each record contains a frame object, filename, line number, function
1341 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001342 framelist = []
1343 while tb:
1344 framelist.append((tb.tb_frame,) + getframeinfo(tb, context))
1345 tb = tb.tb_next
1346 return framelist
1347
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001348def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001349 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001350 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001351
1352def stack(context=1):
1353 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001354 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001355
1356def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001357 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001358 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001359
1360
1361# ------------------------------------------------ static version of getattr
1362
1363_sentinel = object()
1364
Michael Foorde5162652010-11-20 16:40:44 +00001365def _static_getmro(klass):
1366 return type.__dict__['__mro__'].__get__(klass)
1367
Michael Foord95fc51d2010-11-20 15:07:30 +00001368def _check_instance(obj, attr):
1369 instance_dict = {}
1370 try:
1371 instance_dict = object.__getattribute__(obj, "__dict__")
1372 except AttributeError:
1373 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001374 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001375
1376
1377def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001378 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001379 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001380 try:
1381 return entry.__dict__[attr]
1382 except KeyError:
1383 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001384 return _sentinel
1385
Michael Foord35184ed2010-11-20 16:58:30 +00001386def _is_type(obj):
1387 try:
1388 _static_getmro(obj)
1389 except TypeError:
1390 return False
1391 return True
1392
Michael Foorddcebe0f2011-03-15 19:20:44 -04001393def _shadowed_dict(klass):
1394 dict_attr = type.__dict__["__dict__"]
1395 for entry in _static_getmro(klass):
1396 try:
1397 class_dict = dict_attr.__get__(entry)["__dict__"]
1398 except KeyError:
1399 pass
1400 else:
1401 if not (type(class_dict) is types.GetSetDescriptorType and
1402 class_dict.__name__ == "__dict__" and
1403 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001404 return class_dict
1405 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001406
1407def getattr_static(obj, attr, default=_sentinel):
1408 """Retrieve attributes without triggering dynamic lookup via the
1409 descriptor protocol, __getattr__ or __getattribute__.
1410
1411 Note: this function may not be able to retrieve all attributes
1412 that getattr can fetch (like dynamically created attributes)
1413 and may find attributes that getattr can't (like descriptors
1414 that raise AttributeError). It can also return descriptor objects
1415 instead of instance members in some cases. See the
1416 documentation for details.
1417 """
1418 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001419 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001420 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001421 dict_attr = _shadowed_dict(klass)
1422 if (dict_attr is _sentinel or
1423 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001424 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001425 else:
1426 klass = obj
1427
1428 klass_result = _check_class(klass, attr)
1429
1430 if instance_result is not _sentinel and klass_result is not _sentinel:
1431 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1432 _check_class(type(klass_result), '__set__') is not _sentinel):
1433 return klass_result
1434
1435 if instance_result is not _sentinel:
1436 return instance_result
1437 if klass_result is not _sentinel:
1438 return klass_result
1439
1440 if obj is klass:
1441 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001442 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001443 if _shadowed_dict(type(entry)) is _sentinel:
1444 try:
1445 return entry.__dict__[attr]
1446 except KeyError:
1447 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001448 if default is not _sentinel:
1449 return default
1450 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001451
1452
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001453# ------------------------------------------------ generator introspection
1454
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001455GEN_CREATED = 'GEN_CREATED'
1456GEN_RUNNING = 'GEN_RUNNING'
1457GEN_SUSPENDED = 'GEN_SUSPENDED'
1458GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001459
1460def getgeneratorstate(generator):
1461 """Get current state of a generator-iterator.
1462
1463 Possible states are:
1464 GEN_CREATED: Waiting to start execution.
1465 GEN_RUNNING: Currently being executed by the interpreter.
1466 GEN_SUSPENDED: Currently suspended at a yield expression.
1467 GEN_CLOSED: Execution has completed.
1468 """
1469 if generator.gi_running:
1470 return GEN_RUNNING
1471 if generator.gi_frame is None:
1472 return GEN_CLOSED
1473 if generator.gi_frame.f_lasti == -1:
1474 return GEN_CREATED
1475 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001476
1477
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001478def getgeneratorlocals(generator):
1479 """
1480 Get the mapping of generator local variables to their current values.
1481
1482 A dict is returned, with the keys the local variable names and values the
1483 bound values."""
1484
1485 if not isgenerator(generator):
1486 raise TypeError("'{!r}' is not a Python generator".format(generator))
1487
1488 frame = getattr(generator, "gi_frame", None)
1489 if frame is not None:
1490 return generator.gi_frame.f_locals
1491 else:
1492 return {}
1493
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001494###############################################################################
1495### Function Signature Object (PEP 362)
1496###############################################################################
1497
1498
1499_WrapperDescriptor = type(type.__call__)
1500_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001501_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001502
1503_NonUserDefinedCallables = (_WrapperDescriptor,
1504 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001505 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001506 types.BuiltinFunctionType)
1507
1508
Yury Selivanov421f0c72014-01-29 12:05:40 -05001509def _signature_get_user_defined_method(cls, method_name):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001510 try:
1511 meth = getattr(cls, method_name)
1512 except AttributeError:
1513 return
1514 else:
1515 if not isinstance(meth, _NonUserDefinedCallables):
1516 # Once '__signature__' will be added to 'C'-level
1517 # callables, this check won't be necessary
1518 return meth
1519
1520
Yury Selivanov62560fb2014-01-28 12:26:24 -05001521def _signature_get_partial(wrapped_sig, partial, extra_args=()):
1522 # Internal helper to calculate how 'wrapped_sig' signature will
1523 # look like after applying a 'functools.partial' object (or alike)
1524 # on it.
1525
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001526 new_params = OrderedDict(wrapped_sig.parameters.items())
1527
1528 partial_args = partial.args or ()
1529 partial_keywords = partial.keywords or {}
1530
1531 if extra_args:
1532 partial_args = extra_args + partial_args
1533
1534 try:
1535 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1536 except TypeError as ex:
1537 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1538 raise ValueError(msg) from ex
1539
1540 for arg_name, arg_value in ba.arguments.items():
1541 param = new_params[arg_name]
1542 if arg_name in partial_keywords:
1543 # We set a new default value, because the following code
1544 # is correct:
1545 #
1546 # >>> def foo(a): print(a)
1547 # >>> print(partial(partial(foo, a=10), a=20)())
1548 # 20
1549 # >>> print(partial(partial(foo, a=10), a=20)(a=30))
1550 # 30
1551 #
1552 # So, with 'partial' objects, passing a keyword argument is
1553 # like setting a new default value for the corresponding
1554 # parameter
1555 #
1556 # We also mark this parameter with '_partial_kwarg'
1557 # flag. Later, in '_bind', the 'default' value of this
1558 # parameter will be added to 'kwargs', to simulate
1559 # the 'functools.partial' real call.
1560 new_params[arg_name] = param.replace(default=arg_value,
1561 _partial_kwarg=True)
1562
1563 elif (param.kind not in (_VAR_KEYWORD, _VAR_POSITIONAL) and
1564 not param._partial_kwarg):
1565 new_params.pop(arg_name)
1566
1567 return wrapped_sig.replace(parameters=new_params.values())
1568
1569
Yury Selivanov62560fb2014-01-28 12:26:24 -05001570def _signature_bound_method(sig):
1571 # Internal helper to transform signatures for unbound
1572 # functions to bound methods
1573
1574 params = tuple(sig.parameters.values())
1575
1576 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1577 raise ValueError('invalid method signature')
1578
1579 kind = params[0].kind
1580 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1581 # Drop first parameter:
1582 # '(p1, p2[, ...])' -> '(p2[, ...])'
1583 params = params[1:]
1584 else:
1585 if kind is not _VAR_POSITIONAL:
1586 # Unless we add a new parameter type we never
1587 # get here
1588 raise ValueError('invalid argument type')
1589 # It's a var-positional parameter.
1590 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1591
1592 return sig.replace(parameters=params)
1593
1594
Yury Selivanovb77511d2014-01-29 10:46:14 -05001595def _signature_is_builtin(obj):
1596 # Internal helper to test if `obj` is a callable that might
1597 # support Argument Clinic's __text_signature__ protocol.
Yury Selivanov1d241832014-02-02 12:51:20 -05001598 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001599 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001600 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001601 # Can't test 'isinstance(type)' here, as it would
1602 # also be True for regular python classes
1603 obj in (type, object))
1604
1605
Yury Selivanov63da7c72014-01-31 14:48:37 -05001606def _signature_is_functionlike(obj):
1607 # Internal helper to test if `obj` is a duck type of FunctionType.
1608 # A good example of such objects are functions compiled with
1609 # Cython, which have all attributes that a pure Python function
1610 # would have, but have their code statically compiled.
1611
1612 if not callable(obj) or isclass(obj):
1613 # All function-like objects are obviously callables,
1614 # and not classes.
1615 return False
1616
1617 name = getattr(obj, '__name__', None)
1618 code = getattr(obj, '__code__', None)
1619 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1620 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1621 annotations = getattr(obj, '__annotations__', None)
1622
1623 return (isinstance(code, types.CodeType) and
1624 isinstance(name, str) and
1625 (defaults is None or isinstance(defaults, tuple)) and
1626 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1627 isinstance(annotations, dict))
1628
1629
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001630def _signature_get_bound_param(spec):
1631 # Internal helper to get first parameter name from a
1632 # __text_signature__ of a builtin method, which should
1633 # be in the following format: '($param1, ...)'.
1634 # Assumptions are that the first argument won't have
1635 # a default value or an annotation.
1636
1637 assert spec.startswith('($')
1638
1639 pos = spec.find(',')
1640 if pos == -1:
1641 pos = spec.find(')')
1642
1643 cpos = spec.find(':')
1644 assert cpos == -1 or cpos > pos
1645
1646 cpos = spec.find('=')
1647 assert cpos == -1 or cpos > pos
1648
1649 return spec[2:pos]
1650
1651
Larry Hastings2623c8c2014-02-08 22:15:29 -08001652def _signature_strip_non_python_syntax(signature):
1653 """
1654 Takes a signature in Argument Clinic's extended signature format.
1655 Returns a tuple of three things:
1656 * that signature re-rendered in standard Python syntax,
1657 * the index of the "self" parameter (generally 0), or None if
1658 the function does not have a "self" parameter, and
1659 * the index of the last "positional only" parameter,
1660 or None if the signature has no positional-only parameters.
1661 """
1662
1663 if not signature:
1664 return signature, None, None
1665
1666 self_parameter = None
1667 last_positional_only = None
1668
1669 lines = [l.encode('ascii') for l in signature.split('\n')]
1670 generator = iter(lines).__next__
1671 token_stream = tokenize.tokenize(generator)
1672
1673 delayed_comma = False
1674 skip_next_comma = False
1675 text = []
1676 add = text.append
1677
1678 current_parameter = 0
1679 OP = token.OP
1680 ERRORTOKEN = token.ERRORTOKEN
1681
1682 # token stream always starts with ENCODING token, skip it
1683 t = next(token_stream)
1684 assert t.type == tokenize.ENCODING
1685
1686 for t in token_stream:
1687 type, string = t.type, t.string
1688
1689 if type == OP:
1690 if string == ',':
1691 if skip_next_comma:
1692 skip_next_comma = False
1693 else:
1694 assert not delayed_comma
1695 delayed_comma = True
1696 current_parameter += 1
1697 continue
1698
1699 if string == '/':
1700 assert not skip_next_comma
1701 assert last_positional_only is None
1702 skip_next_comma = True
1703 last_positional_only = current_parameter - 1
1704 continue
1705
1706 if (type == ERRORTOKEN) and (string == '$'):
1707 assert self_parameter is None
1708 self_parameter = current_parameter
1709 continue
1710
1711 if delayed_comma:
1712 delayed_comma = False
1713 if not ((type == OP) and (string == ')')):
1714 add(', ')
1715 add(string)
1716 if (string == ','):
1717 add(' ')
1718 clean_signature = ''.join(text)
1719 return clean_signature, self_parameter, last_positional_only
1720
1721
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001722def _signature_fromstr(cls, obj, s):
1723 # Internal helper to parse content of '__text_signature__'
1724 # and return a Signature based on it
1725 Parameter = cls._parameter_cls
1726
Larry Hastings2623c8c2014-02-08 22:15:29 -08001727 clean_signature, self_parameter, last_positional_only = \
1728 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001729
Larry Hastings2623c8c2014-02-08 22:15:29 -08001730 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001731
1732 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001733 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001734 except SyntaxError:
1735 module = None
1736
1737 if not isinstance(module, ast.Module):
1738 raise ValueError("{!r} builtin has invalid signature".format(obj))
1739
1740 f = module.body[0]
1741
1742 parameters = []
1743 empty = Parameter.empty
1744 invalid = object()
1745
1746 module = None
1747 module_dict = {}
1748 module_name = getattr(obj, '__module__', None)
1749 if module_name:
1750 module = sys.modules.get(module_name, None)
1751 if module:
1752 module_dict = module.__dict__
1753 sys_module_dict = sys.modules
1754
1755 def parse_name(node):
1756 assert isinstance(node, ast.arg)
1757 if node.annotation != None:
1758 raise ValueError("Annotations are not currently supported")
1759 return node.arg
1760
1761 def wrap_value(s):
1762 try:
1763 value = eval(s, module_dict)
1764 except NameError:
1765 try:
1766 value = eval(s, sys_module_dict)
1767 except NameError:
1768 raise RuntimeError()
1769
1770 if isinstance(value, str):
1771 return ast.Str(value)
1772 if isinstance(value, (int, float)):
1773 return ast.Num(value)
1774 if isinstance(value, bytes):
1775 return ast.Bytes(value)
1776 if value in (True, False, None):
1777 return ast.NameConstant(value)
1778 raise RuntimeError()
1779
1780 class RewriteSymbolics(ast.NodeTransformer):
1781 def visit_Attribute(self, node):
1782 a = []
1783 n = node
1784 while isinstance(n, ast.Attribute):
1785 a.append(n.attr)
1786 n = n.value
1787 if not isinstance(n, ast.Name):
1788 raise RuntimeError()
1789 a.append(n.id)
1790 value = ".".join(reversed(a))
1791 return wrap_value(value)
1792
1793 def visit_Name(self, node):
1794 if not isinstance(node.ctx, ast.Load):
1795 raise ValueError()
1796 return wrap_value(node.id)
1797
1798 def p(name_node, default_node, default=empty):
1799 name = parse_name(name_node)
1800 if name is invalid:
1801 return None
1802 if default_node and default_node is not _empty:
1803 try:
1804 default_node = RewriteSymbolics().visit(default_node)
1805 o = ast.literal_eval(default_node)
1806 except ValueError:
1807 o = invalid
1808 if o is invalid:
1809 return None
1810 default = o if o is not invalid else default
1811 parameters.append(Parameter(name, kind, default=default, annotation=empty))
1812
1813 # non-keyword-only parameters
1814 args = reversed(f.args.args)
1815 defaults = reversed(f.args.defaults)
1816 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001817 if last_positional_only is not None:
1818 kind = Parameter.POSITIONAL_ONLY
1819 else:
1820 kind = Parameter.POSITIONAL_OR_KEYWORD
1821 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001822 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001823 if i == last_positional_only:
1824 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001825
1826 # *args
1827 if f.args.vararg:
1828 kind = Parameter.VAR_POSITIONAL
1829 p(f.args.vararg, empty)
1830
1831 # keyword-only arguments
1832 kind = Parameter.KEYWORD_ONLY
1833 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
1834 p(name, default)
1835
1836 # **kwargs
1837 if f.args.kwarg:
1838 kind = Parameter.VAR_KEYWORD
1839 p(f.args.kwarg, empty)
1840
Larry Hastings2623c8c2014-02-08 22:15:29 -08001841 if self_parameter is not None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001842 assert parameters
1843 if getattr(obj, '__self__', None):
1844 # strip off self, it's already been bound
1845 parameters.pop(0)
1846 else:
1847 # for builtins, self parameter is always positional-only!
1848 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
1849 parameters[0] = p
1850
1851 return cls(parameters, return_annotation=cls.empty)
1852
1853
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001854def signature(obj):
1855 '''Get a signature object for the passed callable.'''
1856
1857 if not callable(obj):
1858 raise TypeError('{!r} is not a callable object'.format(obj))
1859
1860 if isinstance(obj, types.MethodType):
1861 # In this case we skip the first parameter of the underlying
1862 # function (usually `self` or `cls`).
1863 sig = signature(obj.__func__)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001864 return _signature_bound_method(sig)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001865
Nick Coghlane8c45d62013-07-28 20:00:01 +10001866 # Was this function wrapped by a decorator?
1867 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
1868
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001869 try:
1870 sig = obj.__signature__
1871 except AttributeError:
1872 pass
1873 else:
1874 if sig is not None:
1875 return sig
1876
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001877 try:
1878 partialmethod = obj._partialmethod
1879 except AttributeError:
1880 pass
1881 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05001882 if isinstance(partialmethod, functools.partialmethod):
1883 # Unbound partialmethod (see functools.partialmethod)
1884 # This means, that we need to calculate the signature
1885 # as if it's a regular partial object, but taking into
1886 # account that the first positional argument
1887 # (usually `self`, or `cls`) will not be passed
1888 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001889
Yury Selivanov0486f812014-01-29 12:18:59 -05001890 wrapped_sig = signature(partialmethod.func)
1891 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001892
Yury Selivanov0486f812014-01-29 12:18:59 -05001893 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
1894 new_params = (first_wrapped_param,) + tuple(sig.parameters.values())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001895
Yury Selivanov0486f812014-01-29 12:18:59 -05001896 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001897
Yury Selivanov76c6c592014-01-29 10:52:57 -05001898 if _signature_is_builtin(obj):
1899 return Signature.from_builtin(obj)
1900
Yury Selivanov63da7c72014-01-31 14:48:37 -05001901 if isfunction(obj) or _signature_is_functionlike(obj):
1902 # If it's a pure Python function, or an object that is duck type
1903 # of a Python function (Cython functions, for instance), then:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001904 return Signature.from_function(obj)
1905
1906 if isinstance(obj, functools.partial):
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001907 wrapped_sig = signature(obj.func)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001908 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001909
1910 sig = None
1911 if isinstance(obj, type):
1912 # obj is a class or a metaclass
1913
1914 # First, let's see if it has an overloaded __call__ defined
1915 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05001916 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001917 if call is not None:
1918 sig = signature(call)
1919 else:
1920 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05001921 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001922 if new is not None:
1923 sig = signature(new)
1924 else:
1925 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05001926 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001927 if init is not None:
1928 sig = signature(init)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001929
1930 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001931 # At this point we know, that `obj` is a class, with no user-
1932 # defined '__init__', '__new__', or class-level '__call__'
1933
Larry Hastings2623c8c2014-02-08 22:15:29 -08001934 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001935 # Since '__text_signature__' is implemented as a
1936 # descriptor that extracts text signature from the
1937 # class docstring, if 'obj' is derived from a builtin
1938 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08001939 # Therefore, we go through the MRO (except the last
1940 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001941 # class with non-empty text signature.
1942 try:
1943 text_sig = base.__text_signature__
1944 except AttributeError:
1945 pass
1946 else:
1947 if text_sig:
1948 # If 'obj' class has a __text_signature__ attribute:
1949 # return a signature based on it
1950 return _signature_fromstr(Signature, obj, text_sig)
1951
1952 # No '__text_signature__' was found for the 'obj' class.
1953 # Last option is to check if its '__init__' is
1954 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08001955 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001956 # We have a class (not metaclass), but no user-defined
1957 # __init__ or __new__ for it
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001958 if obj.__init__ is object.__init__:
1959 # Return a signature of 'object' builtin.
1960 return signature(object)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001961
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001962 elif not isinstance(obj, _NonUserDefinedCallables):
1963 # An object with __call__
1964 # We also check that the 'obj' is not an instance of
1965 # _WrapperDescriptor or _MethodWrapper to avoid
1966 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05001967 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001968 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001969 try:
1970 sig = signature(call)
1971 except ValueError as ex:
1972 msg = 'no signature found for {!r}'.format(obj)
1973 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001974
1975 if sig is not None:
1976 # For classes and objects we skip the first parameter of their
1977 # __call__, __new__, or __init__ methods
Yury Selivanov62560fb2014-01-28 12:26:24 -05001978 return _signature_bound_method(sig)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001979
1980 if isinstance(obj, types.BuiltinFunctionType):
1981 # Raise a nicer error message for builtins
1982 msg = 'no signature found for builtin function {!r}'.format(obj)
1983 raise ValueError(msg)
1984
1985 raise ValueError('callable {!r} is not supported by signature'.format(obj))
1986
1987
1988class _void:
1989 '''A private marker - used in Parameter & Signature'''
1990
1991
1992class _empty:
1993 pass
1994
1995
1996class _ParameterKind(int):
1997 def __new__(self, *args, name):
1998 obj = int.__new__(self, *args)
1999 obj._name = name
2000 return obj
2001
2002 def __str__(self):
2003 return self._name
2004
2005 def __repr__(self):
2006 return '<_ParameterKind: {!r}>'.format(self._name)
2007
2008
2009_POSITIONAL_ONLY = _ParameterKind(0, name='POSITIONAL_ONLY')
2010_POSITIONAL_OR_KEYWORD = _ParameterKind(1, name='POSITIONAL_OR_KEYWORD')
2011_VAR_POSITIONAL = _ParameterKind(2, name='VAR_POSITIONAL')
2012_KEYWORD_ONLY = _ParameterKind(3, name='KEYWORD_ONLY')
2013_VAR_KEYWORD = _ParameterKind(4, name='VAR_KEYWORD')
2014
2015
2016class Parameter:
2017 '''Represents a parameter in a function signature.
2018
2019 Has the following public attributes:
2020
2021 * name : str
2022 The name of the parameter as a string.
2023 * default : object
2024 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002025 parameter has no default value, this attribute is set to
2026 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002027 * annotation
2028 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002029 parameter has no annotation, this attribute is set to
2030 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002031 * kind : str
2032 Describes how argument values are bound to the parameter.
2033 Possible values: `Parameter.POSITIONAL_ONLY`,
2034 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2035 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
2036 '''
2037
2038 __slots__ = ('_name', '_kind', '_default', '_annotation', '_partial_kwarg')
2039
2040 POSITIONAL_ONLY = _POSITIONAL_ONLY
2041 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2042 VAR_POSITIONAL = _VAR_POSITIONAL
2043 KEYWORD_ONLY = _KEYWORD_ONLY
2044 VAR_KEYWORD = _VAR_KEYWORD
2045
2046 empty = _empty
2047
2048 def __init__(self, name, kind, *, default=_empty, annotation=_empty,
2049 _partial_kwarg=False):
2050
2051 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
2052 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
2053 raise ValueError("invalid value for 'Parameter.kind' attribute")
2054 self._kind = kind
2055
2056 if default is not _empty:
2057 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2058 msg = '{} parameters cannot have default values'.format(kind)
2059 raise ValueError(msg)
2060 self._default = default
2061 self._annotation = annotation
2062
Yury Selivanov2393dca2014-01-27 15:07:58 -05002063 if name is _empty:
2064 raise ValueError('name is a required attribute for Parameter')
2065
2066 if not isinstance(name, str):
2067 raise TypeError("name must be a str, not a {!r}".format(name))
2068
2069 if not name.isidentifier():
2070 raise ValueError('{!r} is not a valid parameter name'.format(name))
2071
2072 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002073
2074 self._partial_kwarg = _partial_kwarg
2075
2076 @property
2077 def name(self):
2078 return self._name
2079
2080 @property
2081 def default(self):
2082 return self._default
2083
2084 @property
2085 def annotation(self):
2086 return self._annotation
2087
2088 @property
2089 def kind(self):
2090 return self._kind
2091
2092 def replace(self, *, name=_void, kind=_void, annotation=_void,
2093 default=_void, _partial_kwarg=_void):
2094 '''Creates a customized copy of the Parameter.'''
2095
2096 if name is _void:
2097 name = self._name
2098
2099 if kind is _void:
2100 kind = self._kind
2101
2102 if annotation is _void:
2103 annotation = self._annotation
2104
2105 if default is _void:
2106 default = self._default
2107
2108 if _partial_kwarg is _void:
2109 _partial_kwarg = self._partial_kwarg
2110
2111 return type(self)(name, kind, default=default, annotation=annotation,
2112 _partial_kwarg=_partial_kwarg)
2113
2114 def __str__(self):
2115 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002116 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002117
2118 # Add annotation and default value
2119 if self._annotation is not _empty:
2120 formatted = '{}:{}'.format(formatted,
2121 formatannotation(self._annotation))
2122
2123 if self._default is not _empty:
2124 formatted = '{}={}'.format(formatted, repr(self._default))
2125
2126 if kind == _VAR_POSITIONAL:
2127 formatted = '*' + formatted
2128 elif kind == _VAR_KEYWORD:
2129 formatted = '**' + formatted
2130
2131 return formatted
2132
2133 def __repr__(self):
2134 return '<{} at {:#x} {!r}>'.format(self.__class__.__name__,
2135 id(self), self.name)
2136
2137 def __eq__(self, other):
Yury Selivanov0ba5f0d2014-01-31 15:30:30 -05002138 # NB: We deliberately do not compare '_partial_kwarg' attributes
2139 # here. Imagine we have a following situation:
2140 #
2141 # def foo(a, b=1): pass
2142 # def bar(a, b): pass
2143 # bar2 = functools.partial(bar, b=1)
2144 #
2145 # For the above scenario, signatures for `foo` and `bar2` should
2146 # be equal. '_partial_kwarg' attribute is an internal flag, to
2147 # distinguish between keyword parameters with defaults and
2148 # keyword parameters which got their defaults from functools.partial
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002149 return (issubclass(other.__class__, Parameter) and
2150 self._name == other._name and
2151 self._kind == other._kind and
2152 self._default == other._default and
2153 self._annotation == other._annotation)
2154
2155 def __ne__(self, other):
2156 return not self.__eq__(other)
2157
2158
2159class BoundArguments:
2160 '''Result of `Signature.bind` call. Holds the mapping of arguments
2161 to the function's parameters.
2162
2163 Has the following public attributes:
2164
2165 * arguments : OrderedDict
2166 An ordered mutable mapping of parameters' names to arguments' values.
2167 Does not contain arguments' default values.
2168 * signature : Signature
2169 The Signature object that created this instance.
2170 * args : tuple
2171 Tuple of positional arguments values.
2172 * kwargs : dict
2173 Dict of keyword arguments values.
2174 '''
2175
2176 def __init__(self, signature, arguments):
2177 self.arguments = arguments
2178 self._signature = signature
2179
2180 @property
2181 def signature(self):
2182 return self._signature
2183
2184 @property
2185 def args(self):
2186 args = []
2187 for param_name, param in self._signature.parameters.items():
2188 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
2189 param._partial_kwarg):
2190 # Keyword arguments mapped by 'functools.partial'
2191 # (Parameter._partial_kwarg is True) are mapped
2192 # in 'BoundArguments.kwargs', along with VAR_KEYWORD &
2193 # KEYWORD_ONLY
2194 break
2195
2196 try:
2197 arg = self.arguments[param_name]
2198 except KeyError:
2199 # We're done here. Other arguments
2200 # will be mapped in 'BoundArguments.kwargs'
2201 break
2202 else:
2203 if param.kind == _VAR_POSITIONAL:
2204 # *args
2205 args.extend(arg)
2206 else:
2207 # plain argument
2208 args.append(arg)
2209
2210 return tuple(args)
2211
2212 @property
2213 def kwargs(self):
2214 kwargs = {}
2215 kwargs_started = False
2216 for param_name, param in self._signature.parameters.items():
2217 if not kwargs_started:
2218 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
2219 param._partial_kwarg):
2220 kwargs_started = True
2221 else:
2222 if param_name not in self.arguments:
2223 kwargs_started = True
2224 continue
2225
2226 if not kwargs_started:
2227 continue
2228
2229 try:
2230 arg = self.arguments[param_name]
2231 except KeyError:
2232 pass
2233 else:
2234 if param.kind == _VAR_KEYWORD:
2235 # **kwargs
2236 kwargs.update(arg)
2237 else:
2238 # plain keyword argument
2239 kwargs[param_name] = arg
2240
2241 return kwargs
2242
2243 def __eq__(self, other):
2244 return (issubclass(other.__class__, BoundArguments) and
2245 self.signature == other.signature and
2246 self.arguments == other.arguments)
2247
2248 def __ne__(self, other):
2249 return not self.__eq__(other)
2250
2251
2252class Signature:
2253 '''A Signature object represents the overall signature of a function.
2254 It stores a Parameter object for each parameter accepted by the
2255 function, as well as information specific to the function itself.
2256
2257 A Signature object has the following public attributes and methods:
2258
2259 * parameters : OrderedDict
2260 An ordered mapping of parameters' names to the corresponding
2261 Parameter objects (keyword-only arguments are in the same order
2262 as listed in `code.co_varnames`).
2263 * return_annotation : object
2264 The annotation for the return type of the function if specified.
2265 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002266 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002267 * bind(*args, **kwargs) -> BoundArguments
2268 Creates a mapping from positional and keyword arguments to
2269 parameters.
2270 * bind_partial(*args, **kwargs) -> BoundArguments
2271 Creates a partial mapping from positional and keyword arguments
2272 to parameters (simulating 'functools.partial' behavior.)
2273 '''
2274
2275 __slots__ = ('_return_annotation', '_parameters')
2276
2277 _parameter_cls = Parameter
2278 _bound_arguments_cls = BoundArguments
2279
2280 empty = _empty
2281
2282 def __init__(self, parameters=None, *, return_annotation=_empty,
2283 __validate_parameters__=True):
2284 '''Constructs Signature from the given list of Parameter
2285 objects and 'return_annotation'. All arguments are optional.
2286 '''
2287
2288 if parameters is None:
2289 params = OrderedDict()
2290 else:
2291 if __validate_parameters__:
2292 params = OrderedDict()
2293 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002294 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002295
2296 for idx, param in enumerate(parameters):
2297 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002298 name = param.name
2299
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002300 if kind < top_kind:
2301 msg = 'wrong parameter order: {} before {}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05002302 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002303 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002304 elif kind > top_kind:
2305 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002306 top_kind = kind
2307
Yury Selivanov07a9e452014-01-29 10:58:16 -05002308 if (kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD) and
2309 not param._partial_kwarg):
2310 # If we have a positional-only or positional-or-keyword
2311 # parameter, that does not have its default value set
2312 # by 'functools.partial' or other "partial" signature:
2313 if param.default is _empty:
2314 if kind_defaults:
2315 # No default for this parameter, but the
2316 # previous parameter of the same kind had
2317 # a default
2318 msg = 'non-default argument follows default ' \
2319 'argument'
2320 raise ValueError(msg)
2321 else:
2322 # There is a default for this parameter.
2323 kind_defaults = True
2324
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002325 if name in params:
2326 msg = 'duplicate parameter name: {!r}'.format(name)
2327 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002328
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002329 params[name] = param
2330 else:
2331 params = OrderedDict(((param.name, param)
2332 for param in parameters))
2333
2334 self._parameters = types.MappingProxyType(params)
2335 self._return_annotation = return_annotation
2336
2337 @classmethod
2338 def from_function(cls, func):
2339 '''Constructs Signature for the given python function'''
2340
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002341 is_duck_function = False
2342 if not isfunction(func):
2343 if _signature_is_functionlike(func):
2344 is_duck_function = True
2345 else:
2346 # If it's not a pure Python function, and not a duck type
2347 # of pure function:
2348 raise TypeError('{!r} is not a Python function'.format(func))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002349
2350 Parameter = cls._parameter_cls
2351
2352 # Parameter information.
2353 func_code = func.__code__
2354 pos_count = func_code.co_argcount
2355 arg_names = func_code.co_varnames
2356 positional = tuple(arg_names[:pos_count])
2357 keyword_only_count = func_code.co_kwonlyargcount
2358 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
2359 annotations = func.__annotations__
2360 defaults = func.__defaults__
2361 kwdefaults = func.__kwdefaults__
2362
2363 if defaults:
2364 pos_default_count = len(defaults)
2365 else:
2366 pos_default_count = 0
2367
2368 parameters = []
2369
2370 # Non-keyword-only parameters w/o defaults.
2371 non_default_count = pos_count - pos_default_count
2372 for name in positional[:non_default_count]:
2373 annotation = annotations.get(name, _empty)
2374 parameters.append(Parameter(name, annotation=annotation,
2375 kind=_POSITIONAL_OR_KEYWORD))
2376
2377 # ... w/ defaults.
2378 for offset, name in enumerate(positional[non_default_count:]):
2379 annotation = annotations.get(name, _empty)
2380 parameters.append(Parameter(name, annotation=annotation,
2381 kind=_POSITIONAL_OR_KEYWORD,
2382 default=defaults[offset]))
2383
2384 # *args
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002385 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002386 name = arg_names[pos_count + keyword_only_count]
2387 annotation = annotations.get(name, _empty)
2388 parameters.append(Parameter(name, annotation=annotation,
2389 kind=_VAR_POSITIONAL))
2390
2391 # Keyword-only parameters.
2392 for name in keyword_only:
2393 default = _empty
2394 if kwdefaults is not None:
2395 default = kwdefaults.get(name, _empty)
2396
2397 annotation = annotations.get(name, _empty)
2398 parameters.append(Parameter(name, annotation=annotation,
2399 kind=_KEYWORD_ONLY,
2400 default=default))
2401 # **kwargs
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002402 if func_code.co_flags & CO_VARKEYWORDS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002403 index = pos_count + keyword_only_count
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002404 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002405 index += 1
2406
2407 name = arg_names[index]
2408 annotation = annotations.get(name, _empty)
2409 parameters.append(Parameter(name, annotation=annotation,
2410 kind=_VAR_KEYWORD))
2411
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002412 # Is 'func' is a pure Python function - don't validate the
2413 # parameters list (for correct order and defaults), it should be OK.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002414 return cls(parameters,
2415 return_annotation=annotations.get('return', _empty),
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002416 __validate_parameters__=is_duck_function)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002417
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002418 @classmethod
2419 def from_builtin(cls, func):
Yury Selivanovb77511d2014-01-29 10:46:14 -05002420 if not _signature_is_builtin(func):
2421 raise TypeError("{!r} is not a Python builtin "
2422 "function".format(func))
2423
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002424 s = getattr(func, "__text_signature__", None)
2425 if not s:
Yury Selivanovb77511d2014-01-29 10:46:14 -05002426 raise ValueError("no signature found for builtin {!r}".format(func))
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002427
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002428 return _signature_fromstr(cls, func, s)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002429
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002430 @property
2431 def parameters(self):
2432 return self._parameters
2433
2434 @property
2435 def return_annotation(self):
2436 return self._return_annotation
2437
2438 def replace(self, *, parameters=_void, return_annotation=_void):
2439 '''Creates a customized copy of the Signature.
2440 Pass 'parameters' and/or 'return_annotation' arguments
2441 to override them in the new copy.
2442 '''
2443
2444 if parameters is _void:
2445 parameters = self.parameters.values()
2446
2447 if return_annotation is _void:
2448 return_annotation = self._return_annotation
2449
2450 return type(self)(parameters,
2451 return_annotation=return_annotation)
2452
2453 def __eq__(self, other):
2454 if (not issubclass(type(other), Signature) or
2455 self.return_annotation != other.return_annotation or
2456 len(self.parameters) != len(other.parameters)):
2457 return False
2458
2459 other_positions = {param: idx
2460 for idx, param in enumerate(other.parameters.keys())}
2461
2462 for idx, (param_name, param) in enumerate(self.parameters.items()):
2463 if param.kind == _KEYWORD_ONLY:
2464 try:
2465 other_param = other.parameters[param_name]
2466 except KeyError:
2467 return False
2468 else:
2469 if param != other_param:
2470 return False
2471 else:
2472 try:
2473 other_idx = other_positions[param_name]
2474 except KeyError:
2475 return False
2476 else:
2477 if (idx != other_idx or
2478 param != other.parameters[param_name]):
2479 return False
2480
2481 return True
2482
2483 def __ne__(self, other):
2484 return not self.__eq__(other)
2485
2486 def _bind(self, args, kwargs, *, partial=False):
2487 '''Private method. Don't use directly.'''
2488
2489 arguments = OrderedDict()
2490
2491 parameters = iter(self.parameters.values())
2492 parameters_ex = ()
2493 arg_vals = iter(args)
2494
2495 if partial:
2496 # Support for binding arguments to 'functools.partial' objects.
2497 # See 'functools.partial' case in 'signature()' implementation
2498 # for details.
2499 for param_name, param in self.parameters.items():
2500 if (param._partial_kwarg and param_name not in kwargs):
2501 # Simulating 'functools.partial' behavior
2502 kwargs[param_name] = param.default
2503
2504 while True:
2505 # Let's iterate through the positional arguments and corresponding
2506 # parameters
2507 try:
2508 arg_val = next(arg_vals)
2509 except StopIteration:
2510 # No more positional arguments
2511 try:
2512 param = next(parameters)
2513 except StopIteration:
2514 # No more parameters. That's it. Just need to check that
2515 # we have no `kwargs` after this while loop
2516 break
2517 else:
2518 if param.kind == _VAR_POSITIONAL:
2519 # That's OK, just empty *args. Let's start parsing
2520 # kwargs
2521 break
2522 elif param.name in kwargs:
2523 if param.kind == _POSITIONAL_ONLY:
2524 msg = '{arg!r} parameter is positional only, ' \
2525 'but was passed as a keyword'
2526 msg = msg.format(arg=param.name)
2527 raise TypeError(msg) from None
2528 parameters_ex = (param,)
2529 break
2530 elif (param.kind == _VAR_KEYWORD or
2531 param.default is not _empty):
2532 # That's fine too - we have a default value for this
2533 # parameter. So, lets start parsing `kwargs`, starting
2534 # with the current parameter
2535 parameters_ex = (param,)
2536 break
2537 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002538 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2539 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002540 if partial:
2541 parameters_ex = (param,)
2542 break
2543 else:
2544 msg = '{arg!r} parameter lacking default value'
2545 msg = msg.format(arg=param.name)
2546 raise TypeError(msg) from None
2547 else:
2548 # We have a positional argument to process
2549 try:
2550 param = next(parameters)
2551 except StopIteration:
2552 raise TypeError('too many positional arguments') from None
2553 else:
2554 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2555 # Looks like we have no parameter for this positional
2556 # argument
2557 raise TypeError('too many positional arguments')
2558
2559 if param.kind == _VAR_POSITIONAL:
2560 # We have an '*args'-like argument, let's fill it with
2561 # all positional arguments we have left and move on to
2562 # the next phase
2563 values = [arg_val]
2564 values.extend(arg_vals)
2565 arguments[param.name] = tuple(values)
2566 break
2567
2568 if param.name in kwargs:
2569 raise TypeError('multiple values for argument '
2570 '{arg!r}'.format(arg=param.name))
2571
2572 arguments[param.name] = arg_val
2573
2574 # Now, we iterate through the remaining parameters to process
2575 # keyword arguments
2576 kwargs_param = None
2577 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002578 if param.kind == _VAR_KEYWORD:
2579 # Memorize that we have a '**kwargs'-like parameter
2580 kwargs_param = param
2581 continue
2582
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002583 if param.kind == _VAR_POSITIONAL:
2584 # Named arguments don't refer to '*args'-like parameters.
2585 # We only arrive here if the positional arguments ended
2586 # before reaching the last parameter before *args.
2587 continue
2588
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002589 param_name = param.name
2590 try:
2591 arg_val = kwargs.pop(param_name)
2592 except KeyError:
2593 # We have no value for this parameter. It's fine though,
2594 # if it has a default value, or it is an '*args'-like
2595 # parameter, left alone by the processing of positional
2596 # arguments.
2597 if (not partial and param.kind != _VAR_POSITIONAL and
2598 param.default is _empty):
2599 raise TypeError('{arg!r} parameter lacking default value'. \
2600 format(arg=param_name)) from None
2601
2602 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002603 if param.kind == _POSITIONAL_ONLY:
2604 # This should never happen in case of a properly built
2605 # Signature object (but let's have this check here
2606 # to ensure correct behaviour just in case)
2607 raise TypeError('{arg!r} parameter is positional only, '
2608 'but was passed as a keyword'. \
2609 format(arg=param.name))
2610
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002611 arguments[param_name] = arg_val
2612
2613 if kwargs:
2614 if kwargs_param is not None:
2615 # Process our '**kwargs'-like parameter
2616 arguments[kwargs_param.name] = kwargs
2617 else:
2618 raise TypeError('too many keyword arguments')
2619
2620 return self._bound_arguments_cls(self, arguments)
2621
Yury Selivanovc45873e2014-01-29 12:10:27 -05002622 def bind(*args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002623 '''Get a BoundArguments object, that maps the passed `args`
2624 and `kwargs` to the function's signature. Raises `TypeError`
2625 if the passed arguments can not be bound.
2626 '''
Yury Selivanovc45873e2014-01-29 12:10:27 -05002627 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002628
Yury Selivanovc45873e2014-01-29 12:10:27 -05002629 def bind_partial(*args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002630 '''Get a BoundArguments object, that partially maps the
2631 passed `args` and `kwargs` to the function's signature.
2632 Raises `TypeError` if the passed arguments can not be bound.
2633 '''
Yury Selivanovc45873e2014-01-29 12:10:27 -05002634 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002635
2636 def __str__(self):
2637 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002638 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002639 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002640 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002641 formatted = str(param)
2642
2643 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002644
2645 if kind == _POSITIONAL_ONLY:
2646 render_pos_only_separator = True
2647 elif render_pos_only_separator:
2648 # It's not a positional-only parameter, and the flag
2649 # is set to 'True' (there were pos-only params before.)
2650 result.append('/')
2651 render_pos_only_separator = False
2652
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002653 if kind == _VAR_POSITIONAL:
2654 # OK, we have an '*args'-like parameter, so we won't need
2655 # a '*' to separate keyword-only arguments
2656 render_kw_only_separator = False
2657 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
2658 # We have a keyword-only parameter to render and we haven't
2659 # rendered an '*args'-like parameter before, so add a '*'
2660 # separator to the parameters list ("foo(arg1, *, arg2)" case)
2661 result.append('*')
2662 # This condition should be only triggered once, so
2663 # reset the flag
2664 render_kw_only_separator = False
2665
2666 result.append(formatted)
2667
Yury Selivanov2393dca2014-01-27 15:07:58 -05002668 if render_pos_only_separator:
2669 # There were only positional-only parameters, hence the
2670 # flag was not reset to 'False'
2671 result.append('/')
2672
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002673 rendered = '({})'.format(', '.join(result))
2674
2675 if self.return_annotation is not _empty:
2676 anno = formatannotation(self.return_annotation)
2677 rendered += ' -> {}'.format(anno)
2678
2679 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002680
2681def _main():
2682 """ Logic for inspecting an object given at command line """
2683 import argparse
2684 import importlib
2685
2686 parser = argparse.ArgumentParser()
2687 parser.add_argument(
2688 'object',
2689 help="The object to be analysed. "
2690 "It supports the 'module:qualname' syntax")
2691 parser.add_argument(
2692 '-d', '--details', action='store_true',
2693 help='Display info about the module rather than its source code')
2694
2695 args = parser.parse_args()
2696
2697 target = args.object
2698 mod_name, has_attrs, attrs = target.partition(":")
2699 try:
2700 obj = module = importlib.import_module(mod_name)
2701 except Exception as exc:
2702 msg = "Failed to import {} ({}: {})".format(mod_name,
2703 type(exc).__name__,
2704 exc)
2705 print(msg, file=sys.stderr)
2706 exit(2)
2707
2708 if has_attrs:
2709 parts = attrs.split(".")
2710 obj = module
2711 for part in parts:
2712 obj = getattr(obj, part)
2713
2714 if module.__name__ in sys.builtin_module_names:
2715 print("Can't get info for builtin modules.", file=sys.stderr)
2716 exit(1)
2717
2718 if args.details:
2719 print('Target: {}'.format(target))
2720 print('Origin: {}'.format(getsourcefile(module)))
2721 print('Cached: {}'.format(module.__cached__))
2722 if obj is module:
2723 print('Loader: {}'.format(repr(module.__loader__)))
2724 if hasattr(module, '__path__'):
2725 print('Submodule search path: {}'.format(module.__path__))
2726 else:
2727 try:
2728 __, lineno = findsource(obj)
2729 except Exception:
2730 pass
2731 else:
2732 print('Line: {}'.format(lineno))
2733
2734 print('\n')
2735 else:
2736 print(getsource(obj))
2737
2738
2739if __name__ == "__main__":
2740 _main()