Type annotations for boto3.Snowball 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-snowball
Type annotations for boto3.Snowball 1.14.3 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 Snowball
service.
python -m pip install boto3-stubs[snowball]
How to use
Client annotations
SnowballClient
provides annotations for boto3.client("snowball")
.
import boto3
from mypy_boto3_snowball import SnowballClient
from mypy_boto3_snowball.paginator import (
DescribeAddressesPaginator,
ListClusterJobsPaginator,
ListClustersPaginator,
ListCompatibleImagesPaginator,
ListJobsPaginator,
)
from mypy_boto3_snowball.type_defs import AddressTypeDef, ...
client: SnowballClient = boto3.client("snowball")
# 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: SnowballClient = session.client("snowball")
Paginators annotations
mypy_boto3_snowball.paginator
module contains type annotations for all paginators.
client: SnowballClient = boto3.client("snowball")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_addresses_paginator: DescribeAddressesPaginator = client.get_paginator("describe_addresses")
list_cluster_jobs_paginator: ListClusterJobsPaginator = client.get_paginator("list_cluster_jobs")
list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
list_compatible_images_paginator: ListCompatibleImagesPaginator = client.get_paginator("list_compatible_images")
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
Typed dictionations
mypy_boto3_snowball.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AddressTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_snowball
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("snowball")
session_client = boto3.Session().client("snowball")
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-snowball-1.14.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cdbd516ab1b675aee8e5998246d102a2d0054a76abce965bc025f54e079d90d3 |
|
MD5 | 3c864aa0540091e4ff2726a8f22b856d |
|
BLAKE2b-256 | 6fb8c45d47b4ca41abaf33a6cfbbf8b99e4e44f7b062ae98c35d367fe4211150 |
Hashes for mypy_boto3_snowball-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea99fabdcaa8dc8b4711885792c1421d95d59e9172182c28e092f5b682beedef |
|
MD5 | 7f8e16911c7c7c79eb8bca11ebd74ff4 |
|
BLAKE2b-256 | e5d303468a9958798964640c6edc0cfdd4d7a79c9e6c28c28449b35a473fe256 |