Skip to content

ClassRecord

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

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

ClassRecord

Show source in class_record.py:16

Wrapper for an ast.ClassDef node.

Arguments

  • node - AST node.

Signature

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

See also

ClassRecord().find_record

Show source in class_record.py:34

Find child method or attribute record.

Arguments

  • name - Record name to lookup.

Returns

Itself or None.

Signature

def find_record(self, name: str) -> Optional[NodeRecord]:
    ...

See also

ClassRecord().get_public_methods

Show source in class_record.py:87

Get Class public methods.

Skips methods with names starting with _ and magic methods __ if they have no docstring. Method __init__ is always skipped.

Returns

A list of child records.

Signature

def get_public_methods(self) -> List[FunctionRecord]:
    ...

See also

ClassRecord().init_method

Show source in class_record.py:126

Get the __init__ method.

Signature

@property
def init_method(self) -> Optional[FunctionRecord]:
    ...

See also

ClassRecord().iter_records

Show source in class_record.py:74

Iterate over Class public methods.

Yields

A child record.

Signature

def iter_records(self) -> Iterator[NodeRecord]:
    ...

See also

ClassRecord().related_names

Show source in class_record.py:57

Set of related names.

Signature

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