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