Type annotations for boto3.Glacier 1.14.27 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-glacier
Type annotations for boto3.Glacier 1.14.27 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 Glacier
service.
python -m pip install boto3-stubs[glacier]
How to use
Client annotations
GlacierClient
provides annotations for boto3.client("glacier")
.
import boto3
from mypy_boto3_glacier import GlacierClient, GlacierServiceResource
from mypy_boto3_glacier.paginator import (
ListJobsPaginator,
ListMultipartUploadsPaginator,
ListPartsPaginator,
ListVaultsPaginator,
)
from mypy_boto3_glacier.service_resource import (
Account,
Archive,
Job,
MultipartUpload,
Notification,
ServiceResourceVaultsCollection,
Vault,
)
from mypy_boto3_glacier.type_defs import CSVInputTypeDef, ...
from mypy_boto3_glacier.waiter import VaultExistsWaiter, VaultNotExistsWaiter
client: GlacierClient = boto3.client("glacier")
# 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: GlacierClient = session.client("glacier")
Paginators annotations
mypy_boto3_glacier.paginator
module contains type annotations for all paginators.
client: GlacierClient = boto3.client("glacier")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
list_multipart_uploads_paginator: ListMultipartUploadsPaginator = client.get_paginator("list_multipart_uploads")
list_parts_paginator: ListPartsPaginator = client.get_paginator("list_parts")
list_vaults_paginator: ListVaultsPaginator = client.get_paginator("list_vaults")
Waiters annotations
mypy_boto3_glacier.waiter
module contains type annotations for all waiters.
client: GlacierClient = boto3.client("glacier")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
vault_exists_waiter: VaultExistsWaiter = client.get_waiter("vault_exists")
vault_not_exists_waiter: VaultNotExistsWaiter = client.get_waiter("vault_not_exists")
Service Resource annotations
GlacierServiceResource
provides annotations for boto3.resource("glacier")
.
resource: GlacierServiceResource = boto3.resource("glacier")
# now resource 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_resource: GlacierServiceResource = session.resource("glacier")
Other resources annotations
mypy_boto3_glacier.service_resource
module contains type annotations for all resources.
resource: GlacierServiceResource = boto3.resource("glacier")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
my_account: Account = resource.Account(...)
my_archive: Archive = resource.Archive(...)
my_job: Job = resource.Job(...)
my_multipart_upload: MultipartUpload = resource.MultipartUpload(...)
my_notification: Notification = resource.Notification(...)
my_vault: Vault = resource.Vault(...)
Collections annotations
mypy_boto3_glacier.service_resource
module contains type annotations
for all GlacierServiceResource
collections.
resource: GlacierServiceResource = boto3.resource("glacier")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
vaults: glacier_resources.ServiceResourceVaultsCollection = resource.vaults
Typed dictionations
mypy_boto3_glacier.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> CSVInputTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_glacier
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("glacier")
resource = boto3.resource("glacier")
session_client = boto3.Session().client("glacier")
session_resource = boto3.Session().resource("glacier")
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-glacier-1.14.27.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d1b34f648f271efb4bb52a3d0df0cd5ffb8999c166a4774be387b640ba4ddfe9 |
|
MD5 | dc0a8edcbea14714fd674ec0b568eee0 |
|
BLAKE2b-256 | 1a50b56c7a0781bbff7b0f3129b15f2010a3b94a677451535b130f3ab3d74dfd |
Hashes for mypy_boto3_glacier-1.14.27.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7435e1cb5f6d7fc6c60a1f0af3e932e41877ca83cc05657659cb23d4a2409208 |
|
MD5 | 434d01eaf467f170b66aeddef8d4c22a |
|
BLAKE2b-256 | 81f2b1727b80fa46c1ce6d029986a69db9f5b008774b7f9a03ee13321905e7d4 |