ServicePackage

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

Parsed Service package.

• mypy-boto3-builder / Modules / Mypy Boto3 Builder / Structures / ServicePackage
  • ServicePackage
    • ServicePackage().client
    • ServicePackage().extract_literals
    • ServicePackage().extract_typed_dicts
    • ServicePackage().get_client_required_import_records
    • ServicePackage().get_doc_link
    • ServicePackage().get_init_all_names
    • ServicePackage().get_init_import_records
    • ServicePackage().get_literals_required_import_records
    • ServicePackage().get_local_doc_link
    • ServicePackage().get_paginator_required_import_records
    • ServicePackage().get_service_resource_required_import_records
    • ServicePackage().get_type_defs_required_import_records
    • ServicePackage().get_waiter_required_import_records
    • ServicePackage().iterate_types
    • ServicePackage().validate

ServicePackage

[find in source code]

class ServicePackage(Package):
    def __init__(
        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(),
    ):

Parsed Service package.

See also

• BasePackageData
• Function
• Package
• Paginator
• ServiceName
• TypeLiteral
• TypeTypedDict
• Waiter

ServicePackage().client

[find in source code]

@property
def client() -> Client:

Service Client.

See also

• Client

ServicePackage().extract_literals

[find in source code]

def extract_literals() -> list[TypeLiteral]:

Extract literals from children.

See also

• TypeLiteral

ServicePackage().extract_typed_dicts

[find in source code]

def extract_typed_dicts() -> list[TypeTypedDict]:

Extract typed dicts from children.

Attempts to resolve circular typed dicts.

See also

• TypeTypedDict

ServicePackage().get_client_required_import_records

[find in source code]

def get_client_required_import_records() -> list[ImportRecord]:

Get import records for client.py[i].

See also

• ImportRecord

ServicePackage().get_doc_link

[find in source code]

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

Get link to local docs with anchor.

Arguments

• file - HTML file name
• parts - Anchor parts

ServicePackage().get_init_all_names

[find in source code]

def get_init_all_names() -> list[str]:

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

ServicePackage().get_init_import_records

[find in source code]

def get_init_import_records() -> list[ImportRecord]:

Get import records for __init__.py[i].

See also

• ImportRecord

ServicePackage().get_literals_required_import_records

[find in source code]

def get_literals_required_import_records() -> list[ImportRecord]:

Get import records for literals.py[i].

See also

• ImportRecord

ServicePackage().get_local_doc_link

[find in source code]

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

Get link to local docs.

ServicePackage().get_paginator_required_import_records

[find in source code]

def get_paginator_required_import_records() -> list[ImportRecord]:

Get import records for paginator.py[i].

See also

• ImportRecord

ServicePackage().get_service_resource_required_import_records

[find in source code]

def get_service_resource_required_import_records() -> list[ImportRecord]:

Get import records for service_resource.py[i].

See also

• ImportRecord

ServicePackage().get_type_defs_required_import_records

[find in source code]

def get_type_defs_required_import_records() -> list[ImportRecord]:

Get import records for type_defs.py[i].

See also

• ImportRecord

ServicePackage().get_waiter_required_import_records

[find in source code]

def get_waiter_required_import_records() -> list[ImportRecord]:

Get import records for waiter.py[i].

See also

• ImportRecord

ServicePackage().iterate_types

[find in source code]

def iterate_types() -> Iterator[FakeAnnotation]:

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

See also

• FakeAnnotation

ServicePackage().validate

[find in source code]

def validate() -> None:

Validate parsed module.

Finds duplicated names. Finds conflicts with reserved Python words.