mypy-boto3-deadline: AWS Deadline Cloud Type Stubs

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0, affecting all generated packages including `mypy-boto3-deadline`. Projects using Python 3.8 or older will encounter compatibility issues.
  Fix: Upgrade your Python environment to version 3.9 or newer.
• breaking Generated `TypeDef` names may have changed in `mypy-boto3-builder` version 8.9.0. Specifically, packed method arguments use shorter names (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`), and conflicting `Extra` postfixes were moved (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`).
  Fix: Review your code for any explicit imports or usage of `TypeDef` names, and update them according to the new naming conventions. Refer to the specific service's documentation for exact `TypeDef` names.
• gotcha `mypy-boto3-deadline` provides only type stubs and does not include the actual `boto3` runtime. Your application must have `boto3` installed to function at runtime. The type stubs are solely for static analysis.
  Fix: Always ensure `boto3` is installed in your runtime environment (e.g., `pip install boto3`). Consider using `if TYPE_CHECKING:` blocks for type stub imports to avoid unnecessary runtime dependencies.
• gotcha For large projects or when using PyCharm, performance issues with Literal overloads in type stubs (issue PY-40997) might lead to high CPU usage or slow IDE performance. This is a known issue affecting `boto3-stubs` and related packages.
  Fix: Consider installing the `boto3-stubs-lite` version (e.g., `pip install 'boto3-stubs-lite[deadline]'`) if available for your service, which is more RAM-friendly but requires explicit type annotations. Alternatively, disable PyCharm's internal type checker and use `mypy` or `pyright` instead for type checking.
• gotcha When using `mypy-boto3` stubs with `pylint`, you might encounter 'undefined variable' warnings for type-hinted variables. This is a known interaction issue when `TYPE_CHECKING` blocks are used without runtime fallback.
  Fix: To fix this, set all types to `object` in non-`TYPE_CHECKING` mode. For example: `if TYPE_CHECKING: from mypy_boto3_ec2.client import EC2Client else: EC2Client = object`.

Install

• pip install mypy-boto3-deadline boto3 mypy Install service stubs, boto3 runtime, and mypy
• pip install 'boto3-stubs[deadline]' boto3 mypy Alternative via boto3-stubs extras

Imports

• DeadlineCloudClient

  from mypy_boto3_deadline.client import DeadlineCloudClient

  Imports the type for the DeadlineCloud client.
• AcceleratorCountRangeTypeDef

  from mypy_boto3_deadline.type_defs import AcceleratorCountRangeTypeDef

  Imports specific TypedDict definitions for API call parameters or responses. Check official documentation for specific TypeDefs.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-deadline` to add type hints to your `boto3` DeadlineCloud client. It uses `TYPE_CHECKING` for conditional imports, ensuring the type stubs are only used during static analysis and not bundled with runtime dependencies. It then retrieves a list of Deadline Cloud fleets with full type-hinting support.

import boto3
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from mypy_boto3_deadline.client import DeadlineCloudClient
    from mypy_boto3_deadline.type_defs import ListFleetsResponseTypeDef

def list_deadline_fleets() -> ListFleetsResponseTypeDef:
    # Using type hint for the client provides auto-completion and type checking
    client: DeadlineCloudClient = boto3.client("deadline")
    response = client.list_fleets()
    print(f"Found {len(response['fleets'])} fleets.")
    return response

if __name__ == "__main__":
    # This part runs only if the script is executed, not during type checking
    # Replace with actual API calls or mock data for testing
    try:
        fleets_data = list_deadline_fleets()
        # Access type-hinted data, e.g., fleets_data['nextToken']
    except Exception as e:
        print(f"Error listing fleets: {e}")