Function Objects

Class:class:`Function` instances describe functions defined by def

statements. They have the following attributes:

..class::Function

..attribute::Function.file

Class:class:`!Function` instances describe functions defined by def

statements. They have the following attributes:

Name of the file in which the function is defined.

..attribute::file

The name of the module defining the function described.

..attribute::module

Thename of the module defining the function described.

The name of the function.

..attribute::name

The line number in the file where the definition starts.

..attribute::lineno

For top-level functions, None. For nested functions, the parent.

..versionadded::3.7

..attribute::parent

For top-level functions, ``None``. For nested functions, the parent.

..attribute::Function.children

..versionadded::3.7

A dictionary mapping names to descriptors for nested functions and

classes.

..versionadded::3.7

..attribute::children

A:class:`dictionary <dict>` mapping names to descriptors for nested functions and

classes.

..attribute::Function.is_async

..versionadded::3.7

``True`` for functions that are defined with the ``async`` prefix, ``False`` otherwise.

..versionadded::3.10

..attribute::is_async

``True`` for functions that are defined with the

:keyword:`async <async def>` prefix, ``False`` otherwise.

..versionadded::3.10

.. _pyclbr-class-objects:

Class Objects

Class:class:`Class` instances describe classes defined by class

statements. They have the same attributes as Functions and two more.

..class::Class

Class:class:`!Class` instances describe classes defined by class

statements. They have the same attributes as:class:`Functions <Function>`

and two more.

..attribute::Class.file

..attribute::file

Name of the file in which the class is defined.

Name of the file in which the class is defined.

..attribute::Class.module

..attribute::module

The name of the module defining the class described.

The name of the module defining the class described.

..attribute::Class.name

..attribute::name

The name of the class.

The name of the class.

..attribute::Class.lineno

..attribute::lineno

The line number in the file where the definition starts.

The line number in the file where the definition starts.

..attribute::Class.parent

..attribute::parent

For top-level classes, None. For nested classes, the parent.

For top-level classes, None. For nested classes, the parent.

..versionadded::3.7

..versionadded::3.7

..attribute::Class.children

..attribute::children

A dictionary mapping names to descriptors for nested functions and

classes.

A dictionary mapping names to descriptors for nested functions and

classes.

..versionadded::3.7

..versionadded::3.7

..attribute::Class.super

..attribute::super

A list of:class:`Class` objects which describe the immediate base

classes of the class being described. Classes which are named as

superclasses but which are not discoverable by:func:`readmodule_ex`

are listed as a string with the class name instead of as

:class:`Class` objects.

A list of:class:`!Class` objects which describe the immediate base

classes of the class being described. Classes which are named as

superclasses but which are not discoverable by:func:`readmodule_ex`

are listed as a string with the class name instead of as

:class:`!Class` objects.

..attribute::Class.methods

..attribute::methods

A dictionary mapping method names to line numbers. This can be

derived from the newer children dictionary, but remains for

back-compatibility.

A:class:`dictionary <dict>` mapping method names to line numbers.

This can be derived from the newer:attr:`children` dictionary,

but remains for

back-compatibility.

Doc/library/platform.rst

Doc/library/plistlib.rst

Doc/library/profile.rst

Doc/library/pyclbr.rst

Doc/library/pydoc.rst

Doc/library/pyexpat.rst

Doc/library/readline.rst