Type annotations for boto3.Transfer 1.14.52 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-transfer
Type annotations for boto3.Transfer 1.14.52 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.3.1.
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 DescribedSecurityPolicyTypeDef, ...
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() -> DescribedSecurityPolicyTypeDef:
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.52.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9be48d7002538bc9d56182c59edd0f6c85563c895f1f513c34408616a75fcd6 |
|
MD5 | cc1dd7572b01acda014ed8b2eb2d7e78 |
|
BLAKE2b-256 | 554d5b1d10ba85010267d939aac68549265c0387c4614f222f6900738212f9a7 |
Hashes for mypy_boto3_transfer-1.14.52.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e78727db0e1d53984d97e6b0a6aae3e9f026af8350cbf4b915e6e64131dd32fb |
|
MD5 | b203fb5b1ad74366d4bbb468378feade |
|
BLAKE2b-256 | 4d9f258bb46e2b10b8e19ed643e0958fe83b9dc1f9efb37eb52da71525f3feb1 |