Type annotations for boto3.DataSync 1.14.28 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-datasync
Type annotations for boto3.DataSync 1.14.28 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.28.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f43d75e0fd4aa04bcf6ce3d2a84da616b7339a1d280fe74f164ac07dc0d383d |
|
MD5 | 529d6f66f2271bb3c093378ce63b27d0 |
|
BLAKE2b-256 | d56abed15d0104f5743045e70675f15c433dd102955b9c6365bb09e12bf430fb |
Hashes for mypy_boto3_datasync-1.14.28.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 557c2ee37d17a9634bdab523e66a3e014ca2093b4bd9c9253cbcd7ee3965d35b |
|
MD5 | 1c49f8ab9c8ef32642bf6298a6f1fdb4 |
|
BLAKE2b-256 | ba4cad3b180699eceba60d4b70391ccb653c71e51632439688f6ed62555bda2b |