ClassRecord

Auto-generated documentation for mypy_boto3_builder.structures.class_record module.

Base class for all structures that can be rendered to a class.

ClassRecord

[find in source code]

class ClassRecord():
    def __init__(
        name: str,
        methods: Iterable[Method] = tuple(),
        attributes: Iterable[Attribute] = tuple(),
        bases: Iterable[FakeAnnotation] = tuple(),
        use_alias: bool = False,
    ):

Base class for all structures that can be rendered to a class.

See also

ClassRecord().alias_name

[find in source code]

@property
def alias_name() -> str:

Class alias name for safe import.

[find in source code]

@property
def boto3_doc_link() -> str:

Link to boto3 docs.

ClassRecord().get_internal_imports

[find in source code]

def get_internal_imports() -> set[InternalImport]:

Get internal imports from methods.

See also

ClassRecord().get_method

[find in source code]

def get_method(name: str) -> Method:

Get method by name.

See also

ClassRecord().get_required_import_records

[find in source code]

def get_required_import_records() -> set[ImportRecord]:

Extract import records from required type annotations.

See also

ClassRecord().iterate_types

[find in source code]

def iterate_types() -> Iterator[FakeAnnotation]:

Iterate over type annotations for methods, attributes and bases.

See also

ClassRecord().method_names

[find in source code]

@property
def method_names() -> list[str]:

Unique method names.

ClassRecord().render_alias

[find in source code]

def render_alias() -> str:

Render alias expression.

ClassRecord().variable_name

[find in source code]

@property
def variable_name() -> str:

Variable name for an instance of this class.