ClassRecord
mypy-boto3-builder Index / Mypy Boto3 Builder / Structures / ClassRecord
Auto-generated documentation for mypy_boto3_builder.structures.class_record module.
ClassRecord
Show source in class_record.py:16
Base class for all structures that can be rendered to a class.
Signature
class ClassRecord:
def __init__(
self,
name: str,
methods: Iterable[Method] = tuple(),
attributes: Iterable[Attribute] = tuple(),
bases: Iterable[FakeAnnotation] = tuple(),
use_alias: bool = False,
):
...
See also
ClassRecord().alias_name
Show source in class_record.py:45
Class alias name for safe import.
Signature
@property
def alias_name(self) -> str:
...
ClassRecord().boto3_doc_link
Show source in class_record.py:38
Link to boto3 docs.
Signature
@property
def boto3_doc_link(self) -> str:
...
ClassRecord().get_internal_imports
Show source in class_record.py:86
Get internal imports from methods.
Signature
def get_internal_imports(self) -> set[InternalImport]:
...
See also
ClassRecord().get_method
Show source in class_record.py:113
Get method by name.
Signature
def get_method(self, name: str) -> Method:
...
See also
ClassRecord().get_required_import_records
Show source in class_record.py:73
Extract import records from required type annotations.
Signature
def get_required_import_records(self) -> set[ImportRecord]:
...
See also
ClassRecord().iterate_types
Show source in class_record.py:62
Iterate over type annotations for methods, attributes and bases.
Signature
def iterate_types(self) -> Iterator[FakeAnnotation]:
...
See also
ClassRecord().method_names
Show source in class_record.py:106
Unique method names.
Signature
@property
def method_names(self) -> list[str]:
...
ClassRecord().render_alias
Show source in class_record.py:56
Render alias expression.
Signature
def render_alias(self) -> str:
...
ClassRecord().variable_name
Show source in class_record.py:99
Variable name for an instance of this class.
Signature
@property
def variable_name(self) -> str:
...