mypy-boto3-translate Type Stubs

Warnings

• breaking Starting with `mypy-boto3-builder` version 8.12.0 (which generates `mypy-boto3-translate` packages), Python 3.8 is no longer supported. The `requires_python` metadata is now `>=3.9`.
  Fix: Upgrade your Python environment to 3.9 or newer. Alternatively, pin your `mypy-boto3-translate` version to an older release if Python 3.8 support is critical.
• breaking The `mypy-boto3-builder` (version 8.9.0) introduced changes to generated TypeDef naming conventions. For instance, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`, and the `Extra` postfix for conflicting names moved to the end (e.g., `CreateDistributionExtraRequestTypeDef` -> `CreateDistributionRequestExtraTypeDef`).
  Fix: Update your code to use the new TypeDef names. Consult the `mypy-boto3` documentation or regenerate your stub references.
• gotcha These packages provide only type stubs for `boto3`. You must install `boto3` itself separately for your application to run at runtime. `mypy-boto3-translate` does not automatically install `boto3`.
  Fix: Ensure `boto3` is included in your project's dependencies (e.g., `pip install boto3`).
• gotcha For the most accurate type checking, it is crucial to align the version of `mypy-boto3-translate` with the version of `boto3` you are using at runtime. Mismatched versions can lead to incorrect type hints or undetected API discrepancies.
  Fix: Install `mypy-boto3-translate` with a version that matches your `boto3` installation (e.g., if `boto3` is 1.42.3, install `mypy-boto3-translate==1.42.3`).
• gotcha The `mypy-boto3` ecosystem migrated to PEP 561 package format with `mypy-boto3-builder` version 8.12.0. While this is a standard for distributing type stubs, older tooling or specific `mypy` configurations might experience changes in how stubs are discovered or resolved.
  Fix: Ensure your `mypy` or other type checker is up-to-date. If encountering stub resolution issues, verify your `mypy` configuration (e.g., `mypy_path`).

Install

• pip install mypy-boto3-translate Install type stubs
• pip install boto3 Install boto3 (runtime dependency)

Imports

• TranslateClient

  from mypy_boto3_translate.client import TranslateClient

• TranslateTextRequestRequestTypeDef

  from mypy_boto3_translate.type_defs import TranslateTextRequestRequestTypeDef

• TranslateTextResponseTypeDef

  from mypy_boto3_translate.type_defs import TranslateTextResponseTypeDef

• JobStatusType

  from mypy_boto3_translate.literals import JobStatusType

Quickstart

This quickstart demonstrates how to use `mypy-boto3-translate` with `boto3` to type-hint a client and its method calls for the Translate service. It includes type hints for both the client instance and the request/response payloads, ensuring static type safety.

import boto3
from typing import TYPE_CHECKING, Dict, Any

# These imports are only for type checking and are typically guarded
# to prevent runtime errors if the stub package is not installed.
if TYPE_CHECKING:
    from mypy_boto3_translate.client import TranslateClient
    from mypy_boto3_translate.type_defs import (
        TranslateTextRequestRequestTypeDef,
        TranslateTextResponseTypeDef
    )

def translate_text_example(text: str, source_language: str, target_language: str) -> Dict[str, Any]:
    """Translates text using AWS Translate service with type hints."""
    # Create a boto3 client. The type hint helps mypy understand its methods.
    client: TranslateClient = boto3.client("translate")

    # Define the request payload with a type hint for validation.
    request_payload: TranslateTextRequestRequestTypeDef = {
        "Text": text,
        "SourceLanguageCode": source_language,
        "TargetLanguageCode": target_language
        # Optional parameters can also be type-hinted and added here:
        # 'TerminologyNames': [],
        # 'Settings': {'Formality': 'FORMAL'}
    }

    # Call the service method. The response is also type-hinted.
    response: TranslateTextResponseTypeDef = client.translate_text(**request_payload)
    return response

if __name__ == "__main__":
    import os
    # Ensure AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials)
    # For this example, we'll use dummy text. Boto3 will handle credential lookup.
    # If running locally, make sure your AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
    # are set as environment variables or configured in ~/.aws/credentials.

    try:
        translated_output = translate_text_example(
            text="Hello, world! How are you today?",
            source_language="en",
            target_language="es"
        )
        print(f"Original text: Hello, world! How are you today?")
        print(f"Translated text (ES): {translated_output['TranslatedText']}")
        # Expected output: Translated text (ES): ¡Hola, mundo! ¿Cómo estás hoy?
    except Exception as e:
        print(f"An error occurred: {e}")
        print("Please ensure AWS credentials are configured and the Translate service is accessible.")