# mypy-boto3-textract
[![PyPI - mypy-boto3-textract](https://img.shields.io/pypi/v/mypy-boto3-textract.svg?color=blue)](https://pypi.org/project/mypy-boto3-textract)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-textract.svg?color=blue)](https://pypi.org/project/mypy-boto3-textract)
[![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.Textract 1.17.21](https://boto3.amazonaws.com/v1/documentation/api/1.17.21/reference/services/textract.html#Textract) 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.4.0](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-textract](#mypy-boto3-textract)
- [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 `Textract` service.
```bash
python -m pip install boto3-stubs[textract]
```
## 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[textract]` in your environment: `python -m pip install 'boto3-stubs[textract]'`
Both type checking and auto-complete should work for `Textract` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[textract]` in your environment: `python -m pip install 'boto3-stubs[textract]'`
Both type checking and auto-complete should work for `Textract` 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[textract]` in your environment: `python -m pip install 'boto3-stubs[textract]'`
- Run `mypy` as usual
Type checking should work for `Textract` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[textract]` in your environment: `python -m pip install 'boto3-stubs[textract]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `Textract` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`TextractClient` provides annotations for `boto3.client("textract")`.
```python
import boto3
from mypy_boto3_textract import TextractClient
client: TextractClient = boto3.client("textract")
# 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: TextractClient = session.client("textract")
```
### Typed dictionations
`mypy_boto3_textract.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_textract.type_defs import (
BlockTypeDef,
BoundingBoxTypeDef,
DocumentMetadataTypeDef,
GeometryTypeDef,
HumanLoopActivationOutputTypeDef,
HumanLoopDataAttributesTypeDef,
PointTypeDef,
RelationshipTypeDef,
ResponseMetadata,
S3ObjectTypeDef,
WarningTypeDef,
AnalyzeDocumentResponseTypeDef,
DetectDocumentTextResponseTypeDef,
DocumentLocationTypeDef,
DocumentTypeDef,
GetDocumentAnalysisResponseTypeDef,
GetDocumentTextDetectionResponseTypeDef,
HumanLoopConfigTypeDef,
NotificationChannelTypeDef,
OutputConfigTypeDef,
StartDocumentAnalysisResponseTypeDef,
StartDocumentTextDetectionResponseTypeDef,
)
def get_structure() -> BlockTypeDef:
return {
...
}
```
挣扎的蓝藻
- 粉丝: 14w+
- 资源: 15万+
最新资源
- 培训效果评估调查问卷(修改版).docx
- 中国地级市CO2排放数据(2000-2023年).zip
- 基于MicroPython在ESP32上用TFT-LCD-ST7735显示图像
- 北大纵横—江西泓泰—1201人力资源管理概论培训.ppt
- 北大纵横—江西泓泰—泓泰培训制度-FINAL.doc
- 北大纵横—江西泓泰—江西泓泰工作分析培训报告-final.ppt
- 北大纵横—江西泓泰—人力资源规划制度培训.ppt
- 北大纵横—江西泓泰—瑞兴管理思想培训.ppt
- 北大纵横—江西泓泰—瑞兴人力资源管理培训-招聘和发展.ppt
- 北大纵横—江西泓泰—瑞兴人力资源管理培训-培训.ppt
- 北大纵横—金瀚—冬映红培训制度-0621.doc
- 北大纵横—金瀚—福科多培训制度-0621.doc
- 北大纵横—金瀚—金瀚集团全面预算管理培训报告.ppt
- 北大纵横—金瀚—培训制度-0618.doc
- 北大纵横—金瀚—全面预算管理培训-word.doc
- 2022-2023年度广东省职校信息安全管理与评估竞赛试题解析
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈