Type annotations for boto3.Glacier 1.14.12 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-glacier
Type annotations for boto3.Glacier 1.14.12 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.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76973d061799c471ba2ed07d0dcad3bba98dd2f4500df45abec37501173ea0b2 |
|
MD5 | 19972f98a6c4ed9a9a1247fa7439c9f2 |
|
BLAKE2b-256 | e3a14a8f6eed2d6f77dc5b50d04a05fa268574b2abfcae285a387fa6573a2c67 |
Hashes for mypy_boto3_glacier-1.14.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da4b6d7ac906641b327d4f2cb723391d1ce37507f1f4f8b0c2d6200d487d77cd |
|
MD5 | 02f344609227a3b25016522f375b41ed |
|
BLAKE2b-256 | 569a63049735ac147cd97db7c68a54c54ac9b64ae54c23f6988017def2346c5b |