Type Annotations for boto3 CloudFront

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generated `mypy-boto3-cloudfront 1.42.80`), support for Python 3.8 has been removed. Projects using this version of the stubs or newer require Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking Builder version 8.9.0 introduced breaking changes to TypeDef naming conventions. For instance, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and `CreateDistributionExtraRequestTypeDef` became `CreateDistributionRequestExtraTypeDef`. If you're explicitly using these full TypeDef names, they may need to be updated.
  Fix: Update your code to use the new, shorter TypeDef names. Refer to the specific service's documentation for exact TypeDef names.
• gotcha The version of `mypy-boto3-cloudfront` typically aligns with the `boto3` version it provides stubs for (e.g., `1.42.80` for `boto3==1.42.80`). Using significantly mismatched `boto3` and `mypy-boto3-*` versions can lead to type checking errors or missing type hints if API signatures have changed between versions.
  Fix: Ensure your `boto3` and `mypy-boto3-cloudfront` package versions are as closely aligned as possible, ideally using the same major and minor version numbers where applicable.
• gotcha When using explicit type annotations, some IDEs (like VSCode without full function overload support) may require explicitly importing `Client` types and `TypeDef` structures. While `mypy` and PyCharm might infer types more readily, explicit imports ensure consistent behavior across tools.
  Fix: For maximum compatibility and clarity, explicitly import `CloudFrontClient` and any `TypeDef`s from `mypy_boto3_cloudfront.client` and `mypy_boto3_cloudfront.type_defs` respectively. Consider using `if TYPE_CHECKING:` for development-only dependencies.

Install

• pip install mypy-boto3-cloudfront Install service-specific stubs
• pip install boto3 'mypy-boto3-cloudfront' Install with boto3 (recommended)

Imports

• CloudFrontClient

  from mypy_boto3_cloudfront.client import CloudFrontClient

  Import the specific client type for CloudFront.
• DistributionTypeDef

  from mypy_boto3_cloudfront.type_defs import DistributionSummaryTypeDef

  Import TypeDefs for specific service responses or input parameters. (Note: using DistributionSummaryTypeDef as an example, as exact TypeDef names can vary. Always check docs for the precise TypeDef name).

Quickstart

This example demonstrates how to initialize a `boto3` CloudFront client with type hints and retrieve a list of distributions. It uses `TYPE_CHECKING` for conditional imports, ensuring the stub package is only a development dependency. The response items are type-hinted using a `DistributionSummaryTypeDef`.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_cloudfront.client import CloudFrontClient
    from mypy_boto3_cloudfront.type_defs import DistributionSummaryTypeDef

# Instantiate a boto3 client (type-hinted for mypy)
cloudfront_client: 'CloudFrontClient' = boto3.client('cloudfront')

# Example: List distributions with type-hinted response
try:
    response = cloudfront_client.list_distributions()
    distributions: list['DistributionSummaryTypeDef'] = response.get('DistributionList', {}).get('Items', [])

    if distributions:
        print(f"Found {len(distributions)} CloudFront distributions.")
        for dist in distributions:
            print(f"  Distribution ID: {dist.get('Id')}, Domain Name: {dist.get('DomainName')}")
    else:
        print("No CloudFront distributions found.")
except Exception as e:
    print(f"Error listing distributions: {e}")