Type annotations for boto3 CodeDeploy

Warnings

• breaking Python 3.8 support was removed starting with `mypy-boto3-builder` version 8.12.0 and affects all generated `mypy-boto3-*` packages, including `mypy-boto3-codedeploy`.
  Fix: Upgrade your Python environment to 3.9 or higher. The `requires_python` metadata is `^3.9`.
• breaking In `mypy-boto3-builder` version 8.9.0, there were breaking changes to TypeDef naming conventions. Specifically, `TypeDefs` for packed method arguments use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`).
  Fix: Review and update `TypeDef` import paths and usage in your codebase to reflect the new naming conventions. Consult the specific service's `type_defs.pyi` for accurate names.
• deprecated The standalone `mypy-boto3` package (e.g., `pip install mypy-boto3`) is considered legacy. Users are encouraged to install service-specific packages like `mypy-boto3-codedeploy` directly, or use the `boto3-stubs` package with service-specific extras (`pip install 'boto3-stubs[codedeploy]'`).
  Fix: Migrate from `mypy-boto3` to either standalone `mypy-boto3-codedeploy` or `boto3-stubs[codedeploy]` for better modularity and future compatibility.
• gotcha When using PyCharm, performance issues with `Literal` overloads have been reported (PY-40997). This can lead to slow IDE performance when using full `boto3-stubs` packages.
  Fix: If experiencing performance issues in PyCharm, consider using `boto3-stubs-lite` (e.g., `pip install 'boto3-stubs-lite[codedeploy]'`) which requires explicit type annotations but can be more RAM-friendly until the PyCharm issue is resolved.

Install

• pip install mypy-boto3-codedeploy Standalone package
• pip install 'boto3-stubs[codedeploy]' # Requires boto3-stubs>=8.9.0 Via boto3-stubs with extras

Imports

• CodeDeployClient

  from mypy_boto3_codedeploy.client import CodeDeployClient

  Legacy import path from older mypy-boto3 versions (pre-8.9.0). Current standalone packages use service-specific top-level modules like `mypy_boto3_codedeploy`.
• DeploymentInfoTypeDef

  from mypy_boto3_codedeploy.type_defs import DeploymentInfoTypeDef

  Type definitions are typically found in the `type_defs` submodule.

Quickstart

This quickstart demonstrates how to get a type-hinted CodeDeploy client and use it to list applications. It includes explicit type annotations for `CodeDeployClient` and a response `TypeDef` to leverage the type stubs effectively.

import boto3
from typing import TYPE_CHECKING
from os import environ

if TYPE_CHECKING:
    from mypy_boto3_codedeploy.client import CodeDeployClient
    from mypy_boto3_codedeploy.type_defs import ListApplicationsOutputTypeDef

def get_codedeploy_client() -> CodeDeployClient:
    """Returns a type-hinted CodeDeploy client."""
    session = boto3.session.Session(
        aws_access_key_id=environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=environ.get('AWS_SECRET_ACCESS_KEY', ''),
        aws_session_token=environ.get('AWS_SESSION_TOKEN', ''),
        region_name=environ.get('AWS_REGION', 'us-east-1')
    )
    return session.client("codedeploy")

def list_codedeploy_applications():
    client: CodeDeployClient = get_codedeploy_client()
    response: ListApplicationsOutputTypeDef = client.list_applications()
    print("CodeDeploy Applications:")
    for app_name in response.get("applications", []):
        print(f"- {app_name}")

if __name__ == "__main__":
    list_codedeploy_applications()