# mypy-boto3-efs
[![PyPI - mypy-boto3-efs](https://img.shields.io/pypi/v/mypy-boto3-efs.svg?color=blue)](https://pypi.org/project/mypy-boto3-efs)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-efs.svg?color=blue)](https://pypi.org/project/mypy-boto3-efs)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-efs?color=blue)](https://pypistats.org/packages/mypy-boto3-efs)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.EFS 1.17.64](https://boto3.amazonaws.com/v1/documentation/api/1.17.64/reference/services/efs.html#EFS) 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.8.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
[auto-generated docs](https://github.com/vemel/mypy_boto3_builder/service_docs/mypy_boto3_efs/README.md)
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-efs](#mypy-boto3-efs)
- [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)
## How to install
Install `boto3-stubs` for `EFS` service.
```bash
python -m pip install boto3-stubs[efs]
```
## 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[efs]` in your environment: `python -m pip install 'boto3-stubs[efs]'`
Both type checking and auto-complete should work for `EFS` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[efs]` in your environment: `python -m pip install 'boto3-stubs[efs]'`
Both type checking and auto-complete should work for `EFS` 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[efs]` in your environment: `python -m pip install 'boto3-stubs[efs]'`
- Run `mypy` as usual
Type checking should work for `EFS` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[efs]` in your environment: `python -m pip install 'boto3-stubs[efs]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `EFS` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`EFSClient` provides annotations for `boto3.client("efs")`.
```python
import boto3
from mypy_boto3_efs import EFSClient
client: EFSClient = boto3.client("efs")
# 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: EFSClient = session.client("efs")
```
### Paginators annotations
`mypy_boto3_efs.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_efs import EFSClient
from mypy_boto3_efs.paginator import (
DescribeFileSystemsPaginator,
DescribeMountTargetsPaginator,
DescribeTagsPaginator,
)
client: EFSClient = boto3.client("efs")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_file_systems_paginator: DescribeFileSystemsPaginator = client.get_paginator("describe_file_systems")
describe_mount_targets_paginator: DescribeMountTargetsPaginator = client.get_paginator("describe_mount_targets")
describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
```
### Literals
`mypy_boto3_efs.literals` module contains literals extracted from shapes
that can be used in user code for type checking.
```python
from mypy_boto3_efs.literals import (
DescribeFileSystemsPaginatorName,
DescribeMountTargetsPaginatorName,
DescribeTagsPaginatorName,
LifeCycleState,
PerformanceMode,
Status,
ThroughputMode,
TransitionToIARules,
)
def check_value(value: DescribeFileSystemsPaginatorName) -> bool:
...
```
### Typed dictionaries
`mypy_boto3_efs.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_efs.type_defs import (
AccessPointDescriptionTypeDef,
BackupPolicyDescriptionTypeDef,
BackupPolicyTypeDef,
CreationInfoTypeDef,
DescribeAccessPointsResponseTypeDef,
DescribeFileSystemsResponseTypeDef,
DescribeMountTargetSecurityGroupsResponseTypeDef,
DescribeMountTargetsResponseTypeDef,
DescribeTagsResponseTypeDef,
FileSystemDescriptionTypeDef,
FileSystemPolicyDescriptionTypeDef,
FileSystemSizeTypeDef,
LifecycleConfigurationDescriptionTypeDef,
LifecyclePolicyTypeDef,
ListTagsForResourceResponseTypeDef,
MountTargetDescriptionTypeDef,
PaginatorConfigTypeDef,
PosixUserTypeDef,
RootDirectoryTypeDef,
TagTypeDef,
)
def get_structure() -> AccessPointDescriptionTypeDef:
return {
...
}
```
没有合适的资源?快使用搜索试试~ 我知道了~
PyPI 官网下载 | mypy-boto3-efs-1.17.64.1.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 102 浏览量
2022-01-13
13:27:08
上传
评论
收藏 10KB GZ 举报
温馨提示
共23个文件
py:8个
pyi:5个
txt:4个
资源来自pypi官网。 资源全名:mypy-boto3-efs-1.17.64.1.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-efs-1.17.64.1.tar.gz (23个子文件)
mypy-boto3-efs-1.17.64.1
PKG-INFO 9KB
mypy_boto3_efs
type_defs.py 5KB
py.typed 0B
type_defs.pyi 5KB
literals.py 1KB
client.py 17KB
__main__.py 712B
__init__.py 1KB
client.pyi 17KB
paginator.pyi 4KB
paginator.py 4KB
version.py 57B
literals.pyi 1KB
__init__.pyi 1KB
mypy_boto3_efs.egg-info
PKG-INFO 9KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 596B
top_level.txt 15B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
README.md 6KB
共 23 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功