├── .gitignore ├── MANIFEST.in ├── README.md ├── docs ├── SocketServer_classes.png ├── ast_classes.png ├── logging_classes.png ├── maxjob_classes.png ├── maxjob_packages.png ├── pluggy_classes.png ├── pyplantuml_packages.png ├── re_classes.png ├── setuptools_classes.png ├── tokenize_classes.png ├── tox_classes.png ├── urllib_classes.png └── webbrowser_classes.png ├── experiments ├── inspect_help.txt ├── inspecttest.py ├── inspecttest.tmp ├── notes.txt ├── plantuml.txt ├── py2plantuml.py ├── submit.py ├── templates.py └── test.py ├── pyplantuml ├── __init__.py ├── adapter.py ├── cli.py ├── online.py └── writer.py ├── setup.py └── tests ├── test___init__.py ├── test_adapter.py ├── test_cli.py ├── test_online.py └── test_writer.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | 4 | *.sublime-* 5 | *.egg* 6 | dist 7 | build 8 | 9 | venv -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.md -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pyplantuml 2 | 3 | ![](docs/pyplantuml_packages.png) 4 | 5 | Creates UML diagrams (package and class structure) from Python source code. 6 | 7 | Build on top of pylint's pyreverse to do the static code analysis and supports most of its original commandline interface. 8 | 9 | It basically outputs plantuml description as text files instead of .dot files. The plantuml code features a simple syntax and is a great base for manual extension, e.g. to sketch out ideas on how to evolve the data model. 10 | 11 | 12 | ## Installation 13 | 14 | From pypi: 15 | 16 | $ pip install pyplantuml 17 | 18 | From source: 19 | 20 | $ python setup.py develop 21 | 22 | After installation it is available from the commandline as two commands, see below. 23 | 24 | 25 | ## Dependencies 26 | 27 | * [pylint](https://www.pylint.org/), for it includes [astroid](https://www.astroid.org/) and [pyreverse](https://www.logilab.org/blogentry/6883). 28 | 29 | * [plantuml](http://de.plantuml.com/), to convert the resulting text files to images. It is enough to download the **plantuml.jar** and place it somewhere in a directory that is on your PATH, pyplantuml will then be able to find it. 30 | 31 | 32 | ## Usage 33 | 34 | $ cd 35 | 36 | $ pyplantuml [pyreverse-options] 37 | 38 | If a plantuml.jar can be found on PATH, it will automatically be 39 | called afterwards to convert the text files to images. 40 | 41 | $ pyplantuml-web [pyreverse-options] 42 | 43 | Will use the online form on www.plantuml.com for conversion and 44 | display the result in your default browser. Do not use for sensitive data! 45 | 46 | 47 | ## Examples 48 | 49 | pyplantuml is a great way to visualize the data structure of an existing package. It can be used on custom packages as well as builtins, as some of the examples below illustrate. 50 | 51 | ### ast 52 | ![](docs/ast_classes.png) 53 | 54 | ### logging 55 | ![](docs/logging_classes.png) 56 | 57 | ### maxjob 58 | ![](docs/maxjob_packages.png) 59 | ![](docs/maxjob_classes.png) 60 | 61 | ### pluggy 62 | ![](docs/pluggy_classes.png) 63 | 64 | ### re 65 | ![](docs/re_classes.png) 66 | 67 | ### setuptools 68 | ![](docs/setuptools_classes.png) 69 | 70 | ### SocketServer 71 | ![](docs/SocketServer_classes.png) 72 | 73 | ### tokenize 74 | ![](docs/tokenize_classes.png) 75 | 76 | ### tox 77 | ![](docs/tox_classes.png) 78 | 79 | ### urllib 80 | ![](docs/urllib_classes.png) 81 | 82 | ### webbrowser 83 | ![](docs/webbrowser_classes.png) -------------------------------------------------------------------------------- /docs/SocketServer_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/SocketServer_classes.png -------------------------------------------------------------------------------- /docs/ast_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/ast_classes.png -------------------------------------------------------------------------------- /docs/logging_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/logging_classes.png -------------------------------------------------------------------------------- /docs/maxjob_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/maxjob_classes.png -------------------------------------------------------------------------------- /docs/maxjob_packages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/maxjob_packages.png -------------------------------------------------------------------------------- /docs/pluggy_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/pluggy_classes.png -------------------------------------------------------------------------------- /docs/pyplantuml_packages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/pyplantuml_packages.png -------------------------------------------------------------------------------- /docs/re_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/re_classes.png -------------------------------------------------------------------------------- /docs/setuptools_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/setuptools_classes.png -------------------------------------------------------------------------------- /docs/tokenize_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/tokenize_classes.png -------------------------------------------------------------------------------- /docs/tox_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/tox_classes.png -------------------------------------------------------------------------------- /docs/urllib_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/urllib_classes.png -------------------------------------------------------------------------------- /docs/webbrowser_classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/cb109/pyplantuml/3318ee832456eca3b8a6390b30515e182383e36f/docs/webbrowser_classes.png -------------------------------------------------------------------------------- /experiments/inspect_help.txt: -------------------------------------------------------------------------------- 1 | Help on module inspect: 2 | 3 | NAME 4 | inspect - Get useful information from live Python objects. 5 | 6 | DESCRIPTION 7 | This module encapsulates the interface provided by the internal special 8 | attributes (co_*, im_*, tb_*, etc.) in a friendlier fashion. 9 | It also provides some help for examining source code and class layout. 10 | 11 | Here are some of the useful functions provided by this module: 12 | 13 | ismodule(), isclass(), ismethod(), isfunction(), isgeneratorfunction(), 14 | isgenerator(), istraceback(), isframe(), iscode(), isbuiltin(), 15 | isroutine() - check object types 16 | getmembers() - get members of an object that satisfy a given condition 17 | 18 | getfile(), getsourcefile(), getsource() - find an object's source code 19 | getdoc(), getcomments() - get documentation on an object 20 | getmodule() - determine the module that an object came from 21 | getclasstree() - arrange classes so as to represent their hierarchy 22 | 23 | getargspec(), getargvalues(), getcallargs() - get info about function arguments 24 | getfullargspec() - same, with support for Python-3000 features 25 | formatargspec(), formatargvalues() - format an argument spec 26 | getouterframes(), getinnerframes() - get info about frames 27 | currentframe() - get the current stack frame 28 | stack(), trace() - get info about frames on the stack or in a traceback 29 | 30 | signature() - get a Signature object for the callable 31 | 32 | CLASSES 33 | builtins.Exception(builtins.BaseException) 34 | EndOfBlock 35 | builtins.object 36 | BlockFinder 37 | BoundArguments 38 | Parameter 39 | Signature 40 | builtins.tuple(builtins.object) 41 | ArgInfo 42 | ArgSpec 43 | Arguments 44 | Attribute 45 | ClosureVars 46 | FullArgSpec 47 | ModuleInfo 48 | Traceback 49 | 50 | class ArgInfo(builtins.tuple) 51 | | ArgInfo(args, varargs, keywords, locals) 52 | | 53 | | Method resolution order: 54 | | ArgInfo 55 | | builtins.tuple 56 | | builtins.object 57 | | 58 | | Methods defined here: 59 | | 60 | | __getnewargs__(self) 61 | | Return self as a plain tuple. Used by copy and pickle. 62 | | 63 | | __getstate__(self) 64 | | Exclude the OrderedDict from pickling 65 | | 66 | | __repr__(self) 67 | | Return a nicely formatted representation string 68 | | 69 | | _asdict(self) 70 | | Return a new OrderedDict which maps field names to their values. 71 | | 72 | | _replace(_self, **kwds) 73 | | Return a new ArgInfo object replacing specified fields with new values 74 | | 75 | | ---------------------------------------------------------------------- 76 | | Class methods defined here: 77 | | 78 | | _make(iterable, new=, len=) from builtins.type 79 | | Make a new ArgInfo object from a sequence or iterable 80 | | 81 | | ---------------------------------------------------------------------- 82 | | Static methods defined here: 83 | | 84 | | __new__(_cls, args, varargs, keywords, locals) 85 | | Create new instance of ArgInfo(args, varargs, keywords, locals) 86 | | 87 | | ---------------------------------------------------------------------- 88 | | Data descriptors defined here: 89 | | 90 | | __dict__ 91 | | A new OrderedDict mapping field names to their values 92 | | 93 | | args 94 | | Alias for field number 0 95 | | 96 | | keywords 97 | | Alias for field number 2 98 | | 99 | | locals 100 | | Alias for field number 3 101 | | 102 | | varargs 103 | | Alias for field number 1 104 | | 105 | | ---------------------------------------------------------------------- 106 | | Data and other attributes defined here: 107 | | 108 | | _fields = ('args', 'varargs', 'keywords', 'locals') 109 | | 110 | | _source = "from builtins import property as _property, tupl..._itemget... 111 | | 112 | | ---------------------------------------------------------------------- 113 | | Methods inherited from builtins.tuple: 114 | | 115 | | __add__(self, value, /) 116 | | Return self+value. 117 | | 118 | | __contains__(self, key, /) 119 | | Return key in self. 120 | | 121 | | __eq__(self, value, /) 122 | | Return self==value. 123 | | 124 | | __ge__(self, value, /) 125 | | Return self>=value. 126 | | 127 | | __getattribute__(self, name, /) 128 | | Return getattr(self, name). 129 | | 130 | | __getitem__(self, key, /) 131 | | Return self[key]. 132 | | 133 | | __gt__(self, value, /) 134 | | Return self>value. 135 | | 136 | | __hash__(self, /) 137 | | Return hash(self). 138 | | 139 | | __iter__(self, /) 140 | | Implement iter(self). 141 | | 142 | | __le__(self, value, /) 143 | | Return self<=value. 144 | | 145 | | __len__(self, /) 146 | | Return len(self). 147 | | 148 | | __lt__(self, value, /) 149 | | Return self integer -- return number of occurrences of value 165 | | 166 | | index(...) 167 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 168 | | Raises ValueError if the value is not present. 169 | 170 | class ArgSpec(builtins.tuple) 171 | | ArgSpec(args, varargs, keywords, defaults) 172 | | 173 | | Method resolution order: 174 | | ArgSpec 175 | | builtins.tuple 176 | | builtins.object 177 | | 178 | | Methods defined here: 179 | | 180 | | __getnewargs__(self) 181 | | Return self as a plain tuple. Used by copy and pickle. 182 | | 183 | | __getstate__(self) 184 | | Exclude the OrderedDict from pickling 185 | | 186 | | __repr__(self) 187 | | Return a nicely formatted representation string 188 | | 189 | | _asdict(self) 190 | | Return a new OrderedDict which maps field names to their values. 191 | | 192 | | _replace(_self, **kwds) 193 | | Return a new ArgSpec object replacing specified fields with new values 194 | | 195 | | ---------------------------------------------------------------------- 196 | | Class methods defined here: 197 | | 198 | | _make(iterable, new=, len=) from builtins.type 199 | | Make a new ArgSpec object from a sequence or iterable 200 | | 201 | | ---------------------------------------------------------------------- 202 | | Static methods defined here: 203 | | 204 | | __new__(_cls, args, varargs, keywords, defaults) 205 | | Create new instance of ArgSpec(args, varargs, keywords, defaults) 206 | | 207 | | ---------------------------------------------------------------------- 208 | | Data descriptors defined here: 209 | | 210 | | __dict__ 211 | | A new OrderedDict mapping field names to their values 212 | | 213 | | args 214 | | Alias for field number 0 215 | | 216 | | defaults 217 | | Alias for field number 3 218 | | 219 | | keywords 220 | | Alias for field number 2 221 | | 222 | | varargs 223 | | Alias for field number 1 224 | | 225 | | ---------------------------------------------------------------------- 226 | | Data and other attributes defined here: 227 | | 228 | | _fields = ('args', 'varargs', 'keywords', 'defaults') 229 | | 230 | | _source = "from builtins import property as _property, tupl..._itemget... 231 | | 232 | | ---------------------------------------------------------------------- 233 | | Methods inherited from builtins.tuple: 234 | | 235 | | __add__(self, value, /) 236 | | Return self+value. 237 | | 238 | | __contains__(self, key, /) 239 | | Return key in self. 240 | | 241 | | __eq__(self, value, /) 242 | | Return self==value. 243 | | 244 | | __ge__(self, value, /) 245 | | Return self>=value. 246 | | 247 | | __getattribute__(self, name, /) 248 | | Return getattr(self, name). 249 | | 250 | | __getitem__(self, key, /) 251 | | Return self[key]. 252 | | 253 | | __gt__(self, value, /) 254 | | Return self>value. 255 | | 256 | | __hash__(self, /) 257 | | Return hash(self). 258 | | 259 | | __iter__(self, /) 260 | | Implement iter(self). 261 | | 262 | | __le__(self, value, /) 263 | | Return self<=value. 264 | | 265 | | __len__(self, /) 266 | | Return len(self). 267 | | 268 | | __lt__(self, value, /) 269 | | Return self integer -- return number of occurrences of value 285 | | 286 | | index(...) 287 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 288 | | Raises ValueError if the value is not present. 289 | 290 | class Arguments(builtins.tuple) 291 | | Arguments(args, varargs, varkw) 292 | | 293 | | Method resolution order: 294 | | Arguments 295 | | builtins.tuple 296 | | builtins.object 297 | | 298 | | Methods defined here: 299 | | 300 | | __getnewargs__(self) 301 | | Return self as a plain tuple. Used by copy and pickle. 302 | | 303 | | __getstate__(self) 304 | | Exclude the OrderedDict from pickling 305 | | 306 | | __repr__(self) 307 | | Return a nicely formatted representation string 308 | | 309 | | _asdict(self) 310 | | Return a new OrderedDict which maps field names to their values. 311 | | 312 | | _replace(_self, **kwds) 313 | | Return a new Arguments object replacing specified fields with new values 314 | | 315 | | ---------------------------------------------------------------------- 316 | | Class methods defined here: 317 | | 318 | | _make(iterable, new=, len=) from builtins.type 319 | | Make a new Arguments object from a sequence or iterable 320 | | 321 | | ---------------------------------------------------------------------- 322 | | Static methods defined here: 323 | | 324 | | __new__(_cls, args, varargs, varkw) 325 | | Create new instance of Arguments(args, varargs, varkw) 326 | | 327 | | ---------------------------------------------------------------------- 328 | | Data descriptors defined here: 329 | | 330 | | __dict__ 331 | | A new OrderedDict mapping field names to their values 332 | | 333 | | args 334 | | Alias for field number 0 335 | | 336 | | varargs 337 | | Alias for field number 1 338 | | 339 | | varkw 340 | | Alias for field number 2 341 | | 342 | | ---------------------------------------------------------------------- 343 | | Data and other attributes defined here: 344 | | 345 | | _fields = ('args', 'varargs', 'varkw') 346 | | 347 | | _source = "from builtins import property as _property, tupl..._itemget... 348 | | 349 | | ---------------------------------------------------------------------- 350 | | Methods inherited from builtins.tuple: 351 | | 352 | | __add__(self, value, /) 353 | | Return self+value. 354 | | 355 | | __contains__(self, key, /) 356 | | Return key in self. 357 | | 358 | | __eq__(self, value, /) 359 | | Return self==value. 360 | | 361 | | __ge__(self, value, /) 362 | | Return self>=value. 363 | | 364 | | __getattribute__(self, name, /) 365 | | Return getattr(self, name). 366 | | 367 | | __getitem__(self, key, /) 368 | | Return self[key]. 369 | | 370 | | __gt__(self, value, /) 371 | | Return self>value. 372 | | 373 | | __hash__(self, /) 374 | | Return hash(self). 375 | | 376 | | __iter__(self, /) 377 | | Implement iter(self). 378 | | 379 | | __le__(self, value, /) 380 | | Return self<=value. 381 | | 382 | | __len__(self, /) 383 | | Return len(self). 384 | | 385 | | __lt__(self, value, /) 386 | | Return self integer -- return number of occurrences of value 402 | | 403 | | index(...) 404 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 405 | | Raises ValueError if the value is not present. 406 | 407 | class Attribute(builtins.tuple) 408 | | Attribute(name, kind, defining_class, object) 409 | | 410 | | Method resolution order: 411 | | Attribute 412 | | builtins.tuple 413 | | builtins.object 414 | | 415 | | Methods defined here: 416 | | 417 | | __getnewargs__(self) 418 | | Return self as a plain tuple. Used by copy and pickle. 419 | | 420 | | __getstate__(self) 421 | | Exclude the OrderedDict from pickling 422 | | 423 | | __repr__(self) 424 | | Return a nicely formatted representation string 425 | | 426 | | _asdict(self) 427 | | Return a new OrderedDict which maps field names to their values. 428 | | 429 | | _replace(_self, **kwds) 430 | | Return a new Attribute object replacing specified fields with new values 431 | | 432 | | ---------------------------------------------------------------------- 433 | | Class methods defined here: 434 | | 435 | | _make(iterable, new=, len=) from builtins.type 436 | | Make a new Attribute object from a sequence or iterable 437 | | 438 | | ---------------------------------------------------------------------- 439 | | Static methods defined here: 440 | | 441 | | __new__(_cls, name, kind, defining_class, object) 442 | | Create new instance of Attribute(name, kind, defining_class, object) 443 | | 444 | | ---------------------------------------------------------------------- 445 | | Data descriptors defined here: 446 | | 447 | | __dict__ 448 | | A new OrderedDict mapping field names to their values 449 | | 450 | | defining_class 451 | | Alias for field number 2 452 | | 453 | | kind 454 | | Alias for field number 1 455 | | 456 | | name 457 | | Alias for field number 0 458 | | 459 | | object 460 | | Alias for field number 3 461 | | 462 | | ---------------------------------------------------------------------- 463 | | Data and other attributes defined here: 464 | | 465 | | _fields = ('name', 'kind', 'defining_class', 'object') 466 | | 467 | | _source = "from builtins import property as _property, tupl..._itemget... 468 | | 469 | | ---------------------------------------------------------------------- 470 | | Methods inherited from builtins.tuple: 471 | | 472 | | __add__(self, value, /) 473 | | Return self+value. 474 | | 475 | | __contains__(self, key, /) 476 | | Return key in self. 477 | | 478 | | __eq__(self, value, /) 479 | | Return self==value. 480 | | 481 | | __ge__(self, value, /) 482 | | Return self>=value. 483 | | 484 | | __getattribute__(self, name, /) 485 | | Return getattr(self, name). 486 | | 487 | | __getitem__(self, key, /) 488 | | Return self[key]. 489 | | 490 | | __gt__(self, value, /) 491 | | Return self>value. 492 | | 493 | | __hash__(self, /) 494 | | Return hash(self). 495 | | 496 | | __iter__(self, /) 497 | | Implement iter(self). 498 | | 499 | | __le__(self, value, /) 500 | | Return self<=value. 501 | | 502 | | __len__(self, /) 503 | | Return len(self). 504 | | 505 | | __lt__(self, value, /) 506 | | Return self integer -- return number of occurrences of value 522 | | 523 | | index(...) 524 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 525 | | Raises ValueError if the value is not present. 526 | 527 | class BlockFinder(builtins.object) 528 | | Provide a tokeneater() method to detect the end of a code block. 529 | | 530 | | Methods defined here: 531 | | 532 | | __init__(self) 533 | | 534 | | tokeneater(self, type, token, srowcol, erowcol, line) 535 | | 536 | | ---------------------------------------------------------------------- 537 | | Data descriptors defined here: 538 | | 539 | | __dict__ 540 | | dictionary for instance variables (if defined) 541 | | 542 | | __weakref__ 543 | | list of weak references to the object (if defined) 544 | 545 | class BoundArguments(builtins.object) 546 | | Result of `Signature.bind` call. Holds the mapping of arguments 547 | | to the function's parameters. 548 | | 549 | | Has the following public attributes: 550 | | 551 | | * arguments : OrderedDict 552 | | An ordered mutable mapping of parameters' names to arguments' values. 553 | | Does not contain arguments' default values. 554 | | * signature : Signature 555 | | The Signature object that created this instance. 556 | | * args : tuple 557 | | Tuple of positional arguments values. 558 | | * kwargs : dict 559 | | Dict of keyword arguments values. 560 | | 561 | | Methods defined here: 562 | | 563 | | __eq__(self, other) 564 | | 565 | | __init__(self, signature, arguments) 566 | | 567 | | __ne__(self, other) 568 | | 569 | | ---------------------------------------------------------------------- 570 | | Data descriptors defined here: 571 | | 572 | | __dict__ 573 | | dictionary for instance variables (if defined) 574 | | 575 | | __weakref__ 576 | | list of weak references to the object (if defined) 577 | | 578 | | args 579 | | 580 | | kwargs 581 | | 582 | | signature 583 | | 584 | | ---------------------------------------------------------------------- 585 | | Data and other attributes defined here: 586 | | 587 | | __hash__ = None 588 | 589 | class ClosureVars(builtins.tuple) 590 | | ClosureVars(nonlocals, globals, builtins, unbound) 591 | | 592 | | Method resolution order: 593 | | ClosureVars 594 | | builtins.tuple 595 | | builtins.object 596 | | 597 | | Methods defined here: 598 | | 599 | | __getnewargs__(self) 600 | | Return self as a plain tuple. Used by copy and pickle. 601 | | 602 | | __getstate__(self) 603 | | Exclude the OrderedDict from pickling 604 | | 605 | | __repr__(self) 606 | | Return a nicely formatted representation string 607 | | 608 | | _asdict(self) 609 | | Return a new OrderedDict which maps field names to their values. 610 | | 611 | | _replace(_self, **kwds) 612 | | Return a new ClosureVars object replacing specified fields with new values 613 | | 614 | | ---------------------------------------------------------------------- 615 | | Class methods defined here: 616 | | 617 | | _make(iterable, new=, len=) from builtins.type 618 | | Make a new ClosureVars object from a sequence or iterable 619 | | 620 | | ---------------------------------------------------------------------- 621 | | Static methods defined here: 622 | | 623 | | __new__(_cls, nonlocals, globals, builtins, unbound) 624 | | Create new instance of ClosureVars(nonlocals, globals, builtins, unbound) 625 | | 626 | | ---------------------------------------------------------------------- 627 | | Data descriptors defined here: 628 | | 629 | | __dict__ 630 | | A new OrderedDict mapping field names to their values 631 | | 632 | | builtins 633 | | Alias for field number 2 634 | | 635 | | globals 636 | | Alias for field number 1 637 | | 638 | | nonlocals 639 | | Alias for field number 0 640 | | 641 | | unbound 642 | | Alias for field number 3 643 | | 644 | | ---------------------------------------------------------------------- 645 | | Data and other attributes defined here: 646 | | 647 | | _fields = ('nonlocals', 'globals', 'builtins', 'unbound') 648 | | 649 | | _source = "from builtins import property as _property, tupl..._itemget... 650 | | 651 | | ---------------------------------------------------------------------- 652 | | Methods inherited from builtins.tuple: 653 | | 654 | | __add__(self, value, /) 655 | | Return self+value. 656 | | 657 | | __contains__(self, key, /) 658 | | Return key in self. 659 | | 660 | | __eq__(self, value, /) 661 | | Return self==value. 662 | | 663 | | __ge__(self, value, /) 664 | | Return self>=value. 665 | | 666 | | __getattribute__(self, name, /) 667 | | Return getattr(self, name). 668 | | 669 | | __getitem__(self, key, /) 670 | | Return self[key]. 671 | | 672 | | __gt__(self, value, /) 673 | | Return self>value. 674 | | 675 | | __hash__(self, /) 676 | | Return hash(self). 677 | | 678 | | __iter__(self, /) 679 | | Implement iter(self). 680 | | 681 | | __le__(self, value, /) 682 | | Return self<=value. 683 | | 684 | | __len__(self, /) 685 | | Return len(self). 686 | | 687 | | __lt__(self, value, /) 688 | | Return self integer -- return number of occurrences of value 704 | | 705 | | index(...) 706 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 707 | | Raises ValueError if the value is not present. 708 | 709 | class EndOfBlock(builtins.Exception) 710 | | Method resolution order: 711 | | EndOfBlock 712 | | builtins.Exception 713 | | builtins.BaseException 714 | | builtins.object 715 | | 716 | | Data descriptors defined here: 717 | | 718 | | __weakref__ 719 | | list of weak references to the object (if defined) 720 | | 721 | | ---------------------------------------------------------------------- 722 | | Methods inherited from builtins.Exception: 723 | | 724 | | __init__(self, /, *args, **kwargs) 725 | | Initialize self. See help(type(self)) for accurate signature. 726 | | 727 | | __new__(*args, **kwargs) from builtins.type 728 | | Create and return a new object. See help(type) for accurate signature. 729 | | 730 | | ---------------------------------------------------------------------- 731 | | Methods inherited from builtins.BaseException: 732 | | 733 | | __delattr__(self, name, /) 734 | | Implement delattr(self, name). 735 | | 736 | | __getattribute__(self, name, /) 737 | | Return getattr(self, name). 738 | | 739 | | __reduce__(...) 740 | | 741 | | __repr__(self, /) 742 | | Return repr(self). 743 | | 744 | | __setattr__(self, name, value, /) 745 | | Implement setattr(self, name, value). 746 | | 747 | | __setstate__(...) 748 | | 749 | | __str__(self, /) 750 | | Return str(self). 751 | | 752 | | with_traceback(...) 753 | | Exception.with_traceback(tb) -- 754 | | set self.__traceback__ to tb and return self. 755 | | 756 | | ---------------------------------------------------------------------- 757 | | Data descriptors inherited from builtins.BaseException: 758 | | 759 | | __cause__ 760 | | exception cause 761 | | 762 | | __context__ 763 | | exception context 764 | | 765 | | __dict__ 766 | | 767 | | __suppress_context__ 768 | | 769 | | __traceback__ 770 | | 771 | | args 772 | 773 | class FullArgSpec(builtins.tuple) 774 | | FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations) 775 | | 776 | | Method resolution order: 777 | | FullArgSpec 778 | | builtins.tuple 779 | | builtins.object 780 | | 781 | | Methods defined here: 782 | | 783 | | __getnewargs__(self) 784 | | Return self as a plain tuple. Used by copy and pickle. 785 | | 786 | | __getstate__(self) 787 | | Exclude the OrderedDict from pickling 788 | | 789 | | __repr__(self) 790 | | Return a nicely formatted representation string 791 | | 792 | | _asdict(self) 793 | | Return a new OrderedDict which maps field names to their values. 794 | | 795 | | _replace(_self, **kwds) 796 | | Return a new FullArgSpec object replacing specified fields with new values 797 | | 798 | | ---------------------------------------------------------------------- 799 | | Class methods defined here: 800 | | 801 | | _make(iterable, new=, len=) from builtins.type 802 | | Make a new FullArgSpec object from a sequence or iterable 803 | | 804 | | ---------------------------------------------------------------------- 805 | | Static methods defined here: 806 | | 807 | | __new__(_cls, args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations) 808 | | Create new instance of FullArgSpec(args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, annotations) 809 | | 810 | | ---------------------------------------------------------------------- 811 | | Data descriptors defined here: 812 | | 813 | | __dict__ 814 | | A new OrderedDict mapping field names to their values 815 | | 816 | | annotations 817 | | Alias for field number 6 818 | | 819 | | args 820 | | Alias for field number 0 821 | | 822 | | defaults 823 | | Alias for field number 3 824 | | 825 | | kwonlyargs 826 | | Alias for field number 4 827 | | 828 | | kwonlydefaults 829 | | Alias for field number 5 830 | | 831 | | varargs 832 | | Alias for field number 1 833 | | 834 | | varkw 835 | | Alias for field number 2 836 | | 837 | | ---------------------------------------------------------------------- 838 | | Data and other attributes defined here: 839 | | 840 | | _fields = ('args', 'varargs', 'varkw', 'defaults', 'kwonlyargs', 'kwon... 841 | | 842 | | _source = "from builtins import property as _property, tupl..._itemget... 843 | | 844 | | ---------------------------------------------------------------------- 845 | | Methods inherited from builtins.tuple: 846 | | 847 | | __add__(self, value, /) 848 | | Return self+value. 849 | | 850 | | __contains__(self, key, /) 851 | | Return key in self. 852 | | 853 | | __eq__(self, value, /) 854 | | Return self==value. 855 | | 856 | | __ge__(self, value, /) 857 | | Return self>=value. 858 | | 859 | | __getattribute__(self, name, /) 860 | | Return getattr(self, name). 861 | | 862 | | __getitem__(self, key, /) 863 | | Return self[key]. 864 | | 865 | | __gt__(self, value, /) 866 | | Return self>value. 867 | | 868 | | __hash__(self, /) 869 | | Return hash(self). 870 | | 871 | | __iter__(self, /) 872 | | Implement iter(self). 873 | | 874 | | __le__(self, value, /) 875 | | Return self<=value. 876 | | 877 | | __len__(self, /) 878 | | Return len(self). 879 | | 880 | | __lt__(self, value, /) 881 | | Return self integer -- return number of occurrences of value 897 | | 898 | | index(...) 899 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 900 | | Raises ValueError if the value is not present. 901 | 902 | class ModuleInfo(builtins.tuple) 903 | | ModuleInfo(name, suffix, mode, module_type) 904 | | 905 | | Method resolution order: 906 | | ModuleInfo 907 | | builtins.tuple 908 | | builtins.object 909 | | 910 | | Methods defined here: 911 | | 912 | | __getnewargs__(self) 913 | | Return self as a plain tuple. Used by copy and pickle. 914 | | 915 | | __getstate__(self) 916 | | Exclude the OrderedDict from pickling 917 | | 918 | | __repr__(self) 919 | | Return a nicely formatted representation string 920 | | 921 | | _asdict(self) 922 | | Return a new OrderedDict which maps field names to their values. 923 | | 924 | | _replace(_self, **kwds) 925 | | Return a new ModuleInfo object replacing specified fields with new values 926 | | 927 | | ---------------------------------------------------------------------- 928 | | Class methods defined here: 929 | | 930 | | _make(iterable, new=, len=) from builtins.type 931 | | Make a new ModuleInfo object from a sequence or iterable 932 | | 933 | | ---------------------------------------------------------------------- 934 | | Static methods defined here: 935 | | 936 | | __new__(_cls, name, suffix, mode, module_type) 937 | | Create new instance of ModuleInfo(name, suffix, mode, module_type) 938 | | 939 | | ---------------------------------------------------------------------- 940 | | Data descriptors defined here: 941 | | 942 | | __dict__ 943 | | A new OrderedDict mapping field names to their values 944 | | 945 | | mode 946 | | Alias for field number 2 947 | | 948 | | module_type 949 | | Alias for field number 3 950 | | 951 | | name 952 | | Alias for field number 0 953 | | 954 | | suffix 955 | | Alias for field number 1 956 | | 957 | | ---------------------------------------------------------------------- 958 | | Data and other attributes defined here: 959 | | 960 | | _fields = ('name', 'suffix', 'mode', 'module_type') 961 | | 962 | | _source = "from builtins import property as _property, tupl..._itemget... 963 | | 964 | | ---------------------------------------------------------------------- 965 | | Methods inherited from builtins.tuple: 966 | | 967 | | __add__(self, value, /) 968 | | Return self+value. 969 | | 970 | | __contains__(self, key, /) 971 | | Return key in self. 972 | | 973 | | __eq__(self, value, /) 974 | | Return self==value. 975 | | 976 | | __ge__(self, value, /) 977 | | Return self>=value. 978 | | 979 | | __getattribute__(self, name, /) 980 | | Return getattr(self, name). 981 | | 982 | | __getitem__(self, key, /) 983 | | Return self[key]. 984 | | 985 | | __gt__(self, value, /) 986 | | Return self>value. 987 | | 988 | | __hash__(self, /) 989 | | Return hash(self). 990 | | 991 | | __iter__(self, /) 992 | | Implement iter(self). 993 | | 994 | | __le__(self, value, /) 995 | | Return self<=value. 996 | | 997 | | __len__(self, /) 998 | | Return len(self). 999 | | 1000 | | __lt__(self, value, /) 1001 | | Return self integer -- return number of occurrences of value 1017 | | 1018 | | index(...) 1019 | | T.index(value, [start, [stop]]) -> integer -- return first index of value. 1020 | | Raises ValueError if the value is not present. 1021 | 1022 | class Parameter(builtins.object) 1023 | | Represents a parameter in a function signature. 1024 | | 1025 | | Has the following public attributes: 1026 | | 1027 | | * name : str 1028 | | The name of the parameter as a string. 1029 | | * default : object 1030 | | The default value for the parameter if specified. If the 1031 | | parameter has no default value, this attribute is set to 1032 | | `Parameter.empty`. 1033 | | * annotation 1034 | | The annotation for the parameter if specified. If the 1035 | | parameter has no annotation, this attribute is set to 1036 | | `Parameter.empty`. 1037 | | * kind : str 1038 | | Describes how argument values are bound to the parameter. 1039 | | Possible values: `Parameter.POSITIONAL_ONLY`, 1040 | | `Parameter.POSITIONAL_OR_KEYWORD`, `Parameter.VAR_POSITIONAL`, 1041 | | `Parameter.KEYWORD_ONLY`, `Parameter.VAR_KEYWORD`. 1042 | | 1043 | | Methods defined here: 1044 | | 1045 | | __eq__(self, other) 1046 | | 1047 | | __init__(self, name, kind, *, default, annotation) 1048 | | 1049 | | __ne__(self, other) 1050 | | 1051 | | __repr__(self) 1052 | | 1053 | | __str__(self) 1054 | | 1055 | | replace(self, *, name=, kind=, annotation=, default=) 1056 | | Creates a customized copy of the Parameter. 1057 | | 1058 | | ---------------------------------------------------------------------- 1059 | | Data descriptors defined here: 1060 | | 1061 | | annotation 1062 | | 1063 | | default 1064 | | 1065 | | kind 1066 | | 1067 | | name 1068 | | 1069 | | ---------------------------------------------------------------------- 1070 | | Data and other attributes defined here: 1071 | | 1072 | | KEYWORD_ONLY = <_ParameterKind: 'KEYWORD_ONLY'> 1073 | | 1074 | | POSITIONAL_ONLY = <_ParameterKind: 'POSITIONAL_ONLY'> 1075 | | 1076 | | POSITIONAL_OR_KEYWORD = <_ParameterKind: 'POSITIONAL_OR_KEYWORD'> 1077 | | 1078 | | VAR_KEYWORD = <_ParameterKind: 'VAR_KEYWORD'> 1079 | | 1080 | | VAR_POSITIONAL = <_ParameterKind: 'VAR_POSITIONAL'> 1081 | | 1082 | | __hash__ = None 1083 | | 1084 | | empty = 1085 | 1086 | class Signature(builtins.object) 1087 | | A Signature object represents the overall signature of a function. 1088 | | It stores a Parameter object for each parameter accepted by the 1089 | | function, as well as information specific to the function itself. 1090 | | 1091 | | A Signature object has the following public attributes and methods: 1092 | | 1093 | | * parameters : OrderedDict 1094 | | An ordered mapping of parameters' names to the corresponding 1095 | | Parameter objects (keyword-only arguments are in the same order 1096 | | as listed in `code.co_varnames`). 1097 | | * return_annotation : object 1098 | | The annotation for the return type of the function if specified. 1099 | | If the function has no annotation for its return type, this 1100 | | attribute is set to `Signature.empty`. 1101 | | * bind(*args, **kwargs) -> BoundArguments 1102 | | Creates a mapping from positional and keyword arguments to 1103 | | parameters. 1104 | | * bind_partial(*args, **kwargs) -> BoundArguments 1105 | | Creates a partial mapping from positional and keyword arguments 1106 | | to parameters (simulating 'functools.partial' behavior.) 1107 | | 1108 | | Methods defined here: 1109 | | 1110 | | __eq__(self, other) 1111 | | 1112 | | __init__(self, parameters=None, *, return_annotation, __validate_parameters__=True) 1113 | | Constructs Signature from the given list of Parameter 1114 | | objects and 'return_annotation'. All arguments are optional. 1115 | | 1116 | | __ne__(self, other) 1117 | | 1118 | | __str__(self) 1119 | | 1120 | | bind(*args, **kwargs) 1121 | | Get a BoundArguments object, that maps the passed `args` 1122 | | and `kwargs` to the function's signature. Raises `TypeError` 1123 | | if the passed arguments can not be bound. 1124 | | 1125 | | bind_partial(*args, **kwargs) 1126 | | Get a BoundArguments object, that partially maps the 1127 | | passed `args` and `kwargs` to the function's signature. 1128 | | Raises `TypeError` if the passed arguments can not be bound. 1129 | | 1130 | | replace(self, *, parameters=, return_annotation=) 1131 | | Creates a customized copy of the Signature. 1132 | | Pass 'parameters' and/or 'return_annotation' arguments 1133 | | to override them in the new copy. 1134 | | 1135 | | ---------------------------------------------------------------------- 1136 | | Class methods defined here: 1137 | | 1138 | | from_builtin(func) from builtins.type 1139 | | 1140 | | from_function(func) from builtins.type 1141 | | Constructs Signature for the given python function 1142 | | 1143 | | ---------------------------------------------------------------------- 1144 | | Data descriptors defined here: 1145 | | 1146 | | parameters 1147 | | 1148 | | return_annotation 1149 | | 1150 | | ---------------------------------------------------------------------- 1151 | | Data and other attributes defined here: 1152 | | 1153 | | __hash__ = None 1154 | | 1155 | | empty = 1156 | 1157 | class Traceback(builtins.tuple) 1158 | | Traceback(filename, lineno, function, code_context, index) 1159 | | 1160 | | Method resolution order: 1161 | | Traceback 1162 | | builtins.tuple 1163 | | builtins.object 1164 | | 1165 | | Methods defined here: 1166 | | 1167 | | __getnewargs__(self) 1168 | | Return self as a plain tuple. Used by copy and pickle. 1169 | | 1170 | | __getstate__(self) 1171 | | Exclude the OrderedDict from pickling 1172 | | 1173 | | __repr__(self) 1174 | | Return a nicely formatted representation string 1175 | | 1176 | | _asdict(self) 1177 | | Return a new OrderedDict which maps field names to their values. 1178 | | 1179 | | _replace(_self, **kwds) 1180 | | Return a new Traceback object replacing specified fields with new values 1181 | | 1182 | | ---------------------------------------------------------------------- 1183 | | Class methods defined here: 1184 | | 1185 | | _make(iterable, new=, len=) from builtins.type 1186 | | Make a new Traceback object from a sequence or iterable 1187 | | 1188 | | ---------------------------------------------------------------------- 1189 | | Static methods defined here: 1190 | | 1191 | | __new__(_cls, filename, lineno, function, code_context, index) 1192 | | Create new instance of Traceback(filename, lineno, function, code_context, index) 1193 | | 1194 | | ---------------------------------------------------------------------- 1195 | | Data descriptors defined here: 1196 | | 1197 | | __dict__ 1198 | | A new OrderedDict mapping field names to their values 1199 | | 1200 | | code_context 1201 | | Alias for field number 3 1202 | | 1203 | | filename 1204 | | Alias for field number 0 1205 | | 1206 | | function 1207 | | Alias for field number 2 1208 | | 1209 | | index 1210 | | Alias for field number 4 1211 | | 1212 | | lineno 1213 | | Alias for field number 1 1214 | | 1215 | | ---------------------------------------------------------------------- 1216 | | Data and other attributes defined here: 1217 | | 1218 | | _fields = ('filename', 'lineno', 'function', 'code_context', 'index') 1219 | | 1220 | | _source = "from builtins import property as _property, tupl..._itemget... 1221 | | 1222 | | ---------------------------------------------------------------------- 1223 | | Methods inherited from builtins.tuple: 1224 | | 1225 | | __add__(self, value, /) 1226 | | Return self+value. 1227 | | 1228 | | __contains__(self, key, /) 1229 | | Return key in self. 1230 | | 1231 | | __eq__(self, value, /) 1232 | | Return self==value. 1233 | | 1234 | | __ge__(self, value, /) 1235 | | Return self>=value. 1236 | | 1237 | | __getattribute__(self, name, /) 1238 | | Return getattr(self, name). 1239 | | 1240 | | __getitem__(self, key, /) 1241 | | Return self[key]. 1242 | | 1243 | | __gt__(self, value, /) 1244 | | Return self>value. 1245 | | 1246 | | __hash__(self, /) 1247 | | Return hash(self). 1248 | | 1249 | | __iter__(self, /) 1250 | | Implement iter(self). 1251 | | 1252 | | __le__(self, value, /) 1253 | | Return self<=value. 1254 | | 1255 | | __len__(self, /) 1256 | | Return len(self). 1257 | | 1258 | | __lt__(self, value, /) 1259 | | Return self integer -- return number of occurrences of value 1275 | 1276 | FUNCTIONS 1277 | classify_class_attrs(cls) 1278 | Return list of attribute-descriptor tuples. 1279 | 1280 | For each name in dir(cls), the return list contains a 4-tuple 1281 | with these elements: 1282 | 1283 | 0. The name (a string). 1284 | 1285 | 1. The kind of attribute this is, one of these strings: 1286 | 'class method' created via classmethod() 1287 | 'static method' created via staticmethod() 1288 | 'property' created via property() 1289 | 'method' any other flavor of method or descriptor 1290 | 'data' not a method 1291 | 1292 | 2. The class which defined this attribute (a class). 1293 | 1294 | 3. The object as obtained by calling getattr; if this fails, or if the 1295 | resulting object does not live anywhere in the class' mro (including 1296 | metaclasses) then the object is looked up in the defining class's 1297 | dict (found by walking the mro). 1298 | 1299 | If one of the items in dir(cls) is stored in the metaclass it will now 1300 | be discovered and not have None be listed as the class in which it was 1301 | defined. Any items whose home class cannot be discovered are skipped. 1302 | 1303 | cleandoc(doc) 1304 | Clean up indentation from docstrings. 1305 | 1306 | Any whitespace that can be uniformly removed from the second line 1307 | onwards is removed. 1308 | 1309 | currentframe() 1310 | Return the frame of the caller or None if this is not possible. 1311 | 1312 | findsource(object) 1313 | Return the entire source file and starting line number for an object. 1314 | 1315 | The argument may be a module, class, method, function, traceback, frame, 1316 | or code object. The source code is returned as a list of all the lines 1317 | in the file and the line number indexes a line in that list. An OSError 1318 | is raised if the source code cannot be retrieved. 1319 | 1320 | formatannotation(annotation, base_module=None) 1321 | 1322 | formatannotationrelativeto(object) 1323 | 1324 | formatargspec(args, varargs=None, varkw=None, defaults=None, kwonlyargs=(), kwonlydefaults={}, annotations={}, formatarg=, formatvarargs= at 0x025A6DF8>, formatvarkw= at 0x025A6E40>, formatvalue= at 0x025A6E88>, formatreturns= at 0x025A6ED0>, formatannotation=) 1325 | Format an argument spec from the values returned by getargspec 1326 | or getfullargspec. 1327 | 1328 | The first seven arguments are (args, varargs, varkw, defaults, 1329 | kwonlyargs, kwonlydefaults, annotations). The other five arguments 1330 | are the corresponding optional formatting functions that are called to 1331 | turn names and values into strings. The last argument is an optional 1332 | function to format the sequence of arguments. 1333 | 1334 | formatargvalues(args, varargs, varkw, locals, formatarg=, formatvarargs= at 0x025A6F60>, formatvarkw= at 0x025A6FA8>, formatvalue= at 0x025A1030>) 1335 | Format an argument spec from the 4 values returned by getargvalues. 1336 | 1337 | The first four arguments are (args, varargs, varkw, locals). The 1338 | next four arguments are the corresponding optional formatting functions 1339 | that are called to turn names and values into strings. The ninth 1340 | argument is an optional function to format the sequence of arguments. 1341 | 1342 | getabsfile(object, _filename=None) 1343 | Return an absolute path to the source or compiled file for an object. 1344 | 1345 | The idea is for each object to have a unique origin, so this routine 1346 | normalizes the result as much as possible. 1347 | 1348 | getargs(co) 1349 | Get information about the arguments accepted by a code object. 1350 | 1351 | Three things are returned: (args, varargs, varkw), where 1352 | 'args' is the list of argument names. Keyword-only arguments are 1353 | appended. 'varargs' and 'varkw' are the names of the * and ** 1354 | arguments or None. 1355 | 1356 | getargspec(func) 1357 | Get the names and default values of a function's arguments. 1358 | 1359 | A tuple of four things is returned: (args, varargs, varkw, defaults). 1360 | 'args' is a list of the argument names. 1361 | 'args' will include keyword-only argument names. 1362 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. 1363 | 'defaults' is an n-tuple of the default values of the last n arguments. 1364 | 1365 | Use the getfullargspec() API for Python-3000 code, as annotations 1366 | and keyword arguments are supported. getargspec() will raise ValueError 1367 | if the func has either annotations or keyword arguments. 1368 | 1369 | getargvalues(frame) 1370 | Get information about arguments passed into a particular frame. 1371 | 1372 | A tuple of four things is returned: (args, varargs, varkw, locals). 1373 | 'args' is a list of the argument names. 1374 | 'varargs' and 'varkw' are the names of the * and ** arguments or None. 1375 | 'locals' is the locals dictionary of the given frame. 1376 | 1377 | getattr_static(obj, attr, default=