DocClassAbstractAttrs

ClassDataClassSource

DocClassAbstractAttrs(
    methods: list[DocFunction] = [],
    properties: list[DocProp] = [],
    operators: list[DocOpTemplate] = []
)

Additional abstract attributes of a class. If the class is not abstract, this collection will fall back to None.

Fields

Name	Type	Required	Description
methods	list[DocFunction]		The list of abstract methods of this class.
properties	list[DocProp]		The list of abstract properties of this class.
operators	list[DocOpTemplate]		The list of abstract operators of this class.

Methods

as_md_text

v_1: str = self.as_md_text(renderer: ProtocolComponent)

Render as Markdown text.

Requires

Name	Type	Required	Description
renderer	ProtocolComponent		The renderer providing component rendering.

Returns

Name	Type	Description
v_1	str	The Markdown text rendered from the section.

Properties

is_not_implemented

is_not_implemented: bool = self.is_not_implemented

A flag. If it is True, the abstract class still have the methods that are not implemented.