Type Annotations for boto3 DocDB

Warnings

• breaking Support for Python 3.8 has been removed across all packages generated by `mypy-boto3-builder`, including `mypy-boto3-docdb` versions 8.12.0 and above.
  Fix: Upgrade your Python environment to 3.9 or higher. If you must use Python 3.8, pin `mypy-boto3-docdb` to a version older than 8.12.0 (e.g., `<8.12.0`).
• breaking `mypy-boto3` packages migrated to PEP 561. While this improves how type checkers find stubs, it might affect complex build setups or older type checker versions.
  Fix: Ensure your type checker (e.g., Mypy) is updated to a recent version that fully supports PEP 561. Standard `pip install` usage should generally be unaffected.
• gotcha `mypy-boto3-docdb` provides *only* type stubs. It does not include the `boto3` runtime library itself. Your application still requires `boto3` to be installed and available at runtime.
  Fix: Install `boto3` (e.g., `pip install boto3`) as a runtime dependency and `mypy-boto3-docdb` as a development dependency (e.g., `pip install mypy-boto3-docdb`).
• breaking TypeDef names for method arguments may have been shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). This can break existing explicit type annotations.
  Fix: Update your type annotations to reflect the new, shorter TypeDef names for method arguments as per the latest stub definitions. Refer to the specific `mypy-boto3-docdb` documentation for updated names.

Install

• pip install boto3 mypy-boto3-docdb mypy Install with runtime dependency and type checker

Imports

• DocDBClient

  from mypy_boto3_docdb.client import DocDBClient

  This is the type hint for the DocDB client returned by `boto3.client('docdb')`.
• DescribeDBInstancesResponseTypeDef

  from mypy_boto3_docdb.type_defs import DescribeDBInstancesResponseTypeDef

  Import TypedDicts for specific API call responses to enable precise type checking of return values.

Quickstart

This example demonstrates how to use `mypy-boto3-docdb` for type hinting a `boto3` DocDB client. It explicitly imports `DocDBClient` and `DescribeDBInstancesResponseTypeDef` under a `TYPE_CHECKING` guard, ensuring they are only used during static analysis and do not add runtime dependencies. The `boto3.client('docdb')` call is type-hinted, enabling autocompletion and type validation for DocDB-specific methods and their responses.

from typing import TYPE_CHECKING
import boto3

if TYPE_CHECKING:
    from mypy_boto3_docdb.client import DocDBClient
    from mypy_boto3_docdb.type_defs import DescribeDBInstancesResponseTypeDef


def get_docdb_instances() -> "DescribeDBInstancesResponseTypeDef":
    # The type hint 'DocDBClient' is picked up by mypy and IDEs.
    # At runtime, you still get the regular boto3 client.
    client: DocDBClient = boto3.client("docdb")
    response = client.describe_db_instances()
    print(f"Found {len(response['DBInstances'])} DocDB instances.")
    return response

if __name__ == "__main__":
    # This example requires AWS credentials configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY
    # or ~/.aws/credentials) to run successfully against a real AWS account.
    try:
        instances_data = get_docdb_instances()
        # Further processing with type-checked 'instances_data'
    except Exception as e:
        print(f"Error describing DocDB instances: {e}")