Lines Matching +full:parent +full:- +full:module
1 :mod:`pyclbr` --- Python module browser support
4 .. module:: pyclbr
5 :synopsis: Supports information extraction for a Python module browser.
11 --------------
13 The :mod:`pyclbr` module provides limited information about the
14 functions, classes, and methods defined in a Python-coded module. The
15 information is sufficient to implement a module browser. The
17 importing the module, so this module is safe to use with untrusted code.
18 This restriction makes it impossible to use this module with modules not
23 .. function:: readmodule(module, path=None)
25 Return a dictionary mapping module-level class names to class
27 included. Parameter *module* is a string with the name of the module
28 to read; it may be the name of a module within a package. If given,
30 which is used to locate the module source code.
36 .. function:: readmodule_ex(module, path=None)
38 Return a dictionary-based tree containing a function or class
39 descriptors for each function and class defined in the module with a
41 module-level function and class names to their descriptors. Nested
42 objects are entered into the children dictionary of their parent. As
43 with readmodule, *module* names the module to be read and *path* is
44 prepended to sys.path. If the module being read is a package, the
50 new children attribute. Each has a new parent attribute.
57 .. _pyclbr-function-objects:
60 ----------------
70 .. attribute:: Function.module
72 The name of the module defining the function described.
85 .. attribute:: Function.parent
87 For top-level functions, None. For nested functions, the parent.
107 .. _pyclbr-class-objects:
110 -------------
120 .. attribute:: Class.module
122 The name of the module defining the class described.
135 .. attribute:: Class.parent
137 For top-level classes, None. For nested classes, the parent.
163 back-compatibility.