Type annotations for boto3.Rekognition 1.14.2 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-rekognition
Type annotations for boto3.Rekognition 1.14.2 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.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 702ed6ae7599ab29468367bf9f2adf107d3008bc3ea2f7bbd5bc4bfbc4161001 |
|
MD5 | 0a23ed211758cdc14f9e1ac0daa3c07e |
|
BLAKE2b-256 | 23453ea6d3b2f2a79db8727a4a474a4af8e4002261b8e135a43b3f4f60a9943a |
Hashes for mypy_boto3_rekognition-1.14.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 85a8ce99bf31c39d7ba2fff2784ac2dcc06e5c0b7586d642667812d9a5bfe2ca |
|
MD5 | f4b5a203a38f6bcb1a46b3407fe9fb20 |
|
BLAKE2b-256 | 0c6cfed4e2e6ff1d66d3996be835ed015ffc41d0a14f032cbdb2918a542ca124 |