mypy-boto3-pinpoint: Type Annotations for AWS Pinpoint with boto3

Warnings

• breaking Support for Python 3.8 was removed starting with mypy-boto3-builder v8.12.0, which affects all generated stub packages including mypy-boto3-pinpoint. The minimum required Python version is now 3.9.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking Specific TypeDef names were changed for consistency and brevity (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`) in mypy-boto3-builder v8.9.0. If your code explicitly references these verbose TypeDefs, it will break.
  Fix: Update explicit TypeDef imports and references to use the shorter, revised names. Consult the `mypy_boto3_pinpoint.type_defs` module for the correct names.
• gotcha mypy-boto3-pinpoint provides *only* type annotations. The actual `boto3` library must be installed separately for the code to run at runtime. Failure to install `boto3` will result in `ModuleNotFoundError` or similar runtime errors.
  Fix: Ensure `boto3` is installed alongside `mypy-boto3-pinpoint` using `pip install boto3 mypy-boto3-pinpoint`.
• gotcha The versioning of individual `mypy-boto3-*` service stub packages (like `mypy-boto3-pinpoint`) is tied to the `boto3` version they annotate. However, the `mypy-boto3-builder` tool, which generates these stubs, has its own independent versioning.
  Fix: When troubleshooting or upgrading, note that the builder's version does not directly match the stub package's version. Refer to the `mypy-boto3-builder` release notes for changes affecting stub generation and `mypy-boto3-pinpoint` PyPI/docs for its specific version compatibility with `boto3`.
• gotcha While many IDEs and recent `mypy` versions can infer types without explicit stub imports, using `if TYPE_CHECKING:` guards the stub imports. This prevents adding the stub package as a runtime dependency and can avoid potential import conflicts or performance issues with some tooling.
  Fix: Wrap your `mypy-boto3-pinpoint` imports within an `if TYPE_CHECKING:` block, as shown in the quickstart example, to ensure they are only active during type checking.

Install

• pip install mypy-boto3-pinpoint boto3 Install with boto3

Imports

• PinpointClient

  from mypy_boto3_pinpoint.client import PinpointClient

  The type stub is provided by mypy_boto3_pinpoint, not directly by boto3 itself. Although modern type checkers often infer this, explicit import from the stub package is the most robust approach.

Quickstart

This quickstart demonstrates how to obtain a type-hinted Pinpoint client using `boto3.session.Session().client()` and `mypy_boto3_pinpoint.client.PinpointClient`. The `if TYPE_CHECKING:` block ensures that the type stub import is only processed by static analysis tools, preventing a runtime dependency on the stub package.

from typing import TYPE_CHECKING
import boto3
from boto3.session import Session

if TYPE_CHECKING:
    from mypy_boto3_pinpoint.client import PinpointClient

def get_pinpoint_client() -> 'PinpointClient':
    # In a real application, consider using AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
    # environment variables or other boto3 credential providers.
    # For local development or testing, this might use ~/.aws/credentials
    # or IAM roles.
    session = Session(region_name='us-east-1')
    return session.client('pinpoint')

# Example usage (will be type-checked by mypy):
client = get_pinpoint_client()
# client.send_messages(...) # mypy will now validate arguments for send_messages
print(f"Pinpoint client created: {client}")

# Without TYPE_CHECKING, the import is ignored at runtime, preventing a direct dependency on the stub package.
# In a runtime context without type checking, `client` is simply the boto3 client object.