mypy-boto3-transfer

1.42.84 · active · verified Sat Apr 11

mypy-boto3-transfer provides type annotations for the `boto3` Transfer service, generated with `mypy-boto3-builder`. It ensures `mypy` can correctly validate usage of the `boto3` Transfer client and associated data types. The library is actively maintained, with releases typically synchronized with `boto3` updates and `mypy-boto3-builder` enhancements, currently at version 1.42.84.

Warnings

breaking Support for Python 3.8 was removed in `mypy-boto3-builder` version 8.12.0. Users on Python 3.8 will need to upgrade to Python 3.9 or newer to use the latest `mypy-boto3-transfer` stubs.
Fix: Upgrade your Python environment to 3.9 or a later version.
gotcha `mypy-boto3-transfer` provides type stubs only. You must also install the actual `boto3` library (`pip install boto3`) for your code to run at runtime. Without `boto3`, your application will encounter runtime import errors.
Fix: Ensure `boto3` is installed alongside `mypy-boto3-transfer` in your project's dependencies.
breaking `mypy-boto3-builder` version 8.9.0 introduced breaking changes to `TypeDef` naming conventions (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). If you directly imported specific `TypeDef` classes by their full names, these imports may break.
Fix: Review your explicit `TypeDef` imports and update them to the new, often shorter, naming convention. Refer to the specific service's `type_defs.pyi` for correct names.
breaking `mypy-boto3-builder` version 8.12.0 migrated all packages, including `mypy-boto3-transfer`, to be PEP 561 compliant. While this improves standard type-checking workflows, custom build systems or specific tooling that relied on previous package structures might need adjustments.
Fix: Ensure your environment correctly handles PEP 561-compliant stub packages. Most modern `mypy` setups should work seamlessly, but verify if you have custom type-stub discovery configurations.

Install

pip install mypy-boto3-transfer Install service stubs
pip install boto3 Install runtime dependency

Imports

TransferClient

from mypy_boto3_transfer.client import TransferClient

ListServersResponseTypeDef

from mypy_boto3_transfer.type_defs import ListServersResponseTypeDef

Quickstart

Demonstrates how to import and use the `TransferClient` type to annotate a `boto3` client, enabling static type checking with `mypy` for AWS Transfer service operations. It also shows a common response type definition.

import boto3
from mypy_boto3_transfer.client import TransferClient
from mypy_boto3_transfer.type_defs import ListServersResponseTypeDef
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    # These imports are for type checking only and will not be executed at runtime
    # They provide type hints for boto3 service clients and responses.
    client: TransferClient = boto3.client("transfer")
    response: ListServersResponseTypeDef = client.list_servers()
    print(f"Found {len(response['Servers'])} Transfer servers.")

# Example of actual runtime usage (uncomment to run)
# client = boto3.client("transfer")
# response = client.list_servers()
# print(f"Runtime: Found {len(response['Servers'])} Transfer servers.")

view raw JSON →