mypy-boto3-cloud9 Type Annotations

Warnings

• breaking Support for Python 3.8 was officially removed starting with `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 will need to upgrade their Python version to 3.9 or newer.
  Fix: Upgrade Python to 3.9 or a later version.
• breaking TypeDef naming conventions were changed in `mypy-boto3-builder` version 8.9.0. This might lead to breaking changes for explicit `TypeDef` imports, where names like `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`.
  Fix: Review and update `TypeDef` import names and usages based on the new convention.
• gotcha The `mypy-boto3` ecosystem migrated to PEP 561 compliant packages in `mypy-boto3-builder` version 8.12.0. While this generally improves compatibility, ensure your tooling (e.g., `setuptools`, `pip`) is up-to-date to correctly recognize and utilize these new package structures.
  Fix: Update `pip` and other package management tools to their latest versions. Verify `mypy` is configured to find stub packages correctly.
• gotcha While `mypy-boto3-cloud9` provides standalone stubs, for comprehensive type-hinting of `boto3.client` and `boto3.resource` calls, using the `boto3-stubs` meta-package (e.g., `pip install 'boto3-stubs[cloud9]'`) is often recommended. Standalone packages might require more explicit type annotations for `boto3.client` return values.
  Fix: Consider installing `boto3-stubs` with the desired service extras, or explicitly annotate the return type of `boto3.client()` calls (e.g., `client: Cloud9Client = boto3.client("cloud9")`).
• gotcha AWS services can be renamed or deprecated, leading to corresponding changes in `mypy-boto3` packages. For example, `sms-voice` was excluded in `mypy-boto3-builder` 8.11.0, recommending `pinpoint-sms-voice` instead. Always check release notes if a service package seems to be missing or misbehaving.
  Fix: Consult the `mypy-boto3-builder` changelog or documentation for service-specific updates if type stubs for a particular AWS service are not found or cause issues.

Install

• pip install mypy-boto3-cloud9 boto3 mypy Install standalone package with boto3 and mypy
• pip install 'boto3-stubs[cloud9]' boto3 mypy Install via boto3-stubs meta-package

Imports

• Cloud9Client

  from mypy_boto3_cloud9.client import Cloud9Client

  The primary client type for Cloud9 operations.
• ListEnvironmentsResultTypeDef

  from mypy_boto3_cloud9.type_defs import ListEnvironmentsResultTypeDef

  Example of a type definition for a specific API response.
• Cloud9ServiceName

  from mypy_boto3_cloud9.literals import Cloud9ServiceName

  Literal type for 'cloud9' service name, useful for explicit client typing with boto3-stubs.

Quickstart

This example demonstrates how to use `mypy-boto3-cloud9` to type-hint a `boto3` Cloud9 client and its response. It lists the available Cloud9 environments in a specified AWS region. Run `mypy cloud9_example.py` to check for type errors.

import boto3
from mypy_boto3_cloud9.client import Cloud9Client
from mypy_boto3_cloud9.type_defs import ListEnvironmentsResultTypeDef

def get_cloud9_environments(region: str) -> ListEnvironmentsResultTypeDef:
    """Lists AWS Cloud9 environments with type annotations."""
    client: Cloud9Client = boto3.client("cloud9", region_name=region)
    response: ListEnvironmentsResultTypeDef = client.list_environments()
    return response

if __name__ == "__main__":
    # Replace with your desired region, or use environment variable/config
    aws_region = "us-east-1"
    try:
        environments = get_cloud9_environments(aws_region)
        print(f"Cloud9 environments in {aws_region}:")
        for env_id in environments.get("environmentIds", []):
            print(f"- {env_id}")
    except Exception as e:
        print(f"Error listing environments: {e}")

# To run with mypy:
# save as cloud9_example.py
# mypy cloud9_example.py