Skip to content

Textract module#

Index > Textract

Auto-generated documentation for Textract type annotations stubs module mypy-boto3-textract.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Textract.

From PyPI with pip#

Install boto3-stubs for Textract service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[textract]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[textract]'


# standalone installation
python -m pip install mypy-boto3-textract

How to uninstall#

python -m pip uninstall -y mypy-boto3-textract

Usage#

Code samples can be found in Examples.

TextractClient#

Type annotations and code completion for boto3.client("textract") as TextractClient boto3 documentation

# TextractClient usage example

from boto3.session import Session

from mypy_boto3_textract.client import TextractClient

def get_client() -> TextractClient:
    return Session().client("textract")

Paginators#

Type annotations and code completion for paginators from boto3.client("textract").get_paginator("...").

# ListAdapterVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_textract.paginator import ListAdapterVersionsPaginator

def get_list_adapter_versions_paginator() -> ListAdapterVersionsPaginator:
    return Session().client("textract").get_paginator("list_adapter_versions"))

Literals#

Type annotations for literals used in methods and schema.

# AdapterVersionStatusType usage example

from mypy_boto3_textract.literals import AdapterVersionStatusType

def get_value() -> AdapterVersionStatusType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.