mypy-boto3-tnb

Warnings

• breaking Python 3.8 support was removed with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 will need to upgrade to Python 3.9 or newer to use newly generated stubs.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking The `mypy-boto3` ecosystem migrated to PEP 561 compliant packages with `mypy-boto3-builder` 8.12.0. While this generally improves type checker compatibility, ensure your type checker (e.g., MyPy, Pyright) is up-to-date to properly discover the new package structure.
  Fix: Update your type checker (e.g., `pip install --upgrade mypy pyright`). Review your type checker configuration if issues persist.
• breaking TypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0. Some `TypeDef` names were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`) or had postfixes moved, which can break explicit `TypeDef` imports.
  Fix: Update your `TypeDef` import paths and names in your code to match the new conventions. Use IDE autocomplete or generated documentation to find the correct names.
• gotcha This library provides *only* type annotations. You must still install the `boto3` runtime library (e.g., `pip install boto3`) for your code to function at runtime.
  Fix: Ensure `boto3` is installed alongside `mypy-boto3-tnb` in your project environment.
• gotcha For optimal type checking, especially with standalone stub packages like `mypy-boto3-tnb`, it is recommended to explicitly annotate `boto3.client()` and `boto3.resource()` calls with the imported client types. While some IDEs might infer types, explicit annotations ensure consistent and reliable type checking across tools.
  Fix: Add explicit type annotations to your `boto3.client()` and `boto3.resource()` calls, e.g., `client: TelcoNetworkBuilderClient = boto3.client("tnb")`.

Install

• pip install mypy-boto3-tnb boto3 Install with boto3 runtime

Imports

• TelcoNetworkBuilderClient

  from mypy_boto3_tnb.client import TelcoNetworkBuilderClient

  Imports the typed client for the TelcoNetworkBuilder service.
• CreateSolFunctionPackageInputRequestTypeDef

  from mypy_boto3_tnb.type_defs import CreateSolFunctionPackageInputRequestTypeDef

  Imports a sample TypeDef for input parameters, common for explicit type hinting of request/response objects. Specific TypeDef names should be looked up in the library's documentation or IDE autocomplete.
• TnbClient

  from mypy_boto3_tnb import TNBClient

  The primary client class is named `TelcoNetworkBuilderClient` or `TNBClient` depending on context and specific generated version, not `TnbClient`. Always refer to documentation or IDE for exact generated name.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-tnb` to add type hints for the TelcoNetworkBuilder service client. It shows the explicit import of the typed client and a `TypeDef` for return values, enhancing code completion and type checking for `boto3` operations. Remember to have AWS credentials configured for the `boto3.client` call to succeed.

import boto3
from mypy_boto3_tnb.client import TelcoNetworkBuilderClient
from mypy_boto3_tnb.type_defs import CreateSolFunctionPackageOutputTypeDef

def create_tnb_function_package(package_name: str) -> CreateSolFunctionPackageOutputTypeDef:
    # mypy-boto3-tnb provides type hints, boto3 is the runtime
    client: TelcoNetworkBuilderClient = boto3.client("tnb")

    # Example API call with type hinting for input and output
    response: CreateSolFunctionPackageOutputTypeDef = client.create_sol_function_package(
        tags={
            "Name": package_name
        }
    )
    print(f"Successfully created SOL Function Package: {response.get('id')}")
    return response

if __name__ == "__main__":
    # This code is for demonstration and requires AWS credentials configured
    # It will attempt to create a resource, which may incur costs.
    # Replace 'my-test-package' with a unique name.
    try:
        package_output = create_tnb_function_package("my-test-package")
        # Additional operations with package_output can be typed here
    except Exception as e:
        print(f"An error occurred: {e}")