Skip to content

NodeRecord

Handsdown API Index / Handsdown / AST Parser / Node Records / NodeRecord

Auto-generated documentation for handsdown.ast_parser.node_records.node_record module.

NodeRecord

Show source in node_record.py:13

Base class for all node records.

Signature

class NodeRecord:
    def __init__(self, node: ast.AST) -> None:
        ...

NodeRecord().class_name

Show source in node_record.py:156

Record class name.

Signature

@property
def class_name(self) -> str:
    ...

NodeRecord().get_documented_attribute_strings

Show source in node_record.py:138

Render each of attribute_records to a Markdown string.

Includes name, docstring and value of an ArgumentRecord.

Returns

A list of rendered strings.

Signature

def get_documented_attribute_strings(self) -> List[str]:
    ...

NodeRecord().line_number

Show source in node_record.py:32

Return node line number in source.

Returns

A line number startign with 1.

Signature

@property
def line_number(self) -> int:
    ...

NodeRecord().line_number

Show source in node_record.py:47

Signature

@line_number.setter
def line_number(self, value: int) -> None:
    ...

NodeRecord().parse

Show source in node_record.py:84

Get all information from a node.

Executes only once if called multiple times.

Signature

def parse(self) -> None:
    ...

NodeRecord().related_names

Show source in node_record.py:68

Get a set of referenced object names in node.

Returns an empty set, should be overriden by a child class.

Returns

A set of referenced object name.

Signature

@property
def related_names(self) -> Set[str]:
    ...

NodeRecord().render

Show source in node_record.py:108

Render node to a string.

Returns

A string representation of node.

Signature

def render(self) -> str:
    ...