Type annotations for boto3.DataSync 1.14.15 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-datasync
Type annotations for boto3.DataSync 1.14.15 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.15.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bdfcd42f0c0020cc3c19e2b9c02a80ffe1806299af71d35276770120b6d7b0f4 |
|
MD5 | 8e01db4a38a0a2f21279fd482be90875 |
|
BLAKE2b-256 | 3e2b91c3084386148900aea0e938bbeae3608307c1ce98d7ef2cdfadb07f776b |
Hashes for mypy_boto3_datasync-1.14.15.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2ffe8a1eb28e8de714adfcbb86cc8a8cd21b008924c2172a6419fde71caa70f1 |
|
MD5 | 2f02ae8524d73ab91e4d5ef7cab86b57 |
|
BLAKE2b-256 | b0e3d9734d2a3688498cb953814001431c7359ac8a6793794a8a9c00a014d6be |