# mypy-boto3-dataexchange
[![PyPI - mypy-boto3-dataexchange](https://img.shields.io/pypi/v/mypy-boto3-dataexchange.svg?color=blue)](https://pypi.org/project/mypy-boto3-dataexchange)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-dataexchange.svg?color=blue)](https://pypi.org/project/mypy-boto3-dataexchange)
[![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.DataExchange 1.16.30](https://boto3.amazonaws.com/v1/documentation/api/1.16.30/reference/services/dataexchange.html#DataExchange) service
compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.
Generated by [mypy-boto3-buider 4.1.3](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-dataexchange](#mypy-boto3-dataexchange)
- [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 `DataExchange` service.
```bash
python -m pip install boto3-stubs[dataexchange]
```
## 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[dataexchange]` in your environment: `python -m pip install 'boto3-stubs[dataexchange]'`
Both type checking and auto-complete should work for `DataExchange` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[dataexchange]` in your environment: `python -m pip install 'boto3-stubs[dataexchange]'`
Both type checking and auto-complete should work for `DataExchange` 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[dataexchange]` in your environment: `python -m pip install 'boto3-stubs[dataexchange]'`
- Run `mypy` as usual
Type checking should work for `DataExchange` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[dataexchange]` in your environment: `python -m pip install 'boto3-stubs[dataexchange]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `DataExchange` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`DataExchangeClient` provides annotations for `boto3.client("dataexchange")`.
```python
import boto3
from mypy_boto3_dataexchange import DataExchangeClient
client: DataExchangeClient = boto3.client("dataexchange")
# 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: DataExchangeClient = session.client("dataexchange")
```
### Paginators annotations
`mypy_boto3_dataexchange.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_dataexchange import DataExchangeClient
from mypy_boto3_dataexchange.paginator import (
ListDataSetRevisionsPaginator,
ListDataSetsPaginator,
ListJobsPaginator,
ListRevisionAssetsPaginator,
)
client: DataExchangeClient = boto3.client("dataexchange")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_data_set_revisions_paginator: ListDataSetRevisionsPaginator = client.get_paginator("list_data_set_revisions")
list_data_sets_paginator: ListDataSetsPaginator = client.get_paginator("list_data_sets")
list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
list_revision_assets_paginator: ListRevisionAssetsPaginator = client.get_paginator("list_revision_assets")
```
### Typed dictionations
`mypy_boto3_dataexchange.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_dataexchange.type_defs import (
AssetDestinationEntryTypeDef,
AssetDetailsTypeDef,
AssetEntryTypeDef,
AssetSourceEntryTypeDef,
CreateDataSetResponseTypeDef,
CreateJobResponseTypeDef,
CreateRevisionResponseTypeDef,
DataSetEntryTypeDef,
DetailsTypeDef,
ExportAssetsToS3RequestDetailsTypeDef,
ExportAssetsToS3ResponseDetailsTypeDef,
ExportAssetToSignedUrlRequestDetailsTypeDef,
ExportAssetToSignedUrlResponseDetailsTypeDef,
ExportServerSideEncryptionTypeDef,
GetAssetResponseTypeDef,
GetDataSetResponseTypeDef,
GetJobResponseTypeDef,
GetRevisionResponseTypeDef,
ImportAssetFromSignedUrlJobErrorDetailsTypeDef,
ImportAssetFromSignedUrlRequestDetailsTypeDef,
ImportAssetFromSignedUrlResponseDetailsTypeDef,
ImportAssetsFromS3RequestDetailsTypeDef,
ImportAssetsFromS3ResponseDetailsTypeDef,
JobEntryTypeDef,
JobErrorTypeDef,
ListDataSetRevisionsResponseTypeDef,
ListDataSetsResponseTypeDef,
ListJobsResponseTypeDef,
ListRevisionAssetsResponseTypeDef,
ListTagsForResourceResponseTypeDef,
OriginDetailsTypeDef,
PaginatorConfigTypeDef,
RequestDetailsTypeDef,
ResponseDetailsTypeDef,
RevisionEntryTypeDef,
S3SnapshotAssetTypeDef,
UpdateAssetResponseTypeDef,
UpdateDataSetResponseTypeDef,
UpdateRevisionResponseTypeDef,
)
def get_structure() -> AssetDestinationEntryTypeDef:
return {
...
}
```
没有合适的资源?快使用搜索试试~ 我知道了~
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-dataexchange-1.16.30.0.tar.gz (21个子文件)
mypy-boto3-dataexchange-1.16.30.0
PKG-INFO 10KB
setup.cfg 38B
setup.py 2KB
mypy_boto3_dataexchange.egg-info
PKG-INFO 10KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 694B
top_level.txt 24B
dependency_links.txt 1B
mypy_boto3_dataexchange
type_defs.py 16KB
py.typed 0B
type_defs.pyi 15KB
client.py 11KB
__main__.py 404B
__init__.py 1KB
client.pyi 11KB
paginator.pyi 4KB
paginator.py 4KB
version.py 57B
__init__.pyi 1KB
README.md 7KB
共 21 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功