# mypy-boto3-secretsmanager
[![PyPI - mypy-boto3-secretsmanager](https://img.shields.io/pypi/v/mypy-boto3-secretsmanager.svg?color=blue)](https://pypi.org/project/mypy-boto3-secretsmanager)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-secretsmanager.svg?color=blue)](https://pypi.org/project/mypy-boto3-secretsmanager)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.SecretsManager 1.16.54](https://boto3.amazonaws.com/v1/documentation/api/1.16.54/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.3.1](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [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)
- [Waiters annotations](#waiters-annotations)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `SecretsManager` service.
```bash
python -m pip install boto3-stubs[secretsmanager]
```
## Usage
### VSCode
- 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
- 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
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- 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
- 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
### Client annotations
`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
`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")
```
### Typed dictionations
`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,
ListSecretsResponseTypeDef,
ListSecretVersionIdsResponseTypeDef,
PaginatorConfigTypeDef,
PutResourcePolicyResponseTypeDef,
PutSecretValueResponseTypeDef,
RestoreSecretResponseTypeDef,
RotateSecretResponseTypeDef,
RotationRulesTypeTypeDef,
SecretListEntryTypeDef,
SecretVersionsListEntryTypeDef,
TagTypeDef,
UpdateSecretResponseTypeDef,
UpdateSecretVersionStageResponseTypeDef,
ValidateResourcePolicyResponseTypeDef,
ValidationErrorsEntryTypeDef,
)
def get_structure() -> RotationRulesTypeTypeDef:
return {
...
}
```
PyPI 官网下载 | mypy-boto3-secretsmanager-1.16.54.0.tar.gz
版权申诉
88 浏览量
2022-01-28
18:46:02
上传
评论
收藏 9KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- 数电实验一:半加器、电路的逻辑功能、全加器,四人表决电路、组合逻辑电路
- 原生Javaee+jsp的一个课程项目为在线课程管理系统
- 企业人事管理系统 开发框架:vs2022 + asp.net + webform + sqlserver 数据库:sqlser
- jsp基于WEB的考务管理系统的设计与实现(源代码+lw).zip
- jsp基于Web的可维护的数据库浏览器(源代码+lw+答辩PPT).zip
- JSP基于WEB的图书馆借阅系统的设计与实现(源代码+lw).zip
- aht10的linux驱动
- JSP基于WEB网上论坛设计与实现(源代码+lw+开题报告+答辩PPT+外文翻译).zip
- 端午节et-mai开发比记
- JSP基于网络超市商品销售管理系统的设计与实现(源代码+lw).zip
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈