ServicePackage

mypy-boto3-builder Index / Mypy Boto3 Builder / Structures / ServicePackage

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

ServicePackage

Show source in service_package.py:26

Parsed Service package.

Signature

class ServicePackage(Package):
    def __init__(
        self,
        data: type[BasePackageData],
        service_name: ServiceName,
        client: Client | None = None,
        service_resource: ServiceResource | None = None,
        waiters: Iterable[Waiter] = tuple(),
        paginators: Iterable[Paginator] = tuple(),
        typed_dicts: Iterable[TypeTypedDict] = tuple(),
        literals: Iterable[TypeLiteral] = tuple(),
        helper_functions: Iterable[Function] = tuple(),
    ):
        ...

See also

ServicePackage().client

Show source in service_package.py:55

Service Client.

Signature

@property
def client(self) -> Client:
    ...

See also

ServicePackage().extract_literals

Show source in service_package.py:64

Extract literals from children.

Signature

def extract_literals(self) -> list[TypeLiteral]:
    ...

See also

ServicePackage().extract_typed_dicts

Show source in service_package.py:118

Extract typed dicts from children.

Attempts to resolve circular typed dicts.

Signature

def extract_typed_dicts(self) -> list[TypeTypedDict]:
    ...

See also

ServicePackage().get_client_required_import_records

Show source in service_package.py:190

Get import records for client.py[i].

Signature

def get_client_required_import_records(self) -> list[ImportRecord]:
    ...

See also

Show source in service_package.py:328

Get link to local docs with anchor.

Arguments

  • file - HTML file name
  • parts - Anchor parts

Signature

def get_doc_link(
    self,
    file: Literal[
        "client", "service_resource", "waiters", "paginators", "type_defs", "literals"
    ],
    *parts: str
) -> str:
    ...

ServicePackage().get_init_all_names

Show source in service_package.py:173

Get __all__ statement names for __init__.py[i].

Signature

def get_init_all_names(self) -> list[str]:
    ...

ServicePackage().get_init_import_records

Show source in service_package.py:138

Get import records for __init__.py[i].

Signature

def get_init_import_records(self) -> list[ImportRecord]:
    ...

See also

ServicePackage().get_literals_required_import_records

Show source in service_package.py:293

Get import records for literals.py[i].

Signature

def get_literals_required_import_records(self) -> list[ImportRecord]:
    ...

See also

Show source in service_package.py:353

Get link to local docs.

Signature

def get_local_doc_link(self, service_name: ServiceName | None = None) -> str:
    ...

ServicePackage().get_paginator_required_import_records

Show source in service_package.py:222

Get import records for paginator.py[i].

Signature

def get_paginator_required_import_records(self) -> list[ImportRecord]:
    ...

See also

ServicePackage().get_service_resource_required_import_records

Show source in service_package.py:206

Get import records for service_resource.py[i].

Signature

def get_service_resource_required_import_records(self) -> list[ImportRecord]:
    ...

See also

ServicePackage().get_type_defs_required_import_records

Show source in service_package.py:257

Get import records for type_defs.py[i].

Signature

def get_type_defs_required_import_records(self) -> list[ImportRecord]:
    ...

See also

ServicePackage().get_waiter_required_import_records

Show source in service_package.py:242

Get import records for waiter.py[i].

Signature

def get_waiter_required_import_records(self) -> list[ImportRecord]:
    ...

See also

ServicePackage().iterate_types

Show source in service_package.py:126

Iterate over type annotations from Client, ServiceResource, waiters and paginators.

Signature

def iterate_types(self) -> Iterator[FakeAnnotation]:
    ...

See also

ServicePackage().validate

Show source in service_package.py:302

Validate parsed module.

Finds duplicated names. Finds conflicts with reserved Python words.

Signature

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