Type annotations for boto3.Transfer 1.14.25 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-transfer
Type annotations for boto3.Transfer 1.14.25 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Transfer
service.
python -m pip install boto3-stubs[transfer]
How to use
Client annotations
TransferClient
provides annotations for boto3.client("transfer")
.
import boto3
from mypy_boto3_transfer import TransferClient
from mypy_boto3_transfer.paginator import ListServersPaginator
from mypy_boto3_transfer.type_defs import DescribedServerTypeDef, ...
client: TransferClient = boto3.client("transfer")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: TransferClient = session.client("transfer")
Paginators annotations
mypy_boto3_transfer.paginator
module contains type annotations for all paginators.
client: TransferClient = boto3.client("transfer")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_servers_paginator: ListServersPaginator = client.get_paginator("list_servers")
Typed dictionations
mypy_boto3_transfer.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> DescribedServerTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_transfer
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("transfer")
session_client = boto3.Session().client("transfer")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-transfer-1.14.25.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b634dc3d2b350659cacb6d70455f9884ec8500a227485cc62dec06d68d83254a |
|
MD5 | 5b47805825347b913281be555690adf2 |
|
BLAKE2b-256 | f6f69ff1b4c1bf6d1556af82a48302b56a4d0b039633c42f4b2aa78ef4124fdf |
Hashes for mypy_boto3_transfer-1.14.25.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6228d211931745652ecd01979422ac97fec37c225f8257591b540f4dd52d9bce |
|
MD5 | 39f347ae96dabd280b41815dfb3bc541 |
|
BLAKE2b-256 | 7e0d56b7610511360574c94c86b9258d65d83a3c8ecef73d2577c90bcb3b6a29 |