mypy-boto3-cloudformation

Warnings

• breaking Python 3.8 support was removed for all mypy-boto3 packages, including mypy-boto3-cloudformation. Projects requiring type stubs must use Python 3.9 or newer.
  Fix: Upgrade your project's Python version to 3.9 or higher. If you must use Python 3.8, pin to an older `mypy-boto3-cloudformation` version (e.g., <1.42.0) and its corresponding `mypy-boto3-builder`.
• breaking All mypy-boto3 packages migrated to PEP 561-compliant distribution. This change primarily affects how type checkers locate stubs, potentially requiring adjustments in build configurations or explicit stub path declarations if you were relying on non-standard stub discovery methods.
  Fix: Ensure your `mypy` configuration (or other type checkers) correctly identifies `mypy-boto3-cloudformation` as a PEP 561-compliant stub package. For most users, this will work out-of-the-box, but check `mypy` output if stubs are not found.
• breaking TypeDef naming conventions were changed for packed method arguments, shortening names (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). Conflicting TypeDef `Extra` postfixes were moved (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`).
  Fix: Review and update your code to use the new, shorter TypeDef names for request/response payloads if you import them explicitly.
• gotcha This library provides type stubs for `boto3`, not the `boto3` runtime itself. You must install `boto3` separately for your code to actually run. Without `boto3`, `mypy-boto3-cloudformation` offers no functional benefit beyond type checking for a non-existent runtime.
  Fix: Always install `boto3` alongside `mypy-boto3-cloudformation` using `pip install boto3 mypy-boto3-cloudformation`.
• gotcha For optimal compatibility and accurate type hints, the major.minor version of `mypy-boto3-cloudformation` (e.g., 1.42.x) should ideally align with the major.minor version of your installed `boto3` (e.g., 1.42.x). Mismatches can lead to type checking errors or missing attributes if the underlying API changes.
  Fix: Keep `mypy-boto3-cloudformation` updated in sync with your `boto3` installation. Use `pip install --upgrade boto3 mypy-boto3-cloudformation` regularly.

Install

• pip install boto3 mypy-boto3-cloudformation Install boto3 (runtime) and stubs

Imports

• CloudFormationClient

  from mypy_boto3_cloudformation.client import CloudFormationClient

• CloudFormationServiceName

  from mypy_boto3_cloudformation import CloudFormationServiceName

  Use the enum `CloudFormationServiceName` for the client name string for type safety.
• StackSummaryTypeDef

  from mypy_boto3_cloudformation.type_defs import StackSummaryTypeDef

  Example of importing a specific TypedDict for request/response structures.

Quickstart

This quickstart demonstrates how to obtain a type-hinted CloudFormation client from boto3 and perform a basic operation like listing stacks. It shows how to use the `CloudFormationClient` type for the client object and `StackSummaryTypeDef` for processing response data, ensuring static type checking of your boto3 interactions.

import boto3
from mypy_boto3_cloudformation.client import CloudFormationClient
from mypy_boto3_cloudformation.type_defs import StackSummaryTypeDef
from mypy_boto3_cloudformation import CloudFormationServiceName

# Get a typed CloudFormation client using CloudFormationServiceName for safety
client: CloudFormationClient = boto3.client(CloudFormationServiceName.CLOUDFORMATION)

# Example: List stacks and iterate with type hints
try:
    response = client.list_stacks(StackStatusFilter=['CREATE_COMPLETE', 'UPDATE_COMPLETE'])
    
    # response['StackSummaries'] is a list of StackSummaryTypeDef
    stacks: list[StackSummaryTypeDef] = response.get('StackSummaries', [])

    if stacks:
        print("CloudFormation Stacks:")
        for stack in stacks:
            print(f"  Name: {stack['StackName']}, Status: {stack['StackStatus']}, Id: {stack['StackId']}")
    else:
        print("No CREATE_COMPLETE or UPDATE_COMPLETE stacks found.")
except Exception as e:
    print(f"Error listing stacks: {e}")

# The type checker (e.g., mypy) will now validate usage of `client`
# and `stack` objects against the CloudFormation API definition.