Type annotations for aiobotocore CloudFormation

Warnings

• breaking Python 3.8 support has been removed since `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 or older will need to upgrade their Python version to use the latest `types-aiobotocore-cloudformation` stubs.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking The `mypy-boto3-builder` migrated to PEP 561 compliant packages in version 8.12.0. While largely transparent, this may impact specific environments or custom type-checking configurations if they relied on older package structures.
  Fix: Ensure your type checker (e.g., mypy, pyright) and environment are up-to-date. Reinstalling the package may resolve any pathing issues.
• breaking TypeDef names might have changed to shorter versions (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`) or had postfixes moved (`CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`) in `mypy-boto3-builder` 8.9.0. This could break direct imports or references to specific TypeDef names.
  Fix: Consult the generated documentation for the specific service to find the correct TypeDef names, or update your code to use the new shorter names.
• gotcha For full type checking capabilities, both `aiobotocore` and the corresponding `types-aiobotocore-*` stub packages must be installed. Without the stub package, type checkers will have limited or no information for `aiobotocore` calls.
  Fix: Always install `types-aiobotocore-cloudformation` alongside `aiobotocore` in your development environment for static analysis.
• gotcha In some IDEs like PyCharm, using `types-aiobotocore` can lead to slow performance or high CPU usage. Workarounds include disabling PyCharm's internal type checker, using external checkers like mypy/pyright, or installing `types-aiobotocore-lite` for a more RAM-friendly option that might require more explicit type annotations.
  Fix: If experiencing performance issues, switch to an external type checker or consider `types-aiobotocore-lite`.

Install

• pip install types-aiobotocore-cloudformation Install direct package
• pip install 'types-aiobotocore[cloudformation]' Install via types-aiobotocore extra

Imports

• CloudFormationClient

  from types_aiobotocore_cloudformation.client import CloudFormationClient

  Type stubs are provided by 'types-aiobotocore-cloudformation', not directly from 'aiobotocore'.
• StackSummaryTypeDef

  from types_aiobotocore_cloudformation.type_defs import StackSummaryTypeDef

  Import TypeDefs directly from the `type_defs` submodule for specific service types.
• StackStatusType

  from types_aiobotocore_cloudformation.literals import StackStatusType

  Literal types (e.g., for status enums) are found in the `literals` submodule.

Quickstart

This quickstart demonstrates how to obtain a typed `CloudFormationClient` using `aiobotocore` and interact with the CloudFormation service to list stacks. The `TYPE_CHECKING` block ensures that the explicit type imports for `CloudFormationClient` and `StackSummaryTypeDef` are only used during type checking, avoiding a runtime dependency on the stub package.

import asyncio
import os
from typing import TYPE_CHECKING

import aiobotocore.session

if TYPE_CHECKING:
    from types_aiobotocore_cloudformation.client import CloudFormationClient
    from types_aiobotocore_cloudformation.type_defs import StackSummaryTypeDef


async def list_cloudformation_stacks():
    session = aiobotocore.session.get_session()
    async with session.create_client(
        "cloudformation",
        region_name=os.environ.get('AWS_REGION', 'us-east-1'),
        aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'testing'),
        aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'testing')
    ) as client:
        # The client variable is automatically type-hinted as CloudFormationClient
        client: "CloudFormationClient"
        response = await client.list_stacks()

        for stack in response.get("StackSummaries", []):
            stack_summary: "StackSummaryTypeDef" = stack
            print(f"Stack Name: {stack_summary['StackName']}, Status: {stack_summary['StackStatus']}")


if __name__ == "__main__":
    asyncio.run(list_cloudformation_stacks())