blob: c3fecb8b8cb5bba3f703bba4d87792541d9421e4 [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
42import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040043import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070044import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100045import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000046from operator import attrgetter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070047from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000048
49# Create constants for the compiler flags in Include/code.h
50# We try to get them from dis to avoid duplication, but fall
Ezio Melotti30b9d5d2013-08-17 15:50:46 +030051# back to hardcoding so the dependency is optional
Nick Coghlan09c81232010-08-17 10:18:16 +000052try:
53 from dis import COMPILER_FLAG_NAMES as _flag_names
Brett Cannoncd171c82013-07-04 17:43:24 -040054except ImportError:
Nick Coghlan09c81232010-08-17 10:18:16 +000055 CO_OPTIMIZED, CO_NEWLOCALS = 0x1, 0x2
56 CO_VARARGS, CO_VARKEYWORDS = 0x4, 0x8
57 CO_NESTED, CO_GENERATOR, CO_NOFREE = 0x10, 0x20, 0x40
58else:
59 mod_dict = globals()
60 for k, v in _flag_names.items():
61 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000062
Christian Heimesbe5b30b2008-03-03 19:18:51 +000063# See Include/object.h
64TPFLAGS_IS_ABSTRACT = 1 << 20
65
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000066# ----------------------------------------------------------- type-checking
67def ismodule(object):
68 """Return true if the object is a module.
69
70 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000071 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000072 __doc__ documentation string
73 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000074 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000075
76def isclass(object):
77 """Return true if the object is a class.
78
79 Class objects provide these attributes:
80 __doc__ documentation string
81 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000082 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000083
84def ismethod(object):
85 """Return true if the object is an instance method.
86
87 Instance method objects provide these attributes:
88 __doc__ documentation string
89 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000090 __func__ function object containing implementation of method
91 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000092 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000093
Tim Peters536d2262001-09-20 05:13:38 +000094def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000095 """Return true if the object is a method descriptor.
96
97 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +000098
99 This is new in Python 2.2, and, for example, is true of int.__add__.
100 An object passing this test has a __get__ attribute but not a __set__
101 attribute, but beyond that the set of attributes varies. __name__ is
102 usually sensible, and __doc__ often is.
103
Tim Petersf1d90b92001-09-20 05:47:55 +0000104 Methods implemented via descriptors that also pass one of the other
105 tests return false from the ismethoddescriptor() test, simply because
106 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000107 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100108 if isclass(object) or ismethod(object) or isfunction(object):
109 # mutual exclusion
110 return False
111 tp = type(object)
112 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000113
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000114def isdatadescriptor(object):
115 """Return true if the object is a data descriptor.
116
117 Data descriptors have both a __get__ and a __set__ attribute. Examples are
118 properties (defined in Python) and getsets and members (defined in C).
119 Typically, data descriptors will also have __name__ and __doc__ attributes
120 (properties, getsets, and members have both of these attributes), but this
121 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100122 if isclass(object) or ismethod(object) or isfunction(object):
123 # mutual exclusion
124 return False
125 tp = type(object)
126 return hasattr(tp, "__set__") and hasattr(tp, "__get__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000127
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000128if hasattr(types, 'MemberDescriptorType'):
129 # CPython and equivalent
130 def ismemberdescriptor(object):
131 """Return true if the object is a member descriptor.
132
133 Member descriptors are specialized descriptors defined in extension
134 modules."""
135 return isinstance(object, types.MemberDescriptorType)
136else:
137 # Other implementations
138 def ismemberdescriptor(object):
139 """Return true if the object is a member descriptor.
140
141 Member descriptors are specialized descriptors defined in extension
142 modules."""
143 return False
144
145if hasattr(types, 'GetSetDescriptorType'):
146 # CPython and equivalent
147 def isgetsetdescriptor(object):
148 """Return true if the object is a getset descriptor.
149
150 getset descriptors are specialized descriptors defined in extension
151 modules."""
152 return isinstance(object, types.GetSetDescriptorType)
153else:
154 # Other implementations
155 def isgetsetdescriptor(object):
156 """Return true if the object is a getset descriptor.
157
158 getset descriptors are specialized descriptors defined in extension
159 modules."""
160 return False
161
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000162def isfunction(object):
163 """Return true if the object is a user-defined function.
164
165 Function objects provide these attributes:
166 __doc__ documentation string
167 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000168 __code__ code object containing compiled function bytecode
169 __defaults__ tuple of any default values for arguments
170 __globals__ global namespace in which this function was defined
171 __annotations__ dict of parameter annotations
172 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000173 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000174
Christian Heimes7131fd92008-02-19 14:21:46 +0000175def isgeneratorfunction(object):
176 """Return true if the object is a user-defined generator function.
177
178 Generator function objects provides same attributes as functions.
179
Alexander Belopolsky977a6842010-08-16 20:17:07 +0000180 See help(isfunction) for attributes listing."""
Georg Brandlb1441c72009-01-03 22:33:39 +0000181 return bool((isfunction(object) or ismethod(object)) and
182 object.__code__.co_flags & CO_GENERATOR)
Christian Heimes7131fd92008-02-19 14:21:46 +0000183
184def isgenerator(object):
185 """Return true if the object is a generator.
186
187 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300188 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000189 close raises a new GeneratorExit exception inside the
190 generator to terminate the iteration
191 gi_code code object
192 gi_frame frame object or possibly None once the generator has
193 been exhausted
194 gi_running set to 1 when generator is executing, 0 otherwise
195 next return the next item from the container
196 send resumes the generator and "sends" a value that becomes
197 the result of the current yield-expression
198 throw used to raise an exception inside the generator"""
199 return isinstance(object, types.GeneratorType)
200
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000201def istraceback(object):
202 """Return true if the object is a traceback.
203
204 Traceback objects provide these attributes:
205 tb_frame frame object at this level
206 tb_lasti index of last attempted instruction in bytecode
207 tb_lineno current line number in Python source code
208 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000209 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000210
211def isframe(object):
212 """Return true if the object is a frame object.
213
214 Frame objects provide these attributes:
215 f_back next outer frame object (this frame's caller)
216 f_builtins built-in namespace seen by this frame
217 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000218 f_globals global namespace seen by this frame
219 f_lasti index of last attempted instruction in bytecode
220 f_lineno current line number in Python source code
221 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000222 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000223 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000224
225def iscode(object):
226 """Return true if the object is a code object.
227
228 Code objects provide these attributes:
229 co_argcount number of arguments (not including * or ** args)
230 co_code string of raw compiled bytecode
231 co_consts tuple of constants used in the bytecode
232 co_filename name of file in which this code object was created
233 co_firstlineno number of first line in Python source code
234 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
235 co_lnotab encoded mapping of line numbers to bytecode indices
236 co_name name with which this code object was defined
237 co_names tuple of names of local variables
238 co_nlocals number of local variables
239 co_stacksize virtual machine stack space required
240 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000241 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000242
243def isbuiltin(object):
244 """Return true if the object is a built-in function or method.
245
246 Built-in functions and methods provide these attributes:
247 __doc__ documentation string
248 __name__ original name of this function or method
249 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000250 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000251
252def isroutine(object):
253 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000254 return (isbuiltin(object)
255 or isfunction(object)
256 or ismethod(object)
257 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000258
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000259def isabstract(object):
260 """Return true if the object is an abstract base class (ABC)."""
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000261 return bool(isinstance(object, type) and object.__flags__ & TPFLAGS_IS_ABSTRACT)
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000262
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000263def getmembers(object, predicate=None):
264 """Return all members of an object as (name, value) pairs sorted by name.
265 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100266 if isclass(object):
267 mro = (object,) + getmro(object)
268 else:
269 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000270 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700271 processed = set()
272 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700273 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700274 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700275 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700276 try:
277 for base in object.__bases__:
278 for k, v in base.__dict__.items():
279 if isinstance(v, types.DynamicClassAttribute):
280 names.append(k)
281 except AttributeError:
282 pass
283 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700284 # First try to get the value via getattr. Some descriptors don't
285 # like calling their __get__ (see bug #1785), so fall back to
286 # looking in the __dict__.
287 try:
288 value = getattr(object, key)
289 # handle the duplicate key
290 if key in processed:
291 raise AttributeError
292 except AttributeError:
293 for base in mro:
294 if key in base.__dict__:
295 value = base.__dict__[key]
296 break
297 else:
298 # could be a (currently) missing slot member, or a buggy
299 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100300 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000301 if not predicate or predicate(value):
302 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700303 processed.add(key)
304 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000305 return results
306
Christian Heimes25bb7832008-01-11 16:17:00 +0000307Attribute = namedtuple('Attribute', 'name kind defining_class object')
308
Tim Peters13b49d32001-09-23 02:00:29 +0000309def classify_class_attrs(cls):
310 """Return list of attribute-descriptor tuples.
311
312 For each name in dir(cls), the return list contains a 4-tuple
313 with these elements:
314
315 0. The name (a string).
316
317 1. The kind of attribute this is, one of these strings:
318 'class method' created via classmethod()
319 'static method' created via staticmethod()
320 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700321 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000322 'data' not a method
323
324 2. The class which defined this attribute (a class).
325
Ethan Furmane03ea372013-09-25 07:14:41 -0700326 3. The object as obtained by calling getattr; if this fails, or if the
327 resulting object does not live anywhere in the class' mro (including
328 metaclasses) then the object is looked up in the defining class's
329 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700330
331 If one of the items in dir(cls) is stored in the metaclass it will now
332 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700333 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000334 """
335
336 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700337 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Ethan Furmane03ea372013-09-25 07:14:41 -0700338 metamro = tuple([cls for cls in metamro if cls not in (type, object)])
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700339 class_bases = (cls,) + mro
340 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000341 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700342 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700343 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700344 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700345 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700346 for k, v in base.__dict__.items():
347 if isinstance(v, types.DynamicClassAttribute):
348 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000349 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700350 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700351
Tim Peters13b49d32001-09-23 02:00:29 +0000352 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100353 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700354 # Normal objects will be looked up with both getattr and directly in
355 # its class' dict (in case getattr fails [bug #1785], and also to look
356 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700357 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700358 # class's dict.
359 #
Tim Peters13b49d32001-09-23 02:00:29 +0000360 # Getting an obj from the __dict__ sometimes reveals more than
361 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100362 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700363 get_obj = None
364 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700365 if name not in processed:
366 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700367 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700368 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700369 get_obj = getattr(cls, name)
370 except Exception as exc:
371 pass
372 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700373 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700374 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700375 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700376 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700377 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700378 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700379 # first look in the classes
380 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700381 srch_obj = getattr(srch_cls, name, None)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700382 if srch_obj == get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700383 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700384 # then check the metaclasses
385 for srch_cls in metamro:
386 try:
387 srch_obj = srch_cls.__getattr__(cls, name)
388 except AttributeError:
389 continue
390 if srch_obj == get_obj:
391 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700392 if last_cls is not None:
393 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700394 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700395 if name in base.__dict__:
396 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700397 if homecls not in metamro:
398 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700399 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700400 if homecls is None:
401 # unable to locate the attribute anywhere, most likely due to
402 # buggy custom __dir__; discard and move on
403 continue
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700404 obj = get_obj or dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700405 # Classify the object or its descriptor.
Ethan Furman63c141c2013-10-18 00:27:39 -0700406 if isinstance(dict_obj, staticmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000407 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700408 obj = dict_obj
Ethan Furman63c141c2013-10-18 00:27:39 -0700409 elif isinstance(dict_obj, classmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000410 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700411 obj = dict_obj
412 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000413 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700414 obj = dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700415 elif isfunction(obj) or ismethoddescriptor(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000416 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100417 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700418 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000419 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700420 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000421 return result
422
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000423# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000424
425def getmro(cls):
426 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000427 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000428
Nick Coghlane8c45d62013-07-28 20:00:01 +1000429# -------------------------------------------------------- function helpers
430
431def unwrap(func, *, stop=None):
432 """Get the object wrapped by *func*.
433
434 Follows the chain of :attr:`__wrapped__` attributes returning the last
435 object in the chain.
436
437 *stop* is an optional callback accepting an object in the wrapper chain
438 as its sole argument that allows the unwrapping to be terminated early if
439 the callback returns a true value. If the callback never returns a true
440 value, the last object in the chain is returned as usual. For example,
441 :func:`signature` uses this to stop unwrapping if any object in the
442 chain has a ``__signature__`` attribute defined.
443
444 :exc:`ValueError` is raised if a cycle is encountered.
445
446 """
447 if stop is None:
448 def _is_wrapper(f):
449 return hasattr(f, '__wrapped__')
450 else:
451 def _is_wrapper(f):
452 return hasattr(f, '__wrapped__') and not stop(f)
453 f = func # remember the original func for error reporting
454 memo = {id(f)} # Memoise by id to tolerate non-hashable objects
455 while _is_wrapper(func):
456 func = func.__wrapped__
457 id_func = id(func)
458 if id_func in memo:
459 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
460 memo.add(id_func)
461 return func
462
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000463# -------------------------------------------------- source code extraction
464def indentsize(line):
465 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000466 expline = line.expandtabs()
467 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000468
469def getdoc(object):
470 """Get the documentation string for an object.
471
472 All tabs are expanded to spaces. To clean up docstrings that are
473 indented to line up with blocks of code, any whitespace than can be
474 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000475 try:
476 doc = object.__doc__
477 except AttributeError:
478 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000479 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000480 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000481 return cleandoc(doc)
482
483def cleandoc(doc):
484 """Clean up indentation from docstrings.
485
486 Any whitespace that can be uniformly removed from the second line
487 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000488 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000489 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000490 except UnicodeError:
491 return None
492 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000493 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000494 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000495 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000496 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000497 if content:
498 indent = len(line) - content
499 margin = min(margin, indent)
500 # Remove indentation.
501 if lines:
502 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000503 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000504 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000505 # Remove any trailing or leading blank lines.
506 while lines and not lines[-1]:
507 lines.pop()
508 while lines and not lines[0]:
509 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000510 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000511
512def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000513 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000514 if ismodule(object):
515 if hasattr(object, '__file__'):
516 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000517 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000518 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500519 if hasattr(object, '__module__'):
520 object = sys.modules.get(object.__module__)
521 if hasattr(object, '__file__'):
522 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000523 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000524 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000525 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000526 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000527 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000528 if istraceback(object):
529 object = object.tb_frame
530 if isframe(object):
531 object = object.f_code
532 if iscode(object):
533 return object.co_filename
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000534 raise TypeError('{!r} is not a module, class, method, '
535 'function, traceback, frame, or code object'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000536
Christian Heimes25bb7832008-01-11 16:17:00 +0000537ModuleInfo = namedtuple('ModuleInfo', 'name suffix mode module_type')
538
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000539def getmoduleinfo(path):
540 """Get the module name, suffix, mode, and module type for a given file."""
Brett Cannoncb66eb02012-05-11 12:58:42 -0400541 warnings.warn('inspect.getmoduleinfo() is deprecated', DeprecationWarning,
542 2)
Brett Cannone4f41de2013-06-16 13:13:40 -0400543 with warnings.catch_warnings():
544 warnings.simplefilter('ignore', PendingDeprecationWarning)
545 import imp
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000546 filename = os.path.basename(path)
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000547 suffixes = [(-len(suffix), suffix, mode, mtype)
548 for suffix, mode, mtype in imp.get_suffixes()]
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000549 suffixes.sort() # try longest suffixes first, in case they overlap
550 for neglen, suffix, mode, mtype in suffixes:
551 if filename[neglen:] == suffix:
Christian Heimes25bb7832008-01-11 16:17:00 +0000552 return ModuleInfo(filename[:neglen], suffix, mode, mtype)
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000553
554def getmodulename(path):
555 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000556 fname = os.path.basename(path)
557 # Check for paths that look like an actual module file
558 suffixes = [(-len(suffix), suffix)
559 for suffix in importlib.machinery.all_suffixes()]
560 suffixes.sort() # try longest suffixes first, in case they overlap
561 for neglen, suffix in suffixes:
562 if fname.endswith(suffix):
563 return fname[:neglen]
564 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000565
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000566def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000567 """Return the filename that can be used to locate an object's source.
568 Return None if no way can be identified to get the source.
569 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000570 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400571 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
572 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
573 if any(filename.endswith(s) for s in all_bytecode_suffixes):
574 filename = (os.path.splitext(filename)[0] +
575 importlib.machinery.SOURCE_SUFFIXES[0])
576 elif any(filename.endswith(s) for s in
577 importlib.machinery.EXTENSION_SUFFIXES):
578 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000579 if os.path.exists(filename):
580 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000581 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400582 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000583 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000584 # or it is in the linecache
585 if filename in linecache.cache:
586 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000587
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000588def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000589 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000590
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000591 The idea is for each object to have a unique origin, so this routine
592 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000593 if _filename is None:
594 _filename = getsourcefile(object) or getfile(object)
595 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000596
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000597modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000598_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000599
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000600def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000601 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000602 if ismodule(object):
603 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000604 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000605 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000606 # Try the filename to modulename cache
607 if _filename is not None and _filename in modulesbyfile:
608 return sys.modules.get(modulesbyfile[_filename])
609 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000610 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000611 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000612 except TypeError:
613 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000614 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000615 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000616 # Update the filename to module name cache and check yet again
617 # Copy sys.modules in order to cope with changes while iterating
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100618 for modname, module in list(sys.modules.items()):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000619 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000620 f = module.__file__
621 if f == _filesbymodname.get(modname, None):
622 # Have already mapped this module, so skip it
623 continue
624 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000625 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000626 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000627 modulesbyfile[f] = modulesbyfile[
628 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000629 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000630 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000631 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000632 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000633 if not hasattr(object, '__name__'):
634 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000635 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000636 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000637 if mainobject is object:
638 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000639 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000640 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000641 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000642 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000643 if builtinobject is object:
644 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000645
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000646def findsource(object):
647 """Return the entire source file and starting line number for an object.
648
649 The argument may be a module, class, method, function, traceback, frame,
650 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200651 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000652 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500653
654 file = getfile(object)
655 sourcefile = getsourcefile(object)
Ezio Melotti1b145922013-03-30 05:17:24 +0200656 if not sourcefile and file[:1] + file[-1:] != '<>':
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200657 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500658 file = sourcefile if sourcefile else file
659
Thomas Wouters89f507f2006-12-13 04:49:30 +0000660 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000661 if module:
662 lines = linecache.getlines(file, module.__dict__)
663 else:
664 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000665 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200666 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000667
668 if ismodule(object):
669 return lines, 0
670
671 if isclass(object):
672 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000673 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
674 # make some effort to find the best matching class definition:
675 # use the one with the least indentation, which is the one
676 # that's most probably not inside a function definition.
677 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000678 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000679 match = pat.match(lines[i])
680 if match:
681 # if it's at toplevel, it's already the best one
682 if lines[i][0] == 'c':
683 return lines, i
684 # else add whitespace to candidate list
685 candidates.append((match.group(1), i))
686 if candidates:
687 # this will sort by whitespace, and by line number,
688 # less whitespace first
689 candidates.sort()
690 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000691 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200692 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000693
694 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000695 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000696 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000697 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000698 if istraceback(object):
699 object = object.tb_frame
700 if isframe(object):
701 object = object.f_code
702 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000703 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200704 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000705 lnum = object.co_firstlineno - 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000706 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000707 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000708 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000709 lnum = lnum - 1
710 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200711 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000712
713def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000714 """Get lines of comments immediately preceding an object's source code.
715
716 Returns None when source can't be found.
717 """
718 try:
719 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200720 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000721 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000722
723 if ismodule(object):
724 # Look for a comment block at the top of the file.
725 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000726 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000727 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000728 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000729 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000730 comments = []
731 end = start
732 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000733 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000734 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000735 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000736
737 # Look for a preceding block of comments at the same indentation.
738 elif lnum > 0:
739 indent = indentsize(lines[lnum])
740 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000741 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000742 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000743 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000744 if end > 0:
745 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000746 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000747 while comment[:1] == '#' and indentsize(lines[end]) == indent:
748 comments[:0] = [comment]
749 end = end - 1
750 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000751 comment = lines[end].expandtabs().lstrip()
752 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000753 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000754 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000755 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000756 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000757
Tim Peters4efb6e92001-06-29 23:51:08 +0000758class EndOfBlock(Exception): pass
759
760class BlockFinder:
761 """Provide a tokeneater() method to detect the end of a code block."""
762 def __init__(self):
763 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000764 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000765 self.started = False
766 self.passline = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000767 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000768
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000769 def tokeneater(self, type, token, srowcol, erowcol, line):
Tim Peters4efb6e92001-06-29 23:51:08 +0000770 if not self.started:
Armin Rigodd5c0232005-09-25 11:45:45 +0000771 # look for the first "def", "class" or "lambda"
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000772 if token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000773 if token == "lambda":
774 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000775 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000776 self.passline = True # skip to the end of the line
Tim Peters4efb6e92001-06-29 23:51:08 +0000777 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000778 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000779 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000780 if self.islambda: # lambdas always end at the first NEWLINE
781 raise EndOfBlock
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000782 elif self.passline:
783 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000784 elif type == tokenize.INDENT:
785 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000786 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000787 elif type == tokenize.DEDENT:
788 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000789 # the end of matching indent/dedent pairs end a block
790 # (note that this only works for "def"/"class" blocks,
791 # not e.g. for "if: else:" or "try: finally:" blocks)
792 if self.indent <= 0:
793 raise EndOfBlock
794 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
795 # any other token on the same indentation level end the previous
796 # block as well, except the pseudo-tokens COMMENT and NL.
797 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000798
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000799def getblock(lines):
800 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000801 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000802 try:
Trent Nelson428de652008-03-18 22:41:35 +0000803 tokens = tokenize.generate_tokens(iter(lines).__next__)
804 for _token in tokens:
805 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000806 except (EndOfBlock, IndentationError):
807 pass
808 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000809
810def getsourcelines(object):
811 """Return a list of source lines and starting line number for an object.
812
813 The argument may be a module, class, method, function, traceback, frame,
814 or code object. The source code is returned as a list of the lines
815 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200816 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000817 raised if the source code cannot be retrieved."""
818 lines, lnum = findsource(object)
819
820 if ismodule(object): return lines, 0
821 else: return getblock(lines[lnum:]), lnum + 1
822
823def getsource(object):
824 """Return the text of the source code for an object.
825
826 The argument may be a module, class, method, function, traceback, frame,
827 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200828 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000829 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000830 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000831
832# --------------------------------------------------- class tree extraction
833def walktree(classes, children, parent):
834 """Recursive helper function for getclasstree()."""
835 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000836 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000837 for c in classes:
838 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000839 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000840 results.append(walktree(children[c], children, c))
841 return results
842
Georg Brandl5ce83a02009-06-01 17:23:51 +0000843def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000844 """Arrange the given list of classes into a hierarchy of nested lists.
845
846 Where a nested list appears, it contains classes derived from the class
847 whose entry immediately precedes the list. Each entry is a 2-tuple
848 containing a class and a tuple of its base classes. If the 'unique'
849 argument is true, exactly one entry appears in the returned structure
850 for each class in the given list. Otherwise, classes using multiple
851 inheritance and their descendants will appear multiple times."""
852 children = {}
853 roots = []
854 for c in classes:
855 if c.__bases__:
856 for parent in c.__bases__:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000857 if not parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000858 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +0300859 if c not in children[parent]:
860 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000861 if unique and parent in classes: break
862 elif c not in roots:
863 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +0000864 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000865 if parent not in classes:
866 roots.append(parent)
867 return walktree(roots, children, None)
868
869# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +0000870Arguments = namedtuple('Arguments', 'args, varargs, varkw')
871
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000872def getargs(co):
873 """Get information about the arguments accepted by a code object.
874
Guido van Rossum2e65f892007-02-28 22:03:49 +0000875 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000876 'args' is the list of argument names. Keyword-only arguments are
877 appended. 'varargs' and 'varkw' are the names of the * and **
878 arguments or None."""
Guido van Rossum2e65f892007-02-28 22:03:49 +0000879 args, varargs, kwonlyargs, varkw = _getfullargs(co)
Christian Heimes25bb7832008-01-11 16:17:00 +0000880 return Arguments(args + kwonlyargs, varargs, varkw)
Guido van Rossum2e65f892007-02-28 22:03:49 +0000881
882def _getfullargs(co):
883 """Get information about the arguments accepted by a code object.
884
885 Four things are returned: (args, varargs, kwonlyargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000886 'args' and 'kwonlyargs' are lists of argument names, and 'varargs'
887 and 'varkw' are the names of the * and ** arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +0000888
889 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000890 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000891
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000892 nargs = co.co_argcount
893 names = co.co_varnames
Guido van Rossum2e65f892007-02-28 22:03:49 +0000894 nkwargs = co.co_kwonlyargcount
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000895 args = list(names[:nargs])
Guido van Rossum2e65f892007-02-28 22:03:49 +0000896 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000897 step = 0
898
Guido van Rossum2e65f892007-02-28 22:03:49 +0000899 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000900 varargs = None
901 if co.co_flags & CO_VARARGS:
902 varargs = co.co_varnames[nargs]
903 nargs = nargs + 1
904 varkw = None
905 if co.co_flags & CO_VARKEYWORDS:
906 varkw = co.co_varnames[nargs]
Guido van Rossum2e65f892007-02-28 22:03:49 +0000907 return args, varargs, kwonlyargs, varkw
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000908
Christian Heimes25bb7832008-01-11 16:17:00 +0000909
910ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
911
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000912def getargspec(func):
913 """Get the names and default values of a function's arguments.
914
915 A tuple of four things is returned: (args, varargs, varkw, defaults).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000916 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000917 'args' will include keyword-only argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000918 'varargs' and 'varkw' are the names of the * and ** arguments or None.
Jeremy Hylton64967882003-06-27 18:14:39 +0000919 'defaults' is an n-tuple of the default values of the last n arguments.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000920
Guido van Rossum2e65f892007-02-28 22:03:49 +0000921 Use the getfullargspec() API for Python-3000 code, as annotations
922 and keyword arguments are supported. getargspec() will raise ValueError
923 if the func has either annotations or keyword arguments.
924 """
925
926 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
927 getfullargspec(func)
928 if kwonlyargs or ann:
Collin Winterce36ad82007-08-30 01:19:48 +0000929 raise ValueError("Function has keyword-only arguments or annotations"
930 ", use getfullargspec() API which can support them")
Christian Heimes25bb7832008-01-11 16:17:00 +0000931 return ArgSpec(args, varargs, varkw, defaults)
932
933FullArgSpec = namedtuple('FullArgSpec',
Benjamin Peterson3d4ca742008-11-12 21:39:01 +0000934 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +0000935
936def getfullargspec(func):
937 """Get the names and default values of a function's arguments.
938
Brett Cannon504d8852007-09-07 02:12:14 +0000939 A tuple of seven things is returned:
940 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults annotations).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000941 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000942 'varargs' and 'varkw' are the names of the * and ** arguments or None.
943 'defaults' is an n-tuple of the default values of the last n arguments.
944 'kwonlyargs' is a list of keyword-only argument names.
945 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
946 'annotations' is a dictionary mapping argument names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000947
Guido van Rossum2e65f892007-02-28 22:03:49 +0000948 The first four items in the tuple correspond to getargspec().
Jeremy Hylton64967882003-06-27 18:14:39 +0000949 """
950
951 if ismethod(func):
Christian Heimesff737952007-11-27 10:40:20 +0000952 func = func.__func__
Jeremy Hylton64967882003-06-27 18:14:39 +0000953 if not isfunction(func):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000954 raise TypeError('{!r} is not a Python function'.format(func))
Guido van Rossum2e65f892007-02-28 22:03:49 +0000955 args, varargs, kwonlyargs, varkw = _getfullargs(func.__code__)
Christian Heimes25bb7832008-01-11 16:17:00 +0000956 return FullArgSpec(args, varargs, varkw, func.__defaults__,
Guido van Rossum2e65f892007-02-28 22:03:49 +0000957 kwonlyargs, func.__kwdefaults__, func.__annotations__)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000958
Christian Heimes25bb7832008-01-11 16:17:00 +0000959ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
960
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000961def getargvalues(frame):
962 """Get information about arguments passed into a particular frame.
963
964 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000965 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000966 'varargs' and 'varkw' are the names of the * and ** arguments or None.
967 'locals' is the locals dictionary of the given frame."""
968 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +0000969 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000970
Guido van Rossum2e65f892007-02-28 22:03:49 +0000971def formatannotation(annotation, base_module=None):
972 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +0000973 if annotation.__module__ in ('builtins', base_module):
Guido van Rossum2e65f892007-02-28 22:03:49 +0000974 return annotation.__name__
975 return annotation.__module__+'.'+annotation.__name__
976 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000977
Guido van Rossum2e65f892007-02-28 22:03:49 +0000978def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000979 module = getattr(object, '__module__', None)
980 def _formatannotation(annotation):
981 return formatannotation(annotation, module)
982 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +0000983
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000984def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +0000985 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000986 formatarg=str,
987 formatvarargs=lambda name: '*' + name,
988 formatvarkw=lambda name: '**' + name,
989 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +0000990 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000991 formatannotation=formatannotation):
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000992 """Format an argument spec from the values returned by getargspec
Guido van Rossum2e65f892007-02-28 22:03:49 +0000993 or getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000994
Guido van Rossum2e65f892007-02-28 22:03:49 +0000995 The first seven arguments are (args, varargs, varkw, defaults,
996 kwonlyargs, kwonlydefaults, annotations). The other five arguments
997 are the corresponding optional formatting functions that are called to
998 turn names and values into strings. The last argument is an optional
999 function to format the sequence of arguments."""
1000 def formatargandannotation(arg):
1001 result = formatarg(arg)
1002 if arg in annotations:
1003 result += ': ' + formatannotation(annotations[arg])
1004 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001005 specs = []
1006 if defaults:
1007 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001008 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001009 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001010 if defaults and i >= firstdefault:
1011 spec = spec + formatvalue(defaults[i - firstdefault])
1012 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001013 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001014 specs.append(formatvarargs(formatargandannotation(varargs)))
1015 else:
1016 if kwonlyargs:
1017 specs.append('*')
1018 if kwonlyargs:
1019 for kwonlyarg in kwonlyargs:
1020 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001021 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001022 spec += formatvalue(kwonlydefaults[kwonlyarg])
1023 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001024 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001025 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001026 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001027 if 'return' in annotations:
1028 result += formatreturns(formatannotation(annotations['return']))
1029 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001030
1031def formatargvalues(args, varargs, varkw, locals,
1032 formatarg=str,
1033 formatvarargs=lambda name: '*' + name,
1034 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001035 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001036 """Format an argument spec from the 4 values returned by getargvalues.
1037
1038 The first four arguments are (args, varargs, varkw, locals). The
1039 next four arguments are the corresponding optional formatting functions
1040 that are called to turn names and values into strings. The ninth
1041 argument is an optional function to format the sequence of arguments."""
1042 def convert(name, locals=locals,
1043 formatarg=formatarg, formatvalue=formatvalue):
1044 return formatarg(name) + formatvalue(locals[name])
1045 specs = []
1046 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001047 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001048 if varargs:
1049 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1050 if varkw:
1051 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001052 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001053
Benjamin Petersone109c702011-06-24 09:37:26 -05001054def _missing_arguments(f_name, argnames, pos, values):
1055 names = [repr(name) for name in argnames if name not in values]
1056 missing = len(names)
1057 if missing == 1:
1058 s = names[0]
1059 elif missing == 2:
1060 s = "{} and {}".format(*names)
1061 else:
1062 tail = ", {} and {}".format(names[-2:])
1063 del names[-2:]
1064 s = ", ".join(names) + tail
1065 raise TypeError("%s() missing %i required %s argument%s: %s" %
1066 (f_name, missing,
1067 "positional" if pos else "keyword-only",
1068 "" if missing == 1 else "s", s))
1069
1070def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001071 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001072 kwonly_given = len([arg for arg in kwonly if arg in values])
1073 if varargs:
1074 plural = atleast != 1
1075 sig = "at least %d" % (atleast,)
1076 elif defcount:
1077 plural = True
1078 sig = "from %d to %d" % (atleast, len(args))
1079 else:
1080 plural = len(args) != 1
1081 sig = str(len(args))
1082 kwonly_sig = ""
1083 if kwonly_given:
1084 msg = " positional argument%s (and %d keyword-only argument%s)"
1085 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1086 "s" if kwonly_given != 1 else ""))
1087 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1088 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1089 "was" if given == 1 and not kwonly_given else "were"))
1090
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001091def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001092 """Get the mapping of arguments to values.
1093
1094 A dict is returned, with keys the function argument names (including the
1095 names of the * and ** arguments, if any), and values the respective bound
1096 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001097 func = func_and_positional[0]
1098 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001099 spec = getfullargspec(func)
1100 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1101 f_name = func.__name__
1102 arg2value = {}
1103
Benjamin Petersonb204a422011-06-05 22:04:07 -05001104
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001105 if ismethod(func) and func.__self__ is not None:
1106 # implicit 'self' (or 'cls' for classmethods) argument
1107 positional = (func.__self__,) + positional
1108 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001109 num_args = len(args)
1110 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001111
Benjamin Petersonb204a422011-06-05 22:04:07 -05001112 n = min(num_pos, num_args)
1113 for i in range(n):
1114 arg2value[args[i]] = positional[i]
1115 if varargs:
1116 arg2value[varargs] = tuple(positional[n:])
1117 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001118 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001119 arg2value[varkw] = {}
1120 for kw, value in named.items():
1121 if kw not in possible_kwargs:
1122 if not varkw:
1123 raise TypeError("%s() got an unexpected keyword argument %r" %
1124 (f_name, kw))
1125 arg2value[varkw][kw] = value
1126 continue
1127 if kw in arg2value:
1128 raise TypeError("%s() got multiple values for argument %r" %
1129 (f_name, kw))
1130 arg2value[kw] = value
1131 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001132 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1133 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001134 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001135 req = args[:num_args - num_defaults]
1136 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001137 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001138 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001139 for i, arg in enumerate(args[num_args - num_defaults:]):
1140 if arg not in arg2value:
1141 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001142 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001143 for kwarg in kwonlyargs:
1144 if kwarg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001145 if kwarg in kwonlydefaults:
1146 arg2value[kwarg] = kwonlydefaults[kwarg]
1147 else:
1148 missing += 1
1149 if missing:
1150 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001151 return arg2value
1152
Nick Coghlan2f92e542012-06-23 19:39:55 +10001153ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1154
1155def getclosurevars(func):
1156 """
1157 Get the mapping of free variables to their current values.
1158
Meador Inge8fda3592012-07-19 21:33:21 -05001159 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001160 and builtin references as seen by the body of the function. A final
1161 set of unbound names that could not be resolved is also provided.
1162 """
1163
1164 if ismethod(func):
1165 func = func.__func__
1166
1167 if not isfunction(func):
1168 raise TypeError("'{!r}' is not a Python function".format(func))
1169
1170 code = func.__code__
1171 # Nonlocal references are named in co_freevars and resolved
1172 # by looking them up in __closure__ by positional index
1173 if func.__closure__ is None:
1174 nonlocal_vars = {}
1175 else:
1176 nonlocal_vars = {
1177 var : cell.cell_contents
1178 for var, cell in zip(code.co_freevars, func.__closure__)
1179 }
1180
1181 # Global and builtin references are named in co_names and resolved
1182 # by looking them up in __globals__ or __builtins__
1183 global_ns = func.__globals__
1184 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1185 if ismodule(builtin_ns):
1186 builtin_ns = builtin_ns.__dict__
1187 global_vars = {}
1188 builtin_vars = {}
1189 unbound_names = set()
1190 for name in code.co_names:
1191 if name in ("None", "True", "False"):
1192 # Because these used to be builtins instead of keywords, they
1193 # may still show up as name references. We ignore them.
1194 continue
1195 try:
1196 global_vars[name] = global_ns[name]
1197 except KeyError:
1198 try:
1199 builtin_vars[name] = builtin_ns[name]
1200 except KeyError:
1201 unbound_names.add(name)
1202
1203 return ClosureVars(nonlocal_vars, global_vars,
1204 builtin_vars, unbound_names)
1205
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001206# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001207
1208Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1209
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001210def getframeinfo(frame, context=1):
1211 """Get information about a frame or traceback object.
1212
1213 A tuple of five things is returned: the filename, the line number of
1214 the current line, the function name, a list of lines of context from
1215 the source code, and the index of the current line within that list.
1216 The optional second argument specifies the number of lines of context
1217 to return, which are centered around the current line."""
1218 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001219 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001220 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001221 else:
1222 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001223 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001224 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001225
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001226 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001227 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001228 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001229 try:
1230 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001231 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001232 lines = index = None
1233 else:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001234 start = max(start, 1)
Raymond Hettingera0501712004-06-15 11:22:53 +00001235 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001236 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001237 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001238 else:
1239 lines = index = None
1240
Christian Heimes25bb7832008-01-11 16:17:00 +00001241 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001242
1243def getlineno(frame):
1244 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001245 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1246 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001247
1248def getouterframes(frame, context=1):
1249 """Get a list of records for a frame and all higher (calling) frames.
1250
1251 Each record contains a frame object, filename, line number, function
1252 name, a list of lines of context, and index within the context."""
1253 framelist = []
1254 while frame:
1255 framelist.append((frame,) + getframeinfo(frame, context))
1256 frame = frame.f_back
1257 return framelist
1258
1259def getinnerframes(tb, context=1):
1260 """Get a list of records for a traceback's frame and all lower frames.
1261
1262 Each record contains a frame object, filename, line number, function
1263 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001264 framelist = []
1265 while tb:
1266 framelist.append((tb.tb_frame,) + getframeinfo(tb, context))
1267 tb = tb.tb_next
1268 return framelist
1269
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001270def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001271 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001272 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001273
1274def stack(context=1):
1275 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001276 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001277
1278def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001279 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001280 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001281
1282
1283# ------------------------------------------------ static version of getattr
1284
1285_sentinel = object()
1286
Michael Foorde5162652010-11-20 16:40:44 +00001287def _static_getmro(klass):
1288 return type.__dict__['__mro__'].__get__(klass)
1289
Michael Foord95fc51d2010-11-20 15:07:30 +00001290def _check_instance(obj, attr):
1291 instance_dict = {}
1292 try:
1293 instance_dict = object.__getattribute__(obj, "__dict__")
1294 except AttributeError:
1295 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001296 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001297
1298
1299def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001300 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001301 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001302 try:
1303 return entry.__dict__[attr]
1304 except KeyError:
1305 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001306 return _sentinel
1307
Michael Foord35184ed2010-11-20 16:58:30 +00001308def _is_type(obj):
1309 try:
1310 _static_getmro(obj)
1311 except TypeError:
1312 return False
1313 return True
1314
Michael Foorddcebe0f2011-03-15 19:20:44 -04001315def _shadowed_dict(klass):
1316 dict_attr = type.__dict__["__dict__"]
1317 for entry in _static_getmro(klass):
1318 try:
1319 class_dict = dict_attr.__get__(entry)["__dict__"]
1320 except KeyError:
1321 pass
1322 else:
1323 if not (type(class_dict) is types.GetSetDescriptorType and
1324 class_dict.__name__ == "__dict__" and
1325 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001326 return class_dict
1327 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001328
1329def getattr_static(obj, attr, default=_sentinel):
1330 """Retrieve attributes without triggering dynamic lookup via the
1331 descriptor protocol, __getattr__ or __getattribute__.
1332
1333 Note: this function may not be able to retrieve all attributes
1334 that getattr can fetch (like dynamically created attributes)
1335 and may find attributes that getattr can't (like descriptors
1336 that raise AttributeError). It can also return descriptor objects
1337 instead of instance members in some cases. See the
1338 documentation for details.
1339 """
1340 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001341 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001342 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001343 dict_attr = _shadowed_dict(klass)
1344 if (dict_attr is _sentinel or
1345 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001346 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001347 else:
1348 klass = obj
1349
1350 klass_result = _check_class(klass, attr)
1351
1352 if instance_result is not _sentinel and klass_result is not _sentinel:
1353 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1354 _check_class(type(klass_result), '__set__') is not _sentinel):
1355 return klass_result
1356
1357 if instance_result is not _sentinel:
1358 return instance_result
1359 if klass_result is not _sentinel:
1360 return klass_result
1361
1362 if obj is klass:
1363 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001364 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001365 if _shadowed_dict(type(entry)) is _sentinel:
1366 try:
1367 return entry.__dict__[attr]
1368 except KeyError:
1369 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001370 if default is not _sentinel:
1371 return default
1372 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001373
1374
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001375# ------------------------------------------------ generator introspection
1376
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001377GEN_CREATED = 'GEN_CREATED'
1378GEN_RUNNING = 'GEN_RUNNING'
1379GEN_SUSPENDED = 'GEN_SUSPENDED'
1380GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001381
1382def getgeneratorstate(generator):
1383 """Get current state of a generator-iterator.
1384
1385 Possible states are:
1386 GEN_CREATED: Waiting to start execution.
1387 GEN_RUNNING: Currently being executed by the interpreter.
1388 GEN_SUSPENDED: Currently suspended at a yield expression.
1389 GEN_CLOSED: Execution has completed.
1390 """
1391 if generator.gi_running:
1392 return GEN_RUNNING
1393 if generator.gi_frame is None:
1394 return GEN_CLOSED
1395 if generator.gi_frame.f_lasti == -1:
1396 return GEN_CREATED
1397 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001398
1399
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001400def getgeneratorlocals(generator):
1401 """
1402 Get the mapping of generator local variables to their current values.
1403
1404 A dict is returned, with the keys the local variable names and values the
1405 bound values."""
1406
1407 if not isgenerator(generator):
1408 raise TypeError("'{!r}' is not a Python generator".format(generator))
1409
1410 frame = getattr(generator, "gi_frame", None)
1411 if frame is not None:
1412 return generator.gi_frame.f_locals
1413 else:
1414 return {}
1415
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001416###############################################################################
1417### Function Signature Object (PEP 362)
1418###############################################################################
1419
1420
1421_WrapperDescriptor = type(type.__call__)
1422_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001423_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001424
1425_NonUserDefinedCallables = (_WrapperDescriptor,
1426 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001427 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001428 types.BuiltinFunctionType)
1429
1430
1431def _get_user_defined_method(cls, method_name):
1432 try:
1433 meth = getattr(cls, method_name)
1434 except AttributeError:
1435 return
1436 else:
1437 if not isinstance(meth, _NonUserDefinedCallables):
1438 # Once '__signature__' will be added to 'C'-level
1439 # callables, this check won't be necessary
1440 return meth
1441
1442
Yury Selivanov62560fb2014-01-28 12:26:24 -05001443def _signature_get_partial(wrapped_sig, partial, extra_args=()):
1444 # Internal helper to calculate how 'wrapped_sig' signature will
1445 # look like after applying a 'functools.partial' object (or alike)
1446 # on it.
1447
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001448 new_params = OrderedDict(wrapped_sig.parameters.items())
1449
1450 partial_args = partial.args or ()
1451 partial_keywords = partial.keywords or {}
1452
1453 if extra_args:
1454 partial_args = extra_args + partial_args
1455
1456 try:
1457 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1458 except TypeError as ex:
1459 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1460 raise ValueError(msg) from ex
1461
1462 for arg_name, arg_value in ba.arguments.items():
1463 param = new_params[arg_name]
1464 if arg_name in partial_keywords:
1465 # We set a new default value, because the following code
1466 # is correct:
1467 #
1468 # >>> def foo(a): print(a)
1469 # >>> print(partial(partial(foo, a=10), a=20)())
1470 # 20
1471 # >>> print(partial(partial(foo, a=10), a=20)(a=30))
1472 # 30
1473 #
1474 # So, with 'partial' objects, passing a keyword argument is
1475 # like setting a new default value for the corresponding
1476 # parameter
1477 #
1478 # We also mark this parameter with '_partial_kwarg'
1479 # flag. Later, in '_bind', the 'default' value of this
1480 # parameter will be added to 'kwargs', to simulate
1481 # the 'functools.partial' real call.
1482 new_params[arg_name] = param.replace(default=arg_value,
1483 _partial_kwarg=True)
1484
1485 elif (param.kind not in (_VAR_KEYWORD, _VAR_POSITIONAL) and
1486 not param._partial_kwarg):
1487 new_params.pop(arg_name)
1488
1489 return wrapped_sig.replace(parameters=new_params.values())
1490
1491
Yury Selivanov62560fb2014-01-28 12:26:24 -05001492def _signature_bound_method(sig):
1493 # Internal helper to transform signatures for unbound
1494 # functions to bound methods
1495
1496 params = tuple(sig.parameters.values())
1497
1498 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1499 raise ValueError('invalid method signature')
1500
1501 kind = params[0].kind
1502 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1503 # Drop first parameter:
1504 # '(p1, p2[, ...])' -> '(p2[, ...])'
1505 params = params[1:]
1506 else:
1507 if kind is not _VAR_POSITIONAL:
1508 # Unless we add a new parameter type we never
1509 # get here
1510 raise ValueError('invalid argument type')
1511 # It's a var-positional parameter.
1512 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1513
1514 return sig.replace(parameters=params)
1515
1516
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001517def signature(obj):
1518 '''Get a signature object for the passed callable.'''
1519
1520 if not callable(obj):
1521 raise TypeError('{!r} is not a callable object'.format(obj))
1522
Larry Hastings5c661892014-01-24 06:17:25 -08001523 if (isinstance(obj, _NonUserDefinedCallables) or
1524 ismethoddescriptor(obj) or
1525 isinstance(obj, type)):
1526 sig = Signature.from_builtin(obj)
1527 if sig:
1528 return sig
1529
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001530 if isinstance(obj, types.MethodType):
1531 # In this case we skip the first parameter of the underlying
1532 # function (usually `self` or `cls`).
1533 sig = signature(obj.__func__)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001534 return _signature_bound_method(sig)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001535
Nick Coghlane8c45d62013-07-28 20:00:01 +10001536 # Was this function wrapped by a decorator?
1537 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
1538
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001539 try:
1540 sig = obj.__signature__
1541 except AttributeError:
1542 pass
1543 else:
1544 if sig is not None:
1545 return sig
1546
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001547 try:
1548 partialmethod = obj._partialmethod
1549 except AttributeError:
1550 pass
1551 else:
1552 # Unbound partialmethod (see functools.partialmethod)
1553 # This means, that we need to calculate the signature
1554 # as if it's a regular partial object, but taking into
1555 # account that the first positional argument
1556 # (usually `self`, or `cls`) will not be passed
1557 # automatically (as for boundmethods)
1558
1559 wrapped_sig = signature(partialmethod.func)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001560 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001561
1562 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
1563 new_params = (first_wrapped_param,) + tuple(sig.parameters.values())
1564
1565 return sig.replace(parameters=new_params)
1566
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001567 if isinstance(obj, types.FunctionType):
1568 return Signature.from_function(obj)
1569
1570 if isinstance(obj, functools.partial):
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001571 wrapped_sig = signature(obj.func)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001572 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001573
1574 sig = None
1575 if isinstance(obj, type):
1576 # obj is a class or a metaclass
1577
1578 # First, let's see if it has an overloaded __call__ defined
1579 # in its metaclass
1580 call = _get_user_defined_method(type(obj), '__call__')
1581 if call is not None:
1582 sig = signature(call)
1583 else:
1584 # Now we check if the 'obj' class has a '__new__' method
1585 new = _get_user_defined_method(obj, '__new__')
1586 if new is not None:
1587 sig = signature(new)
1588 else:
1589 # Finally, we should have at least __init__ implemented
1590 init = _get_user_defined_method(obj, '__init__')
1591 if init is not None:
1592 sig = signature(init)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05001593
1594 if sig is None:
1595 if type in obj.__mro__:
1596 # 'obj' is a metaclass without user-defined __init__
1597 # or __new__. Return a signature of 'type' builtin.
1598 return signature(type)
1599 else:
1600 # We have a class (not metaclass), but no user-defined
1601 # __init__ or __new__ for it
1602 return signature(object)
1603
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001604 elif not isinstance(obj, _NonUserDefinedCallables):
1605 # An object with __call__
1606 # We also check that the 'obj' is not an instance of
1607 # _WrapperDescriptor or _MethodWrapper to avoid
1608 # infinite recursion (and even potential segfault)
1609 call = _get_user_defined_method(type(obj), '__call__')
1610 if call is not None:
1611 sig = signature(call)
1612
1613 if sig is not None:
1614 # For classes and objects we skip the first parameter of their
1615 # __call__, __new__, or __init__ methods
Yury Selivanov62560fb2014-01-28 12:26:24 -05001616 return _signature_bound_method(sig)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001617
1618 if isinstance(obj, types.BuiltinFunctionType):
1619 # Raise a nicer error message for builtins
1620 msg = 'no signature found for builtin function {!r}'.format(obj)
1621 raise ValueError(msg)
1622
1623 raise ValueError('callable {!r} is not supported by signature'.format(obj))
1624
1625
1626class _void:
1627 '''A private marker - used in Parameter & Signature'''
1628
1629
1630class _empty:
1631 pass
1632
1633
1634class _ParameterKind(int):
1635 def __new__(self, *args, name):
1636 obj = int.__new__(self, *args)
1637 obj._name = name
1638 return obj
1639
1640 def __str__(self):
1641 return self._name
1642
1643 def __repr__(self):
1644 return '<_ParameterKind: {!r}>'.format(self._name)
1645
1646
1647_POSITIONAL_ONLY = _ParameterKind(0, name='POSITIONAL_ONLY')
1648_POSITIONAL_OR_KEYWORD = _ParameterKind(1, name='POSITIONAL_OR_KEYWORD')
1649_VAR_POSITIONAL = _ParameterKind(2, name='VAR_POSITIONAL')
1650_KEYWORD_ONLY = _ParameterKind(3, name='KEYWORD_ONLY')
1651_VAR_KEYWORD = _ParameterKind(4, name='VAR_KEYWORD')
1652
1653
1654class Parameter:
1655 '''Represents a parameter in a function signature.
1656
1657 Has the following public attributes:
1658
1659 * name : str
1660 The name of the parameter as a string.
1661 * default : object
1662 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05001663 parameter has no default value, this attribute is set to
1664 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001665 * annotation
1666 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05001667 parameter has no annotation, this attribute is set to
1668 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001669 * kind : str
1670 Describes how argument values are bound to the parameter.
1671 Possible values: `Parameter.POSITIONAL_ONLY`,
1672 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
1673 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
1674 '''
1675
1676 __slots__ = ('_name', '_kind', '_default', '_annotation', '_partial_kwarg')
1677
1678 POSITIONAL_ONLY = _POSITIONAL_ONLY
1679 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
1680 VAR_POSITIONAL = _VAR_POSITIONAL
1681 KEYWORD_ONLY = _KEYWORD_ONLY
1682 VAR_KEYWORD = _VAR_KEYWORD
1683
1684 empty = _empty
1685
1686 def __init__(self, name, kind, *, default=_empty, annotation=_empty,
1687 _partial_kwarg=False):
1688
1689 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
1690 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
1691 raise ValueError("invalid value for 'Parameter.kind' attribute")
1692 self._kind = kind
1693
1694 if default is not _empty:
1695 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
1696 msg = '{} parameters cannot have default values'.format(kind)
1697 raise ValueError(msg)
1698 self._default = default
1699 self._annotation = annotation
1700
Yury Selivanov2393dca2014-01-27 15:07:58 -05001701 if name is _empty:
1702 raise ValueError('name is a required attribute for Parameter')
1703
1704 if not isinstance(name, str):
1705 raise TypeError("name must be a str, not a {!r}".format(name))
1706
1707 if not name.isidentifier():
1708 raise ValueError('{!r} is not a valid parameter name'.format(name))
1709
1710 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001711
1712 self._partial_kwarg = _partial_kwarg
1713
1714 @property
1715 def name(self):
1716 return self._name
1717
1718 @property
1719 def default(self):
1720 return self._default
1721
1722 @property
1723 def annotation(self):
1724 return self._annotation
1725
1726 @property
1727 def kind(self):
1728 return self._kind
1729
1730 def replace(self, *, name=_void, kind=_void, annotation=_void,
1731 default=_void, _partial_kwarg=_void):
1732 '''Creates a customized copy of the Parameter.'''
1733
1734 if name is _void:
1735 name = self._name
1736
1737 if kind is _void:
1738 kind = self._kind
1739
1740 if annotation is _void:
1741 annotation = self._annotation
1742
1743 if default is _void:
1744 default = self._default
1745
1746 if _partial_kwarg is _void:
1747 _partial_kwarg = self._partial_kwarg
1748
1749 return type(self)(name, kind, default=default, annotation=annotation,
1750 _partial_kwarg=_partial_kwarg)
1751
1752 def __str__(self):
1753 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001754 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001755
1756 # Add annotation and default value
1757 if self._annotation is not _empty:
1758 formatted = '{}:{}'.format(formatted,
1759 formatannotation(self._annotation))
1760
1761 if self._default is not _empty:
1762 formatted = '{}={}'.format(formatted, repr(self._default))
1763
1764 if kind == _VAR_POSITIONAL:
1765 formatted = '*' + formatted
1766 elif kind == _VAR_KEYWORD:
1767 formatted = '**' + formatted
1768
1769 return formatted
1770
1771 def __repr__(self):
1772 return '<{} at {:#x} {!r}>'.format(self.__class__.__name__,
1773 id(self), self.name)
1774
1775 def __eq__(self, other):
1776 return (issubclass(other.__class__, Parameter) and
1777 self._name == other._name and
1778 self._kind == other._kind and
1779 self._default == other._default and
1780 self._annotation == other._annotation)
1781
1782 def __ne__(self, other):
1783 return not self.__eq__(other)
1784
1785
1786class BoundArguments:
1787 '''Result of `Signature.bind` call. Holds the mapping of arguments
1788 to the function's parameters.
1789
1790 Has the following public attributes:
1791
1792 * arguments : OrderedDict
1793 An ordered mutable mapping of parameters' names to arguments' values.
1794 Does not contain arguments' default values.
1795 * signature : Signature
1796 The Signature object that created this instance.
1797 * args : tuple
1798 Tuple of positional arguments values.
1799 * kwargs : dict
1800 Dict of keyword arguments values.
1801 '''
1802
1803 def __init__(self, signature, arguments):
1804 self.arguments = arguments
1805 self._signature = signature
1806
1807 @property
1808 def signature(self):
1809 return self._signature
1810
1811 @property
1812 def args(self):
1813 args = []
1814 for param_name, param in self._signature.parameters.items():
1815 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
1816 param._partial_kwarg):
1817 # Keyword arguments mapped by 'functools.partial'
1818 # (Parameter._partial_kwarg is True) are mapped
1819 # in 'BoundArguments.kwargs', along with VAR_KEYWORD &
1820 # KEYWORD_ONLY
1821 break
1822
1823 try:
1824 arg = self.arguments[param_name]
1825 except KeyError:
1826 # We're done here. Other arguments
1827 # will be mapped in 'BoundArguments.kwargs'
1828 break
1829 else:
1830 if param.kind == _VAR_POSITIONAL:
1831 # *args
1832 args.extend(arg)
1833 else:
1834 # plain argument
1835 args.append(arg)
1836
1837 return tuple(args)
1838
1839 @property
1840 def kwargs(self):
1841 kwargs = {}
1842 kwargs_started = False
1843 for param_name, param in self._signature.parameters.items():
1844 if not kwargs_started:
1845 if (param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY) or
1846 param._partial_kwarg):
1847 kwargs_started = True
1848 else:
1849 if param_name not in self.arguments:
1850 kwargs_started = True
1851 continue
1852
1853 if not kwargs_started:
1854 continue
1855
1856 try:
1857 arg = self.arguments[param_name]
1858 except KeyError:
1859 pass
1860 else:
1861 if param.kind == _VAR_KEYWORD:
1862 # **kwargs
1863 kwargs.update(arg)
1864 else:
1865 # plain keyword argument
1866 kwargs[param_name] = arg
1867
1868 return kwargs
1869
1870 def __eq__(self, other):
1871 return (issubclass(other.__class__, BoundArguments) and
1872 self.signature == other.signature and
1873 self.arguments == other.arguments)
1874
1875 def __ne__(self, other):
1876 return not self.__eq__(other)
1877
1878
1879class Signature:
1880 '''A Signature object represents the overall signature of a function.
1881 It stores a Parameter object for each parameter accepted by the
1882 function, as well as information specific to the function itself.
1883
1884 A Signature object has the following public attributes and methods:
1885
1886 * parameters : OrderedDict
1887 An ordered mapping of parameters' names to the corresponding
1888 Parameter objects (keyword-only arguments are in the same order
1889 as listed in `code.co_varnames`).
1890 * return_annotation : object
1891 The annotation for the return type of the function if specified.
1892 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05001893 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001894 * bind(*args, **kwargs) -> BoundArguments
1895 Creates a mapping from positional and keyword arguments to
1896 parameters.
1897 * bind_partial(*args, **kwargs) -> BoundArguments
1898 Creates a partial mapping from positional and keyword arguments
1899 to parameters (simulating 'functools.partial' behavior.)
1900 '''
1901
1902 __slots__ = ('_return_annotation', '_parameters')
1903
1904 _parameter_cls = Parameter
1905 _bound_arguments_cls = BoundArguments
1906
1907 empty = _empty
1908
1909 def __init__(self, parameters=None, *, return_annotation=_empty,
1910 __validate_parameters__=True):
1911 '''Constructs Signature from the given list of Parameter
1912 objects and 'return_annotation'. All arguments are optional.
1913 '''
1914
1915 if parameters is None:
1916 params = OrderedDict()
1917 else:
1918 if __validate_parameters__:
1919 params = OrderedDict()
1920 top_kind = _POSITIONAL_ONLY
1921
1922 for idx, param in enumerate(parameters):
1923 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05001924 name = param.name
1925
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001926 if kind < top_kind:
1927 msg = 'wrong parameter order: {} before {}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05001928 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001929 raise ValueError(msg)
1930 else:
1931 top_kind = kind
1932
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001933 if name in params:
1934 msg = 'duplicate parameter name: {!r}'.format(name)
1935 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05001936
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001937 params[name] = param
1938 else:
1939 params = OrderedDict(((param.name, param)
1940 for param in parameters))
1941
1942 self._parameters = types.MappingProxyType(params)
1943 self._return_annotation = return_annotation
1944
1945 @classmethod
1946 def from_function(cls, func):
1947 '''Constructs Signature for the given python function'''
1948
1949 if not isinstance(func, types.FunctionType):
1950 raise TypeError('{!r} is not a Python function'.format(func))
1951
1952 Parameter = cls._parameter_cls
1953
1954 # Parameter information.
1955 func_code = func.__code__
1956 pos_count = func_code.co_argcount
1957 arg_names = func_code.co_varnames
1958 positional = tuple(arg_names[:pos_count])
1959 keyword_only_count = func_code.co_kwonlyargcount
1960 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
1961 annotations = func.__annotations__
1962 defaults = func.__defaults__
1963 kwdefaults = func.__kwdefaults__
1964
1965 if defaults:
1966 pos_default_count = len(defaults)
1967 else:
1968 pos_default_count = 0
1969
1970 parameters = []
1971
1972 # Non-keyword-only parameters w/o defaults.
1973 non_default_count = pos_count - pos_default_count
1974 for name in positional[:non_default_count]:
1975 annotation = annotations.get(name, _empty)
1976 parameters.append(Parameter(name, annotation=annotation,
1977 kind=_POSITIONAL_OR_KEYWORD))
1978
1979 # ... w/ defaults.
1980 for offset, name in enumerate(positional[non_default_count:]):
1981 annotation = annotations.get(name, _empty)
1982 parameters.append(Parameter(name, annotation=annotation,
1983 kind=_POSITIONAL_OR_KEYWORD,
1984 default=defaults[offset]))
1985
1986 # *args
1987 if func_code.co_flags & 0x04:
1988 name = arg_names[pos_count + keyword_only_count]
1989 annotation = annotations.get(name, _empty)
1990 parameters.append(Parameter(name, annotation=annotation,
1991 kind=_VAR_POSITIONAL))
1992
1993 # Keyword-only parameters.
1994 for name in keyword_only:
1995 default = _empty
1996 if kwdefaults is not None:
1997 default = kwdefaults.get(name, _empty)
1998
1999 annotation = annotations.get(name, _empty)
2000 parameters.append(Parameter(name, annotation=annotation,
2001 kind=_KEYWORD_ONLY,
2002 default=default))
2003 # **kwargs
2004 if func_code.co_flags & 0x08:
2005 index = pos_count + keyword_only_count
2006 if func_code.co_flags & 0x04:
2007 index += 1
2008
2009 name = arg_names[index]
2010 annotation = annotations.get(name, _empty)
2011 parameters.append(Parameter(name, annotation=annotation,
2012 kind=_VAR_KEYWORD))
2013
2014 return cls(parameters,
2015 return_annotation=annotations.get('return', _empty),
2016 __validate_parameters__=False)
2017
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002018 @classmethod
2019 def from_builtin(cls, func):
2020 s = getattr(func, "__text_signature__", None)
2021 if not s:
2022 return None
2023
Larry Hastings2a727912014-01-16 11:32:01 -08002024 Parameter = cls._parameter_cls
2025
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002026 if s.endswith("/)"):
2027 kind = Parameter.POSITIONAL_ONLY
2028 s = s[:-2] + ')'
2029 else:
2030 kind = Parameter.POSITIONAL_OR_KEYWORD
2031
Larry Hastings581ee362014-01-28 05:00:08 -08002032 first_parameter_is_self = s.startswith("($")
2033 if first_parameter_is_self:
2034 s = '(' + s[2:]
2035
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002036 s = "def foo" + s + ": pass"
2037
2038 try:
2039 module = ast.parse(s)
2040 except SyntaxError:
2041 return None
2042 if not isinstance(module, ast.Module):
2043 return None
2044
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002045 f = module.body[0]
2046
2047 parameters = []
2048 empty = Parameter.empty
Larry Hastings16c51912014-01-07 11:53:01 -08002049 invalid = object()
2050
Larry Hastings2a727912014-01-16 11:32:01 -08002051 module = None
2052 module_dict = {}
2053 module_name = getattr(func, '__module__', None)
2054 if module_name:
2055 module = sys.modules.get(module_name, None)
2056 if module:
2057 module_dict = module.__dict__
2058 sys_module_dict = sys.modules
Larry Hastings16c51912014-01-07 11:53:01 -08002059
Larry Hastings2a727912014-01-16 11:32:01 -08002060 def parse_name(node):
2061 assert isinstance(node, ast.arg)
2062 if node.annotation != None:
2063 raise ValueError("Annotations are not currently supported")
2064 return node.arg
Larry Hastings16c51912014-01-07 11:53:01 -08002065
Larry Hastings2a727912014-01-16 11:32:01 -08002066 def wrap_value(s):
2067 try:
2068 value = eval(s, module_dict)
2069 except NameError:
2070 try:
2071 value = eval(s, sys_module_dict)
2072 except NameError:
2073 raise RuntimeError()
Larry Hastings16c51912014-01-07 11:53:01 -08002074
Larry Hastings2a727912014-01-16 11:32:01 -08002075 if isinstance(value, str):
2076 return ast.Str(value)
2077 if isinstance(value, (int, float)):
2078 return ast.Num(value)
2079 if isinstance(value, bytes):
2080 return ast.Bytes(value)
2081 if value in (True, False, None):
2082 return ast.NameConstant(value)
2083 raise RuntimeError()
Larry Hastings16c51912014-01-07 11:53:01 -08002084
Larry Hastings2a727912014-01-16 11:32:01 -08002085 class RewriteSymbolics(ast.NodeTransformer):
2086 def visit_Attribute(self, node):
2087 a = []
2088 n = node
2089 while isinstance(n, ast.Attribute):
2090 a.append(n.attr)
2091 n = n.value
2092 if not isinstance(n, ast.Name):
2093 raise RuntimeError()
2094 a.append(n.id)
2095 value = ".".join(reversed(a))
2096 return wrap_value(value)
2097
2098 def visit_Name(self, node):
Larry Hastings16c51912014-01-07 11:53:01 -08002099 if not isinstance(node.ctx, ast.Load):
Larry Hastings2a727912014-01-16 11:32:01 -08002100 raise ValueError()
2101 return wrap_value(node.id)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002102
2103 def p(name_node, default_node, default=empty):
Larry Hastings2a727912014-01-16 11:32:01 -08002104 name = parse_name(name_node)
Larry Hastings16c51912014-01-07 11:53:01 -08002105 if name is invalid:
2106 return None
Larry Hastings5c661892014-01-24 06:17:25 -08002107 if default_node and default_node is not _empty:
Larry Hastings2a727912014-01-16 11:32:01 -08002108 try:
2109 default_node = RewriteSymbolics().visit(default_node)
2110 o = ast.literal_eval(default_node)
2111 except ValueError:
2112 o = invalid
Larry Hastings16c51912014-01-07 11:53:01 -08002113 if o is invalid:
2114 return None
2115 default = o if o is not invalid else default
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002116 parameters.append(Parameter(name, kind, default=default, annotation=empty))
2117
2118 # non-keyword-only parameters
Larry Hastings16c51912014-01-07 11:53:01 -08002119 args = reversed(f.args.args)
2120 defaults = reversed(f.args.defaults)
2121 iter = itertools.zip_longest(args, defaults, fillvalue=None)
2122 for name, default in reversed(list(iter)):
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002123 p(name, default)
2124
2125 # *args
2126 if f.args.vararg:
2127 kind = Parameter.VAR_POSITIONAL
2128 p(f.args.vararg, empty)
2129
2130 # keyword-only arguments
2131 kind = Parameter.KEYWORD_ONLY
2132 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
2133 p(name, default)
2134
2135 # **kwargs
2136 if f.args.kwarg:
2137 kind = Parameter.VAR_KEYWORD
2138 p(f.args.kwarg, empty)
2139
Larry Hastings581ee362014-01-28 05:00:08 -08002140 if first_parameter_is_self:
2141 assert parameters
2142 if getattr(func, '__self__', None):
2143 # strip off self, it's already been bound
2144 parameters.pop(0)
Larry Hastings5c661892014-01-24 06:17:25 -08002145 else:
2146 # for builtins, self parameter is always positional-only!
2147 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
2148 parameters[0] = p
2149
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002150 return cls(parameters, return_annotation=cls.empty)
2151
2152
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002153 @property
2154 def parameters(self):
2155 return self._parameters
2156
2157 @property
2158 def return_annotation(self):
2159 return self._return_annotation
2160
2161 def replace(self, *, parameters=_void, return_annotation=_void):
2162 '''Creates a customized copy of the Signature.
2163 Pass 'parameters' and/or 'return_annotation' arguments
2164 to override them in the new copy.
2165 '''
2166
2167 if parameters is _void:
2168 parameters = self.parameters.values()
2169
2170 if return_annotation is _void:
2171 return_annotation = self._return_annotation
2172
2173 return type(self)(parameters,
2174 return_annotation=return_annotation)
2175
2176 def __eq__(self, other):
2177 if (not issubclass(type(other), Signature) or
2178 self.return_annotation != other.return_annotation or
2179 len(self.parameters) != len(other.parameters)):
2180 return False
2181
2182 other_positions = {param: idx
2183 for idx, param in enumerate(other.parameters.keys())}
2184
2185 for idx, (param_name, param) in enumerate(self.parameters.items()):
2186 if param.kind == _KEYWORD_ONLY:
2187 try:
2188 other_param = other.parameters[param_name]
2189 except KeyError:
2190 return False
2191 else:
2192 if param != other_param:
2193 return False
2194 else:
2195 try:
2196 other_idx = other_positions[param_name]
2197 except KeyError:
2198 return False
2199 else:
2200 if (idx != other_idx or
2201 param != other.parameters[param_name]):
2202 return False
2203
2204 return True
2205
2206 def __ne__(self, other):
2207 return not self.__eq__(other)
2208
2209 def _bind(self, args, kwargs, *, partial=False):
2210 '''Private method. Don't use directly.'''
2211
2212 arguments = OrderedDict()
2213
2214 parameters = iter(self.parameters.values())
2215 parameters_ex = ()
2216 arg_vals = iter(args)
2217
2218 if partial:
2219 # Support for binding arguments to 'functools.partial' objects.
2220 # See 'functools.partial' case in 'signature()' implementation
2221 # for details.
2222 for param_name, param in self.parameters.items():
2223 if (param._partial_kwarg and param_name not in kwargs):
2224 # Simulating 'functools.partial' behavior
2225 kwargs[param_name] = param.default
2226
2227 while True:
2228 # Let's iterate through the positional arguments and corresponding
2229 # parameters
2230 try:
2231 arg_val = next(arg_vals)
2232 except StopIteration:
2233 # No more positional arguments
2234 try:
2235 param = next(parameters)
2236 except StopIteration:
2237 # No more parameters. That's it. Just need to check that
2238 # we have no `kwargs` after this while loop
2239 break
2240 else:
2241 if param.kind == _VAR_POSITIONAL:
2242 # That's OK, just empty *args. Let's start parsing
2243 # kwargs
2244 break
2245 elif param.name in kwargs:
2246 if param.kind == _POSITIONAL_ONLY:
2247 msg = '{arg!r} parameter is positional only, ' \
2248 'but was passed as a keyword'
2249 msg = msg.format(arg=param.name)
2250 raise TypeError(msg) from None
2251 parameters_ex = (param,)
2252 break
2253 elif (param.kind == _VAR_KEYWORD or
2254 param.default is not _empty):
2255 # That's fine too - we have a default value for this
2256 # parameter. So, lets start parsing `kwargs`, starting
2257 # with the current parameter
2258 parameters_ex = (param,)
2259 break
2260 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002261 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2262 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002263 if partial:
2264 parameters_ex = (param,)
2265 break
2266 else:
2267 msg = '{arg!r} parameter lacking default value'
2268 msg = msg.format(arg=param.name)
2269 raise TypeError(msg) from None
2270 else:
2271 # We have a positional argument to process
2272 try:
2273 param = next(parameters)
2274 except StopIteration:
2275 raise TypeError('too many positional arguments') from None
2276 else:
2277 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2278 # Looks like we have no parameter for this positional
2279 # argument
2280 raise TypeError('too many positional arguments')
2281
2282 if param.kind == _VAR_POSITIONAL:
2283 # We have an '*args'-like argument, let's fill it with
2284 # all positional arguments we have left and move on to
2285 # the next phase
2286 values = [arg_val]
2287 values.extend(arg_vals)
2288 arguments[param.name] = tuple(values)
2289 break
2290
2291 if param.name in kwargs:
2292 raise TypeError('multiple values for argument '
2293 '{arg!r}'.format(arg=param.name))
2294
2295 arguments[param.name] = arg_val
2296
2297 # Now, we iterate through the remaining parameters to process
2298 # keyword arguments
2299 kwargs_param = None
2300 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002301 if param.kind == _VAR_KEYWORD:
2302 # Memorize that we have a '**kwargs'-like parameter
2303 kwargs_param = param
2304 continue
2305
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002306 if param.kind == _VAR_POSITIONAL:
2307 # Named arguments don't refer to '*args'-like parameters.
2308 # We only arrive here if the positional arguments ended
2309 # before reaching the last parameter before *args.
2310 continue
2311
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002312 param_name = param.name
2313 try:
2314 arg_val = kwargs.pop(param_name)
2315 except KeyError:
2316 # We have no value for this parameter. It's fine though,
2317 # if it has a default value, or it is an '*args'-like
2318 # parameter, left alone by the processing of positional
2319 # arguments.
2320 if (not partial and param.kind != _VAR_POSITIONAL and
2321 param.default is _empty):
2322 raise TypeError('{arg!r} parameter lacking default value'. \
2323 format(arg=param_name)) from None
2324
2325 else:
2326 arguments[param_name] = arg_val
2327
2328 if kwargs:
2329 if kwargs_param is not None:
2330 # Process our '**kwargs'-like parameter
2331 arguments[kwargs_param.name] = kwargs
2332 else:
2333 raise TypeError('too many keyword arguments')
2334
2335 return self._bound_arguments_cls(self, arguments)
2336
Antoine Pitroubd41d1b2013-01-29 21:20:57 +01002337 def bind(__bind_self, *args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002338 '''Get a BoundArguments object, that maps the passed `args`
2339 and `kwargs` to the function's signature. Raises `TypeError`
2340 if the passed arguments can not be bound.
2341 '''
Antoine Pitroubd41d1b2013-01-29 21:20:57 +01002342 return __bind_self._bind(args, kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002343
Antoine Pitroubd41d1b2013-01-29 21:20:57 +01002344 def bind_partial(__bind_self, *args, **kwargs):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002345 '''Get a BoundArguments object, that partially maps the
2346 passed `args` and `kwargs` to the function's signature.
2347 Raises `TypeError` if the passed arguments can not be bound.
2348 '''
Antoine Pitroubd41d1b2013-01-29 21:20:57 +01002349 return __bind_self._bind(args, kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002350
2351 def __str__(self):
2352 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002353 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002354 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002355 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002356 formatted = str(param)
2357
2358 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002359
2360 if kind == _POSITIONAL_ONLY:
2361 render_pos_only_separator = True
2362 elif render_pos_only_separator:
2363 # It's not a positional-only parameter, and the flag
2364 # is set to 'True' (there were pos-only params before.)
2365 result.append('/')
2366 render_pos_only_separator = False
2367
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002368 if kind == _VAR_POSITIONAL:
2369 # OK, we have an '*args'-like parameter, so we won't need
2370 # a '*' to separate keyword-only arguments
2371 render_kw_only_separator = False
2372 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
2373 # We have a keyword-only parameter to render and we haven't
2374 # rendered an '*args'-like parameter before, so add a '*'
2375 # separator to the parameters list ("foo(arg1, *, arg2)" case)
2376 result.append('*')
2377 # This condition should be only triggered once, so
2378 # reset the flag
2379 render_kw_only_separator = False
2380
2381 result.append(formatted)
2382
Yury Selivanov2393dca2014-01-27 15:07:58 -05002383 if render_pos_only_separator:
2384 # There were only positional-only parameters, hence the
2385 # flag was not reset to 'False'
2386 result.append('/')
2387
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002388 rendered = '({})'.format(', '.join(result))
2389
2390 if self.return_annotation is not _empty:
2391 anno = formatannotation(self.return_annotation)
2392 rendered += ' -> {}'.format(anno)
2393
2394 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002395
2396def _main():
2397 """ Logic for inspecting an object given at command line """
2398 import argparse
2399 import importlib
2400
2401 parser = argparse.ArgumentParser()
2402 parser.add_argument(
2403 'object',
2404 help="The object to be analysed. "
2405 "It supports the 'module:qualname' syntax")
2406 parser.add_argument(
2407 '-d', '--details', action='store_true',
2408 help='Display info about the module rather than its source code')
2409
2410 args = parser.parse_args()
2411
2412 target = args.object
2413 mod_name, has_attrs, attrs = target.partition(":")
2414 try:
2415 obj = module = importlib.import_module(mod_name)
2416 except Exception as exc:
2417 msg = "Failed to import {} ({}: {})".format(mod_name,
2418 type(exc).__name__,
2419 exc)
2420 print(msg, file=sys.stderr)
2421 exit(2)
2422
2423 if has_attrs:
2424 parts = attrs.split(".")
2425 obj = module
2426 for part in parts:
2427 obj = getattr(obj, part)
2428
2429 if module.__name__ in sys.builtin_module_names:
2430 print("Can't get info for builtin modules.", file=sys.stderr)
2431 exit(1)
2432
2433 if args.details:
2434 print('Target: {}'.format(target))
2435 print('Origin: {}'.format(getsourcefile(module)))
2436 print('Cached: {}'.format(module.__cached__))
2437 if obj is module:
2438 print('Loader: {}'.format(repr(module.__loader__)))
2439 if hasattr(module, '__path__'):
2440 print('Submodule search path: {}'.format(module.__path__))
2441 else:
2442 try:
2443 __, lineno = findsource(obj)
2444 except Exception:
2445 pass
2446 else:
2447 print('Line: {}'.format(lineno))
2448
2449 print('\n')
2450 else:
2451 print(getsource(obj))
2452
2453
2454if __name__ == "__main__":
2455 _main()