Type annotations for boto3.Transfer 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-transfer
Type annotations for boto3.Transfer 1.14.2 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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60ddae5c3d388d55206ffe82e1a5e3408d4f49e7f0bd34247ac274c050775678 |
|
MD5 | e0d0befd781c9bc064d392ef5e3ca75d |
|
BLAKE2b-256 | 6e8275d2b6e74bea9e0c545a793b694f011f17bcfbdde97f242da5047df1b49a |
Hashes for mypy_boto3_transfer-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86fc86aaa586b4d8fdadf27e95206109e07ec1baf116ced2790319a016d57708 |
|
MD5 | 66a4690583d8b4a1c246736b609b3cea |
|
BLAKE2b-256 | dffd13d90956abbce3d60485f903195441dfe854014957ed7f67d8ed545523cd |