Type annotations for boto3.StorageGateway 1.14.49 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-storagegateway
Type annotations for boto3.StorageGateway 1.14.49 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 StorageGateway
service.
python -m pip install boto3-stubs[storagegateway]
How to use
Client annotations
StorageGatewayClient
provides annotations for boto3.client("storagegateway")
.
import boto3
from mypy_boto3_storagegateway import StorageGatewayClient
from mypy_boto3_storagegateway.paginator import (
DescribeTapeArchivesPaginator,
DescribeTapeRecoveryPointsPaginator,
DescribeTapesPaginator,
DescribeVTLDevicesPaginator,
ListFileSharesPaginator,
ListGatewaysPaginator,
ListTagsForResourcePaginator,
ListTapesPaginator,
ListVolumesPaginator,
)
from mypy_boto3_storagegateway.type_defs import AutomaticTapeCreationPolicyInfoTypeDef, ...
client: StorageGatewayClient = boto3.client("storagegateway")
# 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: StorageGatewayClient = session.client("storagegateway")
Paginators annotations
mypy_boto3_storagegateway.paginator
module contains type annotations for all paginators.
client: StorageGatewayClient = boto3.client("storagegateway")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_tape_archives_paginator: DescribeTapeArchivesPaginator = client.get_paginator("describe_tape_archives")
describe_tape_recovery_points_paginator: DescribeTapeRecoveryPointsPaginator = client.get_paginator("describe_tape_recovery_points")
describe_tapes_paginator: DescribeTapesPaginator = client.get_paginator("describe_tapes")
describe_vtl_devices_paginator: DescribeVTLDevicesPaginator = client.get_paginator("describe_vtl_devices")
list_file_shares_paginator: ListFileSharesPaginator = client.get_paginator("list_file_shares")
list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
list_tapes_paginator: ListTapesPaginator = client.get_paginator("list_tapes")
list_volumes_paginator: ListVolumesPaginator = client.get_paginator("list_volumes")
Typed dictionations
mypy_boto3_storagegateway.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AutomaticTapeCreationPolicyInfoTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_storagegateway
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("storagegateway")
session_client = boto3.Session().client("storagegateway")
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-storagegateway-1.14.49.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e29fed56f3948fe07d0bc79dcd4c4b147d1ab97c898680f50fe7e0e68e221dae |
|
MD5 | 22119ee822c02df83b6fdc20ede7d310 |
|
BLAKE2b-256 | 45a91d2503cc4953c16e8167f835975e5001e5ee857e0482d353f507aab1850e |
Hashes for mypy_boto3_storagegateway-1.14.49.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19af5b0a94b28c933ddbfba943f3f8b0d46d5dc5a7295e935c5464f7fee89f51 |
|
MD5 | f01b0cdeb36db79b4969b5a9ec1a33c3 |
|
BLAKE2b-256 | 914c15c191db821630a40fb3223adaf9a924ea3389d38db6c92c8d0ce64e18d0 |