Type annotations for boto3.Rekognition 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-rekognition
Type annotations for boto3.Rekognition 1.14.3 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 Rekognition
service.
python -m pip install boto3-stubs[rekognition]
How to use
Client annotations
RekognitionClient
provides annotations for boto3.client("rekognition")
.
import boto3
from mypy_boto3_rekognition import RekognitionClient
from mypy_boto3_rekognition.paginator import (
DescribeProjectsPaginator,
DescribeProjectVersionsPaginator,
ListCollectionsPaginator,
ListFacesPaginator,
ListStreamProcessorsPaginator,
)
from mypy_boto3_rekognition.type_defs import AgeRangeTypeDef, ...
from mypy_boto3_rekognition.waiter import (
ProjectVersionRunningWaiter,
ProjectVersionTrainingCompletedWaiter,
)
client: RekognitionClient = boto3.client("rekognition")
# 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: RekognitionClient = session.client("rekognition")
Paginators annotations
mypy_boto3_rekognition.paginator
module contains type annotations for all paginators.
client: RekognitionClient = boto3.client("rekognition")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_project_versions_paginator: DescribeProjectVersionsPaginator = client.get_paginator("describe_project_versions")
describe_projects_paginator: DescribeProjectsPaginator = client.get_paginator("describe_projects")
list_collections_paginator: ListCollectionsPaginator = client.get_paginator("list_collections")
list_faces_paginator: ListFacesPaginator = client.get_paginator("list_faces")
list_stream_processors_paginator: ListStreamProcessorsPaginator = client.get_paginator("list_stream_processors")
Waiters annotations
mypy_boto3_rekognition.waiter
module contains type annotations for all waiters.
client: RekognitionClient = boto3.client("rekognition")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
project_version_running_waiter: ProjectVersionRunningWaiter = client.get_waiter("project_version_running")
project_version_training_completed_waiter: ProjectVersionTrainingCompletedWaiter = client.get_waiter("project_version_training_completed")
Typed dictionations
mypy_boto3_rekognition.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AgeRangeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_rekognition
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("rekognition")
session_client = boto3.Session().client("rekognition")
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-rekognition-1.14.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e38484345f44ea5ff55a0506123e719b6e94d37580a79a02c083a453268fdcd6 |
|
MD5 | ad8745fa9f6dcde5383cdf3bbc4e77af |
|
BLAKE2b-256 | bb3edad52d1c38146f5591cf930bce705d0e5f3a9b8b1f85525653d850c2e150 |
Hashes for mypy_boto3_rekognition-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a0c5a04d74c39e1cebf05fa75be398156d1f1644ef6f061b5880e10641a8b10 |
|
MD5 | 1f47b35efd1bdd640fdf7ae794d1d0e3 |
|
BLAKE2b-256 | fcced9f16688709ba62ab148dcbd0d2d3905a297fd0b0935ca4808452abe7b1a |