Type annotations for boto3.Comprehend 1.14.13 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-comprehend
Type annotations for boto3.Comprehend 1.14.13 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for Comprehend
service.
python -m pip install boto3-stubs[comprehend]
How to use
Client annotations
ComprehendClient
provides annotations for boto3.client("comprehend")
.
import boto3
from mypy_boto3_comprehend import ComprehendClient
from mypy_boto3_comprehend.paginator import (
ListDocumentClassificationJobsPaginator,
ListDocumentClassifiersPaginator,
ListDominantLanguageDetectionJobsPaginator,
ListEntitiesDetectionJobsPaginator,
ListEntityRecognizersPaginator,
ListKeyPhrasesDetectionJobsPaginator,
ListSentimentDetectionJobsPaginator,
ListTopicsDetectionJobsPaginator,
)
from mypy_boto3_comprehend.type_defs import BatchDetectDominantLanguageItemResultTypeDef, ...
client: ComprehendClient = boto3.client("comprehend")
# 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: ComprehendClient = session.client("comprehend")
Paginators annotations
mypy_boto3_comprehend.paginator
module contains type annotations for all paginators.
client: ComprehendClient = boto3.client("comprehend")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_document_classification_jobs_paginator: ListDocumentClassificationJobsPaginator = client.get_paginator("list_document_classification_jobs")
list_document_classifiers_paginator: ListDocumentClassifiersPaginator = client.get_paginator("list_document_classifiers")
list_dominant_language_detection_jobs_paginator: ListDominantLanguageDetectionJobsPaginator = client.get_paginator("list_dominant_language_detection_jobs")
list_entities_detection_jobs_paginator: ListEntitiesDetectionJobsPaginator = client.get_paginator("list_entities_detection_jobs")
list_entity_recognizers_paginator: ListEntityRecognizersPaginator = client.get_paginator("list_entity_recognizers")
list_key_phrases_detection_jobs_paginator: ListKeyPhrasesDetectionJobsPaginator = client.get_paginator("list_key_phrases_detection_jobs")
list_sentiment_detection_jobs_paginator: ListSentimentDetectionJobsPaginator = client.get_paginator("list_sentiment_detection_jobs")
list_topics_detection_jobs_paginator: ListTopicsDetectionJobsPaginator = client.get_paginator("list_topics_detection_jobs")
Typed dictionations
mypy_boto3_comprehend.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> BatchDetectDominantLanguageItemResultTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_comprehend
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("comprehend")
session_client = boto3.Session().client("comprehend")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-comprehend-1.14.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1d1c3adf7c3d28a6636ce3ed58977d96f99bc6dee8025d8bb5baaefb6b792be |
|
MD5 | d8e0975ba397e2a0ca4f8250aec6012a |
|
BLAKE2b-256 | 97ea7179b39c7364ea8f7eb08bb7f1004f40c3d15c355ca5cd1b0288fc61d1b8 |
Hashes for mypy_boto3_comprehend-1.14.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 10dd832b4709bd4931abfefe754fdfc5bc028854df73dd95f07e9c8e1c8fef04 |
|
MD5 | c97399385724915dda1610c6372c2017 |
|
BLAKE2b-256 | 0aec5a936e31bff5094d2d14575058a07cba8bbcb929d28d927bc1f3a93161f6 |