Python库 | mypy-boto3-secretsmanager-1.17.71.post1.tar.gz

# mypy-boto3-secretsmanager<a id="mypy-boto3-secretsmanager"></a> [](https://pypi.org/project/mypy-boto3-secretsmanager) [](https://pypi.org/project/mypy-boto3-secretsmanager) [](https://mypy-boto3-builder.readthedocs.io/) [](https://pypistats.org/packages/mypy-boto3-secretsmanager)  Type annotations for [boto3.SecretsManager 1.17.71](https://boto3.amazonaws.com/v1/documentation/api/1.17.71/reference/services/secretsmanager.html#SecretsManager) service compatible with [VSCode](https://code.visualstudio.com/), [PyCharm](https://www.jetbrains.com/pycharm/), [Emacs](https://www.gnu.org/software/emacs/), [Sublime Text](https://www.sublimetext.com/), [mypy](https://github.com/python/mypy), [pyright](https://github.com/microsoft/pyright) and other tools. Generated by [mypy-boto3-buider 4.12.0](https://github.com/vemel/mypy_boto3_builder). More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in [mypy-boto3-secretsmanager docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_secretsmanager/) See how it helps to find and fix potential bugs:  - [mypy-boto3-secretsmanager](#mypy-boto3-secretsmanager) - [How to install](#how-to-install) - [Usage](#usage) - [VSCode](#vscode) - [PyCharm](#pycharm) - [Other IDEs](#other-ides) - [mypy](#mypy) - [pyright](#pyright) - [Explicit type annotations](#explicit-type-annotations) - [Client annotations](#client-annotations) - [Paginators annotations](#paginators-annotations) - [Literals](#literals) - [Typed dictionaries](#typed-dictionaries) - [Versioning](#versioning) - [Documentation](#documentation) - [Support and contributing](#support-and-contributing) ## How to install<a id="how-to-install"></a> Install `boto3-stubs` for `SecretsManager` service. ```bash python -m pip install boto3-stubs[secretsmanager] ``` ## Usage<a id="usage"></a> ### VSCode<a id="vscode"></a> - Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) - Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) - Set `Pylance` as your Python Language Server - Install `boto-stubs[secretsmanager]` in your environment: `python -m pip install 'boto3-stubs[secretsmanager]'` Both type checking and auto-complete should work for `SecretsManager` service. No explicit type annotations required, write your `boto3` code as usual. ### PyCharm<a id="pycharm"></a> - Install `boto-stubs[secretsmanager]` in your environment: `python -m pip install 'boto3-stubs[secretsmanager]'` Both type checking and auto-complete should work for `SecretsManager` service. No explicit type annotations required, write your `boto3` code as usual. Auto-complete can be slow on big projects or if you have a lot of installed `boto3-stubs` submodules. ### Other IDEs<a id="other-ides"></a> Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work. ### mypy<a id="mypy"></a> - Install `mypy`: `python -m pip install mypy` - Install `boto-stubs[secretsmanager]` in your environment: `python -m pip install 'boto3-stubs[secretsmanager]'` - Run `mypy` as usual Type checking should work for `SecretsManager` service. No explicit type annotations required, write your `boto3` code as usual. ### pyright<a id="pyright"></a> - Install `pyright`: `yarn global add pyright` - Install `boto-stubs[secretsmanager]` in your environment: `python -m pip install 'boto3-stubs[secretsmanager]'` - Optionally, you can install `boto3-stubs` to `typings` folder. Type checking should work for `SecretsManager` service. No explicit type annotations required, write your `boto3` code as usual. ## Explicit type annotations<a id="explicit-type-annotations"></a> ### Client annotations<a id="client-annotations"></a> `SecretsManagerClient` provides annotations for `boto3.client("secretsmanager")`. ```python import boto3 from mypy_boto3_secretsmanager import SecretsManagerClient 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<a id="paginators-annotations"></a> `mypy_boto3_secretsmanager.paginator` module contains type annotations for all paginators. ```python from mypy_boto3_secretsmanager import SecretsManagerClient from mypy_boto3_secretsmanager.paginator import ( ListSecretsPaginator, ) 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") ``` ### Literals<a id="literals"></a> `mypy_boto3_secretsmanager.literals` module contains literals extracted from shapes that can be used in user code for type checking. ```python from mypy_boto3_secretsmanager.literals import ( FilterNameStringType, ListSecretsPaginatorName, SortOrderType, StatusType, ) def check_value(value: FilterNameStringType) -> bool: ... ``` ### Typed dictionaries<a id="typed-dictionaries"></a> `mypy_boto3_secretsmanager.type_defs` module contains structures and shapes assembled to typed dictionaries for additional type checking. ```python from mypy_boto3_secretsmanager.type_defs import ( CancelRotateSecretResponseTypeDef, CreateSecretResponseTypeDef, DeleteResourcePolicyResponseTypeDef, DeleteSecretResponseTypeDef, DescribeSecretResponseTypeDef, FilterTypeDef, GetRandomPasswordResponseTypeDef, GetResourcePolicyResponseTypeDef, GetSecretValueResponseTypeDef, ListSecretVersionIdsResponseTypeDef, ListSecretsResponseTypeDef, PaginatorConfigTypeDef, PutResourcePolicyResponseTypeDef, PutSecretValueResponseTypeDef, RemoveRegionsFromReplicationResponseTypeDef, ReplicaRegionTypeTypeDef, ReplicateSecretToRegionsResponseTypeDef, ReplicationStatusTypeTypeDef, RestoreSecretResponseTypeDef, RotateSecretResponseTypeDef, RotationRulesTypeTypeDef, SecretListEntryTypeDef, SecretVersionsListEntryTypeDef, StopReplicationToReplicaResponseTypeDef, TagTypeDef, UpdateSecretResponseTypeDef, UpdateSecretVersionStageResponseTypeDef, ValidateResourcePolicyResponseTypeDef, ValidationErrorsEntryTypeDef, ) def get_structure() -> CancelRotateSecretResponseTypeDef: return { ... } ``` ## Versioning<a id="versioning"></a> `mypy-boto3-secretsmanager` version is the same as related `boto3` version and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. ## Documentation<a id="documentation"></a> All type annotations can be found in [mypy-boto3-secretsmanager docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_secretsmanager/) ## Support and contributing<a id="support-and-contributing"></a> This package is auto-generated. Please reports any bugs or request new features in [mypy-boto3-builder](https://github.com/vemel/mypy_boto3_builder/issues/) repository.