Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1 | """Get useful information from live Python objects. |
| 2 | |
| 3 | This module encapsulates the interface provided by the internal special |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 4 | attributes (co_*, im_*, tb_*, etc.) in a friendlier fashion. |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 5 | It also provides some help for examining source code and class layout. |
| 6 | |
| 7 | Here are some of the useful functions provided by this module: |
| 8 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 9 | ismodule(), isclass(), ismethod(), isfunction(), isgeneratorfunction(), |
| 10 | isgenerator(), istraceback(), isframe(), iscode(), isbuiltin(), |
| 11 | isroutine() - check object types |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 12 | 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 Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 19 | getargspec(), getargvalues(), getcallargs() - get info about function arguments |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 20 | getfullargspec() - same, with support for Python-3000 features |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 21 | 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 |
| 25 | """ |
| 26 | |
| 27 | # This module is in the public domain. No warranties. |
| 28 | |
Ka-Ping Yee | 8b58b84 | 2001-03-01 13:56:16 +0000 | [diff] [blame] | 29 | __author__ = 'Ka-Ping Yee <ping@lfw.org>' |
| 30 | __date__ = '1 Jan 2001' |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 31 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 32 | import sys |
| 33 | import os |
| 34 | import types |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 35 | import itertools |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 36 | import string |
| 37 | import re |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 38 | import imp |
| 39 | import tokenize |
| 40 | import linecache |
Raymond Hettinger | a1a992c | 2005-03-11 06:46:45 +0000 | [diff] [blame] | 41 | from operator import attrgetter |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 42 | from collections import namedtuple |
Nick Coghlan | 09c8123 | 2010-08-17 10:18:16 +0000 | [diff] [blame] | 43 | |
| 44 | # Create constants for the compiler flags in Include/code.h |
| 45 | # We try to get them from dis to avoid duplication, but fall |
| 46 | # back to hardcording so the dependency is optional |
| 47 | try: |
| 48 | from dis import COMPILER_FLAG_NAMES as _flag_names |
| 49 | except ImportError: |
| 50 | CO_OPTIMIZED, CO_NEWLOCALS = 0x1, 0x2 |
| 51 | CO_VARARGS, CO_VARKEYWORDS = 0x4, 0x8 |
| 52 | CO_NESTED, CO_GENERATOR, CO_NOFREE = 0x10, 0x20, 0x40 |
| 53 | else: |
| 54 | mod_dict = globals() |
| 55 | for k, v in _flag_names.items(): |
| 56 | mod_dict["CO_" + v] = k |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 57 | |
Christian Heimes | be5b30b | 2008-03-03 19:18:51 +0000 | [diff] [blame] | 58 | # See Include/object.h |
| 59 | TPFLAGS_IS_ABSTRACT = 1 << 20 |
| 60 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 61 | # ----------------------------------------------------------- type-checking |
| 62 | def ismodule(object): |
| 63 | """Return true if the object is a module. |
| 64 | |
| 65 | Module objects provide these attributes: |
Barry Warsaw | 28a691b | 2010-04-17 00:19:56 +0000 | [diff] [blame] | 66 | __cached__ pathname to byte compiled file |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 67 | __doc__ documentation string |
| 68 | __file__ filename (missing for built-in modules)""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 69 | return isinstance(object, types.ModuleType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 70 | |
| 71 | def isclass(object): |
| 72 | """Return true if the object is a class. |
| 73 | |
| 74 | Class objects provide these attributes: |
| 75 | __doc__ documentation string |
| 76 | __module__ name of module in which this class was defined""" |
Benjamin Peterson | c465600 | 2009-01-17 22:41:18 +0000 | [diff] [blame] | 77 | return isinstance(object, type) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 78 | |
| 79 | def ismethod(object): |
| 80 | """Return true if the object is an instance method. |
| 81 | |
| 82 | Instance method objects provide these attributes: |
| 83 | __doc__ documentation string |
| 84 | __name__ name with which this method was defined |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 85 | __func__ function object containing implementation of method |
| 86 | __self__ instance to which this method is bound""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 87 | return isinstance(object, types.MethodType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 88 | |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 89 | def ismethoddescriptor(object): |
Tim Peters | f1d90b9 | 2001-09-20 05:47:55 +0000 | [diff] [blame] | 90 | """Return true if the object is a method descriptor. |
| 91 | |
| 92 | But not if ismethod() or isclass() or isfunction() are true. |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 93 | |
| 94 | This is new in Python 2.2, and, for example, is true of int.__add__. |
| 95 | An object passing this test has a __get__ attribute but not a __set__ |
| 96 | attribute, but beyond that the set of attributes varies. __name__ is |
| 97 | usually sensible, and __doc__ often is. |
| 98 | |
Tim Peters | f1d90b9 | 2001-09-20 05:47:55 +0000 | [diff] [blame] | 99 | Methods implemented via descriptors that also pass one of the other |
| 100 | tests return false from the ismethoddescriptor() test, simply because |
| 101 | the other tests promise more -- you can, e.g., count on having the |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 102 | __func__ attribute (etc) when an object passes ismethod().""" |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 103 | return (hasattr(object, "__get__") |
| 104 | and not hasattr(object, "__set__") # else it's a data descriptor |
| 105 | and not ismethod(object) # mutual exclusion |
Tim Peters | f1d90b9 | 2001-09-20 05:47:55 +0000 | [diff] [blame] | 106 | and not isfunction(object) |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 107 | and not isclass(object)) |
| 108 | |
Martin v. Löwis | e59e2ba | 2003-05-03 09:09:02 +0000 | [diff] [blame] | 109 | def isdatadescriptor(object): |
| 110 | """Return true if the object is a data descriptor. |
| 111 | |
| 112 | Data descriptors have both a __get__ and a __set__ attribute. Examples are |
| 113 | properties (defined in Python) and getsets and members (defined in C). |
| 114 | Typically, data descriptors will also have __name__ and __doc__ attributes |
| 115 | (properties, getsets, and members have both of these attributes), but this |
| 116 | is not guaranteed.""" |
| 117 | return (hasattr(object, "__set__") and hasattr(object, "__get__")) |
| 118 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 119 | if hasattr(types, 'MemberDescriptorType'): |
| 120 | # CPython and equivalent |
| 121 | def ismemberdescriptor(object): |
| 122 | """Return true if the object is a member descriptor. |
| 123 | |
| 124 | Member descriptors are specialized descriptors defined in extension |
| 125 | modules.""" |
| 126 | return isinstance(object, types.MemberDescriptorType) |
| 127 | else: |
| 128 | # Other implementations |
| 129 | def ismemberdescriptor(object): |
| 130 | """Return true if the object is a member descriptor. |
| 131 | |
| 132 | Member descriptors are specialized descriptors defined in extension |
| 133 | modules.""" |
| 134 | return False |
| 135 | |
| 136 | if hasattr(types, 'GetSetDescriptorType'): |
| 137 | # CPython and equivalent |
| 138 | def isgetsetdescriptor(object): |
| 139 | """Return true if the object is a getset descriptor. |
| 140 | |
| 141 | getset descriptors are specialized descriptors defined in extension |
| 142 | modules.""" |
| 143 | return isinstance(object, types.GetSetDescriptorType) |
| 144 | else: |
| 145 | # Other implementations |
| 146 | def isgetsetdescriptor(object): |
| 147 | """Return true if the object is a getset descriptor. |
| 148 | |
| 149 | getset descriptors are specialized descriptors defined in extension |
| 150 | modules.""" |
| 151 | return False |
| 152 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 153 | def isfunction(object): |
| 154 | """Return true if the object is a user-defined function. |
| 155 | |
| 156 | Function objects provide these attributes: |
| 157 | __doc__ documentation string |
| 158 | __name__ name with which this function was defined |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 159 | __code__ code object containing compiled function bytecode |
| 160 | __defaults__ tuple of any default values for arguments |
| 161 | __globals__ global namespace in which this function was defined |
| 162 | __annotations__ dict of parameter annotations |
| 163 | __kwdefaults__ dict of keyword only parameters with defaults""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 164 | return isinstance(object, types.FunctionType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 165 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 166 | def isgeneratorfunction(object): |
| 167 | """Return true if the object is a user-defined generator function. |
| 168 | |
| 169 | Generator function objects provides same attributes as functions. |
| 170 | |
Alexander Belopolsky | 977a684 | 2010-08-16 20:17:07 +0000 | [diff] [blame] | 171 | See help(isfunction) for attributes listing.""" |
Georg Brandl | b1441c7 | 2009-01-03 22:33:39 +0000 | [diff] [blame] | 172 | return bool((isfunction(object) or ismethod(object)) and |
| 173 | object.__code__.co_flags & CO_GENERATOR) |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 174 | |
| 175 | def isgenerator(object): |
| 176 | """Return true if the object is a generator. |
| 177 | |
| 178 | Generator objects provide these attributes: |
| 179 | __iter__ defined to support interation over container |
| 180 | close raises a new GeneratorExit exception inside the |
| 181 | generator to terminate the iteration |
| 182 | gi_code code object |
| 183 | gi_frame frame object or possibly None once the generator has |
| 184 | been exhausted |
| 185 | gi_running set to 1 when generator is executing, 0 otherwise |
| 186 | next return the next item from the container |
| 187 | send resumes the generator and "sends" a value that becomes |
| 188 | the result of the current yield-expression |
| 189 | throw used to raise an exception inside the generator""" |
| 190 | return isinstance(object, types.GeneratorType) |
| 191 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 192 | def istraceback(object): |
| 193 | """Return true if the object is a traceback. |
| 194 | |
| 195 | Traceback objects provide these attributes: |
| 196 | tb_frame frame object at this level |
| 197 | tb_lasti index of last attempted instruction in bytecode |
| 198 | tb_lineno current line number in Python source code |
| 199 | tb_next next inner traceback object (called by this level)""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 200 | return isinstance(object, types.TracebackType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 201 | |
| 202 | def isframe(object): |
| 203 | """Return true if the object is a frame object. |
| 204 | |
| 205 | Frame objects provide these attributes: |
| 206 | f_back next outer frame object (this frame's caller) |
| 207 | f_builtins built-in namespace seen by this frame |
| 208 | f_code code object being executed in this frame |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 209 | f_globals global namespace seen by this frame |
| 210 | f_lasti index of last attempted instruction in bytecode |
| 211 | f_lineno current line number in Python source code |
| 212 | f_locals local namespace seen by this frame |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 213 | f_trace tracing function for this frame, or None""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 214 | return isinstance(object, types.FrameType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 215 | |
| 216 | def iscode(object): |
| 217 | """Return true if the object is a code object. |
| 218 | |
| 219 | Code objects provide these attributes: |
| 220 | co_argcount number of arguments (not including * or ** args) |
| 221 | co_code string of raw compiled bytecode |
| 222 | co_consts tuple of constants used in the bytecode |
| 223 | co_filename name of file in which this code object was created |
| 224 | co_firstlineno number of first line in Python source code |
| 225 | co_flags bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg |
| 226 | co_lnotab encoded mapping of line numbers to bytecode indices |
| 227 | co_name name with which this code object was defined |
| 228 | co_names tuple of names of local variables |
| 229 | co_nlocals number of local variables |
| 230 | co_stacksize virtual machine stack space required |
| 231 | co_varnames tuple of names of arguments and local variables""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 232 | return isinstance(object, types.CodeType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 233 | |
| 234 | def isbuiltin(object): |
| 235 | """Return true if the object is a built-in function or method. |
| 236 | |
| 237 | Built-in functions and methods provide these attributes: |
| 238 | __doc__ documentation string |
| 239 | __name__ original name of this function or method |
| 240 | __self__ instance to which a method is bound, or None""" |
Tim Peters | 28bc59f | 2001-09-16 08:40:16 +0000 | [diff] [blame] | 241 | return isinstance(object, types.BuiltinFunctionType) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 242 | |
| 243 | def isroutine(object): |
| 244 | """Return true if the object is any kind of function or method.""" |
Tim Peters | 536d226 | 2001-09-20 05:13:38 +0000 | [diff] [blame] | 245 | return (isbuiltin(object) |
| 246 | or isfunction(object) |
| 247 | or ismethod(object) |
| 248 | or ismethoddescriptor(object)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 249 | |
Christian Heimes | be5b30b | 2008-03-03 19:18:51 +0000 | [diff] [blame] | 250 | def isabstract(object): |
| 251 | """Return true if the object is an abstract base class (ABC).""" |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 252 | return bool(isinstance(object, type) and object.__flags__ & TPFLAGS_IS_ABSTRACT) |
Christian Heimes | be5b30b | 2008-03-03 19:18:51 +0000 | [diff] [blame] | 253 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 254 | def getmembers(object, predicate=None): |
| 255 | """Return all members of an object as (name, value) pairs sorted by name. |
| 256 | Optionally, only return members that satisfy a given predicate.""" |
| 257 | results = [] |
| 258 | for key in dir(object): |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 259 | try: |
| 260 | value = getattr(object, key) |
| 261 | except AttributeError: |
| 262 | continue |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 263 | if not predicate or predicate(value): |
| 264 | results.append((key, value)) |
| 265 | results.sort() |
| 266 | return results |
| 267 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 268 | Attribute = namedtuple('Attribute', 'name kind defining_class object') |
| 269 | |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 270 | def classify_class_attrs(cls): |
| 271 | """Return list of attribute-descriptor tuples. |
| 272 | |
| 273 | For each name in dir(cls), the return list contains a 4-tuple |
| 274 | with these elements: |
| 275 | |
| 276 | 0. The name (a string). |
| 277 | |
| 278 | 1. The kind of attribute this is, one of these strings: |
| 279 | 'class method' created via classmethod() |
| 280 | 'static method' created via staticmethod() |
| 281 | 'property' created via property() |
| 282 | 'method' any other flavor of method |
| 283 | 'data' not a method |
| 284 | |
| 285 | 2. The class which defined this attribute (a class). |
| 286 | |
| 287 | 3. The object as obtained directly from the defining class's |
| 288 | __dict__, not via getattr. This is especially important for |
| 289 | data attributes: C.data is just a data object, but |
| 290 | C.__dict__['data'] may be a data descriptor with additional |
| 291 | info, like a __doc__ string. |
| 292 | """ |
| 293 | |
| 294 | mro = getmro(cls) |
| 295 | names = dir(cls) |
| 296 | result = [] |
| 297 | for name in names: |
| 298 | # Get the object associated with the name. |
| 299 | # Getting an obj from the __dict__ sometimes reveals more than |
| 300 | # using getattr. Static and class methods are dramatic examples. |
| 301 | if name in cls.__dict__: |
| 302 | obj = cls.__dict__[name] |
| 303 | else: |
| 304 | obj = getattr(cls, name) |
| 305 | |
| 306 | # Figure out where it was defined. |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 307 | homecls = getattr(obj, "__objclass__", None) |
| 308 | if homecls is None: |
Guido van Rossum | 687ae00 | 2001-10-15 22:03:32 +0000 | [diff] [blame] | 309 | # search the dicts. |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 310 | for base in mro: |
| 311 | if name in base.__dict__: |
| 312 | homecls = base |
| 313 | break |
| 314 | |
| 315 | # Get the object again, in order to get it from the defining |
| 316 | # __dict__ instead of via getattr (if possible). |
| 317 | if homecls is not None and name in homecls.__dict__: |
| 318 | obj = homecls.__dict__[name] |
| 319 | |
| 320 | # Also get the object via getattr. |
| 321 | obj_via_getattr = getattr(cls, name) |
| 322 | |
| 323 | # Classify the object. |
| 324 | if isinstance(obj, staticmethod): |
| 325 | kind = "static method" |
| 326 | elif isinstance(obj, classmethod): |
| 327 | kind = "class method" |
| 328 | elif isinstance(obj, property): |
| 329 | kind = "property" |
Christian Heimes | 4a22b5d | 2007-11-25 09:39:14 +0000 | [diff] [blame] | 330 | elif (isfunction(obj_via_getattr) or |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 331 | ismethoddescriptor(obj_via_getattr)): |
| 332 | kind = "method" |
| 333 | else: |
| 334 | kind = "data" |
| 335 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 336 | result.append(Attribute(name, kind, homecls, obj)) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 337 | |
| 338 | return result |
| 339 | |
Tim Peters | e0b2d7a | 2001-09-22 06:10:55 +0000 | [diff] [blame] | 340 | # ----------------------------------------------------------- class helpers |
Tim Peters | e0b2d7a | 2001-09-22 06:10:55 +0000 | [diff] [blame] | 341 | |
| 342 | def getmro(cls): |
| 343 | "Return tuple of base classes (including cls) in method resolution order." |
Benjamin Peterson | b82c8e5 | 2010-11-04 00:38:49 +0000 | [diff] [blame] | 344 | return cls.__mro__ |
Tim Peters | e0b2d7a | 2001-09-22 06:10:55 +0000 | [diff] [blame] | 345 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 346 | # -------------------------------------------------- source code extraction |
| 347 | def indentsize(line): |
| 348 | """Return the indent size, in spaces, at the start of a line of text.""" |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 349 | expline = line.expandtabs() |
| 350 | return len(expline) - len(expline.lstrip()) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 351 | |
| 352 | def getdoc(object): |
| 353 | """Get the documentation string for an object. |
| 354 | |
| 355 | All tabs are expanded to spaces. To clean up docstrings that are |
| 356 | indented to line up with blocks of code, any whitespace than can be |
| 357 | uniformly removed from the second line onwards is removed.""" |
Tim Peters | 2400831 | 2002-03-17 18:56:20 +0000 | [diff] [blame] | 358 | try: |
| 359 | doc = object.__doc__ |
| 360 | except AttributeError: |
| 361 | return None |
Guido van Rossum | 3172c5d | 2007-10-16 18:12:55 +0000 | [diff] [blame] | 362 | if not isinstance(doc, str): |
Tim Peters | 2400831 | 2002-03-17 18:56:20 +0000 | [diff] [blame] | 363 | return None |
Georg Brandl | 0c77a82 | 2008-06-10 16:37:50 +0000 | [diff] [blame] | 364 | return cleandoc(doc) |
| 365 | |
| 366 | def cleandoc(doc): |
| 367 | """Clean up indentation from docstrings. |
| 368 | |
| 369 | Any whitespace that can be uniformly removed from the second line |
| 370 | onwards is removed.""" |
Tim Peters | 2400831 | 2002-03-17 18:56:20 +0000 | [diff] [blame] | 371 | try: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 372 | lines = doc.expandtabs().split('\n') |
Tim Peters | 2400831 | 2002-03-17 18:56:20 +0000 | [diff] [blame] | 373 | except UnicodeError: |
| 374 | return None |
| 375 | else: |
Ka-Ping Yee | a59ef7b | 2002-11-30 03:53:15 +0000 | [diff] [blame] | 376 | # Find minimum indentation of any non-blank lines after first line. |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 377 | margin = sys.maxsize |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 378 | for line in lines[1:]: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 379 | content = len(line.lstrip()) |
Ka-Ping Yee | a59ef7b | 2002-11-30 03:53:15 +0000 | [diff] [blame] | 380 | if content: |
| 381 | indent = len(line) - content |
| 382 | margin = min(margin, indent) |
| 383 | # Remove indentation. |
| 384 | if lines: |
| 385 | lines[0] = lines[0].lstrip() |
Christian Heimes | a37d4c6 | 2007-12-04 23:02:19 +0000 | [diff] [blame] | 386 | if margin < sys.maxsize: |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 387 | for i in range(1, len(lines)): lines[i] = lines[i][margin:] |
Ka-Ping Yee | a59ef7b | 2002-11-30 03:53:15 +0000 | [diff] [blame] | 388 | # Remove any trailing or leading blank lines. |
| 389 | while lines and not lines[-1]: |
| 390 | lines.pop() |
| 391 | while lines and not lines[0]: |
| 392 | lines.pop(0) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 393 | return '\n'.join(lines) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 394 | |
| 395 | def getfile(object): |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 396 | """Work out which source or compiled file an object was defined in.""" |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 397 | if ismodule(object): |
| 398 | if hasattr(object, '__file__'): |
| 399 | return object.__file__ |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 400 | raise TypeError('{!r} is a built-in module'.format(object)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 401 | if isclass(object): |
Ka-Ping Yee | c99e0f1 | 2001-04-13 12:10:40 +0000 | [diff] [blame] | 402 | object = sys.modules.get(object.__module__) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 403 | if hasattr(object, '__file__'): |
| 404 | return object.__file__ |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 405 | raise TypeError('{!r} is a built-in class'.format(object)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 406 | if ismethod(object): |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 407 | object = object.__func__ |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 408 | if isfunction(object): |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 409 | object = object.__code__ |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 410 | if istraceback(object): |
| 411 | object = object.tb_frame |
| 412 | if isframe(object): |
| 413 | object = object.f_code |
| 414 | if iscode(object): |
| 415 | return object.co_filename |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 416 | raise TypeError('{!r} is not a module, class, method, ' |
| 417 | 'function, traceback, frame, or code object'.format(object)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 418 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 419 | ModuleInfo = namedtuple('ModuleInfo', 'name suffix mode module_type') |
| 420 | |
Ka-Ping Yee | 4d6fc7f | 2001-04-10 11:43:00 +0000 | [diff] [blame] | 421 | def getmoduleinfo(path): |
| 422 | """Get the module name, suffix, mode, and module type for a given file.""" |
| 423 | filename = os.path.basename(path) |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 424 | suffixes = [(-len(suffix), suffix, mode, mtype) |
| 425 | for suffix, mode, mtype in imp.get_suffixes()] |
Ka-Ping Yee | 4d6fc7f | 2001-04-10 11:43:00 +0000 | [diff] [blame] | 426 | suffixes.sort() # try longest suffixes first, in case they overlap |
| 427 | for neglen, suffix, mode, mtype in suffixes: |
| 428 | if filename[neglen:] == suffix: |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 429 | return ModuleInfo(filename[:neglen], suffix, mode, mtype) |
Ka-Ping Yee | 4d6fc7f | 2001-04-10 11:43:00 +0000 | [diff] [blame] | 430 | |
| 431 | def getmodulename(path): |
| 432 | """Return the module name for a given file, or None.""" |
| 433 | info = getmoduleinfo(path) |
| 434 | if info: return info[0] |
| 435 | |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 436 | def getsourcefile(object): |
R. David Murray | a1b3740 | 2010-06-17 02:04:29 +0000 | [diff] [blame] | 437 | """Return the filename that can be used to locate an object's source. |
| 438 | Return None if no way can be identified to get the source. |
| 439 | """ |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 440 | filename = getfile(object) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 441 | if filename[-4:].lower() in ('.pyc', '.pyo'): |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 442 | filename = filename[:-4] + '.py' |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 443 | for suffix, mode, kind in imp.get_suffixes(): |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 444 | if 'b' in mode and filename[-len(suffix):].lower() == suffix: |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 445 | # Looks like a binary file. We want to only return a text file. |
| 446 | return None |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 447 | if os.path.exists(filename): |
| 448 | return filename |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 449 | # only return a non-existent filename if the module has a PEP 302 loader |
| 450 | if hasattr(getmodule(object, filename), '__loader__'): |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 451 | return filename |
R. David Murray | a1b3740 | 2010-06-17 02:04:29 +0000 | [diff] [blame] | 452 | # or it is in the linecache |
| 453 | if filename in linecache.cache: |
| 454 | return filename |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 455 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 456 | def getabsfile(object, _filename=None): |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 457 | """Return an absolute path to the source or compiled file for an object. |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 458 | |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 459 | The idea is for each object to have a unique origin, so this routine |
| 460 | normalizes the result as much as possible.""" |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 461 | if _filename is None: |
| 462 | _filename = getsourcefile(object) or getfile(object) |
| 463 | return os.path.normcase(os.path.abspath(_filename)) |
Ka-Ping Yee | c113c24 | 2001-03-02 02:08:53 +0000 | [diff] [blame] | 464 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 465 | modulesbyfile = {} |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 466 | _filesbymodname = {} |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 467 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 468 | def getmodule(object, _filename=None): |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 469 | """Return the module an object was defined in, or None if not found.""" |
Ka-Ping Yee | 202c99b | 2001-04-13 09:15:08 +0000 | [diff] [blame] | 470 | if ismodule(object): |
| 471 | return object |
Johannes Gijsbers | 9324526 | 2004-09-11 15:53:22 +0000 | [diff] [blame] | 472 | if hasattr(object, '__module__'): |
Ka-Ping Yee | 8b58b84 | 2001-03-01 13:56:16 +0000 | [diff] [blame] | 473 | return sys.modules.get(object.__module__) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 474 | # Try the filename to modulename cache |
| 475 | if _filename is not None and _filename in modulesbyfile: |
| 476 | return sys.modules.get(modulesbyfile[_filename]) |
| 477 | # Try the cache again with the absolute file name |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 478 | try: |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 479 | file = getabsfile(object, _filename) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 480 | except TypeError: |
| 481 | return None |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 482 | if file in modulesbyfile: |
Ka-Ping Yee | b38bbbd | 2003-03-28 16:29:50 +0000 | [diff] [blame] | 483 | return sys.modules.get(modulesbyfile[file]) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 484 | # Update the filename to module name cache and check yet again |
| 485 | # Copy sys.modules in order to cope with changes while iterating |
| 486 | for modname, module in sys.modules.items(): |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 487 | if ismodule(module) and hasattr(module, '__file__'): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 488 | f = module.__file__ |
| 489 | if f == _filesbymodname.get(modname, None): |
| 490 | # Have already mapped this module, so skip it |
| 491 | continue |
| 492 | _filesbymodname[modname] = f |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 493 | f = getabsfile(module) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 494 | # Always map to the name the module knows itself by |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 495 | modulesbyfile[f] = modulesbyfile[ |
| 496 | os.path.realpath(f)] = module.__name__ |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 497 | if file in modulesbyfile: |
Ka-Ping Yee | b38bbbd | 2003-03-28 16:29:50 +0000 | [diff] [blame] | 498 | return sys.modules.get(modulesbyfile[file]) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 499 | # Check the main module |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 500 | main = sys.modules['__main__'] |
Brett Cannon | 4a671fe | 2003-06-15 22:33:28 +0000 | [diff] [blame] | 501 | if not hasattr(object, '__name__'): |
| 502 | return None |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 503 | if hasattr(main, object.__name__): |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 504 | mainobject = getattr(main, object.__name__) |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 505 | if mainobject is object: |
| 506 | return main |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 507 | # Check builtins |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 508 | builtin = sys.modules['builtins'] |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 509 | if hasattr(builtin, object.__name__): |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 510 | builtinobject = getattr(builtin, object.__name__) |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 511 | if builtinobject is object: |
| 512 | return builtin |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 513 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 514 | def findsource(object): |
| 515 | """Return the entire source file and starting line number for an object. |
| 516 | |
| 517 | The argument may be a module, class, method, function, traceback, frame, |
| 518 | or code object. The source code is returned as a list of all the lines |
| 519 | in the file and the line number indexes a line in that list. An IOError |
| 520 | is raised if the source code cannot be retrieved.""" |
R. David Murray | 74b8924 | 2009-05-13 17:33:03 +0000 | [diff] [blame] | 521 | file = getsourcefile(object) |
| 522 | if not file: |
| 523 | raise IOError('source code not available') |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 524 | module = getmodule(object, file) |
Thomas Wouters | 477c8d5 | 2006-05-27 19:21:47 +0000 | [diff] [blame] | 525 | if module: |
| 526 | lines = linecache.getlines(file, module.__dict__) |
| 527 | else: |
| 528 | lines = linecache.getlines(file) |
Neil Schemenauer | f06f853 | 2002-03-23 23:51:04 +0000 | [diff] [blame] | 529 | if not lines: |
Jeremy Hylton | ab91902 | 2003-06-27 18:41:20 +0000 | [diff] [blame] | 530 | raise IOError('could not get source code') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 531 | |
| 532 | if ismodule(object): |
| 533 | return lines, 0 |
| 534 | |
| 535 | if isclass(object): |
| 536 | name = object.__name__ |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 537 | pat = re.compile(r'^(\s*)class\s*' + name + r'\b') |
| 538 | # make some effort to find the best matching class definition: |
| 539 | # use the one with the least indentation, which is the one |
| 540 | # that's most probably not inside a function definition. |
| 541 | candidates = [] |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 542 | for i in range(len(lines)): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 543 | match = pat.match(lines[i]) |
| 544 | if match: |
| 545 | # if it's at toplevel, it's already the best one |
| 546 | if lines[i][0] == 'c': |
| 547 | return lines, i |
| 548 | # else add whitespace to candidate list |
| 549 | candidates.append((match.group(1), i)) |
| 550 | if candidates: |
| 551 | # this will sort by whitespace, and by line number, |
| 552 | # less whitespace first |
| 553 | candidates.sort() |
| 554 | return lines, candidates[0][1] |
Jeremy Hylton | ab91902 | 2003-06-27 18:41:20 +0000 | [diff] [blame] | 555 | else: |
| 556 | raise IOError('could not find class definition') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 557 | |
| 558 | if ismethod(object): |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 559 | object = object.__func__ |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 560 | if isfunction(object): |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 561 | object = object.__code__ |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 562 | if istraceback(object): |
| 563 | object = object.tb_frame |
| 564 | if isframe(object): |
| 565 | object = object.f_code |
| 566 | if iscode(object): |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 567 | if not hasattr(object, 'co_firstlineno'): |
Jeremy Hylton | ab91902 | 2003-06-27 18:41:20 +0000 | [diff] [blame] | 568 | raise IOError('could not find function definition') |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 569 | lnum = object.co_firstlineno - 1 |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 570 | pat = re.compile(r'^(\s*def\s)|(.*(?<!\w)lambda(:|\s))|^(\s*@)') |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 571 | while lnum > 0: |
Ka-Ping Yee | a6e5971 | 2001-03-10 09:31:55 +0000 | [diff] [blame] | 572 | if pat.match(lines[lnum]): break |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 573 | lnum = lnum - 1 |
| 574 | return lines, lnum |
Jeremy Hylton | ab91902 | 2003-06-27 18:41:20 +0000 | [diff] [blame] | 575 | raise IOError('could not find code object') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 576 | |
| 577 | def getcomments(object): |
Jeremy Hylton | b4c17c8 | 2002-03-28 23:01:56 +0000 | [diff] [blame] | 578 | """Get lines of comments immediately preceding an object's source code. |
| 579 | |
| 580 | Returns None when source can't be found. |
| 581 | """ |
| 582 | try: |
| 583 | lines, lnum = findsource(object) |
| 584 | except (IOError, TypeError): |
| 585 | return None |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 586 | |
| 587 | if ismodule(object): |
| 588 | # Look for a comment block at the top of the file. |
| 589 | start = 0 |
Ka-Ping Yee | b910efe | 2001-04-12 13:17:17 +0000 | [diff] [blame] | 590 | if lines and lines[0][:2] == '#!': start = 1 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 591 | while start < len(lines) and lines[start].strip() in ('', '#'): |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 592 | start = start + 1 |
Ka-Ping Yee | b910efe | 2001-04-12 13:17:17 +0000 | [diff] [blame] | 593 | if start < len(lines) and lines[start][:1] == '#': |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 594 | comments = [] |
| 595 | end = start |
| 596 | while end < len(lines) and lines[end][:1] == '#': |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 597 | comments.append(lines[end].expandtabs()) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 598 | end = end + 1 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 599 | return ''.join(comments) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 600 | |
| 601 | # Look for a preceding block of comments at the same indentation. |
| 602 | elif lnum > 0: |
| 603 | indent = indentsize(lines[lnum]) |
| 604 | end = lnum - 1 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 605 | if end >= 0 and lines[end].lstrip()[:1] == '#' and \ |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 606 | indentsize(lines[end]) == indent: |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 607 | comments = [lines[end].expandtabs().lstrip()] |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 608 | if end > 0: |
| 609 | end = end - 1 |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 610 | comment = lines[end].expandtabs().lstrip() |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 611 | while comment[:1] == '#' and indentsize(lines[end]) == indent: |
| 612 | comments[:0] = [comment] |
| 613 | end = end - 1 |
| 614 | if end < 0: break |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 615 | comment = lines[end].expandtabs().lstrip() |
| 616 | while comments and comments[0].strip() == '#': |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 617 | comments[:1] = [] |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 618 | while comments and comments[-1].strip() == '#': |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 619 | comments[-1:] = [] |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 620 | return ''.join(comments) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 621 | |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 622 | class EndOfBlock(Exception): pass |
| 623 | |
| 624 | class BlockFinder: |
| 625 | """Provide a tokeneater() method to detect the end of a code block.""" |
| 626 | def __init__(self): |
| 627 | self.indent = 0 |
Johannes Gijsbers | a5855d5 | 2005-03-12 16:37:11 +0000 | [diff] [blame] | 628 | self.islambda = False |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 629 | self.started = False |
| 630 | self.passline = False |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 631 | self.last = 1 |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 632 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 633 | def tokeneater(self, type, token, srowcol, erowcol, line): |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 634 | if not self.started: |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 635 | # look for the first "def", "class" or "lambda" |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 636 | if token in ("def", "class", "lambda"): |
Johannes Gijsbers | a5855d5 | 2005-03-12 16:37:11 +0000 | [diff] [blame] | 637 | if token == "lambda": |
| 638 | self.islambda = True |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 639 | self.started = True |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 640 | self.passline = True # skip to the end of the line |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 641 | elif type == tokenize.NEWLINE: |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 642 | self.passline = False # stop skipping when a NEWLINE is seen |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 643 | self.last = srowcol[0] |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 644 | if self.islambda: # lambdas always end at the first NEWLINE |
| 645 | raise EndOfBlock |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 646 | elif self.passline: |
| 647 | pass |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 648 | elif type == tokenize.INDENT: |
| 649 | self.indent = self.indent + 1 |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 650 | self.passline = True |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 651 | elif type == tokenize.DEDENT: |
| 652 | self.indent = self.indent - 1 |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 653 | # the end of matching indent/dedent pairs end a block |
| 654 | # (note that this only works for "def"/"class" blocks, |
| 655 | # not e.g. for "if: else:" or "try: finally:" blocks) |
| 656 | if self.indent <= 0: |
| 657 | raise EndOfBlock |
| 658 | elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL): |
| 659 | # any other token on the same indentation level end the previous |
| 660 | # block as well, except the pseudo-tokens COMMENT and NL. |
| 661 | raise EndOfBlock |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 662 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 663 | def getblock(lines): |
| 664 | """Extract the block of code at the top of the given list of lines.""" |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 665 | blockfinder = BlockFinder() |
Tim Peters | 4efb6e9 | 2001-06-29 23:51:08 +0000 | [diff] [blame] | 666 | try: |
Trent Nelson | 428de65 | 2008-03-18 22:41:35 +0000 | [diff] [blame] | 667 | tokens = tokenize.generate_tokens(iter(lines).__next__) |
| 668 | for _token in tokens: |
| 669 | blockfinder.tokeneater(*_token) |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 670 | except (EndOfBlock, IndentationError): |
| 671 | pass |
| 672 | return lines[:blockfinder.last] |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 673 | |
| 674 | def getsourcelines(object): |
| 675 | """Return a list of source lines and starting line number for an object. |
| 676 | |
| 677 | The argument may be a module, class, method, function, traceback, frame, |
| 678 | or code object. The source code is returned as a list of the lines |
| 679 | corresponding to the object and the line number indicates where in the |
| 680 | original source file the first line of code was found. An IOError is |
| 681 | raised if the source code cannot be retrieved.""" |
| 682 | lines, lnum = findsource(object) |
| 683 | |
| 684 | if ismodule(object): return lines, 0 |
| 685 | else: return getblock(lines[lnum:]), lnum + 1 |
| 686 | |
| 687 | def getsource(object): |
| 688 | """Return the text of the source code for an object. |
| 689 | |
| 690 | The argument may be a module, class, method, function, traceback, frame, |
| 691 | or code object. The source code is returned as a single string. An |
| 692 | IOError is raised if the source code cannot be retrieved.""" |
| 693 | lines, lnum = getsourcelines(object) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 694 | return ''.join(lines) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 695 | |
| 696 | # --------------------------------------------------- class tree extraction |
| 697 | def walktree(classes, children, parent): |
| 698 | """Recursive helper function for getclasstree().""" |
| 699 | results = [] |
Raymond Hettinger | a1a992c | 2005-03-11 06:46:45 +0000 | [diff] [blame] | 700 | classes.sort(key=attrgetter('__module__', '__name__')) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 701 | for c in classes: |
| 702 | results.append((c, c.__bases__)) |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 703 | if c in children: |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 704 | results.append(walktree(children[c], children, c)) |
| 705 | return results |
| 706 | |
Georg Brandl | 5ce83a0 | 2009-06-01 17:23:51 +0000 | [diff] [blame] | 707 | def getclasstree(classes, unique=False): |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 708 | """Arrange the given list of classes into a hierarchy of nested lists. |
| 709 | |
| 710 | Where a nested list appears, it contains classes derived from the class |
| 711 | whose entry immediately precedes the list. Each entry is a 2-tuple |
| 712 | containing a class and a tuple of its base classes. If the 'unique' |
| 713 | argument is true, exactly one entry appears in the returned structure |
| 714 | for each class in the given list. Otherwise, classes using multiple |
| 715 | inheritance and their descendants will appear multiple times.""" |
| 716 | children = {} |
| 717 | roots = [] |
| 718 | for c in classes: |
| 719 | if c.__bases__: |
| 720 | for parent in c.__bases__: |
Raymond Hettinger | 54f0222 | 2002-06-01 14:18:47 +0000 | [diff] [blame] | 721 | if not parent in children: |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 722 | children[parent] = [] |
| 723 | children[parent].append(c) |
| 724 | if unique and parent in classes: break |
| 725 | elif c not in roots: |
| 726 | roots.append(c) |
Raymond Hettinger | e0d4972 | 2002-06-02 18:55:56 +0000 | [diff] [blame] | 727 | for parent in children: |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 728 | if parent not in classes: |
| 729 | roots.append(parent) |
| 730 | return walktree(roots, children, None) |
| 731 | |
| 732 | # ------------------------------------------------ argument list extraction |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 733 | Arguments = namedtuple('Arguments', 'args, varargs, varkw') |
| 734 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 735 | def getargs(co): |
| 736 | """Get information about the arguments accepted by a code object. |
| 737 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 738 | Three things are returned: (args, varargs, varkw), where |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 739 | 'args' is the list of argument names. Keyword-only arguments are |
| 740 | appended. 'varargs' and 'varkw' are the names of the * and ** |
| 741 | arguments or None.""" |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 742 | args, varargs, kwonlyargs, varkw = _getfullargs(co) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 743 | return Arguments(args + kwonlyargs, varargs, varkw) |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 744 | |
| 745 | def _getfullargs(co): |
| 746 | """Get information about the arguments accepted by a code object. |
| 747 | |
| 748 | Four things are returned: (args, varargs, kwonlyargs, varkw), where |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 749 | 'args' and 'kwonlyargs' are lists of argument names, and 'varargs' |
| 750 | and 'varkw' are the names of the * and ** arguments or None.""" |
Jeremy Hylton | 6496788 | 2003-06-27 18:14:39 +0000 | [diff] [blame] | 751 | |
| 752 | if not iscode(co): |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 753 | raise TypeError('{!r} is not a code object'.format(co)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 754 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 755 | nargs = co.co_argcount |
| 756 | names = co.co_varnames |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 757 | nkwargs = co.co_kwonlyargcount |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 758 | args = list(names[:nargs]) |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 759 | kwonlyargs = list(names[nargs:nargs+nkwargs]) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 760 | step = 0 |
| 761 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 762 | nargs += nkwargs |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 763 | varargs = None |
| 764 | if co.co_flags & CO_VARARGS: |
| 765 | varargs = co.co_varnames[nargs] |
| 766 | nargs = nargs + 1 |
| 767 | varkw = None |
| 768 | if co.co_flags & CO_VARKEYWORDS: |
| 769 | varkw = co.co_varnames[nargs] |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 770 | return args, varargs, kwonlyargs, varkw |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 771 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 772 | |
| 773 | ArgSpec = namedtuple('ArgSpec', 'args varargs keywords defaults') |
| 774 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 775 | def getargspec(func): |
| 776 | """Get the names and default values of a function's arguments. |
| 777 | |
| 778 | A tuple of four things is returned: (args, varargs, varkw, defaults). |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 779 | 'args' is a list of the argument names. |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 780 | 'args' will include keyword-only argument names. |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 781 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. |
Jeremy Hylton | 6496788 | 2003-06-27 18:14:39 +0000 | [diff] [blame] | 782 | 'defaults' is an n-tuple of the default values of the last n arguments. |
Guido van Rossum | a8add0e | 2007-05-14 22:03:55 +0000 | [diff] [blame] | 783 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 784 | Use the getfullargspec() API for Python-3000 code, as annotations |
| 785 | and keyword arguments are supported. getargspec() will raise ValueError |
| 786 | if the func has either annotations or keyword arguments. |
| 787 | """ |
| 788 | |
| 789 | args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \ |
| 790 | getfullargspec(func) |
| 791 | if kwonlyargs or ann: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 792 | raise ValueError("Function has keyword-only arguments or annotations" |
| 793 | ", use getfullargspec() API which can support them") |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 794 | return ArgSpec(args, varargs, varkw, defaults) |
| 795 | |
| 796 | FullArgSpec = namedtuple('FullArgSpec', |
Benjamin Peterson | 3d4ca74 | 2008-11-12 21:39:01 +0000 | [diff] [blame] | 797 | 'args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations') |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 798 | |
| 799 | def getfullargspec(func): |
| 800 | """Get the names and default values of a function's arguments. |
| 801 | |
Brett Cannon | 504d885 | 2007-09-07 02:12:14 +0000 | [diff] [blame] | 802 | A tuple of seven things is returned: |
| 803 | (args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults annotations). |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 804 | 'args' is a list of the argument names. |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 805 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. |
| 806 | 'defaults' is an n-tuple of the default values of the last n arguments. |
| 807 | 'kwonlyargs' is a list of keyword-only argument names. |
| 808 | 'kwonlydefaults' is a dictionary mapping names from kwonlyargs to defaults. |
| 809 | 'annotations' is a dictionary mapping argument names to annotations. |
Guido van Rossum | a8add0e | 2007-05-14 22:03:55 +0000 | [diff] [blame] | 810 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 811 | The first four items in the tuple correspond to getargspec(). |
Jeremy Hylton | 6496788 | 2003-06-27 18:14:39 +0000 | [diff] [blame] | 812 | """ |
| 813 | |
| 814 | if ismethod(func): |
Christian Heimes | ff73795 | 2007-11-27 10:40:20 +0000 | [diff] [blame] | 815 | func = func.__func__ |
Jeremy Hylton | 6496788 | 2003-06-27 18:14:39 +0000 | [diff] [blame] | 816 | if not isfunction(func): |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 817 | raise TypeError('{!r} is not a Python function'.format(func)) |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 818 | args, varargs, kwonlyargs, varkw = _getfullargs(func.__code__) |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 819 | return FullArgSpec(args, varargs, varkw, func.__defaults__, |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 820 | kwonlyargs, func.__kwdefaults__, func.__annotations__) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 821 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 822 | ArgInfo = namedtuple('ArgInfo', 'args varargs keywords locals') |
| 823 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 824 | def getargvalues(frame): |
| 825 | """Get information about arguments passed into a particular frame. |
| 826 | |
| 827 | A tuple of four things is returned: (args, varargs, varkw, locals). |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 828 | 'args' is a list of the argument names. |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 829 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. |
| 830 | 'locals' is the locals dictionary of the given frame.""" |
| 831 | args, varargs, varkw = getargs(frame.f_code) |
Benjamin Peterson | 1a6e0d0 | 2008-10-25 15:49:17 +0000 | [diff] [blame] | 832 | return ArgInfo(args, varargs, varkw, frame.f_locals) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 833 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 834 | def formatannotation(annotation, base_module=None): |
| 835 | if isinstance(annotation, type): |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 836 | if annotation.__module__ in ('builtins', base_module): |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 837 | return annotation.__name__ |
| 838 | return annotation.__module__+'.'+annotation.__name__ |
| 839 | return repr(annotation) |
Guido van Rossum | a8add0e | 2007-05-14 22:03:55 +0000 | [diff] [blame] | 840 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 841 | def formatannotationrelativeto(object): |
Guido van Rossum | a8add0e | 2007-05-14 22:03:55 +0000 | [diff] [blame] | 842 | module = getattr(object, '__module__', None) |
| 843 | def _formatannotation(annotation): |
| 844 | return formatannotation(annotation, module) |
| 845 | return _formatannotation |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 846 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 847 | def formatargspec(args, varargs=None, varkw=None, defaults=None, |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 848 | kwonlyargs=(), kwonlydefaults={}, annotations={}, |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 849 | formatarg=str, |
| 850 | formatvarargs=lambda name: '*' + name, |
| 851 | formatvarkw=lambda name: '**' + name, |
| 852 | formatvalue=lambda value: '=' + repr(value), |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 853 | formatreturns=lambda text: ' -> ' + text, |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 854 | formatannotation=formatannotation): |
Guido van Rossum | a8add0e | 2007-05-14 22:03:55 +0000 | [diff] [blame] | 855 | """Format an argument spec from the values returned by getargspec |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 856 | or getfullargspec. |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 857 | |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 858 | The first seven arguments are (args, varargs, varkw, defaults, |
| 859 | kwonlyargs, kwonlydefaults, annotations). The other five arguments |
| 860 | are the corresponding optional formatting functions that are called to |
| 861 | turn names and values into strings. The last argument is an optional |
| 862 | function to format the sequence of arguments.""" |
| 863 | def formatargandannotation(arg): |
| 864 | result = formatarg(arg) |
| 865 | if arg in annotations: |
| 866 | result += ': ' + formatannotation(annotations[arg]) |
| 867 | return result |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 868 | specs = [] |
| 869 | if defaults: |
| 870 | firstdefault = len(args) - len(defaults) |
Benjamin Peterson | b58dda7 | 2009-01-18 22:27:04 +0000 | [diff] [blame] | 871 | for i, arg in enumerate(args): |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 872 | spec = formatargandannotation(arg) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 873 | if defaults and i >= firstdefault: |
| 874 | spec = spec + formatvalue(defaults[i - firstdefault]) |
| 875 | specs.append(spec) |
Raymond Hettinger | 936654b | 2002-06-01 03:06:31 +0000 | [diff] [blame] | 876 | if varargs is not None: |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 877 | specs.append(formatvarargs(formatargandannotation(varargs))) |
| 878 | else: |
| 879 | if kwonlyargs: |
| 880 | specs.append('*') |
| 881 | if kwonlyargs: |
| 882 | for kwonlyarg in kwonlyargs: |
| 883 | spec = formatargandannotation(kwonlyarg) |
Benjamin Peterson | 9953a8d | 2009-01-17 04:15:01 +0000 | [diff] [blame] | 884 | if kwonlydefaults and kwonlyarg in kwonlydefaults: |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 885 | spec += formatvalue(kwonlydefaults[kwonlyarg]) |
| 886 | specs.append(spec) |
Raymond Hettinger | 936654b | 2002-06-01 03:06:31 +0000 | [diff] [blame] | 887 | if varkw is not None: |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 888 | specs.append(formatvarkw(formatargandannotation(varkw))) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 889 | result = '(' + ', '.join(specs) + ')' |
Guido van Rossum | 2e65f89 | 2007-02-28 22:03:49 +0000 | [diff] [blame] | 890 | if 'return' in annotations: |
| 891 | result += formatreturns(formatannotation(annotations['return'])) |
| 892 | return result |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 893 | |
| 894 | def formatargvalues(args, varargs, varkw, locals, |
| 895 | formatarg=str, |
| 896 | formatvarargs=lambda name: '*' + name, |
| 897 | formatvarkw=lambda name: '**' + name, |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 898 | formatvalue=lambda value: '=' + repr(value)): |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 899 | """Format an argument spec from the 4 values returned by getargvalues. |
| 900 | |
| 901 | The first four arguments are (args, varargs, varkw, locals). The |
| 902 | next four arguments are the corresponding optional formatting functions |
| 903 | that are called to turn names and values into strings. The ninth |
| 904 | argument is an optional function to format the sequence of arguments.""" |
| 905 | def convert(name, locals=locals, |
| 906 | formatarg=formatarg, formatvalue=formatvalue): |
| 907 | return formatarg(name) + formatvalue(locals[name]) |
| 908 | specs = [] |
| 909 | for i in range(len(args)): |
Georg Brandl | c1c4bf8 | 2010-10-15 16:07:41 +0000 | [diff] [blame] | 910 | specs.append(convert(args[i])) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 911 | if varargs: |
| 912 | specs.append(formatvarargs(varargs) + formatvalue(locals[varargs])) |
| 913 | if varkw: |
| 914 | specs.append(formatvarkw(varkw) + formatvalue(locals[varkw])) |
Neal Norwitz | 9d72bb4 | 2007-04-17 08:48:32 +0000 | [diff] [blame] | 915 | return '(' + ', '.join(specs) + ')' |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 916 | |
Benjamin Peterson | b204a42 | 2011-06-05 22:04:07 -0500 | [diff] [blame] | 917 | def _positional_error(f_name, args, kwonly, varargs, defcount, given, values): |
| 918 | atleast = len(args) - defcount |
| 919 | if given is None: |
| 920 | given = len([arg for arg in args if arg in values]) |
| 921 | kwonly_given = len([arg for arg in kwonly if arg in values]) |
| 922 | if varargs: |
| 923 | plural = atleast != 1 |
| 924 | sig = "at least %d" % (atleast,) |
| 925 | elif defcount: |
| 926 | plural = True |
| 927 | sig = "from %d to %d" % (atleast, len(args)) |
| 928 | else: |
| 929 | plural = len(args) != 1 |
| 930 | sig = str(len(args)) |
| 931 | kwonly_sig = "" |
| 932 | if kwonly_given: |
| 933 | msg = " positional argument%s (and %d keyword-only argument%s)" |
| 934 | kwonly_sig = (msg % ("s" if given != 1 else "", kwonly_given, |
| 935 | "s" if kwonly_given != 1 else "")) |
| 936 | raise TypeError("%s() takes %s positional argument%s but %d%s %s given" % |
| 937 | (f_name, sig, "s" if plural else "", given, kwonly_sig, |
| 938 | "was" if given == 1 and not kwonly_given else "were")) |
| 939 | |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 940 | def getcallargs(func, *positional, **named): |
| 941 | """Get the mapping of arguments to values. |
| 942 | |
| 943 | A dict is returned, with keys the function argument names (including the |
| 944 | names of the * and ** arguments, if any), and values the respective bound |
| 945 | values from 'positional' and 'named'.""" |
| 946 | spec = getfullargspec(func) |
| 947 | args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = spec |
| 948 | f_name = func.__name__ |
| 949 | arg2value = {} |
| 950 | |
Benjamin Peterson | b204a42 | 2011-06-05 22:04:07 -0500 | [diff] [blame] | 951 | |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 952 | if ismethod(func) and func.__self__ is not None: |
| 953 | # implicit 'self' (or 'cls' for classmethods) argument |
| 954 | positional = (func.__self__,) + positional |
| 955 | num_pos = len(positional) |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 956 | num_args = len(args) |
| 957 | num_defaults = len(defaults) if defaults else 0 |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 958 | |
Benjamin Peterson | b204a42 | 2011-06-05 22:04:07 -0500 | [diff] [blame] | 959 | n = min(num_pos, num_args) |
| 960 | for i in range(n): |
| 961 | arg2value[args[i]] = positional[i] |
| 962 | if varargs: |
| 963 | arg2value[varargs] = tuple(positional[n:]) |
| 964 | possible_kwargs = set(args + kwonlyargs) |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 965 | if varkw: |
Benjamin Peterson | b204a42 | 2011-06-05 22:04:07 -0500 | [diff] [blame] | 966 | arg2value[varkw] = {} |
| 967 | for kw, value in named.items(): |
| 968 | if kw not in possible_kwargs: |
| 969 | if not varkw: |
| 970 | raise TypeError("%s() got an unexpected keyword argument %r" % |
| 971 | (f_name, kw)) |
| 972 | arg2value[varkw][kw] = value |
| 973 | continue |
| 974 | if kw in arg2value: |
| 975 | raise TypeError("%s() got multiple values for argument %r" % |
| 976 | (f_name, kw)) |
| 977 | arg2value[kw] = value |
| 978 | if num_pos > num_args and not varargs: |
| 979 | _positional_error(f_name, args, kwonlyargs, varargs, num_defaults, |
| 980 | num_pos, arg2value) |
| 981 | if num_pos < num_args: |
| 982 | for arg in args[:num_args - num_defaults]: |
| 983 | if arg not in arg2value: |
| 984 | _positional_error(f_name, args, kwonlyargs, varargs, |
| 985 | num_defaults, None, arg2value) |
| 986 | for i, arg in enumerate(args[num_args - num_defaults:]): |
| 987 | if arg not in arg2value: |
| 988 | arg2value[arg] = defaults[i] |
| 989 | for kwarg in kwonlyargs: |
| 990 | if kwarg not in arg2value: |
| 991 | if kwarg not in kwonlydefaults: |
| 992 | raise TypeError("%s() requires keyword-only argument %r" % |
| 993 | (f_name, kwarg)) |
| 994 | arg2value[kwarg] = kwonlydefaults[kwarg] |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 995 | return arg2value |
| 996 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 997 | # -------------------------------------------------- stack frame extraction |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 998 | |
| 999 | Traceback = namedtuple('Traceback', 'filename lineno function code_context index') |
| 1000 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1001 | def getframeinfo(frame, context=1): |
| 1002 | """Get information about a frame or traceback object. |
| 1003 | |
| 1004 | A tuple of five things is returned: the filename, the line number of |
| 1005 | the current line, the function name, a list of lines of context from |
| 1006 | the source code, and the index of the current line within that list. |
| 1007 | The optional second argument specifies the number of lines of context |
| 1008 | to return, which are centered around the current line.""" |
| 1009 | if istraceback(frame): |
Andrew M. Kuchling | ba8b6bc | 2004-06-05 14:11:59 +0000 | [diff] [blame] | 1010 | lineno = frame.tb_lineno |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1011 | frame = frame.tb_frame |
Andrew M. Kuchling | ba8b6bc | 2004-06-05 14:11:59 +0000 | [diff] [blame] | 1012 | else: |
| 1013 | lineno = frame.f_lineno |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1014 | if not isframe(frame): |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 1015 | raise TypeError('{!r} is not a frame or traceback object'.format(frame)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1016 | |
Neil Schemenauer | f06f853 | 2002-03-23 23:51:04 +0000 | [diff] [blame] | 1017 | filename = getsourcefile(frame) or getfile(frame) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1018 | if context > 0: |
Guido van Rossum | 54e54c6 | 2001-09-04 19:14:14 +0000 | [diff] [blame] | 1019 | start = lineno - 1 - context//2 |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1020 | try: |
| 1021 | lines, lnum = findsource(frame) |
Ka-Ping Yee | 4eb0c00 | 2001-03-02 05:50:34 +0000 | [diff] [blame] | 1022 | except IOError: |
| 1023 | lines = index = None |
| 1024 | else: |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1025 | start = max(start, 1) |
Raymond Hettinger | a050171 | 2004-06-15 11:22:53 +0000 | [diff] [blame] | 1026 | start = max(0, min(start, len(lines) - context)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1027 | lines = lines[start:start+context] |
Ka-Ping Yee | 59ade08 | 2001-03-01 03:55:35 +0000 | [diff] [blame] | 1028 | index = lineno - 1 - start |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1029 | else: |
| 1030 | lines = index = None |
| 1031 | |
Christian Heimes | 25bb783 | 2008-01-11 16:17:00 +0000 | [diff] [blame] | 1032 | return Traceback(filename, lineno, frame.f_code.co_name, lines, index) |
Ka-Ping Yee | 59ade08 | 2001-03-01 03:55:35 +0000 | [diff] [blame] | 1033 | |
| 1034 | def getlineno(frame): |
| 1035 | """Get the line number from a frame object, allowing for optimization.""" |
Michael W. Hudson | dd32a91 | 2002-08-15 14:59:02 +0000 | [diff] [blame] | 1036 | # FrameType.f_lineno is now a descriptor that grovels co_lnotab |
| 1037 | return frame.f_lineno |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1038 | |
| 1039 | def getouterframes(frame, context=1): |
| 1040 | """Get a list of records for a frame and all higher (calling) frames. |
| 1041 | |
| 1042 | Each record contains a frame object, filename, line number, function |
| 1043 | name, a list of lines of context, and index within the context.""" |
| 1044 | framelist = [] |
| 1045 | while frame: |
| 1046 | framelist.append((frame,) + getframeinfo(frame, context)) |
| 1047 | frame = frame.f_back |
| 1048 | return framelist |
| 1049 | |
| 1050 | def getinnerframes(tb, context=1): |
| 1051 | """Get a list of records for a traceback's frame and all lower frames. |
| 1052 | |
| 1053 | Each record contains a frame object, filename, line number, function |
| 1054 | name, a list of lines of context, and index within the context.""" |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1055 | framelist = [] |
| 1056 | while tb: |
| 1057 | framelist.append((tb.tb_frame,) + getframeinfo(tb, context)) |
| 1058 | tb = tb.tb_next |
| 1059 | return framelist |
| 1060 | |
Benjamin Peterson | 42ac475 | 2010-08-09 13:05:35 +0000 | [diff] [blame] | 1061 | def currentframe(): |
Benjamin Peterson | a3a3fc6 | 2010-08-09 15:49:56 +0000 | [diff] [blame] | 1062 | """Return the frame of the caller or None if this is not possible.""" |
Benjamin Peterson | 42ac475 | 2010-08-09 13:05:35 +0000 | [diff] [blame] | 1063 | return sys._getframe(1) if hasattr(sys, "_getframe") else None |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1064 | |
| 1065 | def stack(context=1): |
| 1066 | """Return a list of records for the stack above the caller's frame.""" |
Jeremy Hylton | ab91902 | 2003-06-27 18:41:20 +0000 | [diff] [blame] | 1067 | return getouterframes(sys._getframe(1), context) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 1068 | |
| 1069 | def trace(context=1): |
Tim Peters | 85ba673 | 2001-02-28 08:26:44 +0000 | [diff] [blame] | 1070 | """Return a list of records for the stack below the current exception.""" |
Fred Drake | d451ec1 | 2002-04-26 02:29:55 +0000 | [diff] [blame] | 1071 | return getinnerframes(sys.exc_info()[2], context) |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1072 | |
| 1073 | |
| 1074 | # ------------------------------------------------ static version of getattr |
| 1075 | |
| 1076 | _sentinel = object() |
| 1077 | |
Michael Foord | e516265 | 2010-11-20 16:40:44 +0000 | [diff] [blame] | 1078 | def _static_getmro(klass): |
| 1079 | return type.__dict__['__mro__'].__get__(klass) |
| 1080 | |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1081 | def _check_instance(obj, attr): |
| 1082 | instance_dict = {} |
| 1083 | try: |
| 1084 | instance_dict = object.__getattribute__(obj, "__dict__") |
| 1085 | except AttributeError: |
| 1086 | pass |
Michael Foord | dcebe0f | 2011-03-15 19:20:44 -0400 | [diff] [blame] | 1087 | return dict.get(instance_dict, attr, _sentinel) |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1088 | |
| 1089 | |
| 1090 | def _check_class(klass, attr): |
Michael Foord | e516265 | 2010-11-20 16:40:44 +0000 | [diff] [blame] | 1091 | for entry in _static_getmro(klass): |
Michael Foord | dcebe0f | 2011-03-15 19:20:44 -0400 | [diff] [blame] | 1092 | if not _shadowed_dict(type(entry)): |
| 1093 | try: |
| 1094 | return entry.__dict__[attr] |
| 1095 | except KeyError: |
| 1096 | pass |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1097 | return _sentinel |
| 1098 | |
Michael Foord | 35184ed | 2010-11-20 16:58:30 +0000 | [diff] [blame] | 1099 | def _is_type(obj): |
| 1100 | try: |
| 1101 | _static_getmro(obj) |
| 1102 | except TypeError: |
| 1103 | return False |
| 1104 | return True |
| 1105 | |
Michael Foord | dcebe0f | 2011-03-15 19:20:44 -0400 | [diff] [blame] | 1106 | def _shadowed_dict(klass): |
| 1107 | dict_attr = type.__dict__["__dict__"] |
| 1108 | for entry in _static_getmro(klass): |
| 1109 | try: |
| 1110 | class_dict = dict_attr.__get__(entry)["__dict__"] |
| 1111 | except KeyError: |
| 1112 | pass |
| 1113 | else: |
| 1114 | if not (type(class_dict) is types.GetSetDescriptorType and |
| 1115 | class_dict.__name__ == "__dict__" and |
| 1116 | class_dict.__objclass__ is entry): |
| 1117 | return True |
| 1118 | return False |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1119 | |
| 1120 | def getattr_static(obj, attr, default=_sentinel): |
| 1121 | """Retrieve attributes without triggering dynamic lookup via the |
| 1122 | descriptor protocol, __getattr__ or __getattribute__. |
| 1123 | |
| 1124 | Note: this function may not be able to retrieve all attributes |
| 1125 | that getattr can fetch (like dynamically created attributes) |
| 1126 | and may find attributes that getattr can't (like descriptors |
| 1127 | that raise AttributeError). It can also return descriptor objects |
| 1128 | instead of instance members in some cases. See the |
| 1129 | documentation for details. |
| 1130 | """ |
| 1131 | instance_result = _sentinel |
Michael Foord | 35184ed | 2010-11-20 16:58:30 +0000 | [diff] [blame] | 1132 | if not _is_type(obj): |
Michael Foord | cc7ebb8 | 2010-11-20 16:20:16 +0000 | [diff] [blame] | 1133 | klass = type(obj) |
Michael Foord | dcebe0f | 2011-03-15 19:20:44 -0400 | [diff] [blame] | 1134 | if not _shadowed_dict(klass): |
| 1135 | instance_result = _check_instance(obj, attr) |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1136 | else: |
| 1137 | klass = obj |
| 1138 | |
| 1139 | klass_result = _check_class(klass, attr) |
| 1140 | |
| 1141 | if instance_result is not _sentinel and klass_result is not _sentinel: |
| 1142 | if (_check_class(type(klass_result), '__get__') is not _sentinel and |
| 1143 | _check_class(type(klass_result), '__set__') is not _sentinel): |
| 1144 | return klass_result |
| 1145 | |
| 1146 | if instance_result is not _sentinel: |
| 1147 | return instance_result |
| 1148 | if klass_result is not _sentinel: |
| 1149 | return klass_result |
| 1150 | |
| 1151 | if obj is klass: |
| 1152 | # for types we check the metaclass too |
Michael Foord | e516265 | 2010-11-20 16:40:44 +0000 | [diff] [blame] | 1153 | for entry in _static_getmro(type(klass)): |
Michael Foord | 95fc51d | 2010-11-20 15:07:30 +0000 | [diff] [blame] | 1154 | try: |
| 1155 | return entry.__dict__[attr] |
| 1156 | except KeyError: |
| 1157 | pass |
| 1158 | if default is not _sentinel: |
| 1159 | return default |
| 1160 | raise AttributeError(attr) |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1161 | |
| 1162 | |
Nick Coghlan | 7921b9f | 2010-11-30 06:36:04 +0000 | [diff] [blame] | 1163 | GEN_CREATED = 'GEN_CREATED' |
| 1164 | GEN_RUNNING = 'GEN_RUNNING' |
| 1165 | GEN_SUSPENDED = 'GEN_SUSPENDED' |
| 1166 | GEN_CLOSED = 'GEN_CLOSED' |
Nick Coghlan | e0f0465 | 2010-11-21 03:44:04 +0000 | [diff] [blame] | 1167 | |
| 1168 | def getgeneratorstate(generator): |
| 1169 | """Get current state of a generator-iterator. |
| 1170 | |
| 1171 | Possible states are: |
| 1172 | GEN_CREATED: Waiting to start execution. |
| 1173 | GEN_RUNNING: Currently being executed by the interpreter. |
| 1174 | GEN_SUSPENDED: Currently suspended at a yield expression. |
| 1175 | GEN_CLOSED: Execution has completed. |
| 1176 | """ |
| 1177 | if generator.gi_running: |
| 1178 | return GEN_RUNNING |
| 1179 | if generator.gi_frame is None: |
| 1180 | return GEN_CLOSED |
| 1181 | if generator.gi_frame.f_lasti == -1: |
| 1182 | return GEN_CREATED |
| 1183 | return GEN_SUSPENDED |