dataclasses ¤

Built-in extension adding support for dataclasses.

This extension re-creates __init__ methods of dataclasses during static analysis.

Classes:

DataclassesExtension –

Built-in extension adding support for dataclasses.

DataclassesExtension ¤


          flowchart TD
          griffe.extensions.dataclasses.DataclassesExtension[DataclassesExtension]
          griffe.extensions.base.Extension[Extension]

                        griffe.extensions.base.Extension --> griffe.extensions.dataclasses.DataclassesExtension
              


          click griffe.extensions.dataclasses.DataclassesExtension href "" "griffe.extensions.dataclasses.DataclassesExtension"
          click griffe.extensions.base.Extension href "" "griffe.extensions.base.Extension"

Built-in extension adding support for dataclasses.

This extension creates __init__ methods of dataclasses if they don't already exist.

Methods:

generic_inspect –

Extend the base generic inspection with extensions.
generic_visit –

Visit children nodes.
inspect –

Inspect a node.
on_attribute_instance –

Run when an Attribute has been created.
on_attribute_node –

Run when visiting a new attribute node during static/dynamic analysis.
on_class_instance –

Run when a Class has been created.
on_class_members –

Run when members of a Class have been loaded.
on_class_node –

Run when visiting a new class node during static/dynamic analysis.
on_function_instance –

Run when a Function has been created.
on_function_node –

Run when visiting a new function node during static/dynamic analysis.
on_instance –

Run when an Object has been created.
on_members –

Run when members of an Object have been loaded.
on_module_instance –

Run when a Module has been created.
on_module_members –

Run when members of a Module have been loaded.
on_module_node –

Run when visiting a new module node during static/dynamic analysis.
on_node –

Run when visiting a new node during static/dynamic analysis.
on_package_loaded –

Hook for loaded packages.
visit –

Visit a node.

generic_inspect ¤

generic_inspect(node: ObjectNode) -> None

Extend the base generic inspection with extensions.

Parameters:

node (ObjectNode) –

The node to inspect.

generic_visit ¤

generic_visit(node: AST) -> None

Visit children nodes.

Parameters:

node (AST) –

The node to visit the children of.

inspect ¤

inspect(node: ObjectNode) -> None

Inspect a node.

Parameters:

node (ObjectNode) –

The node to inspect.

on_attribute_instance ¤

on_attribute_instance(
    *, node: AST | ObjectNode, attr: Attribute
) -> None

Run when an Attribute has been created.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
attr (Attribute) –

The attribute instance.

on_attribute_node ¤

on_attribute_node(*, node: AST | ObjectNode) -> None

Run when visiting a new attribute node during static/dynamic analysis.

Parameters:

node (AST | ObjectNode) –

The currently visited node.

on_class_instance ¤

on_class_instance(
    *, node: AST | ObjectNode, cls: Class
) -> None

Run when a Class has been created.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
cls (Class) –

The class instance.

on_class_members ¤

on_class_members(
    *, node: AST | ObjectNode, cls: Class
) -> None

Run when members of a Class have been loaded.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
cls (Class) –

The class instance.

on_class_node ¤

on_class_node(*, node: AST | ObjectNode) -> None

Run when visiting a new class node during static/dynamic analysis.

Parameters:

node (AST | ObjectNode) –

The currently visited node.

on_function_instance ¤

on_function_instance(
    *, node: AST | ObjectNode, func: Function
) -> None

Run when a Function has been created.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
func (Function) –

The function instance.

on_function_node ¤

on_function_node(*, node: AST | ObjectNode) -> None

Run when visiting a new function node during static/dynamic analysis.

Parameters:

node (AST | ObjectNode) –

The currently visited node.

on_instance ¤

on_instance(*, node: AST | ObjectNode, obj: Object) -> None

Run when an Object has been created.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
obj (Object) –

The object instance.

on_members ¤

on_members(*, node: AST | ObjectNode, obj: Object) -> None

Run when members of an Object have been loaded.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
obj (Object) –

The object instance.

on_module_instance ¤

on_module_instance(
    *, node: AST | ObjectNode, mod: Module
) -> None

Run when a Module has been created.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
mod (Module) –

The module instance.

on_module_members ¤

on_module_members(
    *, node: AST | ObjectNode, mod: Module
) -> None

Run when members of a Module have been loaded.

Parameters:

node (AST | ObjectNode) –

The currently visited node.
mod (Module) –

The module instance.

on_module_node ¤

on_module_node(*, node: AST | ObjectNode) -> None

Run when visiting a new module node during static/dynamic analysis.

Parameters:

node (AST | ObjectNode) –

The currently visited node.

on_node ¤

on_node(*, node: AST | ObjectNode) -> None

Run when visiting a new node during static/dynamic analysis.

Parameters:

node (AST | ObjectNode) –

The currently visited node.

on_package_loaded ¤

on_package_loaded(*, pkg: Module) -> None

Hook for loaded packages.

Parameters:

pkg (Module) –

The loaded package.

visit ¤

visit(node: AST) -> None

Visit a node.

Parameters:

node (AST) –

The node to visit.