Type annotations for boto3.DataSync 1.14.19 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-datasync
Type annotations for boto3.DataSync 1.14.19 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 DataSync
service.
python -m pip install boto3-stubs[datasync]
How to use
Client annotations
DataSyncClient
provides annotations for boto3.client("datasync")
.
import boto3
from mypy_boto3_datasync import DataSyncClient
from mypy_boto3_datasync.paginator import (
ListAgentsPaginator,
ListLocationsPaginator,
ListTagsForResourcePaginator,
ListTaskExecutionsPaginator,
ListTasksPaginator,
)
from mypy_boto3_datasync.type_defs import AgentListEntryTypeDef, ...
client: DataSyncClient = boto3.client("datasync")
# 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: DataSyncClient = session.client("datasync")
Paginators annotations
mypy_boto3_datasync.paginator
module contains type annotations for all paginators.
client: DataSyncClient = boto3.client("datasync")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_agents_paginator: ListAgentsPaginator = client.get_paginator("list_agents")
list_locations_paginator: ListLocationsPaginator = client.get_paginator("list_locations")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
list_task_executions_paginator: ListTaskExecutionsPaginator = client.get_paginator("list_task_executions")
list_tasks_paginator: ListTasksPaginator = client.get_paginator("list_tasks")
Typed dictionations
mypy_boto3_datasync.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AgentListEntryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_datasync
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("datasync")
session_client = boto3.Session().client("datasync")
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-datasync-1.14.19.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e0a2bdb205a3515c8952ab93a4d562182c00fce4ef262b1e9b618ddf5cc2c536 |
|
MD5 | 204b40788f12b6cd0cb8dcdd91447049 |
|
BLAKE2b-256 | 5ff2321e38fca525ab5f84e7c70593f446911eafc11a4f0a984f16606727a20e |
Hashes for mypy_boto3_datasync-1.14.19.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e42b5bbf420a3ebb8713fa17b8d0244a0c311dcb5a812f7a768a25614eeb65d |
|
MD5 | 20f24536c4be2f9b9aa060e55605ac30 |
|
BLAKE2b-256 | 68d188a5b2fa3a0a3f85a590b0e0d93f77968e8c60693bdf000c78d484d73411 |