Type annotations for boto3.SecretsManager 1.14.45 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-secretsmanager
Type annotations for boto3.SecretsManager 1.14.45 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 SecretsManager
service.
python -m pip install boto3-stubs[secretsmanager]
How to use
Client annotations
SecretsManagerClient
provides annotations for boto3.client("secretsmanager")
.
import boto3
from mypy_boto3_secretsmanager import SecretsManagerClient
from mypy_boto3_secretsmanager.paginator import ListSecretsPaginator
from mypy_boto3_secretsmanager.type_defs import RotationRulesTypeTypeDef, ...
client: SecretsManagerClient = boto3.client("secretsmanager")
# 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: SecretsManagerClient = session.client("secretsmanager")
Paginators annotations
mypy_boto3_secretsmanager.paginator
module contains type annotations for all paginators.
client: SecretsManagerClient = boto3.client("secretsmanager")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_secrets_paginator: ListSecretsPaginator = client.get_paginator("list_secrets")
Typed dictionations
mypy_boto3_secretsmanager.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> RotationRulesTypeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_secretsmanager
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("secretsmanager")
session_client = boto3.Session().client("secretsmanager")
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-secretsmanager-1.14.45.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceb144c3e836956bde20b604ac66c92dfbfed91c6cb7feda40b15b3b53a6f9fc |
|
MD5 | 109aa5c63329f9084484295cbb57f4e7 |
|
BLAKE2b-256 | 2f4a3ed23c0bceee1bdf25ff51fde6e7ad2baadd208ca81e6554655f65838a1e |
Hashes for mypy_boto3_secretsmanager-1.14.45.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b122d739e3d5d810c90fd94d3ac5b0edd7039ea17d9d8b7b64eac3ef5da2120c |
|
MD5 | 135467a406f8dcf0b2381820dde1089c |
|
BLAKE2b-256 | 6cb6a5ddffc4117489ce7a7be67e0110edf0b3928cd4a054a1b36e0f20694d93 |