Type annotations for boto3.SecretsManager 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-secretsmanager
Type annotations for boto3.SecretsManager 1.14.0 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.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 695abc40da3c742fce1ec33694a53e208e268764af59be78dc655cdd68c6d7c9 |
|
MD5 | 2568fb14293d1fedb77c17a9d5f3120b |
|
BLAKE2b-256 | b2646b149317165550daec8afc14c85bdb767ec6b49156beb56cca1245a5ce8c |
Hashes for mypy_boto3_secretsmanager-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | edb116c959c9c86fcdf76470c6decbd0eec003235030895a11a8b6e18d8d56ff |
|
MD5 | bcb1dd0765ca03052ae8bec7e1655296 |
|
BLAKE2b-256 | a37ec5170a5f4ac8ebe03feb105f29e5e9e2920e50a0604ed28e66d2f1085aa2 |