Type annotations for boto3.Polly 1.14.17 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-polly
Type annotations for boto3.Polly 1.14.17 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 Polly
service.
python -m pip install boto3-stubs[polly]
How to use
Client annotations
PollyClient
provides annotations for boto3.client("polly")
.
import boto3
from mypy_boto3_polly import PollyClient
from mypy_boto3_polly.paginator import (
DescribeVoicesPaginator,
ListLexiconsPaginator,
ListSpeechSynthesisTasksPaginator,
)
from mypy_boto3_polly.type_defs import LexiconAttributesTypeDef, ...
client: PollyClient = boto3.client("polly")
# 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: PollyClient = session.client("polly")
Paginators annotations
mypy_boto3_polly.paginator
module contains type annotations for all paginators.
client: PollyClient = boto3.client("polly")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_voices_paginator: DescribeVoicesPaginator = client.get_paginator("describe_voices")
list_lexicons_paginator: ListLexiconsPaginator = client.get_paginator("list_lexicons")
list_speech_synthesis_tasks_paginator: ListSpeechSynthesisTasksPaginator = client.get_paginator("list_speech_synthesis_tasks")
Typed dictionations
mypy_boto3_polly.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> LexiconAttributesTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_polly
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("polly")
session_client = boto3.Session().client("polly")
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-polly-1.14.17.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f23853d7cbf429c05b4be2d43c02b08cf45b5402a5638bb5ecc8494d9e4ef96 |
|
MD5 | aa1f519e7cf06382461a072fe629006c |
|
BLAKE2b-256 | 1ce15e247f58673d896b6f64aab2409bbf4092af08727d7dada210a58c47c087 |
Hashes for mypy_boto3_polly-1.14.17.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e5a50357e137b635b41a485a31fdbf7fc6f32a5df9d272017a3d59de343ac1 |
|
MD5 | c362a6c342cbdaf4dbfe3a8dcc6191bd |
|
BLAKE2b-256 | 0ffa0ce7deef35fc80934e42d7ad2d865241eaad81c359f9b47f3c5af8a157a2 |