Type annotations for boto3.Rekognition 1.14.0 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-rekognition
Type annotations for boto3.Rekognition 1.14.0 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.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 773d0bf298b08e24c4cd4ff15631f55c080a9a1912d94fdfd3fe6cf0684a0932 |
|
MD5 | b67c9c2b2dc653cf41494d56b39b89f7 |
|
BLAKE2b-256 | 9e909a12dcaf273b87a66b4b02af5e6b7e178e0a07dbbf6b6cc9bc707f2dd4c4 |
Hashes for mypy_boto3_rekognition-1.14.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0eafcde4f5db51f5c63f42b3440d5457f365d8ebe31f32358b70a453b359beeb |
|
MD5 | 468ce5ef156eab4cf7b91dac2ce4670d |
|
BLAKE2b-256 | c4c0b0850692d26f29c7bc03060226cd9ff373dc8f3b84c0e2f357120f726be6 |