{
    "content": [
        {
            "type": "text",
            "text": "# pyclbr (pydoc)\n\n**Summary:** pyclbr - Parse a Python module and describe its classes and functions.\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **MODULE REFERENCE** (8 lines)\n- **DESCRIPTION** (40 lines)\n- **CLASSES** (4 lines) — 2 subsections\n  - class Class (23 lines)\n  - class Function (23 lines)\n- **FUNCTIONS** (1 lines) — 2 subsections\n  - readmodule (4 lines)\n  - readmodule_ex (6 lines)\n- **DATA** (2 lines)\n- **FILE** (3 lines)\n\n## Full Content\n\n### NAME\n\npyclbr - Parse a Python module and describe its classes and functions.\n\n### MODULE REFERENCE\n\nhttps://docs.python.org/3.10/library/pyclbr.html\n\nThe following documentation is automatically generated from the Python\nsource files.  It may be incomplete, incorrect or include features that\nare considered implementation detail and may vary between Python\nimplementations.  When in doubt, consult the module reference at the\nlocation listed above.\n\n### DESCRIPTION\n\nParse enough of a Python file to recognize imports and class and\nfunction definitions, and to find out the superclasses of a class.\n\nThe interface consists of a single function:\nreadmoduleex(module, path=None)\nwhere module is the name of a Python module, and path is an optional\nlist of directories where the module is to be searched.  If present,\npath is prepended to the system search path sys.path.  The return value\nis a dictionary.  The keys of the dictionary are the names of the\nclasses and functions defined in the module (including classes that are\ndefined via the from XXX import YYY construct).  The values are\ninstances of classes Class and Function.  One special key/value pair is\npresent for packages: the key 'path' has a list as its value which\ncontains the package search path.\n\nClasses and Functions have a common superclass: Object.  Every instance\nhas the following attributes:\nmodule  -- name of the module;\nname    -- name of the object;\nfile    -- file in which the object is defined;\nlineno  -- line in the file where the object's definition starts;\nendlineno -- line in the file where the object's definition ends;\nparent  -- parent of this object, if any;\nchildren -- nested objects contained in this object.\nThe 'children' attribute is a dictionary mapping names to objects.\n\nInstances of Function describe functions with the attributes from Object,\nplus the following:\nisasync -- if a function is defined with an 'async' prefix\n\nInstances of Class describe classes with the attributes from Object,\nplus the following:\nsuper   -- list of super classes (Class instances if possible);\nmethods -- mapping of method names to beginning line numbers.\nIf the name of a super class is not recognized, the corresponding\nentry in the list of super classes is not a class instance but a\nstring giving the name of the super class.  Since import statements\nare recognized and imported modules are scanned as well, this\nshouldn't happen often.\n\n### CLASSES\n\nObject(builtins.object)\nClass\nFunction\n\n#### class Class\n\n|  Class(module, name, super, file, lineno, parent=None, *, endlineno=None)\n|\n|  Information about a Python class.\n|\n|  Method resolution order:\n|      Class\n|      Object\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, module, name, super, file, lineno, parent=None, *, endlineno=None)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Object:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n#### class Function\n\n|  Function(module, name, file, lineno, parent=None, isasync=False, *, endlineno=None)\n|\n|  Information about a Python function, including methods.\n|\n|  Method resolution order:\n|      Function\n|      Object\n|      builtins.object\n|\n|  Methods defined here:\n|\n|  init(self, module, name, file, lineno, parent=None, isasync=False, *, endlineno=None)\n|      Initialize self.  See help(type(self)) for accurate signature.\n|\n|  ----------------------------------------------------------------------\n|  Data descriptors inherited from Object:\n|\n|  dict\n|      dictionary for instance variables (if defined)\n|\n|  weakref\n|      list of weak references to the object (if defined)\n\n### FUNCTIONS\n\n#### readmodule\n\nReturn Class objects for the top-level classes in module.\n\nThis is the original interface, before Functions were added.\n\n#### readmodule_ex\n\nReturn a dictionary with all functions and classes in module.\n\nSearch for module in PATH + sys.path.\nIf possible, include imported superclasses.\nDo this by reading source, without importing (and executing) it.\n\n### DATA\n\nall = ['readmodule', 'readmoduleex', 'Class', 'Function']\n\n### FILE\n\n/usr/lib/python3.10/pyclbr.py\n\n"
        }
    ],
    "structuredContent": {
        "command": "pyclbr",
        "section": "",
        "mode": "pydoc",
        "summary": "pyclbr - Parse a Python module and describe its classes and functions.",
        "synopsis": null,
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "MODULE REFERENCE",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 40,
                "subsections": []
            },
            {
                "name": "CLASSES",
                "lines": 4,
                "subsections": [
                    {
                        "name": "class Class",
                        "lines": 23
                    },
                    {
                        "name": "class Function",
                        "lines": 23
                    }
                ]
            },
            {
                "name": "FUNCTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "readmodule",
                        "lines": 4
                    },
                    {
                        "name": "readmodule_ex",
                        "lines": 6
                    }
                ]
            },
            {
                "name": "DATA",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "FILE",
                "lines": 3,
                "subsections": []
            }
        ]
    }
}