Type annotations for boto3.Transfer 1.14.51 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-transfer
Type annotations for boto3.Transfer 1.14.51 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.51.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92a02c0ca4a0d9a3827b7a6400878e1378cab58a68e790c2e1b7b19c1f7cb764 |
|
MD5 | 2ee3921271330d02defcab26d06395cc |
|
BLAKE2b-256 | 13b62660578b9356bb7f7d0d64d996b557f913a3266224e3f0d1190a03d2daa6 |
Hashes for mypy_boto3_transfer-1.14.51.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3279f293bf3cb74a545fb9e481169f75abddafef1fd568b60dd6e884aa2b0cf2 |
|
MD5 | 1afef4f52e4fa6a0ad5fa1ef0af749d9 |
|
BLAKE2b-256 | a40cef82dcf9d864bf2e9d601f7ee89ca7f271f89d7cd083aa9356302584091f |