DocClass

ClassDataClassSource

DocClass(
    name: str,
    descr: str,
    init_func: DocFunction = _default_init(),
    init_func_specified: bool = True,
    methods: list[DocFunction] = [],
    properties: list[DocProp] = [],
    operators: list[DocOpTemplate] = [],
    abstract_attrs: DocClassAbstractAttrs | None = None,
    slang: str = "",
    lineno: int = 0,
    type: Literal["class"] = "class"
)

The docstring and basic information of a class.

This serializable data type contains the parsed docstrings of the class body, the initialization function, the properties, the methods, and the overloaded operators.

Fields

Name	Type	Description
`name`	`str`	The name of the class.
`descr`	`str`	The description body of the class.
`init_func`	`DocFunction`	The initialization function of the class.
`init_func_specified`	`bool`	A flag. When it is on, it means that the initialization function has been defined by user.
`methods`	`list[DocFunction]`	The list of methods of this class.
`properties`	`list[DocProp]`	The list of properties of this class.
`operators`	`list[DocOpTemplate]`	The list of operators of this class.
`abstract_attrs`	`DocClassAbstractAttrs \| None`	Additional abstract attributes. Will present only when the class is abstract. For the protocols, this value will be always `None`.
`slang`	`str`	The internal code identifying this class.
`lineno`	`int`	The line number where the class is defined. If the number is unknown, this value will be `0`.
`type`	`Literal["class"]`	The identifier of this documentation item.

Fields​

Fields