blob: ae55347adc145f1a2854a089e42bba7b8ef95e27 [file] [log] [blame]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001"""Get useful information from live Python objects.
2
3This module encapsulates the interface provided by the internal special
Neal Norwitz221085d2007-02-25 20:55:47 +00004attributes (co_*, im_*, tb_*, etc.) in a friendlier fashion.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00005It also provides some help for examining source code and class layout.
6
7Here are some of the useful functions provided by this module:
8
Christian Heimes7131fd92008-02-19 14:21:46 +00009 ismodule(), isclass(), ismethod(), isfunction(), isgeneratorfunction(),
10 isgenerator(), istraceback(), isframe(), iscode(), isbuiltin(),
11 isroutine() - check object types
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000012 getmembers() - get members of an object that satisfy a given condition
13
14 getfile(), getsourcefile(), getsource() - find an object's source code
15 getdoc(), getcomments() - get documentation on an object
16 getmodule() - determine the module that an object came from
17 getclasstree() - arrange classes so as to represent their hierarchy
18
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +000019 getargspec(), getargvalues(), getcallargs() - get info about function arguments
Yury Selivanov0cf3ed62014-04-01 10:17:08 -040020 getfullargspec() - same, with support for Python 3 features
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000021 formatargspec(), formatargvalues() - format an argument spec
22 getouterframes(), getinnerframes() - get info about frames
23 currentframe() - get the current stack frame
24 stack(), trace() - get info about frames on the stack or in a traceback
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070025
26 signature() - get a Signature object for the callable
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000027"""
28
29# This module is in the public domain. No warranties.
30
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070031__author__ = ('Ka-Ping Yee <ping@lfw.org>',
32 'Yury Selivanov <yselivanov@sprymix.com>')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000033
Larry Hastings44e2eaa2013-11-23 15:37:55 -080034import ast
Yury Selivanov21e83a52014-03-27 11:23:13 -040035import enum
Brett Cannoncb66eb02012-05-11 12:58:42 -040036import importlib.machinery
37import itertools
Christian Heimes7131fd92008-02-19 14:21:46 +000038import linecache
Brett Cannoncb66eb02012-05-11 12:58:42 -040039import os
40import re
41import sys
42import tokenize
Larry Hastings2623c8c2014-02-08 22:15:29 -080043import token
Brett Cannoncb66eb02012-05-11 12:58:42 -040044import types
Brett Cannon2b88fcf2012-06-02 22:28:42 -040045import warnings
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070046import functools
Nick Coghlan2f92e542012-06-23 19:39:55 +100047import builtins
Raymond Hettingera1a992c2005-03-11 06:46:45 +000048from operator import attrgetter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -070049from collections import namedtuple, OrderedDict
Nick Coghlan09c81232010-08-17 10:18:16 +000050
51# Create constants for the compiler flags in Include/code.h
52# We try to get them from dis to avoid duplication, but fall
Ezio Melotti30b9d5d2013-08-17 15:50:46 +030053# back to hardcoding so the dependency is optional
Nick Coghlan09c81232010-08-17 10:18:16 +000054try:
55 from dis import COMPILER_FLAG_NAMES as _flag_names
Brett Cannoncd171c82013-07-04 17:43:24 -040056except ImportError:
Nick Coghlan09c81232010-08-17 10:18:16 +000057 CO_OPTIMIZED, CO_NEWLOCALS = 0x1, 0x2
58 CO_VARARGS, CO_VARKEYWORDS = 0x4, 0x8
59 CO_NESTED, CO_GENERATOR, CO_NOFREE = 0x10, 0x20, 0x40
60else:
61 mod_dict = globals()
62 for k, v in _flag_names.items():
63 mod_dict["CO_" + v] = k
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000064
Christian Heimesbe5b30b2008-03-03 19:18:51 +000065# See Include/object.h
66TPFLAGS_IS_ABSTRACT = 1 << 20
67
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000068# ----------------------------------------------------------- type-checking
69def ismodule(object):
70 """Return true if the object is a module.
71
72 Module objects provide these attributes:
Barry Warsaw28a691b2010-04-17 00:19:56 +000073 __cached__ pathname to byte compiled file
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000074 __doc__ documentation string
75 __file__ filename (missing for built-in modules)"""
Tim Peters28bc59f2001-09-16 08:40:16 +000076 return isinstance(object, types.ModuleType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000077
78def isclass(object):
79 """Return true if the object is a class.
80
81 Class objects provide these attributes:
82 __doc__ documentation string
83 __module__ name of module in which this class was defined"""
Benjamin Petersonc4656002009-01-17 22:41:18 +000084 return isinstance(object, type)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000085
86def ismethod(object):
87 """Return true if the object is an instance method.
88
89 Instance method objects provide these attributes:
90 __doc__ documentation string
91 __name__ name with which this method was defined
Christian Heimesff737952007-11-27 10:40:20 +000092 __func__ function object containing implementation of method
93 __self__ instance to which this method is bound"""
Tim Peters28bc59f2001-09-16 08:40:16 +000094 return isinstance(object, types.MethodType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +000095
Tim Peters536d2262001-09-20 05:13:38 +000096def ismethoddescriptor(object):
Tim Petersf1d90b92001-09-20 05:47:55 +000097 """Return true if the object is a method descriptor.
98
99 But not if ismethod() or isclass() or isfunction() are true.
Tim Peters536d2262001-09-20 05:13:38 +0000100
101 This is new in Python 2.2, and, for example, is true of int.__add__.
102 An object passing this test has a __get__ attribute but not a __set__
103 attribute, but beyond that the set of attributes varies. __name__ is
104 usually sensible, and __doc__ often is.
105
Tim Petersf1d90b92001-09-20 05:47:55 +0000106 Methods implemented via descriptors that also pass one of the other
107 tests return false from the ismethoddescriptor() test, simply because
108 the other tests promise more -- you can, e.g., count on having the
Christian Heimesff737952007-11-27 10:40:20 +0000109 __func__ attribute (etc) when an object passes ismethod()."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100110 if isclass(object) or ismethod(object) or isfunction(object):
111 # mutual exclusion
112 return False
113 tp = type(object)
114 return hasattr(tp, "__get__") and not hasattr(tp, "__set__")
Tim Peters536d2262001-09-20 05:13:38 +0000115
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000116def isdatadescriptor(object):
117 """Return true if the object is a data descriptor.
118
119 Data descriptors have both a __get__ and a __set__ attribute. Examples are
120 properties (defined in Python) and getsets and members (defined in C).
121 Typically, data descriptors will also have __name__ and __doc__ attributes
122 (properties, getsets, and members have both of these attributes), but this
123 is not guaranteed."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100124 if isclass(object) or ismethod(object) or isfunction(object):
125 # mutual exclusion
126 return False
127 tp = type(object)
128 return hasattr(tp, "__set__") and hasattr(tp, "__get__")
Martin v. Löwise59e2ba2003-05-03 09:09:02 +0000129
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000130if hasattr(types, 'MemberDescriptorType'):
131 # CPython and equivalent
132 def ismemberdescriptor(object):
133 """Return true if the object is a member descriptor.
134
135 Member descriptors are specialized descriptors defined in extension
136 modules."""
137 return isinstance(object, types.MemberDescriptorType)
138else:
139 # Other implementations
140 def ismemberdescriptor(object):
141 """Return true if the object is a member descriptor.
142
143 Member descriptors are specialized descriptors defined in extension
144 modules."""
145 return False
146
147if hasattr(types, 'GetSetDescriptorType'):
148 # CPython and equivalent
149 def isgetsetdescriptor(object):
150 """Return true if the object is a getset descriptor.
151
152 getset descriptors are specialized descriptors defined in extension
153 modules."""
154 return isinstance(object, types.GetSetDescriptorType)
155else:
156 # Other implementations
157 def isgetsetdescriptor(object):
158 """Return true if the object is a getset descriptor.
159
160 getset descriptors are specialized descriptors defined in extension
161 modules."""
162 return False
163
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000164def isfunction(object):
165 """Return true if the object is a user-defined function.
166
167 Function objects provide these attributes:
168 __doc__ documentation string
169 __name__ name with which this function was defined
Neal Norwitz221085d2007-02-25 20:55:47 +0000170 __code__ code object containing compiled function bytecode
171 __defaults__ tuple of any default values for arguments
172 __globals__ global namespace in which this function was defined
173 __annotations__ dict of parameter annotations
174 __kwdefaults__ dict of keyword only parameters with defaults"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000175 return isinstance(object, types.FunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000176
Christian Heimes7131fd92008-02-19 14:21:46 +0000177def isgeneratorfunction(object):
178 """Return true if the object is a user-defined generator function.
179
180 Generator function objects provides same attributes as functions.
181
Alexander Belopolsky977a6842010-08-16 20:17:07 +0000182 See help(isfunction) for attributes listing."""
Georg Brandlb1441c72009-01-03 22:33:39 +0000183 return bool((isfunction(object) or ismethod(object)) and
184 object.__code__.co_flags & CO_GENERATOR)
Christian Heimes7131fd92008-02-19 14:21:46 +0000185
186def isgenerator(object):
187 """Return true if the object is a generator.
188
189 Generator objects provide these attributes:
Ezio Melotti30b9d5d2013-08-17 15:50:46 +0300190 __iter__ defined to support iteration over container
Christian Heimes7131fd92008-02-19 14:21:46 +0000191 close raises a new GeneratorExit exception inside the
192 generator to terminate the iteration
193 gi_code code object
194 gi_frame frame object or possibly None once the generator has
195 been exhausted
196 gi_running set to 1 when generator is executing, 0 otherwise
197 next return the next item from the container
198 send resumes the generator and "sends" a value that becomes
199 the result of the current yield-expression
200 throw used to raise an exception inside the generator"""
201 return isinstance(object, types.GeneratorType)
202
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000203def istraceback(object):
204 """Return true if the object is a traceback.
205
206 Traceback objects provide these attributes:
207 tb_frame frame object at this level
208 tb_lasti index of last attempted instruction in bytecode
209 tb_lineno current line number in Python source code
210 tb_next next inner traceback object (called by this level)"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000211 return isinstance(object, types.TracebackType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000212
213def isframe(object):
214 """Return true if the object is a frame object.
215
216 Frame objects provide these attributes:
217 f_back next outer frame object (this frame's caller)
218 f_builtins built-in namespace seen by this frame
219 f_code code object being executed in this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000220 f_globals global namespace seen by this frame
221 f_lasti index of last attempted instruction in bytecode
222 f_lineno current line number in Python source code
223 f_locals local namespace seen by this frame
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000224 f_trace tracing function for this frame, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000225 return isinstance(object, types.FrameType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000226
227def iscode(object):
228 """Return true if the object is a code object.
229
230 Code objects provide these attributes:
231 co_argcount number of arguments (not including * or ** args)
232 co_code string of raw compiled bytecode
233 co_consts tuple of constants used in the bytecode
234 co_filename name of file in which this code object was created
235 co_firstlineno number of first line in Python source code
236 co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
237 co_lnotab encoded mapping of line numbers to bytecode indices
238 co_name name with which this code object was defined
239 co_names tuple of names of local variables
240 co_nlocals number of local variables
241 co_stacksize virtual machine stack space required
242 co_varnames tuple of names of arguments and local variables"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000243 return isinstance(object, types.CodeType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000244
245def isbuiltin(object):
246 """Return true if the object is a built-in function or method.
247
248 Built-in functions and methods provide these attributes:
249 __doc__ documentation string
250 __name__ original name of this function or method
251 __self__ instance to which a method is bound, or None"""
Tim Peters28bc59f2001-09-16 08:40:16 +0000252 return isinstance(object, types.BuiltinFunctionType)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000253
254def isroutine(object):
255 """Return true if the object is any kind of function or method."""
Tim Peters536d2262001-09-20 05:13:38 +0000256 return (isbuiltin(object)
257 or isfunction(object)
258 or ismethod(object)
259 or ismethoddescriptor(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000260
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000261def isabstract(object):
262 """Return true if the object is an abstract base class (ABC)."""
Benjamin Petersona0dfa822009-11-13 02:25:08 +0000263 return bool(isinstance(object, type) and object.__flags__ & TPFLAGS_IS_ABSTRACT)
Christian Heimesbe5b30b2008-03-03 19:18:51 +0000264
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000265def getmembers(object, predicate=None):
266 """Return all members of an object as (name, value) pairs sorted by name.
267 Optionally, only return members that satisfy a given predicate."""
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100268 if isclass(object):
269 mro = (object,) + getmro(object)
270 else:
271 mro = ()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000272 results = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700273 processed = set()
274 names = dir(object)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700275 # :dd any DynamicClassAttributes to the list of names if object is a class;
Ethan Furmane03ea372013-09-25 07:14:41 -0700276 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700277 # attribute with the same name as a DynamicClassAttribute exists
Ethan Furmane03ea372013-09-25 07:14:41 -0700278 try:
279 for base in object.__bases__:
280 for k, v in base.__dict__.items():
281 if isinstance(v, types.DynamicClassAttribute):
282 names.append(k)
283 except AttributeError:
284 pass
285 for key in names:
Ethan Furman63c141c2013-10-18 00:27:39 -0700286 # First try to get the value via getattr. Some descriptors don't
287 # like calling their __get__ (see bug #1785), so fall back to
288 # looking in the __dict__.
289 try:
290 value = getattr(object, key)
291 # handle the duplicate key
292 if key in processed:
293 raise AttributeError
294 except AttributeError:
295 for base in mro:
296 if key in base.__dict__:
297 value = base.__dict__[key]
298 break
299 else:
300 # could be a (currently) missing slot member, or a buggy
301 # __dir__; discard and move on
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100302 continue
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000303 if not predicate or predicate(value):
304 results.append((key, value))
Ethan Furmane03ea372013-09-25 07:14:41 -0700305 processed.add(key)
306 results.sort(key=lambda pair: pair[0])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000307 return results
308
Christian Heimes25bb7832008-01-11 16:17:00 +0000309Attribute = namedtuple('Attribute', 'name kind defining_class object')
310
Tim Peters13b49d32001-09-23 02:00:29 +0000311def classify_class_attrs(cls):
312 """Return list of attribute-descriptor tuples.
313
314 For each name in dir(cls), the return list contains a 4-tuple
315 with these elements:
316
317 0. The name (a string).
318
319 1. The kind of attribute this is, one of these strings:
320 'class method' created via classmethod()
321 'static method' created via staticmethod()
322 'property' created via property()
Ethan Furmane03ea372013-09-25 07:14:41 -0700323 'method' any other flavor of method or descriptor
Tim Peters13b49d32001-09-23 02:00:29 +0000324 'data' not a method
325
326 2. The class which defined this attribute (a class).
327
Ethan Furmane03ea372013-09-25 07:14:41 -0700328 3. The object as obtained by calling getattr; if this fails, or if the
329 resulting object does not live anywhere in the class' mro (including
330 metaclasses) then the object is looked up in the defining class's
331 dict (found by walking the mro).
Ethan Furman668dede2013-09-14 18:53:26 -0700332
333 If one of the items in dir(cls) is stored in the metaclass it will now
334 be discovered and not have None be listed as the class in which it was
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700335 defined. Any items whose home class cannot be discovered are skipped.
Tim Peters13b49d32001-09-23 02:00:29 +0000336 """
337
338 mro = getmro(cls)
Ethan Furman668dede2013-09-14 18:53:26 -0700339 metamro = getmro(type(cls)) # for attributes stored in the metaclass
Ethan Furmane03ea372013-09-25 07:14:41 -0700340 metamro = tuple([cls for cls in metamro if cls not in (type, object)])
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700341 class_bases = (cls,) + mro
342 all_bases = class_bases + metamro
Tim Peters13b49d32001-09-23 02:00:29 +0000343 names = dir(cls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700344 # :dd any DynamicClassAttributes to the list of names;
Ethan Furmane03ea372013-09-25 07:14:41 -0700345 # this may result in duplicate entries if, for example, a virtual
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700346 # attribute with the same name as a DynamicClassAttribute exists.
Ethan Furman63c141c2013-10-18 00:27:39 -0700347 for base in mro:
Ethan Furmane03ea372013-09-25 07:14:41 -0700348 for k, v in base.__dict__.items():
349 if isinstance(v, types.DynamicClassAttribute):
350 names.append(k)
Tim Peters13b49d32001-09-23 02:00:29 +0000351 result = []
Ethan Furmane03ea372013-09-25 07:14:41 -0700352 processed = set()
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700353
Tim Peters13b49d32001-09-23 02:00:29 +0000354 for name in names:
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100355 # Get the object associated with the name, and where it was defined.
Ethan Furmane03ea372013-09-25 07:14:41 -0700356 # Normal objects will be looked up with both getattr and directly in
357 # its class' dict (in case getattr fails [bug #1785], and also to look
358 # for a docstring).
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700359 # For DynamicClassAttributes on the second pass we only look in the
Ethan Furmane03ea372013-09-25 07:14:41 -0700360 # class's dict.
361 #
Tim Peters13b49d32001-09-23 02:00:29 +0000362 # Getting an obj from the __dict__ sometimes reveals more than
363 # using getattr. Static and class methods are dramatic examples.
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100364 homecls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700365 get_obj = None
366 dict_obj = None
Ethan Furmane03ea372013-09-25 07:14:41 -0700367 if name not in processed:
368 try:
Ethan Furmana8b07072013-10-18 01:22:08 -0700369 if name == '__dict__':
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700370 raise Exception("__dict__ is special, don't want the proxy")
Ethan Furmane03ea372013-09-25 07:14:41 -0700371 get_obj = getattr(cls, name)
372 except Exception as exc:
373 pass
374 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700375 homecls = getattr(get_obj, "__objclass__", homecls)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700376 if homecls not in class_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700377 # if the resulting object does not live somewhere in the
Ethan Furman63c141c2013-10-18 00:27:39 -0700378 # mro, drop it and search the mro manually
Ethan Furmane03ea372013-09-25 07:14:41 -0700379 homecls = None
Ethan Furman63c141c2013-10-18 00:27:39 -0700380 last_cls = None
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700381 # first look in the classes
382 for srch_cls in class_bases:
Ethan Furman63c141c2013-10-18 00:27:39 -0700383 srch_obj = getattr(srch_cls, name, None)
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700384 if srch_obj == get_obj:
Ethan Furman63c141c2013-10-18 00:27:39 -0700385 last_cls = srch_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700386 # then check the metaclasses
387 for srch_cls in metamro:
388 try:
389 srch_obj = srch_cls.__getattr__(cls, name)
390 except AttributeError:
391 continue
392 if srch_obj == get_obj:
393 last_cls = srch_cls
Ethan Furman63c141c2013-10-18 00:27:39 -0700394 if last_cls is not None:
395 homecls = last_cls
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700396 for base in all_bases:
Ethan Furmane03ea372013-09-25 07:14:41 -0700397 if name in base.__dict__:
398 dict_obj = base.__dict__[name]
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700399 if homecls not in metamro:
400 homecls = base
Ethan Furmane03ea372013-09-25 07:14:41 -0700401 break
Ethan Furman63c141c2013-10-18 00:27:39 -0700402 if homecls is None:
403 # unable to locate the attribute anywhere, most likely due to
404 # buggy custom __dir__; discard and move on
405 continue
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700406 obj = get_obj or dict_obj
Ethan Furmane03ea372013-09-25 07:14:41 -0700407 # Classify the object or its descriptor.
Ethan Furman63c141c2013-10-18 00:27:39 -0700408 if isinstance(dict_obj, staticmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000409 kind = "static method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700410 obj = dict_obj
Ethan Furman63c141c2013-10-18 00:27:39 -0700411 elif isinstance(dict_obj, classmethod):
Tim Peters13b49d32001-09-23 02:00:29 +0000412 kind = "class method"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700413 obj = dict_obj
414 elif isinstance(dict_obj, property):
Tim Peters13b49d32001-09-23 02:00:29 +0000415 kind = "property"
Ethan Furmanb0c84cd2013-10-20 22:37:39 -0700416 obj = dict_obj
Yury Selivanov0860a0b2014-01-31 14:28:44 -0500417 elif isroutine(obj):
Tim Peters13b49d32001-09-23 02:00:29 +0000418 kind = "method"
Antoine Pitrou86a8a9a2011-12-21 09:57:40 +0100419 else:
Ethan Furmane03ea372013-09-25 07:14:41 -0700420 kind = "data"
Christian Heimes25bb7832008-01-11 16:17:00 +0000421 result.append(Attribute(name, kind, homecls, obj))
Ethan Furmane03ea372013-09-25 07:14:41 -0700422 processed.add(name)
Tim Peters13b49d32001-09-23 02:00:29 +0000423 return result
424
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000425# ----------------------------------------------------------- class helpers
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000426
427def getmro(cls):
428 "Return tuple of base classes (including cls) in method resolution order."
Benjamin Petersonb82c8e52010-11-04 00:38:49 +0000429 return cls.__mro__
Tim Peterse0b2d7a2001-09-22 06:10:55 +0000430
Nick Coghlane8c45d62013-07-28 20:00:01 +1000431# -------------------------------------------------------- function helpers
432
433def unwrap(func, *, stop=None):
434 """Get the object wrapped by *func*.
435
436 Follows the chain of :attr:`__wrapped__` attributes returning the last
437 object in the chain.
438
439 *stop* is an optional callback accepting an object in the wrapper chain
440 as its sole argument that allows the unwrapping to be terminated early if
441 the callback returns a true value. If the callback never returns a true
442 value, the last object in the chain is returned as usual. For example,
443 :func:`signature` uses this to stop unwrapping if any object in the
444 chain has a ``__signature__`` attribute defined.
445
446 :exc:`ValueError` is raised if a cycle is encountered.
447
448 """
449 if stop is None:
450 def _is_wrapper(f):
451 return hasattr(f, '__wrapped__')
452 else:
453 def _is_wrapper(f):
454 return hasattr(f, '__wrapped__') and not stop(f)
455 f = func # remember the original func for error reporting
456 memo = {id(f)} # Memoise by id to tolerate non-hashable objects
457 while _is_wrapper(func):
458 func = func.__wrapped__
459 id_func = id(func)
460 if id_func in memo:
461 raise ValueError('wrapper loop when unwrapping {!r}'.format(f))
462 memo.add(id_func)
463 return func
464
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000465# -------------------------------------------------- source code extraction
466def indentsize(line):
467 """Return the indent size, in spaces, at the start of a line of text."""
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000468 expline = line.expandtabs()
469 return len(expline) - len(expline.lstrip())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000470
471def getdoc(object):
472 """Get the documentation string for an object.
473
474 All tabs are expanded to spaces. To clean up docstrings that are
475 indented to line up with blocks of code, any whitespace than can be
476 uniformly removed from the second line onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000477 try:
478 doc = object.__doc__
479 except AttributeError:
480 return None
Guido van Rossum3172c5d2007-10-16 18:12:55 +0000481 if not isinstance(doc, str):
Tim Peters24008312002-03-17 18:56:20 +0000482 return None
Georg Brandl0c77a822008-06-10 16:37:50 +0000483 return cleandoc(doc)
484
485def cleandoc(doc):
486 """Clean up indentation from docstrings.
487
488 Any whitespace that can be uniformly removed from the second line
489 onwards is removed."""
Tim Peters24008312002-03-17 18:56:20 +0000490 try:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000491 lines = doc.expandtabs().split('\n')
Tim Peters24008312002-03-17 18:56:20 +0000492 except UnicodeError:
493 return None
494 else:
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000495 # Find minimum indentation of any non-blank lines after first line.
Christian Heimesa37d4c62007-12-04 23:02:19 +0000496 margin = sys.maxsize
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000497 for line in lines[1:]:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000498 content = len(line.lstrip())
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000499 if content:
500 indent = len(line) - content
501 margin = min(margin, indent)
502 # Remove indentation.
503 if lines:
504 lines[0] = lines[0].lstrip()
Christian Heimesa37d4c62007-12-04 23:02:19 +0000505 if margin < sys.maxsize:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000506 for i in range(1, len(lines)): lines[i] = lines[i][margin:]
Ka-Ping Yeea59ef7b2002-11-30 03:53:15 +0000507 # Remove any trailing or leading blank lines.
508 while lines and not lines[-1]:
509 lines.pop()
510 while lines and not lines[0]:
511 lines.pop(0)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000512 return '\n'.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000513
514def getfile(object):
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000515 """Work out which source or compiled file an object was defined in."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000516 if ismodule(object):
517 if hasattr(object, '__file__'):
518 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000519 raise TypeError('{!r} is a built-in module'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000520 if isclass(object):
Yury Selivanov2eed8b72014-01-27 13:24:56 -0500521 if hasattr(object, '__module__'):
522 object = sys.modules.get(object.__module__)
523 if hasattr(object, '__file__'):
524 return object.__file__
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000525 raise TypeError('{!r} is a built-in class'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000526 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000527 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000528 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000529 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000530 if istraceback(object):
531 object = object.tb_frame
532 if isframe(object):
533 object = object.f_code
534 if iscode(object):
535 return object.co_filename
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000536 raise TypeError('{!r} is not a module, class, method, '
537 'function, traceback, frame, or code object'.format(object))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000538
Christian Heimes25bb7832008-01-11 16:17:00 +0000539ModuleInfo = namedtuple('ModuleInfo', 'name suffix mode module_type')
540
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000541def getmoduleinfo(path):
542 """Get the module name, suffix, mode, and module type for a given file."""
Brett Cannoncb66eb02012-05-11 12:58:42 -0400543 warnings.warn('inspect.getmoduleinfo() is deprecated', DeprecationWarning,
544 2)
Brett Cannone4f41de2013-06-16 13:13:40 -0400545 with warnings.catch_warnings():
546 warnings.simplefilter('ignore', PendingDeprecationWarning)
547 import imp
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000548 filename = os.path.basename(path)
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000549 suffixes = [(-len(suffix), suffix, mode, mtype)
550 for suffix, mode, mtype in imp.get_suffixes()]
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000551 suffixes.sort() # try longest suffixes first, in case they overlap
552 for neglen, suffix, mode, mtype in suffixes:
553 if filename[neglen:] == suffix:
Christian Heimes25bb7832008-01-11 16:17:00 +0000554 return ModuleInfo(filename[:neglen], suffix, mode, mtype)
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000555
556def getmodulename(path):
557 """Return the module name for a given file, or None."""
Nick Coghlan76e07702012-07-18 23:14:57 +1000558 fname = os.path.basename(path)
559 # Check for paths that look like an actual module file
560 suffixes = [(-len(suffix), suffix)
561 for suffix in importlib.machinery.all_suffixes()]
562 suffixes.sort() # try longest suffixes first, in case they overlap
563 for neglen, suffix in suffixes:
564 if fname.endswith(suffix):
565 return fname[:neglen]
566 return None
Ka-Ping Yee4d6fc7f2001-04-10 11:43:00 +0000567
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000568def getsourcefile(object):
R. David Murraya1b37402010-06-17 02:04:29 +0000569 """Return the filename that can be used to locate an object's source.
570 Return None if no way can be identified to get the source.
571 """
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000572 filename = getfile(object)
Brett Cannoncb66eb02012-05-11 12:58:42 -0400573 all_bytecode_suffixes = importlib.machinery.DEBUG_BYTECODE_SUFFIXES[:]
574 all_bytecode_suffixes += importlib.machinery.OPTIMIZED_BYTECODE_SUFFIXES[:]
575 if any(filename.endswith(s) for s in all_bytecode_suffixes):
576 filename = (os.path.splitext(filename)[0] +
577 importlib.machinery.SOURCE_SUFFIXES[0])
578 elif any(filename.endswith(s) for s in
579 importlib.machinery.EXTENSION_SUFFIXES):
580 return None
Thomas Wouters477c8d52006-05-27 19:21:47 +0000581 if os.path.exists(filename):
582 return filename
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000583 # only return a non-existent filename if the module has a PEP 302 loader
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400584 if getattr(getmodule(object, filename), '__loader__', None) is not None:
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000585 return filename
R. David Murraya1b37402010-06-17 02:04:29 +0000586 # or it is in the linecache
587 if filename in linecache.cache:
588 return filename
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000589
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000590def getabsfile(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000591 """Return an absolute path to the source or compiled file for an object.
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000592
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000593 The idea is for each object to have a unique origin, so this routine
594 normalizes the result as much as possible."""
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000595 if _filename is None:
596 _filename = getsourcefile(object) or getfile(object)
597 return os.path.normcase(os.path.abspath(_filename))
Ka-Ping Yeec113c242001-03-02 02:08:53 +0000598
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000599modulesbyfile = {}
Thomas Wouters89f507f2006-12-13 04:49:30 +0000600_filesbymodname = {}
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000601
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000602def getmodule(object, _filename=None):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000603 """Return the module an object was defined in, or None if not found."""
Ka-Ping Yee202c99b2001-04-13 09:15:08 +0000604 if ismodule(object):
605 return object
Johannes Gijsbers93245262004-09-11 15:53:22 +0000606 if hasattr(object, '__module__'):
Ka-Ping Yee8b58b842001-03-01 13:56:16 +0000607 return sys.modules.get(object.__module__)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000608 # Try the filename to modulename cache
609 if _filename is not None and _filename in modulesbyfile:
610 return sys.modules.get(modulesbyfile[_filename])
611 # Try the cache again with the absolute file name
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000612 try:
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000613 file = getabsfile(object, _filename)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000614 except TypeError:
615 return None
Raymond Hettinger54f02222002-06-01 14:18:47 +0000616 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000617 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000618 # Update the filename to module name cache and check yet again
619 # Copy sys.modules in order to cope with changes while iterating
Éric Araujoa74f8ef2011-11-29 16:58:53 +0100620 for modname, module in list(sys.modules.items()):
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000621 if ismodule(module) and hasattr(module, '__file__'):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000622 f = module.__file__
623 if f == _filesbymodname.get(modname, None):
624 # Have already mapped this module, so skip it
625 continue
626 _filesbymodname[modname] = f
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000627 f = getabsfile(module)
Thomas Wouters89f507f2006-12-13 04:49:30 +0000628 # Always map to the name the module knows itself by
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000629 modulesbyfile[f] = modulesbyfile[
630 os.path.realpath(f)] = module.__name__
Raymond Hettinger54f02222002-06-01 14:18:47 +0000631 if file in modulesbyfile:
Ka-Ping Yeeb38bbbd2003-03-28 16:29:50 +0000632 return sys.modules.get(modulesbyfile[file])
Thomas Wouters89f507f2006-12-13 04:49:30 +0000633 # Check the main module
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000634 main = sys.modules['__main__']
Brett Cannon4a671fe2003-06-15 22:33:28 +0000635 if not hasattr(object, '__name__'):
636 return None
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000637 if hasattr(main, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000638 mainobject = getattr(main, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000639 if mainobject is object:
640 return main
Thomas Wouters89f507f2006-12-13 04:49:30 +0000641 # Check builtins
Georg Brandl1a3284e2007-12-02 09:40:06 +0000642 builtin = sys.modules['builtins']
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000643 if hasattr(builtin, object.__name__):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000644 builtinobject = getattr(builtin, object.__name__)
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000645 if builtinobject is object:
646 return builtin
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000647
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000648def findsource(object):
649 """Return the entire source file and starting line number for an object.
650
651 The argument may be a module, class, method, function, traceback, frame,
652 or code object. The source code is returned as a list of all the lines
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200653 in the file and the line number indexes a line in that list. An OSError
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000654 is raised if the source code cannot be retrieved."""
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500655
656 file = getfile(object)
657 sourcefile = getsourcefile(object)
Ezio Melotti1b145922013-03-30 05:17:24 +0200658 if not sourcefile and file[:1] + file[-1:] != '<>':
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200659 raise OSError('source code not available')
Benjamin Peterson9620cc02011-06-11 15:53:11 -0500660 file = sourcefile if sourcefile else file
661
Thomas Wouters89f507f2006-12-13 04:49:30 +0000662 module = getmodule(object, file)
Thomas Wouters477c8d52006-05-27 19:21:47 +0000663 if module:
664 lines = linecache.getlines(file, module.__dict__)
665 else:
666 lines = linecache.getlines(file)
Neil Schemenauerf06f8532002-03-23 23:51:04 +0000667 if not lines:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200668 raise OSError('could not get source code')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000669
670 if ismodule(object):
671 return lines, 0
672
673 if isclass(object):
674 name = object.__name__
Thomas Wouters89f507f2006-12-13 04:49:30 +0000675 pat = re.compile(r'^(\s*)class\s*' + name + r'\b')
676 # make some effort to find the best matching class definition:
677 # use the one with the least indentation, which is the one
678 # that's most probably not inside a function definition.
679 candidates = []
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000680 for i in range(len(lines)):
Thomas Wouters89f507f2006-12-13 04:49:30 +0000681 match = pat.match(lines[i])
682 if match:
683 # if it's at toplevel, it's already the best one
684 if lines[i][0] == 'c':
685 return lines, i
686 # else add whitespace to candidate list
687 candidates.append((match.group(1), i))
688 if candidates:
689 # this will sort by whitespace, and by line number,
690 # less whitespace first
691 candidates.sort()
692 return lines, candidates[0][1]
Jeremy Hyltonab919022003-06-27 18:41:20 +0000693 else:
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200694 raise OSError('could not find class definition')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000695
696 if ismethod(object):
Christian Heimesff737952007-11-27 10:40:20 +0000697 object = object.__func__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000698 if isfunction(object):
Neal Norwitz221085d2007-02-25 20:55:47 +0000699 object = object.__code__
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000700 if istraceback(object):
701 object = object.tb_frame
702 if isframe(object):
703 object = object.f_code
704 if iscode(object):
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000705 if not hasattr(object, 'co_firstlineno'):
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200706 raise OSError('could not find function definition')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000707 lnum = object.co_firstlineno - 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000708 pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)')
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000709 while lnum > 0:
Ka-Ping Yeea6e59712001-03-10 09:31:55 +0000710 if pat.match(lines[lnum]): break
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +0000711 lnum = lnum - 1
712 return lines, lnum
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200713 raise OSError('could not find code object')
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000714
715def getcomments(object):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000716 """Get lines of comments immediately preceding an object's source code.
717
718 Returns None when source can't be found.
719 """
720 try:
721 lines, lnum = findsource(object)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200722 except (OSError, TypeError):
Jeremy Hyltonb4c17c82002-03-28 23:01:56 +0000723 return None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000724
725 if ismodule(object):
726 # Look for a comment block at the top of the file.
727 start = 0
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000728 if lines and lines[0][:2] == '#!': start = 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000729 while start < len(lines) and lines[start].strip() in ('', '#'):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000730 start = start + 1
Ka-Ping Yeeb910efe2001-04-12 13:17:17 +0000731 if start < len(lines) and lines[start][:1] == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000732 comments = []
733 end = start
734 while end < len(lines) and lines[end][:1] == '#':
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000735 comments.append(lines[end].expandtabs())
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000736 end = end + 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000737 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000738
739 # Look for a preceding block of comments at the same indentation.
740 elif lnum > 0:
741 indent = indentsize(lines[lnum])
742 end = lnum - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000743 if end >= 0 and lines[end].lstrip()[:1] == '#' and \
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000744 indentsize(lines[end]) == indent:
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000745 comments = [lines[end].expandtabs().lstrip()]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000746 if end > 0:
747 end = end - 1
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000748 comment = lines[end].expandtabs().lstrip()
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000749 while comment[:1] == '#' and indentsize(lines[end]) == indent:
750 comments[:0] = [comment]
751 end = end - 1
752 if end < 0: break
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000753 comment = lines[end].expandtabs().lstrip()
754 while comments and comments[0].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000755 comments[:1] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000756 while comments and comments[-1].strip() == '#':
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000757 comments[-1:] = []
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000758 return ''.join(comments)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000759
Tim Peters4efb6e92001-06-29 23:51:08 +0000760class EndOfBlock(Exception): pass
761
762class BlockFinder:
763 """Provide a tokeneater() method to detect the end of a code block."""
764 def __init__(self):
765 self.indent = 0
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000766 self.islambda = False
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000767 self.started = False
768 self.passline = False
Armin Rigodd5c0232005-09-25 11:45:45 +0000769 self.last = 1
Tim Peters4efb6e92001-06-29 23:51:08 +0000770
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000771 def tokeneater(self, type, token, srowcol, erowcol, line):
Tim Peters4efb6e92001-06-29 23:51:08 +0000772 if not self.started:
Armin Rigodd5c0232005-09-25 11:45:45 +0000773 # look for the first "def", "class" or "lambda"
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000774 if token in ("def", "class", "lambda"):
Johannes Gijsbersa5855d52005-03-12 16:37:11 +0000775 if token == "lambda":
776 self.islambda = True
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000777 self.started = True
Armin Rigodd5c0232005-09-25 11:45:45 +0000778 self.passline = True # skip to the end of the line
Tim Peters4efb6e92001-06-29 23:51:08 +0000779 elif type == tokenize.NEWLINE:
Armin Rigodd5c0232005-09-25 11:45:45 +0000780 self.passline = False # stop skipping when a NEWLINE is seen
Guido van Rossum1bc535d2007-05-15 18:46:22 +0000781 self.last = srowcol[0]
Armin Rigodd5c0232005-09-25 11:45:45 +0000782 if self.islambda: # lambdas always end at the first NEWLINE
783 raise EndOfBlock
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000784 elif self.passline:
785 pass
Tim Peters4efb6e92001-06-29 23:51:08 +0000786 elif type == tokenize.INDENT:
787 self.indent = self.indent + 1
Johannes Gijsbers1542f342004-12-12 16:46:28 +0000788 self.passline = True
Tim Peters4efb6e92001-06-29 23:51:08 +0000789 elif type == tokenize.DEDENT:
790 self.indent = self.indent - 1
Armin Rigodd5c0232005-09-25 11:45:45 +0000791 # the end of matching indent/dedent pairs end a block
792 # (note that this only works for "def"/"class" blocks,
793 # not e.g. for "if: else:" or "try: finally:" blocks)
794 if self.indent <= 0:
795 raise EndOfBlock
796 elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
797 # any other token on the same indentation level end the previous
798 # block as well, except the pseudo-tokens COMMENT and NL.
799 raise EndOfBlock
Tim Peters4efb6e92001-06-29 23:51:08 +0000800
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000801def getblock(lines):
802 """Extract the block of code at the top of the given list of lines."""
Armin Rigodd5c0232005-09-25 11:45:45 +0000803 blockfinder = BlockFinder()
Tim Peters4efb6e92001-06-29 23:51:08 +0000804 try:
Trent Nelson428de652008-03-18 22:41:35 +0000805 tokens = tokenize.generate_tokens(iter(lines).__next__)
806 for _token in tokens:
807 blockfinder.tokeneater(*_token)
Armin Rigodd5c0232005-09-25 11:45:45 +0000808 except (EndOfBlock, IndentationError):
809 pass
810 return lines[:blockfinder.last]
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000811
812def getsourcelines(object):
813 """Return a list of source lines and starting line number for an object.
814
815 The argument may be a module, class, method, function, traceback, frame,
816 or code object. The source code is returned as a list of the lines
817 corresponding to the object and the line number indicates where in the
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200818 original source file the first line of code was found. An OSError is
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000819 raised if the source code cannot be retrieved."""
Yury Selivanov081bbf62014-09-26 17:34:54 -0400820 object = unwrap(object)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000821 lines, lnum = findsource(object)
822
823 if ismodule(object): return lines, 0
824 else: return getblock(lines[lnum:]), lnum + 1
825
826def getsource(object):
827 """Return the text of the source code for an object.
828
829 The argument may be a module, class, method, function, traceback, frame,
830 or code object. The source code is returned as a single string. An
Andrew Svetlovf7a17b42012-12-25 16:47:37 +0200831 OSError is raised if the source code cannot be retrieved."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000832 lines, lnum = getsourcelines(object)
Neal Norwitz9d72bb42007-04-17 08:48:32 +0000833 return ''.join(lines)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000834
835# --------------------------------------------------- class tree extraction
836def walktree(classes, children, parent):
837 """Recursive helper function for getclasstree()."""
838 results = []
Raymond Hettingera1a992c2005-03-11 06:46:45 +0000839 classes.sort(key=attrgetter('__module__', '__name__'))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000840 for c in classes:
841 results.append((c, c.__bases__))
Raymond Hettinger54f02222002-06-01 14:18:47 +0000842 if c in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000843 results.append(walktree(children[c], children, c))
844 return results
845
Georg Brandl5ce83a02009-06-01 17:23:51 +0000846def getclasstree(classes, unique=False):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000847 """Arrange the given list of classes into a hierarchy of nested lists.
848
849 Where a nested list appears, it contains classes derived from the class
850 whose entry immediately precedes the list. Each entry is a 2-tuple
851 containing a class and a tuple of its base classes. If the 'unique'
852 argument is true, exactly one entry appears in the returned structure
853 for each class in the given list. Otherwise, classes using multiple
854 inheritance and their descendants will appear multiple times."""
855 children = {}
856 roots = []
857 for c in classes:
858 if c.__bases__:
859 for parent in c.__bases__:
Raymond Hettinger54f02222002-06-01 14:18:47 +0000860 if not parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000861 children[parent] = []
Serhiy Storchaka362c1b52013-09-05 17:14:32 +0300862 if c not in children[parent]:
863 children[parent].append(c)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000864 if unique and parent in classes: break
865 elif c not in roots:
866 roots.append(c)
Raymond Hettingere0d49722002-06-02 18:55:56 +0000867 for parent in children:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000868 if parent not in classes:
869 roots.append(parent)
870 return walktree(roots, children, None)
871
872# ------------------------------------------------ argument list extraction
Christian Heimes25bb7832008-01-11 16:17:00 +0000873Arguments = namedtuple('Arguments', 'args, varargs, varkw')
874
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000875def getargs(co):
876 """Get information about the arguments accepted by a code object.
877
Guido van Rossum2e65f892007-02-28 22:03:49 +0000878 Three things are returned: (args, varargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000879 'args' is the list of argument names. Keyword-only arguments are
880 appended. 'varargs' and 'varkw' are the names of the * and **
881 arguments or None."""
Guido van Rossum2e65f892007-02-28 22:03:49 +0000882 args, varargs, kwonlyargs, varkw = _getfullargs(co)
Christian Heimes25bb7832008-01-11 16:17:00 +0000883 return Arguments(args + kwonlyargs, varargs, varkw)
Guido van Rossum2e65f892007-02-28 22:03:49 +0000884
885def _getfullargs(co):
886 """Get information about the arguments accepted by a code object.
887
888 Four things are returned: (args, varargs, kwonlyargs, varkw), where
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000889 'args' and 'kwonlyargs' are lists of argument names, and 'varargs'
890 and 'varkw' are the names of the * and ** arguments or None."""
Jeremy Hylton64967882003-06-27 18:14:39 +0000891
892 if not iscode(co):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +0000893 raise TypeError('{!r} is not a code object'.format(co))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000894
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000895 nargs = co.co_argcount
896 names = co.co_varnames
Guido van Rossum2e65f892007-02-28 22:03:49 +0000897 nkwargs = co.co_kwonlyargcount
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000898 args = list(names[:nargs])
Guido van Rossum2e65f892007-02-28 22:03:49 +0000899 kwonlyargs = list(names[nargs:nargs+nkwargs])
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000900 step = 0
901
Guido van Rossum2e65f892007-02-28 22:03:49 +0000902 nargs += nkwargs
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000903 varargs = None
904 if co.co_flags & CO_VARARGS:
905 varargs = co.co_varnames[nargs]
906 nargs = nargs + 1
907 varkw = None
908 if co.co_flags & CO_VARKEYWORDS:
909 varkw = co.co_varnames[nargs]
Guido van Rossum2e65f892007-02-28 22:03:49 +0000910 return args, varargs, kwonlyargs, varkw
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000911
Christian Heimes25bb7832008-01-11 16:17:00 +0000912
913ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults')
914
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +0000915def getargspec(func):
916 """Get the names and default values of a function's arguments.
917
Guido van Rossume82881c2014-07-15 12:29:11 -0700918 A tuple of four things is returned: (args, varargs, keywords, defaults).
919 'args' is a list of the argument names, including keyword-only argument names.
920 'varargs' and 'keywords' are the names of the * and ** arguments or None.
Jeremy Hylton64967882003-06-27 18:14:39 +0000921 'defaults' is an n-tuple of the default values of the last n arguments.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000922
Yury Selivanov0cf3ed62014-04-01 10:17:08 -0400923 Use the getfullargspec() API for Python 3 code, as annotations
Guido van Rossum2e65f892007-02-28 22:03:49 +0000924 and keyword arguments are supported. getargspec() will raise ValueError
925 if the func has either annotations or keyword arguments.
926 """
927
928 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \
929 getfullargspec(func)
930 if kwonlyargs or ann:
Collin Winterce36ad82007-08-30 01:19:48 +0000931 raise ValueError("Function has keyword-only arguments or annotations"
932 ", use getfullargspec() API which can support them")
Christian Heimes25bb7832008-01-11 16:17:00 +0000933 return ArgSpec(args, varargs, varkw, defaults)
934
935FullArgSpec = namedtuple('FullArgSpec',
Benjamin Peterson3d4ca742008-11-12 21:39:01 +0000936 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations')
Guido van Rossum2e65f892007-02-28 22:03:49 +0000937
938def getfullargspec(func):
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500939 """Get the names and default values of a callable object's arguments.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000940
Brett Cannon504d8852007-09-07 02:12:14 +0000941 A tuple of seven things is returned:
942 (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults annotations).
Georg Brandlc1c4bf82010-10-15 16:07:41 +0000943 'args' is a list of the argument names.
Guido van Rossum2e65f892007-02-28 22:03:49 +0000944 'varargs' and 'varkw' are the names of the * and ** arguments or None.
945 'defaults' is an n-tuple of the default values of the last n arguments.
946 'kwonlyargs' is a list of keyword-only argument names.
947 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults.
948 'annotations' is a dictionary mapping argument names to annotations.
Guido van Rossuma8add0e2007-05-14 22:03:55 +0000949
Guido van Rossum2e65f892007-02-28 22:03:49 +0000950 The first four items in the tuple correspond to getargspec().
Jeremy Hylton64967882003-06-27 18:14:39 +0000951 """
952
Yury Selivanov57d240e2014-02-19 16:27:23 -0500953 try:
954 # Re: `skip_bound_arg=False`
955 #
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500956 # There is a notable difference in behaviour between getfullargspec
957 # and Signature: the former always returns 'self' parameter for bound
958 # methods, whereas the Signature always shows the actual calling
959 # signature of the passed object.
960 #
961 # To simulate this behaviour, we "unbind" bound methods, to trick
962 # inspect.signature to always return their first parameter ("self",
963 # usually)
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500964
Yury Selivanov57d240e2014-02-19 16:27:23 -0500965 # Re: `follow_wrapper_chains=False`
966 #
967 # getfullargspec() historically ignored __wrapped__ attributes,
968 # so we ensure that remains the case in 3.3+
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500969
Yury Selivanov5a23bd02014-03-29 13:47:11 -0400970 sig = _signature_from_callable(func,
971 follow_wrapper_chains=False,
972 skip_bound_arg=False,
973 sigcls=Signature)
Yury Selivanovd82eddc2014-01-29 11:24:39 -0500974 except Exception as ex:
975 # Most of the times 'signature' will raise ValueError.
976 # But, it can also raise AttributeError, and, maybe something
977 # else. So to be fully backwards compatible, we catch all
978 # possible exceptions here, and reraise a TypeError.
979 raise TypeError('unsupported callable') from ex
980
981 args = []
982 varargs = None
983 varkw = None
984 kwonlyargs = []
985 defaults = ()
986 annotations = {}
987 defaults = ()
988 kwdefaults = {}
989
990 if sig.return_annotation is not sig.empty:
991 annotations['return'] = sig.return_annotation
992
993 for param in sig.parameters.values():
994 kind = param.kind
995 name = param.name
996
997 if kind is _POSITIONAL_ONLY:
998 args.append(name)
999 elif kind is _POSITIONAL_OR_KEYWORD:
1000 args.append(name)
1001 if param.default is not param.empty:
1002 defaults += (param.default,)
1003 elif kind is _VAR_POSITIONAL:
1004 varargs = name
1005 elif kind is _KEYWORD_ONLY:
1006 kwonlyargs.append(name)
1007 if param.default is not param.empty:
1008 kwdefaults[name] = param.default
1009 elif kind is _VAR_KEYWORD:
1010 varkw = name
1011
1012 if param.annotation is not param.empty:
1013 annotations[name] = param.annotation
1014
1015 if not kwdefaults:
1016 # compatibility with 'func.__kwdefaults__'
1017 kwdefaults = None
1018
1019 if not defaults:
1020 # compatibility with 'func.__defaults__'
1021 defaults = None
1022
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001023 return FullArgSpec(args, varargs, varkw, defaults,
1024 kwonlyargs, kwdefaults, annotations)
1025
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001026
Christian Heimes25bb7832008-01-11 16:17:00 +00001027ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals')
1028
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001029def getargvalues(frame):
1030 """Get information about arguments passed into a particular frame.
1031
1032 A tuple of four things is returned: (args, varargs, varkw, locals).
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001033 'args' is a list of the argument names.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001034 'varargs' and 'varkw' are the names of the * and ** arguments or None.
1035 'locals' is the locals dictionary of the given frame."""
1036 args, varargs, varkw = getargs(frame.f_code)
Benjamin Peterson1a6e0d02008-10-25 15:49:17 +00001037 return ArgInfo(args, varargs, varkw, frame.f_locals)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001038
Guido van Rossum2e65f892007-02-28 22:03:49 +00001039def formatannotation(annotation, base_module=None):
1040 if isinstance(annotation, type):
Georg Brandl1a3284e2007-12-02 09:40:06 +00001041 if annotation.__module__ in ('builtins', base_module):
Serhiy Storchaka521e5862014-07-22 15:00:37 +03001042 return annotation.__qualname__
1043 return annotation.__module__+'.'+annotation.__qualname__
Guido van Rossum2e65f892007-02-28 22:03:49 +00001044 return repr(annotation)
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001045
Guido van Rossum2e65f892007-02-28 22:03:49 +00001046def formatannotationrelativeto(object):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001047 module = getattr(object, '__module__', None)
1048 def _formatannotation(annotation):
1049 return formatannotation(annotation, module)
1050 return _formatannotation
Guido van Rossum2e65f892007-02-28 22:03:49 +00001051
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001052def formatargspec(args, varargs=None, varkw=None, defaults=None,
Guido van Rossum2e65f892007-02-28 22:03:49 +00001053 kwonlyargs=(), kwonlydefaults={}, annotations={},
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001054 formatarg=str,
1055 formatvarargs=lambda name: '*' + name,
1056 formatvarkw=lambda name: '**' + name,
1057 formatvalue=lambda value: '=' + repr(value),
Guido van Rossum2e65f892007-02-28 22:03:49 +00001058 formatreturns=lambda text: ' -> ' + text,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001059 formatannotation=formatannotation):
Guido van Rossuma8add0e2007-05-14 22:03:55 +00001060 """Format an argument spec from the values returned by getargspec
Guido van Rossum2e65f892007-02-28 22:03:49 +00001061 or getfullargspec.
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001062
Guido van Rossum2e65f892007-02-28 22:03:49 +00001063 The first seven arguments are (args, varargs, varkw, defaults,
1064 kwonlyargs, kwonlydefaults, annotations). The other five arguments
1065 are the corresponding optional formatting functions that are called to
1066 turn names and values into strings. The last argument is an optional
1067 function to format the sequence of arguments."""
1068 def formatargandannotation(arg):
1069 result = formatarg(arg)
1070 if arg in annotations:
1071 result += ': ' + formatannotation(annotations[arg])
1072 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001073 specs = []
1074 if defaults:
1075 firstdefault = len(args) - len(defaults)
Benjamin Petersonb58dda72009-01-18 22:27:04 +00001076 for i, arg in enumerate(args):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001077 spec = formatargandannotation(arg)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001078 if defaults and i >= firstdefault:
1079 spec = spec + formatvalue(defaults[i - firstdefault])
1080 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001081 if varargs is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001082 specs.append(formatvarargs(formatargandannotation(varargs)))
1083 else:
1084 if kwonlyargs:
1085 specs.append('*')
1086 if kwonlyargs:
1087 for kwonlyarg in kwonlyargs:
1088 spec = formatargandannotation(kwonlyarg)
Benjamin Peterson9953a8d2009-01-17 04:15:01 +00001089 if kwonlydefaults and kwonlyarg in kwonlydefaults:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001090 spec += formatvalue(kwonlydefaults[kwonlyarg])
1091 specs.append(spec)
Raymond Hettinger936654b2002-06-01 03:06:31 +00001092 if varkw is not None:
Guido van Rossum2e65f892007-02-28 22:03:49 +00001093 specs.append(formatvarkw(formatargandannotation(varkw)))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001094 result = '(' + ', '.join(specs) + ')'
Guido van Rossum2e65f892007-02-28 22:03:49 +00001095 if 'return' in annotations:
1096 result += formatreturns(formatannotation(annotations['return']))
1097 return result
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001098
1099def formatargvalues(args, varargs, varkw, locals,
1100 formatarg=str,
1101 formatvarargs=lambda name: '*' + name,
1102 formatvarkw=lambda name: '**' + name,
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001103 formatvalue=lambda value: '=' + repr(value)):
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001104 """Format an argument spec from the 4 values returned by getargvalues.
1105
1106 The first four arguments are (args, varargs, varkw, locals). The
1107 next four arguments are the corresponding optional formatting functions
1108 that are called to turn names and values into strings. The ninth
1109 argument is an optional function to format the sequence of arguments."""
1110 def convert(name, locals=locals,
1111 formatarg=formatarg, formatvalue=formatvalue):
1112 return formatarg(name) + formatvalue(locals[name])
1113 specs = []
1114 for i in range(len(args)):
Georg Brandlc1c4bf82010-10-15 16:07:41 +00001115 specs.append(convert(args[i]))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001116 if varargs:
1117 specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
1118 if varkw:
1119 specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
Neal Norwitz9d72bb42007-04-17 08:48:32 +00001120 return '(' + ', '.join(specs) + ')'
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001121
Benjamin Petersone109c702011-06-24 09:37:26 -05001122def _missing_arguments(f_name, argnames, pos, values):
1123 names = [repr(name) for name in argnames if name not in values]
1124 missing = len(names)
1125 if missing == 1:
1126 s = names[0]
1127 elif missing == 2:
1128 s = "{} and {}".format(*names)
1129 else:
Yury Selivanovdccfa132014-03-27 18:42:52 -04001130 tail = ", {} and {}".format(*names[-2:])
Benjamin Petersone109c702011-06-24 09:37:26 -05001131 del names[-2:]
1132 s = ", ".join(names) + tail
1133 raise TypeError("%s() missing %i required %s argument%s: %s" %
1134 (f_name, missing,
1135 "positional" if pos else "keyword-only",
1136 "" if missing == 1 else "s", s))
1137
1138def _too_many(f_name, args, kwonly, varargs, defcount, given, values):
Benjamin Petersonb204a422011-06-05 22:04:07 -05001139 atleast = len(args) - defcount
Benjamin Petersonb204a422011-06-05 22:04:07 -05001140 kwonly_given = len([arg for arg in kwonly if arg in values])
1141 if varargs:
1142 plural = atleast != 1
1143 sig = "at least %d" % (atleast,)
1144 elif defcount:
1145 plural = True
1146 sig = "from %d to %d" % (atleast, len(args))
1147 else:
1148 plural = len(args) != 1
1149 sig = str(len(args))
1150 kwonly_sig = ""
1151 if kwonly_given:
1152 msg = " positional argument%s (and %d keyword-only argument%s)"
1153 kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given,
1154 "s" if kwonly_given != 1 else ""))
1155 raise TypeError("%s() takes %s positional argument%s but %d%s %s given" %
1156 (f_name, sig, "s" if plural else "", given, kwonly_sig,
1157 "was" if given == 1 and not kwonly_given else "were"))
1158
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001159def getcallargs(*func_and_positional, **named):
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001160 """Get the mapping of arguments to values.
1161
1162 A dict is returned, with keys the function argument names (including the
1163 names of the * and ** arguments, if any), and values the respective bound
1164 values from 'positional' and 'named'."""
Benjamin Peterson3e6ab172014-01-02 12:24:08 -06001165 func = func_and_positional[0]
1166 positional = func_and_positional[1:]
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001167 spec = getfullargspec(func)
1168 args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec
1169 f_name = func.__name__
1170 arg2value = {}
1171
Benjamin Petersonb204a422011-06-05 22:04:07 -05001172
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001173 if ismethod(func) and func.__self__ is not None:
1174 # implicit 'self' (or 'cls' for classmethods) argument
1175 positional = (func.__self__,) + positional
1176 num_pos = len(positional)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001177 num_args = len(args)
1178 num_defaults = len(defaults) if defaults else 0
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001179
Benjamin Petersonb204a422011-06-05 22:04:07 -05001180 n = min(num_pos, num_args)
1181 for i in range(n):
1182 arg2value[args[i]] = positional[i]
1183 if varargs:
1184 arg2value[varargs] = tuple(positional[n:])
1185 possible_kwargs = set(args + kwonlyargs)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001186 if varkw:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001187 arg2value[varkw] = {}
1188 for kw, value in named.items():
1189 if kw not in possible_kwargs:
1190 if not varkw:
1191 raise TypeError("%s() got an unexpected keyword argument %r" %
1192 (f_name, kw))
1193 arg2value[varkw][kw] = value
1194 continue
1195 if kw in arg2value:
1196 raise TypeError("%s() got multiple values for argument %r" %
1197 (f_name, kw))
1198 arg2value[kw] = value
1199 if num_pos > num_args and not varargs:
Benjamin Petersone109c702011-06-24 09:37:26 -05001200 _too_many(f_name, args, kwonlyargs, varargs, num_defaults,
1201 num_pos, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001202 if num_pos < num_args:
Benjamin Petersone109c702011-06-24 09:37:26 -05001203 req = args[:num_args - num_defaults]
1204 for arg in req:
Benjamin Petersonb204a422011-06-05 22:04:07 -05001205 if arg not in arg2value:
Benjamin Petersone109c702011-06-24 09:37:26 -05001206 _missing_arguments(f_name, req, True, arg2value)
Benjamin Petersonb204a422011-06-05 22:04:07 -05001207 for i, arg in enumerate(args[num_args - num_defaults:]):
1208 if arg not in arg2value:
1209 arg2value[arg] = defaults[i]
Benjamin Petersone109c702011-06-24 09:37:26 -05001210 missing = 0
Benjamin Petersonb204a422011-06-05 22:04:07 -05001211 for kwarg in kwonlyargs:
1212 if kwarg not in arg2value:
Yury Selivanov875df202014-03-27 18:23:03 -04001213 if kwonlydefaults and kwarg in kwonlydefaults:
Benjamin Petersone109c702011-06-24 09:37:26 -05001214 arg2value[kwarg] = kwonlydefaults[kwarg]
1215 else:
1216 missing += 1
1217 if missing:
1218 _missing_arguments(f_name, kwonlyargs, False, arg2value)
Benjamin Peterson25cd7eb2010-03-30 18:42:32 +00001219 return arg2value
1220
Nick Coghlan2f92e542012-06-23 19:39:55 +10001221ClosureVars = namedtuple('ClosureVars', 'nonlocals globals builtins unbound')
1222
1223def getclosurevars(func):
1224 """
1225 Get the mapping of free variables to their current values.
1226
Meador Inge8fda3592012-07-19 21:33:21 -05001227 Returns a named tuple of dicts mapping the current nonlocal, global
Nick Coghlan2f92e542012-06-23 19:39:55 +10001228 and builtin references as seen by the body of the function. A final
1229 set of unbound names that could not be resolved is also provided.
1230 """
1231
1232 if ismethod(func):
1233 func = func.__func__
1234
1235 if not isfunction(func):
1236 raise TypeError("'{!r}' is not a Python function".format(func))
1237
1238 code = func.__code__
1239 # Nonlocal references are named in co_freevars and resolved
1240 # by looking them up in __closure__ by positional index
1241 if func.__closure__ is None:
1242 nonlocal_vars = {}
1243 else:
1244 nonlocal_vars = {
1245 var : cell.cell_contents
1246 for var, cell in zip(code.co_freevars, func.__closure__)
1247 }
1248
1249 # Global and builtin references are named in co_names and resolved
1250 # by looking them up in __globals__ or __builtins__
1251 global_ns = func.__globals__
1252 builtin_ns = global_ns.get("__builtins__", builtins.__dict__)
1253 if ismodule(builtin_ns):
1254 builtin_ns = builtin_ns.__dict__
1255 global_vars = {}
1256 builtin_vars = {}
1257 unbound_names = set()
1258 for name in code.co_names:
1259 if name in ("None", "True", "False"):
1260 # Because these used to be builtins instead of keywords, they
1261 # may still show up as name references. We ignore them.
1262 continue
1263 try:
1264 global_vars[name] = global_ns[name]
1265 except KeyError:
1266 try:
1267 builtin_vars[name] = builtin_ns[name]
1268 except KeyError:
1269 unbound_names.add(name)
1270
1271 return ClosureVars(nonlocal_vars, global_vars,
1272 builtin_vars, unbound_names)
1273
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001274# -------------------------------------------------- stack frame extraction
Christian Heimes25bb7832008-01-11 16:17:00 +00001275
1276Traceback = namedtuple('Traceback', 'filename lineno function code_context index')
1277
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001278def getframeinfo(frame, context=1):
1279 """Get information about a frame or traceback object.
1280
1281 A tuple of five things is returned: the filename, the line number of
1282 the current line, the function name, a list of lines of context from
1283 the source code, and the index of the current line within that list.
1284 The optional second argument specifies the number of lines of context
1285 to return, which are centered around the current line."""
1286 if istraceback(frame):
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001287 lineno = frame.tb_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001288 frame = frame.tb_frame
Andrew M. Kuchlingba8b6bc2004-06-05 14:11:59 +00001289 else:
1290 lineno = frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001291 if not isframe(frame):
Benjamin Peterson4ac9ce42009-10-04 14:49:41 +00001292 raise TypeError('{!r} is not a frame or traceback object'.format(frame))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001293
Neil Schemenauerf06f8532002-03-23 23:51:04 +00001294 filename = getsourcefile(frame) or getfile(frame)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001295 if context > 0:
Guido van Rossum54e54c62001-09-04 19:14:14 +00001296 start = lineno - 1 - context//2
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001297 try:
1298 lines, lnum = findsource(frame)
Andrew Svetlovf7a17b42012-12-25 16:47:37 +02001299 except OSError:
Ka-Ping Yee4eb0c002001-03-02 05:50:34 +00001300 lines = index = None
1301 else:
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001302 start = max(start, 1)
Raymond Hettingera0501712004-06-15 11:22:53 +00001303 start = max(0, min(start, len(lines) - context))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001304 lines = lines[start:start+context]
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001305 index = lineno - 1 - start
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001306 else:
1307 lines = index = None
1308
Christian Heimes25bb7832008-01-11 16:17:00 +00001309 return Traceback(filename, lineno, frame.f_code.co_name, lines, index)
Ka-Ping Yee59ade082001-03-01 03:55:35 +00001310
1311def getlineno(frame):
1312 """Get the line number from a frame object, allowing for optimization."""
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001313 # FrameType.f_lineno is now a descriptor that grovels co_lnotab
1314 return frame.f_lineno
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001315
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001316FrameInfo = namedtuple('FrameInfo', ('frame',) + Traceback._fields)
1317
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001318def getouterframes(frame, context=1):
1319 """Get a list of records for a frame and all higher (calling) frames.
1320
1321 Each record contains a frame object, filename, line number, function
1322 name, a list of lines of context, and index within the context."""
1323 framelist = []
1324 while frame:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001325 frameinfo = (frame,) + getframeinfo(frame, context)
1326 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001327 frame = frame.f_back
1328 return framelist
1329
1330def getinnerframes(tb, context=1):
1331 """Get a list of records for a traceback's frame and all lower frames.
1332
1333 Each record contains a frame object, filename, line number, function
1334 name, a list of lines of context, and index within the context."""
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001335 framelist = []
1336 while tb:
Antoine Pitroucdcafb72014-08-24 10:50:28 -04001337 frameinfo = (tb.tb_frame,) + getframeinfo(tb, context)
1338 framelist.append(FrameInfo(*frameinfo))
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001339 tb = tb.tb_next
1340 return framelist
1341
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001342def currentframe():
Benjamin Petersona3a3fc62010-08-09 15:49:56 +00001343 """Return the frame of the caller or None if this is not possible."""
Benjamin Peterson42ac4752010-08-09 13:05:35 +00001344 return sys._getframe(1) if hasattr(sys, "_getframe") else None
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001345
1346def stack(context=1):
1347 """Return a list of records for the stack above the caller's frame."""
Jeremy Hyltonab919022003-06-27 18:41:20 +00001348 return getouterframes(sys._getframe(1), context)
Ka-Ping Yee6397c7c2001-02-27 14:43:21 +00001349
1350def trace(context=1):
Tim Peters85ba6732001-02-28 08:26:44 +00001351 """Return a list of records for the stack below the current exception."""
Fred Draked451ec12002-04-26 02:29:55 +00001352 return getinnerframes(sys.exc_info()[2], context)
Michael Foord95fc51d2010-11-20 15:07:30 +00001353
1354
1355# ------------------------------------------------ static version of getattr
1356
1357_sentinel = object()
1358
Michael Foorde5162652010-11-20 16:40:44 +00001359def _static_getmro(klass):
1360 return type.__dict__['__mro__'].__get__(klass)
1361
Michael Foord95fc51d2010-11-20 15:07:30 +00001362def _check_instance(obj, attr):
1363 instance_dict = {}
1364 try:
1365 instance_dict = object.__getattribute__(obj, "__dict__")
1366 except AttributeError:
1367 pass
Michael Foorddcebe0f2011-03-15 19:20:44 -04001368 return dict.get(instance_dict, attr, _sentinel)
Michael Foord95fc51d2010-11-20 15:07:30 +00001369
1370
1371def _check_class(klass, attr):
Michael Foorde5162652010-11-20 16:40:44 +00001372 for entry in _static_getmro(klass):
Michael Foorda51623b2011-12-18 22:01:40 +00001373 if _shadowed_dict(type(entry)) is _sentinel:
Michael Foorddcebe0f2011-03-15 19:20:44 -04001374 try:
1375 return entry.__dict__[attr]
1376 except KeyError:
1377 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001378 return _sentinel
1379
Michael Foord35184ed2010-11-20 16:58:30 +00001380def _is_type(obj):
1381 try:
1382 _static_getmro(obj)
1383 except TypeError:
1384 return False
1385 return True
1386
Michael Foorddcebe0f2011-03-15 19:20:44 -04001387def _shadowed_dict(klass):
1388 dict_attr = type.__dict__["__dict__"]
1389 for entry in _static_getmro(klass):
1390 try:
1391 class_dict = dict_attr.__get__(entry)["__dict__"]
1392 except KeyError:
1393 pass
1394 else:
1395 if not (type(class_dict) is types.GetSetDescriptorType and
1396 class_dict.__name__ == "__dict__" and
1397 class_dict.__objclass__ is entry):
Michael Foorda51623b2011-12-18 22:01:40 +00001398 return class_dict
1399 return _sentinel
Michael Foord95fc51d2010-11-20 15:07:30 +00001400
1401def getattr_static(obj, attr, default=_sentinel):
1402 """Retrieve attributes without triggering dynamic lookup via the
1403 descriptor protocol, __getattr__ or __getattribute__.
1404
1405 Note: this function may not be able to retrieve all attributes
1406 that getattr can fetch (like dynamically created attributes)
1407 and may find attributes that getattr can't (like descriptors
1408 that raise AttributeError). It can also return descriptor objects
1409 instead of instance members in some cases. See the
1410 documentation for details.
1411 """
1412 instance_result = _sentinel
Michael Foord35184ed2010-11-20 16:58:30 +00001413 if not _is_type(obj):
Michael Foordcc7ebb82010-11-20 16:20:16 +00001414 klass = type(obj)
Michael Foorda51623b2011-12-18 22:01:40 +00001415 dict_attr = _shadowed_dict(klass)
1416 if (dict_attr is _sentinel or
1417 type(dict_attr) is types.MemberDescriptorType):
Michael Foorddcebe0f2011-03-15 19:20:44 -04001418 instance_result = _check_instance(obj, attr)
Michael Foord95fc51d2010-11-20 15:07:30 +00001419 else:
1420 klass = obj
1421
1422 klass_result = _check_class(klass, attr)
1423
1424 if instance_result is not _sentinel and klass_result is not _sentinel:
1425 if (_check_class(type(klass_result), '__get__') is not _sentinel and
1426 _check_class(type(klass_result), '__set__') is not _sentinel):
1427 return klass_result
1428
1429 if instance_result is not _sentinel:
1430 return instance_result
1431 if klass_result is not _sentinel:
1432 return klass_result
1433
1434 if obj is klass:
1435 # for types we check the metaclass too
Michael Foorde5162652010-11-20 16:40:44 +00001436 for entry in _static_getmro(type(klass)):
Michael Foord3ba95f82011-12-22 01:13:37 +00001437 if _shadowed_dict(type(entry)) is _sentinel:
1438 try:
1439 return entry.__dict__[attr]
1440 except KeyError:
1441 pass
Michael Foord95fc51d2010-11-20 15:07:30 +00001442 if default is not _sentinel:
1443 return default
1444 raise AttributeError(attr)
Nick Coghlane0f04652010-11-21 03:44:04 +00001445
1446
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001447# ------------------------------------------------ generator introspection
1448
Nick Coghlan7921b9f2010-11-30 06:36:04 +00001449GEN_CREATED = 'GEN_CREATED'
1450GEN_RUNNING = 'GEN_RUNNING'
1451GEN_SUSPENDED = 'GEN_SUSPENDED'
1452GEN_CLOSED = 'GEN_CLOSED'
Nick Coghlane0f04652010-11-21 03:44:04 +00001453
1454def getgeneratorstate(generator):
1455 """Get current state of a generator-iterator.
1456
1457 Possible states are:
1458 GEN_CREATED: Waiting to start execution.
1459 GEN_RUNNING: Currently being executed by the interpreter.
1460 GEN_SUSPENDED: Currently suspended at a yield expression.
1461 GEN_CLOSED: Execution has completed.
1462 """
1463 if generator.gi_running:
1464 return GEN_RUNNING
1465 if generator.gi_frame is None:
1466 return GEN_CLOSED
1467 if generator.gi_frame.f_lasti == -1:
1468 return GEN_CREATED
1469 return GEN_SUSPENDED
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001470
1471
Nick Coghlan04e2e3f2012-06-23 19:52:05 +10001472def getgeneratorlocals(generator):
1473 """
1474 Get the mapping of generator local variables to their current values.
1475
1476 A dict is returned, with the keys the local variable names and values the
1477 bound values."""
1478
1479 if not isgenerator(generator):
1480 raise TypeError("'{!r}' is not a Python generator".format(generator))
1481
1482 frame = getattr(generator, "gi_frame", None)
1483 if frame is not None:
1484 return generator.gi_frame.f_locals
1485 else:
1486 return {}
1487
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001488###############################################################################
1489### Function Signature Object (PEP 362)
1490###############################################################################
1491
1492
1493_WrapperDescriptor = type(type.__call__)
1494_MethodWrapper = type(all.__call__)
Larry Hastings5c661892014-01-24 06:17:25 -08001495_ClassMethodWrapper = type(int.__dict__['from_bytes'])
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001496
1497_NonUserDefinedCallables = (_WrapperDescriptor,
1498 _MethodWrapper,
Larry Hastings5c661892014-01-24 06:17:25 -08001499 _ClassMethodWrapper,
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001500 types.BuiltinFunctionType)
1501
1502
Yury Selivanov421f0c72014-01-29 12:05:40 -05001503def _signature_get_user_defined_method(cls, method_name):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001504 """Private helper. Checks if ``cls`` has an attribute
1505 named ``method_name`` and returns it only if it is a
1506 pure python function.
1507 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001508 try:
1509 meth = getattr(cls, method_name)
1510 except AttributeError:
1511 return
1512 else:
1513 if not isinstance(meth, _NonUserDefinedCallables):
1514 # Once '__signature__' will be added to 'C'-level
1515 # callables, this check won't be necessary
1516 return meth
1517
1518
Yury Selivanov62560fb2014-01-28 12:26:24 -05001519def _signature_get_partial(wrapped_sig, partial, extra_args=()):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001520 """Private helper to calculate how 'wrapped_sig' signature will
1521 look like after applying a 'functools.partial' object (or alike)
1522 on it.
1523 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001524
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001525 old_params = wrapped_sig.parameters
1526 new_params = OrderedDict(old_params.items())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001527
1528 partial_args = partial.args or ()
1529 partial_keywords = partial.keywords or {}
1530
1531 if extra_args:
1532 partial_args = extra_args + partial_args
1533
1534 try:
1535 ba = wrapped_sig.bind_partial(*partial_args, **partial_keywords)
1536 except TypeError as ex:
1537 msg = 'partial object {!r} has incorrect arguments'.format(partial)
1538 raise ValueError(msg) from ex
1539
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001540
Yury Selivanov3f73ca22014-04-08 11:30:45 -04001541 transform_to_kwonly = False
1542 for param_name, param in old_params.items():
1543 try:
1544 arg_value = ba.arguments[param_name]
1545 except KeyError:
1546 pass
1547 else:
1548 if param.kind is _POSITIONAL_ONLY:
1549 # If positional-only parameter is bound by partial,
1550 # it effectively disappears from the signature
1551 new_params.pop(param_name)
1552 continue
1553
1554 if param.kind is _POSITIONAL_OR_KEYWORD:
1555 if param_name in partial_keywords:
1556 # This means that this parameter, and all parameters
1557 # after it should be keyword-only (and var-positional
1558 # should be removed). Here's why. Consider the following
1559 # function:
1560 # foo(a, b, *args, c):
1561 # pass
1562 #
1563 # "partial(foo, a='spam')" will have the following
1564 # signature: "(*, a='spam', b, c)". Because attempting
1565 # to call that partial with "(10, 20)" arguments will
1566 # raise a TypeError, saying that "a" argument received
1567 # multiple values.
1568 transform_to_kwonly = True
1569 # Set the new default value
1570 new_params[param_name] = param.replace(default=arg_value)
1571 else:
1572 # was passed as a positional argument
1573 new_params.pop(param.name)
1574 continue
1575
1576 if param.kind is _KEYWORD_ONLY:
1577 # Set the new default value
1578 new_params[param_name] = param.replace(default=arg_value)
1579
1580 if transform_to_kwonly:
1581 assert param.kind is not _POSITIONAL_ONLY
1582
1583 if param.kind is _POSITIONAL_OR_KEYWORD:
1584 new_param = new_params[param_name].replace(kind=_KEYWORD_ONLY)
1585 new_params[param_name] = new_param
1586 new_params.move_to_end(param_name)
1587 elif param.kind in (_KEYWORD_ONLY, _VAR_KEYWORD):
1588 new_params.move_to_end(param_name)
1589 elif param.kind is _VAR_POSITIONAL:
1590 new_params.pop(param.name)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001591
1592 return wrapped_sig.replace(parameters=new_params.values())
1593
1594
Yury Selivanov62560fb2014-01-28 12:26:24 -05001595def _signature_bound_method(sig):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001596 """Private helper to transform signatures for unbound
1597 functions to bound methods.
1598 """
Yury Selivanov62560fb2014-01-28 12:26:24 -05001599
1600 params = tuple(sig.parameters.values())
1601
1602 if not params or params[0].kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
1603 raise ValueError('invalid method signature')
1604
1605 kind = params[0].kind
1606 if kind in (_POSITIONAL_OR_KEYWORD, _POSITIONAL_ONLY):
1607 # Drop first parameter:
1608 # '(p1, p2[, ...])' -> '(p2[, ...])'
1609 params = params[1:]
1610 else:
1611 if kind is not _VAR_POSITIONAL:
1612 # Unless we add a new parameter type we never
1613 # get here
1614 raise ValueError('invalid argument type')
1615 # It's a var-positional parameter.
1616 # Do nothing. '(*args[, ...])' -> '(*args[, ...])'
1617
1618 return sig.replace(parameters=params)
1619
1620
Yury Selivanovb77511d2014-01-29 10:46:14 -05001621def _signature_is_builtin(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001622 """Private helper to test if `obj` is a callable that might
1623 support Argument Clinic's __text_signature__ protocol.
1624 """
Yury Selivanov1d241832014-02-02 12:51:20 -05001625 return (isbuiltin(obj) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001626 ismethoddescriptor(obj) or
Yury Selivanov1d241832014-02-02 12:51:20 -05001627 isinstance(obj, _NonUserDefinedCallables) or
Yury Selivanovb77511d2014-01-29 10:46:14 -05001628 # Can't test 'isinstance(type)' here, as it would
1629 # also be True for regular python classes
1630 obj in (type, object))
1631
1632
Yury Selivanov63da7c72014-01-31 14:48:37 -05001633def _signature_is_functionlike(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001634 """Private helper to test if `obj` is a duck type of FunctionType.
1635 A good example of such objects are functions compiled with
1636 Cython, which have all attributes that a pure Python function
1637 would have, but have their code statically compiled.
1638 """
Yury Selivanov63da7c72014-01-31 14:48:37 -05001639
1640 if not callable(obj) or isclass(obj):
1641 # All function-like objects are obviously callables,
1642 # and not classes.
1643 return False
1644
1645 name = getattr(obj, '__name__', None)
1646 code = getattr(obj, '__code__', None)
1647 defaults = getattr(obj, '__defaults__', _void) # Important to use _void ...
1648 kwdefaults = getattr(obj, '__kwdefaults__', _void) # ... and not None here
1649 annotations = getattr(obj, '__annotations__', None)
1650
1651 return (isinstance(code, types.CodeType) and
1652 isinstance(name, str) and
1653 (defaults is None or isinstance(defaults, tuple)) and
1654 (kwdefaults is None or isinstance(kwdefaults, dict)) and
1655 isinstance(annotations, dict))
1656
1657
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001658def _signature_get_bound_param(spec):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001659 """ Private helper to get first parameter name from a
1660 __text_signature__ of a builtin method, which should
1661 be in the following format: '($param1, ...)'.
1662 Assumptions are that the first argument won't have
1663 a default value or an annotation.
1664 """
Yury Selivanovd82eddc2014-01-29 11:24:39 -05001665
1666 assert spec.startswith('($')
1667
1668 pos = spec.find(',')
1669 if pos == -1:
1670 pos = spec.find(')')
1671
1672 cpos = spec.find(':')
1673 assert cpos == -1 or cpos > pos
1674
1675 cpos = spec.find('=')
1676 assert cpos == -1 or cpos > pos
1677
1678 return spec[2:pos]
1679
1680
Larry Hastings2623c8c2014-02-08 22:15:29 -08001681def _signature_strip_non_python_syntax(signature):
1682 """
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001683 Private helper function. Takes a signature in Argument Clinic's
1684 extended signature format.
1685
Larry Hastings2623c8c2014-02-08 22:15:29 -08001686 Returns a tuple of three things:
1687 * that signature re-rendered in standard Python syntax,
1688 * the index of the "self" parameter (generally 0), or None if
1689 the function does not have a "self" parameter, and
1690 * the index of the last "positional only" parameter,
1691 or None if the signature has no positional-only parameters.
1692 """
1693
1694 if not signature:
1695 return signature, None, None
1696
1697 self_parameter = None
1698 last_positional_only = None
1699
1700 lines = [l.encode('ascii') for l in signature.split('\n')]
1701 generator = iter(lines).__next__
1702 token_stream = tokenize.tokenize(generator)
1703
1704 delayed_comma = False
1705 skip_next_comma = False
1706 text = []
1707 add = text.append
1708
1709 current_parameter = 0
1710 OP = token.OP
1711 ERRORTOKEN = token.ERRORTOKEN
1712
1713 # token stream always starts with ENCODING token, skip it
1714 t = next(token_stream)
1715 assert t.type == tokenize.ENCODING
1716
1717 for t in token_stream:
1718 type, string = t.type, t.string
1719
1720 if type == OP:
1721 if string == ',':
1722 if skip_next_comma:
1723 skip_next_comma = False
1724 else:
1725 assert not delayed_comma
1726 delayed_comma = True
1727 current_parameter += 1
1728 continue
1729
1730 if string == '/':
1731 assert not skip_next_comma
1732 assert last_positional_only is None
1733 skip_next_comma = True
1734 last_positional_only = current_parameter - 1
1735 continue
1736
1737 if (type == ERRORTOKEN) and (string == '$'):
1738 assert self_parameter is None
1739 self_parameter = current_parameter
1740 continue
1741
1742 if delayed_comma:
1743 delayed_comma = False
1744 if not ((type == OP) and (string == ')')):
1745 add(', ')
1746 add(string)
1747 if (string == ','):
1748 add(' ')
1749 clean_signature = ''.join(text)
1750 return clean_signature, self_parameter, last_positional_only
1751
1752
Yury Selivanov57d240e2014-02-19 16:27:23 -05001753def _signature_fromstr(cls, obj, s, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001754 """Private helper to parse content of '__text_signature__'
1755 and return a Signature based on it.
1756 """
1757
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001758 Parameter = cls._parameter_cls
1759
Larry Hastings2623c8c2014-02-08 22:15:29 -08001760 clean_signature, self_parameter, last_positional_only = \
1761 _signature_strip_non_python_syntax(s)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001762
Larry Hastings2623c8c2014-02-08 22:15:29 -08001763 program = "def foo" + clean_signature + ": pass"
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001764
1765 try:
Larry Hastings2623c8c2014-02-08 22:15:29 -08001766 module = ast.parse(program)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001767 except SyntaxError:
1768 module = None
1769
1770 if not isinstance(module, ast.Module):
1771 raise ValueError("{!r} builtin has invalid signature".format(obj))
1772
1773 f = module.body[0]
1774
1775 parameters = []
1776 empty = Parameter.empty
1777 invalid = object()
1778
1779 module = None
1780 module_dict = {}
1781 module_name = getattr(obj, '__module__', None)
1782 if module_name:
1783 module = sys.modules.get(module_name, None)
1784 if module:
1785 module_dict = module.__dict__
1786 sys_module_dict = sys.modules
1787
1788 def parse_name(node):
1789 assert isinstance(node, ast.arg)
1790 if node.annotation != None:
1791 raise ValueError("Annotations are not currently supported")
1792 return node.arg
1793
1794 def wrap_value(s):
1795 try:
1796 value = eval(s, module_dict)
1797 except NameError:
1798 try:
1799 value = eval(s, sys_module_dict)
1800 except NameError:
1801 raise RuntimeError()
1802
1803 if isinstance(value, str):
1804 return ast.Str(value)
1805 if isinstance(value, (int, float)):
1806 return ast.Num(value)
1807 if isinstance(value, bytes):
1808 return ast.Bytes(value)
1809 if value in (True, False, None):
1810 return ast.NameConstant(value)
1811 raise RuntimeError()
1812
1813 class RewriteSymbolics(ast.NodeTransformer):
1814 def visit_Attribute(self, node):
1815 a = []
1816 n = node
1817 while isinstance(n, ast.Attribute):
1818 a.append(n.attr)
1819 n = n.value
1820 if not isinstance(n, ast.Name):
1821 raise RuntimeError()
1822 a.append(n.id)
1823 value = ".".join(reversed(a))
1824 return wrap_value(value)
1825
1826 def visit_Name(self, node):
1827 if not isinstance(node.ctx, ast.Load):
1828 raise ValueError()
1829 return wrap_value(node.id)
1830
1831 def p(name_node, default_node, default=empty):
1832 name = parse_name(name_node)
1833 if name is invalid:
1834 return None
1835 if default_node and default_node is not _empty:
1836 try:
1837 default_node = RewriteSymbolics().visit(default_node)
1838 o = ast.literal_eval(default_node)
1839 except ValueError:
1840 o = invalid
1841 if o is invalid:
1842 return None
1843 default = o if o is not invalid else default
1844 parameters.append(Parameter(name, kind, default=default, annotation=empty))
1845
1846 # non-keyword-only parameters
1847 args = reversed(f.args.args)
1848 defaults = reversed(f.args.defaults)
1849 iter = itertools.zip_longest(args, defaults, fillvalue=None)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001850 if last_positional_only is not None:
1851 kind = Parameter.POSITIONAL_ONLY
1852 else:
1853 kind = Parameter.POSITIONAL_OR_KEYWORD
1854 for i, (name, default) in enumerate(reversed(list(iter))):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001855 p(name, default)
Larry Hastings2623c8c2014-02-08 22:15:29 -08001856 if i == last_positional_only:
1857 kind = Parameter.POSITIONAL_OR_KEYWORD
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001858
1859 # *args
1860 if f.args.vararg:
1861 kind = Parameter.VAR_POSITIONAL
1862 p(f.args.vararg, empty)
1863
1864 # keyword-only arguments
1865 kind = Parameter.KEYWORD_ONLY
1866 for name, default in zip(f.args.kwonlyargs, f.args.kw_defaults):
1867 p(name, default)
1868
1869 # **kwargs
1870 if f.args.kwarg:
1871 kind = Parameter.VAR_KEYWORD
1872 p(f.args.kwarg, empty)
1873
Larry Hastings2623c8c2014-02-08 22:15:29 -08001874 if self_parameter is not None:
Yury Selivanov8c185ee2014-02-21 01:32:42 -05001875 # Possibly strip the bound argument:
1876 # - We *always* strip first bound argument if
1877 # it is a module.
1878 # - We don't strip first bound argument if
1879 # skip_bound_arg is False.
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001880 assert parameters
Yury Selivanov8c185ee2014-02-21 01:32:42 -05001881 _self = getattr(obj, '__self__', None)
1882 self_isbound = _self is not None
1883 self_ismodule = ismodule(_self)
1884 if self_isbound and (self_ismodule or skip_bound_arg):
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05001885 parameters.pop(0)
1886 else:
1887 # for builtins, self parameter is always positional-only!
1888 p = parameters[0].replace(kind=Parameter.POSITIONAL_ONLY)
1889 parameters[0] = p
1890
1891 return cls(parameters, return_annotation=cls.empty)
1892
1893
Yury Selivanov57d240e2014-02-19 16:27:23 -05001894def _signature_from_builtin(cls, func, skip_bound_arg=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001895 """Private helper function to get signature for
1896 builtin callables.
1897 """
1898
Yury Selivanov57d240e2014-02-19 16:27:23 -05001899 if not _signature_is_builtin(func):
1900 raise TypeError("{!r} is not a Python builtin "
1901 "function".format(func))
1902
1903 s = getattr(func, "__text_signature__", None)
1904 if not s:
1905 raise ValueError("no signature found for builtin {!r}".format(func))
1906
1907 return _signature_fromstr(cls, func, s, skip_bound_arg)
1908
1909
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001910def _signature_from_callable(obj, *,
1911 follow_wrapper_chains=True,
1912 skip_bound_arg=True,
1913 sigcls):
1914
1915 """Private helper function to get signature for arbitrary
1916 callable objects.
1917 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001918
1919 if not callable(obj):
1920 raise TypeError('{!r} is not a callable object'.format(obj))
1921
1922 if isinstance(obj, types.MethodType):
1923 # In this case we skip the first parameter of the underlying
1924 # function (usually `self` or `cls`).
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001925 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04001926 obj.__func__,
1927 follow_wrapper_chains=follow_wrapper_chains,
1928 skip_bound_arg=skip_bound_arg,
1929 sigcls=sigcls)
1930
Yury Selivanov57d240e2014-02-19 16:27:23 -05001931 if skip_bound_arg:
1932 return _signature_bound_method(sig)
1933 else:
1934 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001935
Nick Coghlane8c45d62013-07-28 20:00:01 +10001936 # Was this function wrapped by a decorator?
Yury Selivanov57d240e2014-02-19 16:27:23 -05001937 if follow_wrapper_chains:
1938 obj = unwrap(obj, stop=(lambda f: hasattr(f, "__signature__")))
Nick Coghlane8c45d62013-07-28 20:00:01 +10001939
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001940 try:
1941 sig = obj.__signature__
1942 except AttributeError:
1943 pass
1944 else:
1945 if sig is not None:
Yury Selivanov42407ab2014-06-23 10:23:50 -07001946 if not isinstance(sig, Signature):
1947 raise TypeError(
1948 'unexpected object {!r} in __signature__ '
1949 'attribute'.format(sig))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001950 return sig
1951
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001952 try:
1953 partialmethod = obj._partialmethod
1954 except AttributeError:
1955 pass
1956 else:
Yury Selivanov0486f812014-01-29 12:18:59 -05001957 if isinstance(partialmethod, functools.partialmethod):
1958 # Unbound partialmethod (see functools.partialmethod)
1959 # This means, that we need to calculate the signature
1960 # as if it's a regular partial object, but taking into
1961 # account that the first positional argument
1962 # (usually `self`, or `cls`) will not be passed
1963 # automatically (as for boundmethods)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001964
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001965 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04001966 partialmethod.func,
1967 follow_wrapper_chains=follow_wrapper_chains,
1968 skip_bound_arg=skip_bound_arg,
1969 sigcls=sigcls)
1970
Yury Selivanov0486f812014-01-29 12:18:59 -05001971 sig = _signature_get_partial(wrapped_sig, partialmethod, (None,))
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001972
Yury Selivanov0486f812014-01-29 12:18:59 -05001973 first_wrapped_param = tuple(wrapped_sig.parameters.values())[0]
1974 new_params = (first_wrapped_param,) + tuple(sig.parameters.values())
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001975
Yury Selivanov0486f812014-01-29 12:18:59 -05001976 return sig.replace(parameters=new_params)
Yury Selivanovda5fe4f2014-01-27 17:28:37 -05001977
Yury Selivanov63da7c72014-01-31 14:48:37 -05001978 if isfunction(obj) or _signature_is_functionlike(obj):
1979 # If it's a pure Python function, or an object that is duck type
1980 # of a Python function (Cython functions, for instance), then:
Yury Selivanovda396452014-03-27 12:09:24 -04001981 return sigcls.from_function(obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001982
Yury Selivanova773de02014-02-21 18:30:53 -05001983 if _signature_is_builtin(obj):
Yury Selivanovda396452014-03-27 12:09:24 -04001984 return _signature_from_builtin(sigcls, obj,
Yury Selivanova773de02014-02-21 18:30:53 -05001985 skip_bound_arg=skip_bound_arg)
1986
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001987 if isinstance(obj, functools.partial):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04001988 wrapped_sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04001989 obj.func,
1990 follow_wrapper_chains=follow_wrapper_chains,
1991 skip_bound_arg=skip_bound_arg,
1992 sigcls=sigcls)
Yury Selivanov62560fb2014-01-28 12:26:24 -05001993 return _signature_get_partial(wrapped_sig, obj)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07001994
1995 sig = None
1996 if isinstance(obj, type):
1997 # obj is a class or a metaclass
1998
1999 # First, let's see if it has an overloaded __call__ defined
2000 # in its metaclass
Yury Selivanov421f0c72014-01-29 12:05:40 -05002001 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002002 if call is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002003 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002004 call,
2005 follow_wrapper_chains=follow_wrapper_chains,
2006 skip_bound_arg=skip_bound_arg,
2007 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002008 else:
2009 # Now we check if the 'obj' class has a '__new__' method
Yury Selivanov421f0c72014-01-29 12:05:40 -05002010 new = _signature_get_user_defined_method(obj, '__new__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002011 if new is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002012 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002013 new,
2014 follow_wrapper_chains=follow_wrapper_chains,
2015 skip_bound_arg=skip_bound_arg,
2016 sigcls=sigcls)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002017 else:
2018 # Finally, we should have at least __init__ implemented
Yury Selivanov421f0c72014-01-29 12:05:40 -05002019 init = _signature_get_user_defined_method(obj, '__init__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002020 if init is not None:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002021 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002022 init,
2023 follow_wrapper_chains=follow_wrapper_chains,
2024 skip_bound_arg=skip_bound_arg,
2025 sigcls=sigcls)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002026
2027 if sig is None:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002028 # At this point we know, that `obj` is a class, with no user-
2029 # defined '__init__', '__new__', or class-level '__call__'
2030
Larry Hastings2623c8c2014-02-08 22:15:29 -08002031 for base in obj.__mro__[:-1]:
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002032 # Since '__text_signature__' is implemented as a
2033 # descriptor that extracts text signature from the
2034 # class docstring, if 'obj' is derived from a builtin
2035 # class, its own '__text_signature__' may be 'None'.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002036 # Therefore, we go through the MRO (except the last
2037 # class in there, which is 'object') to find the first
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002038 # class with non-empty text signature.
2039 try:
2040 text_sig = base.__text_signature__
2041 except AttributeError:
2042 pass
2043 else:
2044 if text_sig:
2045 # If 'obj' class has a __text_signature__ attribute:
2046 # return a signature based on it
Yury Selivanovda396452014-03-27 12:09:24 -04002047 return _signature_fromstr(sigcls, obj, text_sig)
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002048
2049 # No '__text_signature__' was found for the 'obj' class.
2050 # Last option is to check if its '__init__' is
2051 # object.__init__ or type.__init__.
Larry Hastings2623c8c2014-02-08 22:15:29 -08002052 if type not in obj.__mro__:
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002053 # We have a class (not metaclass), but no user-defined
2054 # __init__ or __new__ for it
Yury Selivanov7d2bfed2014-02-03 02:46:07 -05002055 if obj.__init__ is object.__init__:
2056 # Return a signature of 'object' builtin.
2057 return signature(object)
Yury Selivanove7dcc5e2014-01-27 19:29:45 -05002058
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002059 elif not isinstance(obj, _NonUserDefinedCallables):
2060 # An object with __call__
2061 # We also check that the 'obj' is not an instance of
2062 # _WrapperDescriptor or _MethodWrapper to avoid
2063 # infinite recursion (and even potential segfault)
Yury Selivanov421f0c72014-01-29 12:05:40 -05002064 call = _signature_get_user_defined_method(type(obj), '__call__')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002065 if call is not None:
Larry Hastings2623c8c2014-02-08 22:15:29 -08002066 try:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002067 sig = _signature_from_callable(
Yury Selivanovda396452014-03-27 12:09:24 -04002068 call,
2069 follow_wrapper_chains=follow_wrapper_chains,
2070 skip_bound_arg=skip_bound_arg,
2071 sigcls=sigcls)
Larry Hastings2623c8c2014-02-08 22:15:29 -08002072 except ValueError as ex:
2073 msg = 'no signature found for {!r}'.format(obj)
2074 raise ValueError(msg) from ex
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002075
2076 if sig is not None:
2077 # For classes and objects we skip the first parameter of their
2078 # __call__, __new__, or __init__ methods
Yury Selivanov57d240e2014-02-19 16:27:23 -05002079 if skip_bound_arg:
2080 return _signature_bound_method(sig)
2081 else:
2082 return sig
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002083
2084 if isinstance(obj, types.BuiltinFunctionType):
2085 # Raise a nicer error message for builtins
2086 msg = 'no signature found for builtin function {!r}'.format(obj)
2087 raise ValueError(msg)
2088
2089 raise ValueError('callable {!r} is not supported by signature'.format(obj))
2090
2091
2092class _void:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002093 """A private marker - used in Parameter & Signature."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002094
2095
2096class _empty:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002097 """Marker object for Signature.empty and Parameter.empty."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002098
2099
Yury Selivanov21e83a52014-03-27 11:23:13 -04002100class _ParameterKind(enum.IntEnum):
2101 POSITIONAL_ONLY = 0
2102 POSITIONAL_OR_KEYWORD = 1
2103 VAR_POSITIONAL = 2
2104 KEYWORD_ONLY = 3
2105 VAR_KEYWORD = 4
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002106
2107 def __str__(self):
Yury Selivanov21e83a52014-03-27 11:23:13 -04002108 return self._name_
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002109
2110
Yury Selivanov21e83a52014-03-27 11:23:13 -04002111_POSITIONAL_ONLY = _ParameterKind.POSITIONAL_ONLY
2112_POSITIONAL_OR_KEYWORD = _ParameterKind.POSITIONAL_OR_KEYWORD
2113_VAR_POSITIONAL = _ParameterKind.VAR_POSITIONAL
2114_KEYWORD_ONLY = _ParameterKind.KEYWORD_ONLY
2115_VAR_KEYWORD = _ParameterKind.VAR_KEYWORD
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002116
2117
2118class Parameter:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002119 """Represents a parameter in a function signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002120
2121 Has the following public attributes:
2122
2123 * name : str
2124 The name of the parameter as a string.
2125 * default : object
2126 The default value for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002127 parameter has no default value, this attribute is set to
2128 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002129 * annotation
2130 The annotation for the parameter if specified. If the
Yury Selivanov8757ead2014-01-28 16:39:25 -05002131 parameter has no annotation, this attribute is set to
2132 `Parameter.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002133 * kind : str
2134 Describes how argument values are bound to the parameter.
2135 Possible values: `Parameter.POSITIONAL_ONLY`,
2136 `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`,
2137 `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002138 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002139
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002140 __slots__ = ('_name', '_kind', '_default', '_annotation')
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002141
2142 POSITIONAL_ONLY = _POSITIONAL_ONLY
2143 POSITIONAL_OR_KEYWORD = _POSITIONAL_OR_KEYWORD
2144 VAR_POSITIONAL = _VAR_POSITIONAL
2145 KEYWORD_ONLY = _KEYWORD_ONLY
2146 VAR_KEYWORD = _VAR_KEYWORD
2147
2148 empty = _empty
2149
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002150 def __init__(self, name, kind, *, default=_empty, annotation=_empty):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002151
2152 if kind not in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD,
2153 _VAR_POSITIONAL, _KEYWORD_ONLY, _VAR_KEYWORD):
2154 raise ValueError("invalid value for 'Parameter.kind' attribute")
2155 self._kind = kind
2156
2157 if default is not _empty:
2158 if kind in (_VAR_POSITIONAL, _VAR_KEYWORD):
2159 msg = '{} parameters cannot have default values'.format(kind)
2160 raise ValueError(msg)
2161 self._default = default
2162 self._annotation = annotation
2163
Yury Selivanov2393dca2014-01-27 15:07:58 -05002164 if name is _empty:
2165 raise ValueError('name is a required attribute for Parameter')
2166
2167 if not isinstance(name, str):
2168 raise TypeError("name must be a str, not a {!r}".format(name))
2169
2170 if not name.isidentifier():
2171 raise ValueError('{!r} is not a valid parameter name'.format(name))
2172
2173 self._name = name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002174
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002175 def __reduce__(self):
2176 return (type(self),
2177 (self._name, self._kind),
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002178 {'_default': self._default,
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002179 '_annotation': self._annotation})
2180
2181 def __setstate__(self, state):
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002182 self._default = state['_default']
2183 self._annotation = state['_annotation']
2184
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002185 @property
2186 def name(self):
2187 return self._name
2188
2189 @property
2190 def default(self):
2191 return self._default
2192
2193 @property
2194 def annotation(self):
2195 return self._annotation
2196
2197 @property
2198 def kind(self):
2199 return self._kind
2200
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002201 def replace(self, *, name=_void, kind=_void,
2202 annotation=_void, default=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002203 """Creates a customized copy of the Parameter."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002204
2205 if name is _void:
2206 name = self._name
2207
2208 if kind is _void:
2209 kind = self._kind
2210
2211 if annotation is _void:
2212 annotation = self._annotation
2213
2214 if default is _void:
2215 default = self._default
2216
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002217 return type(self)(name, kind, default=default, annotation=annotation)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002218
2219 def __str__(self):
2220 kind = self.kind
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002221 formatted = self._name
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002222
2223 # Add annotation and default value
2224 if self._annotation is not _empty:
2225 formatted = '{}:{}'.format(formatted,
2226 formatannotation(self._annotation))
2227
2228 if self._default is not _empty:
2229 formatted = '{}={}'.format(formatted, repr(self._default))
2230
2231 if kind == _VAR_POSITIONAL:
2232 formatted = '*' + formatted
2233 elif kind == _VAR_KEYWORD:
2234 formatted = '**' + formatted
2235
2236 return formatted
2237
2238 def __repr__(self):
Yury Selivanov374375d2014-03-27 12:41:53 -04002239 return '<{} at {:#x} "{}">'.format(self.__class__.__name__,
2240 id(self), self)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002241
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002242 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002243 return hash((self.name, self.kind, self.annotation, self.default))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002244
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002245 def __eq__(self, other):
2246 return (issubclass(other.__class__, Parameter) and
2247 self._name == other._name and
2248 self._kind == other._kind and
2249 self._default == other._default and
2250 self._annotation == other._annotation)
2251
2252 def __ne__(self, other):
2253 return not self.__eq__(other)
2254
2255
2256class BoundArguments:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002257 """Result of `Signature.bind` call. Holds the mapping of arguments
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002258 to the function's parameters.
2259
2260 Has the following public attributes:
2261
2262 * arguments : OrderedDict
2263 An ordered mutable mapping of parameters' names to arguments' values.
2264 Does not contain arguments' default values.
2265 * signature : Signature
2266 The Signature object that created this instance.
2267 * args : tuple
2268 Tuple of positional arguments values.
2269 * kwargs : dict
2270 Dict of keyword arguments values.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002271 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002272
2273 def __init__(self, signature, arguments):
2274 self.arguments = arguments
2275 self._signature = signature
2276
2277 @property
2278 def signature(self):
2279 return self._signature
2280
2281 @property
2282 def args(self):
2283 args = []
2284 for param_name, param in self._signature.parameters.items():
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002285 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002286 break
2287
2288 try:
2289 arg = self.arguments[param_name]
2290 except KeyError:
2291 # We're done here. Other arguments
2292 # will be mapped in 'BoundArguments.kwargs'
2293 break
2294 else:
2295 if param.kind == _VAR_POSITIONAL:
2296 # *args
2297 args.extend(arg)
2298 else:
2299 # plain argument
2300 args.append(arg)
2301
2302 return tuple(args)
2303
2304 @property
2305 def kwargs(self):
2306 kwargs = {}
2307 kwargs_started = False
2308 for param_name, param in self._signature.parameters.items():
2309 if not kwargs_started:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002310 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002311 kwargs_started = True
2312 else:
2313 if param_name not in self.arguments:
2314 kwargs_started = True
2315 continue
2316
2317 if not kwargs_started:
2318 continue
2319
2320 try:
2321 arg = self.arguments[param_name]
2322 except KeyError:
2323 pass
2324 else:
2325 if param.kind == _VAR_KEYWORD:
2326 # **kwargs
2327 kwargs.update(arg)
2328 else:
2329 # plain keyword argument
2330 kwargs[param_name] = arg
2331
2332 return kwargs
2333
2334 def __eq__(self, other):
2335 return (issubclass(other.__class__, BoundArguments) and
2336 self.signature == other.signature and
2337 self.arguments == other.arguments)
2338
2339 def __ne__(self, other):
2340 return not self.__eq__(other)
2341
2342
2343class Signature:
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002344 """A Signature object represents the overall signature of a function.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002345 It stores a Parameter object for each parameter accepted by the
2346 function, as well as information specific to the function itself.
2347
2348 A Signature object has the following public attributes and methods:
2349
2350 * parameters : OrderedDict
2351 An ordered mapping of parameters' names to the corresponding
2352 Parameter objects (keyword-only arguments are in the same order
2353 as listed in `code.co_varnames`).
2354 * return_annotation : object
2355 The annotation for the return type of the function if specified.
2356 If the function has no annotation for its return type, this
Yury Selivanov8757ead2014-01-28 16:39:25 -05002357 attribute is set to `Signature.empty`.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002358 * bind(*args, **kwargs) -> BoundArguments
2359 Creates a mapping from positional and keyword arguments to
2360 parameters.
2361 * bind_partial(*args, **kwargs) -> BoundArguments
2362 Creates a partial mapping from positional and keyword arguments
2363 to parameters (simulating 'functools.partial' behavior.)
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002364 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002365
2366 __slots__ = ('_return_annotation', '_parameters')
2367
2368 _parameter_cls = Parameter
2369 _bound_arguments_cls = BoundArguments
2370
2371 empty = _empty
2372
2373 def __init__(self, parameters=None, *, return_annotation=_empty,
2374 __validate_parameters__=True):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002375 """Constructs Signature from the given list of Parameter
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002376 objects and 'return_annotation'. All arguments are optional.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002377 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002378
2379 if parameters is None:
2380 params = OrderedDict()
2381 else:
2382 if __validate_parameters__:
2383 params = OrderedDict()
2384 top_kind = _POSITIONAL_ONLY
Yury Selivanov07a9e452014-01-29 10:58:16 -05002385 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002386
2387 for idx, param in enumerate(parameters):
2388 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002389 name = param.name
2390
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002391 if kind < top_kind:
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002392 msg = 'wrong parameter order: {!r} before {!r}'
Yury Selivanov2393dca2014-01-27 15:07:58 -05002393 msg = msg.format(top_kind, kind)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002394 raise ValueError(msg)
Yury Selivanov07a9e452014-01-29 10:58:16 -05002395 elif kind > top_kind:
2396 kind_defaults = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002397 top_kind = kind
2398
Yury Selivanov3f73ca22014-04-08 11:30:45 -04002399 if kind in (_POSITIONAL_ONLY, _POSITIONAL_OR_KEYWORD):
Yury Selivanov07a9e452014-01-29 10:58:16 -05002400 if param.default is _empty:
2401 if kind_defaults:
2402 # No default for this parameter, but the
2403 # previous parameter of the same kind had
2404 # a default
2405 msg = 'non-default argument follows default ' \
2406 'argument'
2407 raise ValueError(msg)
2408 else:
2409 # There is a default for this parameter.
2410 kind_defaults = True
2411
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002412 if name in params:
2413 msg = 'duplicate parameter name: {!r}'.format(name)
2414 raise ValueError(msg)
Yury Selivanov2393dca2014-01-27 15:07:58 -05002415
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002416 params[name] = param
2417 else:
2418 params = OrderedDict(((param.name, param)
2419 for param in parameters))
2420
2421 self._parameters = types.MappingProxyType(params)
2422 self._return_annotation = return_annotation
2423
2424 @classmethod
2425 def from_function(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002426 """Constructs Signature for the given python function."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002427
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002428 is_duck_function = False
2429 if not isfunction(func):
2430 if _signature_is_functionlike(func):
2431 is_duck_function = True
2432 else:
2433 # If it's not a pure Python function, and not a duck type
2434 # of pure function:
2435 raise TypeError('{!r} is not a Python function'.format(func))
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002436
2437 Parameter = cls._parameter_cls
2438
2439 # Parameter information.
2440 func_code = func.__code__
2441 pos_count = func_code.co_argcount
2442 arg_names = func_code.co_varnames
2443 positional = tuple(arg_names[:pos_count])
2444 keyword_only_count = func_code.co_kwonlyargcount
2445 keyword_only = arg_names[pos_count:(pos_count + keyword_only_count)]
2446 annotations = func.__annotations__
2447 defaults = func.__defaults__
2448 kwdefaults = func.__kwdefaults__
2449
2450 if defaults:
2451 pos_default_count = len(defaults)
2452 else:
2453 pos_default_count = 0
2454
2455 parameters = []
2456
2457 # Non-keyword-only parameters w/o defaults.
2458 non_default_count = pos_count - pos_default_count
2459 for name in positional[:non_default_count]:
2460 annotation = annotations.get(name, _empty)
2461 parameters.append(Parameter(name, annotation=annotation,
2462 kind=_POSITIONAL_OR_KEYWORD))
2463
2464 # ... w/ defaults.
2465 for offset, name in enumerate(positional[non_default_count:]):
2466 annotation = annotations.get(name, _empty)
2467 parameters.append(Parameter(name, annotation=annotation,
2468 kind=_POSITIONAL_OR_KEYWORD,
2469 default=defaults[offset]))
2470
2471 # *args
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002472 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002473 name = arg_names[pos_count + keyword_only_count]
2474 annotation = annotations.get(name, _empty)
2475 parameters.append(Parameter(name, annotation=annotation,
2476 kind=_VAR_POSITIONAL))
2477
2478 # Keyword-only parameters.
2479 for name in keyword_only:
2480 default = _empty
2481 if kwdefaults is not None:
2482 default = kwdefaults.get(name, _empty)
2483
2484 annotation = annotations.get(name, _empty)
2485 parameters.append(Parameter(name, annotation=annotation,
2486 kind=_KEYWORD_ONLY,
2487 default=default))
2488 # **kwargs
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002489 if func_code.co_flags & CO_VARKEYWORDS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002490 index = pos_count + keyword_only_count
Yury Selivanov89ca85c2014-01-29 16:50:40 -05002491 if func_code.co_flags & CO_VARARGS:
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002492 index += 1
2493
2494 name = arg_names[index]
2495 annotation = annotations.get(name, _empty)
2496 parameters.append(Parameter(name, annotation=annotation,
2497 kind=_VAR_KEYWORD))
2498
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002499 # Is 'func' is a pure Python function - don't validate the
2500 # parameters list (for correct order and defaults), it should be OK.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002501 return cls(parameters,
2502 return_annotation=annotations.get('return', _empty),
Yury Selivanov5334bcd2014-01-31 15:21:51 -05002503 __validate_parameters__=is_duck_function)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002504
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002505 @classmethod
2506 def from_builtin(cls, func):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002507 """Constructs Signature for the given builtin function."""
Yury Selivanov57d240e2014-02-19 16:27:23 -05002508 return _signature_from_builtin(cls, func)
Larry Hastings44e2eaa2013-11-23 15:37:55 -08002509
Yury Selivanovda396452014-03-27 12:09:24 -04002510 @classmethod
2511 def from_callable(cls, obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002512 """Constructs Signature for the given callable object."""
2513 return _signature_from_callable(obj, sigcls=cls)
Yury Selivanovda396452014-03-27 12:09:24 -04002514
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002515 @property
2516 def parameters(self):
2517 return self._parameters
2518
2519 @property
2520 def return_annotation(self):
2521 return self._return_annotation
2522
2523 def replace(self, *, parameters=_void, return_annotation=_void):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002524 """Creates a customized copy of the Signature.
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002525 Pass 'parameters' and/or 'return_annotation' arguments
2526 to override them in the new copy.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002527 """
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002528
2529 if parameters is _void:
2530 parameters = self.parameters.values()
2531
2532 if return_annotation is _void:
2533 return_annotation = self._return_annotation
2534
2535 return type(self)(parameters,
2536 return_annotation=return_annotation)
2537
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002538 def _hash_basis(self):
2539 params = tuple(param for param in self.parameters.values()
2540 if param.kind != _KEYWORD_ONLY)
2541
2542 kwo_params = {param.name: param for param in self.parameters.values()
2543 if param.kind == _KEYWORD_ONLY}
2544
2545 return params, kwo_params, self.return_annotation
2546
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002547 def __hash__(self):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002548 params, kwo_params, return_annotation = self._hash_basis()
2549 kwo_params = frozenset(kwo_params.values())
2550 return hash((params, kwo_params, return_annotation))
Yury Selivanov67ae50e2014-04-08 11:46:50 -04002551
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002552 def __eq__(self, other):
Yury Selivanov08d4a4f2014-09-12 15:48:02 -04002553 return (isinstance(other, Signature) and
2554 self._hash_basis() == other._hash_basis())
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002555
2556 def __ne__(self, other):
2557 return not self.__eq__(other)
2558
2559 def _bind(self, args, kwargs, *, partial=False):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002560 """Private method. Don't use directly."""
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002561
2562 arguments = OrderedDict()
2563
2564 parameters = iter(self.parameters.values())
2565 parameters_ex = ()
2566 arg_vals = iter(args)
2567
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002568 while True:
2569 # Let's iterate through the positional arguments and corresponding
2570 # parameters
2571 try:
2572 arg_val = next(arg_vals)
2573 except StopIteration:
2574 # No more positional arguments
2575 try:
2576 param = next(parameters)
2577 except StopIteration:
2578 # No more parameters. That's it. Just need to check that
2579 # we have no `kwargs` after this while loop
2580 break
2581 else:
2582 if param.kind == _VAR_POSITIONAL:
2583 # That's OK, just empty *args. Let's start parsing
2584 # kwargs
2585 break
2586 elif param.name in kwargs:
2587 if param.kind == _POSITIONAL_ONLY:
2588 msg = '{arg!r} parameter is positional only, ' \
2589 'but was passed as a keyword'
2590 msg = msg.format(arg=param.name)
2591 raise TypeError(msg) from None
2592 parameters_ex = (param,)
2593 break
2594 elif (param.kind == _VAR_KEYWORD or
2595 param.default is not _empty):
2596 # That's fine too - we have a default value for this
2597 # parameter. So, lets start parsing `kwargs`, starting
2598 # with the current parameter
2599 parameters_ex = (param,)
2600 break
2601 else:
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002602 # No default, not VAR_KEYWORD, not VAR_POSITIONAL,
2603 # not in `kwargs`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002604 if partial:
2605 parameters_ex = (param,)
2606 break
2607 else:
2608 msg = '{arg!r} parameter lacking default value'
2609 msg = msg.format(arg=param.name)
2610 raise TypeError(msg) from None
2611 else:
2612 # We have a positional argument to process
2613 try:
2614 param = next(parameters)
2615 except StopIteration:
2616 raise TypeError('too many positional arguments') from None
2617 else:
2618 if param.kind in (_VAR_KEYWORD, _KEYWORD_ONLY):
2619 # Looks like we have no parameter for this positional
2620 # argument
2621 raise TypeError('too many positional arguments')
2622
2623 if param.kind == _VAR_POSITIONAL:
2624 # We have an '*args'-like argument, let's fill it with
2625 # all positional arguments we have left and move on to
2626 # the next phase
2627 values = [arg_val]
2628 values.extend(arg_vals)
2629 arguments[param.name] = tuple(values)
2630 break
2631
2632 if param.name in kwargs:
2633 raise TypeError('multiple values for argument '
2634 '{arg!r}'.format(arg=param.name))
2635
2636 arguments[param.name] = arg_val
2637
2638 # Now, we iterate through the remaining parameters to process
2639 # keyword arguments
2640 kwargs_param = None
2641 for param in itertools.chain(parameters_ex, parameters):
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002642 if param.kind == _VAR_KEYWORD:
2643 # Memorize that we have a '**kwargs'-like parameter
2644 kwargs_param = param
2645 continue
2646
Yury Selivanov38b0d5a2014-01-28 17:27:39 -05002647 if param.kind == _VAR_POSITIONAL:
2648 # Named arguments don't refer to '*args'-like parameters.
2649 # We only arrive here if the positional arguments ended
2650 # before reaching the last parameter before *args.
2651 continue
2652
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002653 param_name = param.name
2654 try:
2655 arg_val = kwargs.pop(param_name)
2656 except KeyError:
2657 # We have no value for this parameter. It's fine though,
2658 # if it has a default value, or it is an '*args'-like
2659 # parameter, left alone by the processing of positional
2660 # arguments.
2661 if (not partial and param.kind != _VAR_POSITIONAL and
2662 param.default is _empty):
2663 raise TypeError('{arg!r} parameter lacking default value'. \
2664 format(arg=param_name)) from None
2665
2666 else:
Yury Selivanov9b9ac952014-01-28 20:54:28 -05002667 if param.kind == _POSITIONAL_ONLY:
2668 # This should never happen in case of a properly built
2669 # Signature object (but let's have this check here
2670 # to ensure correct behaviour just in case)
2671 raise TypeError('{arg!r} parameter is positional only, '
2672 'but was passed as a keyword'. \
2673 format(arg=param.name))
2674
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002675 arguments[param_name] = arg_val
2676
2677 if kwargs:
2678 if kwargs_param is not None:
2679 # Process our '**kwargs'-like parameter
2680 arguments[kwargs_param.name] = kwargs
2681 else:
2682 raise TypeError('too many keyword arguments')
2683
2684 return self._bound_arguments_cls(self, arguments)
2685
Yury Selivanovc45873e2014-01-29 12:10:27 -05002686 def bind(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002687 """Get a BoundArguments object, that maps the passed `args`
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002688 and `kwargs` to the function's signature. Raises `TypeError`
2689 if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002690 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002691 return args[0]._bind(args[1:], kwargs)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002692
Yury Selivanovc45873e2014-01-29 12:10:27 -05002693 def bind_partial(*args, **kwargs):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002694 """Get a BoundArguments object, that partially maps the
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002695 passed `args` and `kwargs` to the function's signature.
2696 Raises `TypeError` if the passed arguments can not be bound.
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002697 """
Yury Selivanovc45873e2014-01-29 12:10:27 -05002698 return args[0]._bind(args[1:], kwargs, partial=True)
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002699
Yury Selivanova5d63dd2014-03-27 11:31:43 -04002700 def __reduce__(self):
2701 return (type(self),
2702 (tuple(self._parameters.values()),),
2703 {'_return_annotation': self._return_annotation})
2704
2705 def __setstate__(self, state):
2706 self._return_annotation = state['_return_annotation']
2707
Yury Selivanov374375d2014-03-27 12:41:53 -04002708 def __repr__(self):
2709 return '<{} at {:#x} "{}">'.format(self.__class__.__name__,
2710 id(self), self)
2711
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002712 def __str__(self):
2713 result = []
Yury Selivanov2393dca2014-01-27 15:07:58 -05002714 render_pos_only_separator = False
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002715 render_kw_only_separator = True
Yury Selivanov2393dca2014-01-27 15:07:58 -05002716 for param in self.parameters.values():
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002717 formatted = str(param)
2718
2719 kind = param.kind
Yury Selivanov2393dca2014-01-27 15:07:58 -05002720
2721 if kind == _POSITIONAL_ONLY:
2722 render_pos_only_separator = True
2723 elif render_pos_only_separator:
2724 # It's not a positional-only parameter, and the flag
2725 # is set to 'True' (there were pos-only params before.)
2726 result.append('/')
2727 render_pos_only_separator = False
2728
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002729 if kind == _VAR_POSITIONAL:
2730 # OK, we have an '*args'-like parameter, so we won't need
2731 # a '*' to separate keyword-only arguments
2732 render_kw_only_separator = False
2733 elif kind == _KEYWORD_ONLY and render_kw_only_separator:
2734 # We have a keyword-only parameter to render and we haven't
2735 # rendered an '*args'-like parameter before, so add a '*'
2736 # separator to the parameters list ("foo(arg1, *, arg2)" case)
2737 result.append('*')
2738 # This condition should be only triggered once, so
2739 # reset the flag
2740 render_kw_only_separator = False
2741
2742 result.append(formatted)
2743
Yury Selivanov2393dca2014-01-27 15:07:58 -05002744 if render_pos_only_separator:
2745 # There were only positional-only parameters, hence the
2746 # flag was not reset to 'False'
2747 result.append('/')
2748
Larry Hastings7c7cbfc2012-06-22 15:19:35 -07002749 rendered = '({})'.format(', '.join(result))
2750
2751 if self.return_annotation is not _empty:
2752 anno = formatannotation(self.return_annotation)
2753 rendered += ' -> {}'.format(anno)
2754
2755 return rendered
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002756
Yury Selivanovda396452014-03-27 12:09:24 -04002757
2758def signature(obj):
Yury Selivanov5a23bd02014-03-29 13:47:11 -04002759 """Get a signature object for the passed callable."""
Yury Selivanovda396452014-03-27 12:09:24 -04002760 return Signature.from_callable(obj)
2761
2762
Nick Coghlanf94a16b2013-09-22 22:46:49 +10002763def _main():
2764 """ Logic for inspecting an object given at command line """
2765 import argparse
2766 import importlib
2767
2768 parser = argparse.ArgumentParser()
2769 parser.add_argument(
2770 'object',
2771 help="The object to be analysed. "
2772 "It supports the 'module:qualname' syntax")
2773 parser.add_argument(
2774 '-d', '--details', action='store_true',
2775 help='Display info about the module rather than its source code')
2776
2777 args = parser.parse_args()
2778
2779 target = args.object
2780 mod_name, has_attrs, attrs = target.partition(":")
2781 try:
2782 obj = module = importlib.import_module(mod_name)
2783 except Exception as exc:
2784 msg = "Failed to import {} ({}: {})".format(mod_name,
2785 type(exc).__name__,
2786 exc)
2787 print(msg, file=sys.stderr)
2788 exit(2)
2789
2790 if has_attrs:
2791 parts = attrs.split(".")
2792 obj = module
2793 for part in parts:
2794 obj = getattr(obj, part)
2795
2796 if module.__name__ in sys.builtin_module_names:
2797 print("Can't get info for builtin modules.", file=sys.stderr)
2798 exit(1)
2799
2800 if args.details:
2801 print('Target: {}'.format(target))
2802 print('Origin: {}'.format(getsourcefile(module)))
2803 print('Cached: {}'.format(module.__cached__))
2804 if obj is module:
2805 print('Loader: {}'.format(repr(module.__loader__)))
2806 if hasattr(module, '__path__'):
2807 print('Submodule search path: {}'.format(module.__path__))
2808 else:
2809 try:
2810 __, lineno = findsource(obj)
2811 except Exception:
2812 pass
2813 else:
2814 print('Line: {}'.format(lineno))
2815
2816 print('\n')
2817 else:
2818 print(getsource(obj))
2819
2820
2821if __name__ == "__main__":
2822 _main()