mypy-boto3-comprehend type annotations

1.42.3 · active · verified Sat Apr 11

mypy-boto3-comprehend provides type annotations for the `boto3` Comprehend service, compatible with `mypy`, `pyright`, VSCode, PyCharm, and other tools. It is part of the `mypy-boto3` ecosystem, with its types automatically generated by `mypy-boto3-builder`. The library ensures that all public classes and methods of the `boto3` Comprehend service have valid, up-to-date type annotations extracted from `botocore` schemas, including documentation links. The project follows a frequent release cadence, often aligning with `boto3` updates.

Warnings

breaking Python 3.8 support has been removed across all `mypy-boto3-*` packages, including `mypy-boto3-comprehend`. Projects must use Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or a later version.
breaking All `mypy-boto3-*` packages, including this one, migrated to PEP 561 compliant distribution. While this is a standard, older toolchains or custom stub paths might require adjustments.
Fix: Ensure your `mypy` or `pyright` configuration and environment are up-to-date and correctly discover PEP 561 stubs. Typically no manual fix is needed for modern setups.
gotcha This package provides *only* type annotations. The `boto3` library itself must be installed in your environment for the code to run. Installing `mypy-boto3-comprehend` does not install `boto3`.
Fix: Ensure `pip install boto3` is executed in your project's environment alongside this stub package.
gotcha PyCharm users may experience slow performance or high CPU usage with `boto3-stubs` packages (which `mypy-boto3-comprehend` is part of, or can be installed as an extra). This is due to PyCharm's internal type checker handling of Literal overloads.
Fix: Consider using `boto3-stubs-lite` instead (e.g., `pip install 'boto3-stubs-lite[comprehend]'`), disabling PyCharm's internal type checker and relying on `mypy` or `pyright` directly, or explicitly typing `session.client()` and `session.resource()` calls.

Install

pip install mypy-boto3-comprehend Install standalone package
pip install 'boto3-stubs[comprehend]' Install as part of boto3-stubs (recommended)

Imports

ComprehendClient
```
from mypy_boto3_comprehend import ComprehendClient
```
For explicit client typing when using `boto3.client('comprehend')`.

Quickstart

This example demonstrates how to obtain a Comprehend client with and without explicit type annotations. Explicitly typing the client with `ComprehendClient` from `mypy_boto3_comprehend` provides full type checking and autocompletion for `boto3` operations on the Comprehend service.

import boto3
from mypy_boto3_comprehend import ComprehendClient
from typing import TYPE_CHECKING

# Boto3 client without explicit typing (type checkers may infer correctly)
client = boto3.client("comprehend")
client.detect_dominant_language(Text="Hello, this is a test.")

# Explicit typing for better IDE support and type checking
if TYPE_CHECKING:
    # In a real scenario, use actual AWS credentials
    # or ensure they are configured via environment variables or ~/.aws/credentials
    session = boto3.Session(region_name='us-east-1') # Or any appropriate region
    typed_client: ComprehendClient = session.client("comprehend")
    
    response = typed_client.detect_dominant_language(Text="Hola, esto es una prueba.")
    print(response['Languages'][0]['LanguageCode'])

view raw JSON →