Skip to content

Examples#

Index > Textract > Examples

Auto-generated documentation for Textract type annotations stubs module types-aiobotocore-textract.

Client#

Implicit type annotations#

Can be used with types-aioboto3[textract] package installed.

Write your Textract code as usual, type checking and code completion should work out of the box.

# TextractClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("textract") as client:  # (1)
    result = await client.analyze_document()  # (2)
  1. client: TextractClient
  2. result: AnalyzeDocumentResponseTypeDef
# ListAdapterVersionsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("textract") as client:  # (1)
    paginator = client.get_paginator("list_adapter_versions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: TextractClient
  2. paginator: ListAdapterVersionsPaginator
  3. item: ListAdapterVersionsResponseTypeDef

Explicit type annotations#

With types-aioboto3-lite[textract] or a standalone types_aiobotocore_textract package, you have to explicitly specify client: TextractClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# TextractClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_textract.client import TextractClient
from types_aiobotocore_textract.type_defs import AnalyzeDocumentResponseTypeDef
from types_aiobotocore_textract.type_defs import AnalyzeDocumentRequestRequestTypeDef


session = Session()

client: TextractClient
async with session.client("textract") as client:  # (1)
    kwargs: AnalyzeDocumentRequestRequestTypeDef = {...}  # (2)
    result: AnalyzeDocumentResponseTypeDef = await client.analyze_document(**kwargs)  # (3)
  1. client: TextractClient
  2. kwargs: AnalyzeDocumentRequestRequestTypeDef
  3. result: AnalyzeDocumentResponseTypeDef
# ListAdapterVersionsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_textract.client import TextractClient
from types_aiobotocore_textract.paginator import ListAdapterVersionsPaginator
from types_aiobotocore_textract.type_defs import ListAdapterVersionsResponseTypeDef


session = Session()

client: TextractClient
async with session.client("textract") as client:  # (1)
    paginator: ListAdapterVersionsPaginator = client.get_paginator("list_adapter_versions")  # (2)
    async for item in paginator.paginate(...):
        item: ListAdapterVersionsResponseTypeDef
        print(item)  # (3)
  1. client: TextractClient
  2. paginator: ListAdapterVersionsPaginator
  3. item: ListAdapterVersionsResponseTypeDef