mypy-boto3-launch-wizard

Warnings

• breaking Python 3.8 support was removed for all `mypy-boto3` packages (including this one) as of `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older must upgrade their Python version.
  Fix: Upgrade Python to 3.9 or newer.
• breaking Some TypeDef naming conventions changed in `mypy-boto3-builder` 8.9.0. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. This can lead to breaking type check errors if you're using explicit TypeDef imports.
  Fix: Update your TypeDef import names to match the new shorter conventions or consult the specific service documentation for the correct TypeDef names.
• gotcha Starting with `mypy-boto3-builder` 8.12.0, all generated packages migrated to PEP 561 (distribution of type information for Python packages). While this generally improves compatibility, it might require ensuring your type checkers (like mypy) are up-to-date and correctly configured to discover PEP 561 compliant stub packages.
  Fix: Ensure your `mypy` and IDE configurations are up-to-date and correctly configured for PEP 561 type stub discovery. Usually, no manual action is needed if `mypy` is correctly set up.
• gotcha PyCharm users might experience slow performance and high CPU usage due to an issue with Literal overloads (issue PY-40997). It is recommended to use the `boto3-stubs-lite` version if available for the service or disable PyCharm's type checker and rely on `mypy`/`pyright` instead.
  Fix: Consider using `boto3-stubs-lite[launch-wizard]` (if available) or rely on external type checkers like `mypy` or `pyright`.

Install

• pip install mypy-boto3-launch-wizard Install standalone stubs
• pip install 'boto3-stubs[launch-wizard]' Install as part of boto3-stubs

Imports

• LaunchWizardClient

  from mypy_boto3_launch_wizard.client import LaunchWizardClient

  For explicit type annotation of the boto3 client object.
• LaunchWizardServiceName

  from mypy_boto3_launch_wizard.literals import LaunchWizardServiceName

  For literal type hints for the service name.

Quickstart

This quickstart demonstrates how to obtain a type-hinted AWS LaunchWizard client using `boto3` and the `mypy-boto3-launch-wizard` stubs. It uses a `TYPE_CHECKING` block to ensure the stubs are only used for static analysis, preventing a runtime dependency if desired.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_launch_wizard.client import LaunchWizardClient


def get_launch_wizard_client() -> LaunchWizardClient:
    """Provides a type-hinted AWS LaunchWizard client."""
    # boto3.client is dynamically typed, so explicit annotation is needed for mypy
    client: LaunchWizardClient = boto3.client(
        "launch-wizard",
        region_name=os.environ.get('AWS_DEFAULT_REGION', 'us-east-1'),
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', '')
    )
    return client

# Example usage:
if __name__ == "__main__":
    import os
    client = get_launch_wizard_client()
    try:
        # Replace with an actual LaunchWizard API call, e.g., listing deployments
        # This will provide type hints for available methods and parameters
        response = client.list_deployments()
        print("Successfully retrieved LaunchWizard deployments (or similar call).")
        print(f"Deployments: {response.get('deployments', [])}")
    except Exception as e:
        print(f"An error occurred: {e}")
        print("Ensure AWS credentials and region are configured.")