💾 Archived View for tris.fyi › pydoc › pyclbr captured on 2022-07-16 at 14:56:35. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

pyclbr

Parse a Python module and describe its classes and functions.

Parse enough of a Python file to recognize imports and class and
function definitions, and to find out the superclasses of a class.

The interface consists of a single function:
    readmodule_ex(module, path=None)
where module is the name of a Python module, and path is an optional
list of directories where the module is to be searched.  If present,
path is prepended to the system search path sys.path.  The return value
is a dictionary.  The keys of the dictionary are the names of the
classes and functions defined in the module (including classes that are
defined via the from XXX import YYY construct).  The values are
instances of classes Class and Function.  One special key/value pair is
present for packages: the key '__path__' has a list as its value which
contains the package search path.

Classes and Functions have a common superclass: _Object.  Every instance
has the following attributes:
    module  -- name of the module;
    name    -- name of the object;
    file    -- file in which the object is defined;
    lineno  -- line in the file where the object's definition starts;
    parent  -- parent of this object, if any;
    children -- nested objects contained in this object.
The 'children' attribute is a dictionary mapping names to objects.

Instances of Function describe functions with the attributes from _Object.

Instances of Class describe classes with the attributes from _Object,
plus the following:
    super   -- list of super classes (Class instances if possible);
    methods -- mapping of method names to beginning line numbers.
If the name of a super class is not recognized, the corresponding
entry in the list of super classes is not a class instance but a
string giving the name of the super class.  Since import statements
are recognized and imported modules are scanned as well, this
shouldn't happen often.

Classes

Class

Information about a Python class.

Function

Information about a Python function, including methods.

Functions

readmodule

readmodule(module, path=None)

  Return Class objects for the top-level classes in module.

      This is the original interface, before Functions were added.

readmodule_ex

readmodule_ex(module, path=None)

  Return a dictionary with all functions and classes in module.

      Search for module in PATH + sys.path.
      If possible, include imported superclasses.
      Do this by reading source, without importing (and executing) it.

Other members

DEDENT = 6

NAME = 1

OP = 54

Modules

importlib

sys

tokenize