Type annotations for boto3.Support 1.14.21 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-support
Type annotations for boto3.Support 1.14.21 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 Support
service.
python -m pip install boto3-stubs[support]
How to use
Client annotations
SupportClient
provides annotations for boto3.client("support")
.
import boto3
from mypy_boto3_support import SupportClient
from mypy_boto3_support.paginator import DescribeCasesPaginator, DescribeCommunicationsPaginator
from mypy_boto3_support.type_defs import AttachmentDetailsTypeDef, ...
client: SupportClient = boto3.client("support")
# 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: SupportClient = session.client("support")
Paginators annotations
mypy_boto3_support.paginator
module contains type annotations for all paginators.
client: SupportClient = boto3.client("support")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_cases_paginator: DescribeCasesPaginator = client.get_paginator("describe_cases")
describe_communications_paginator: DescribeCommunicationsPaginator = client.get_paginator("describe_communications")
Typed dictionations
mypy_boto3_support.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AttachmentDetailsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_support
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("support")
session_client = boto3.Session().client("support")
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-support-1.14.21.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fec722019c9ead70d0dd7c8572fdad7e5e4e976d9563c57c710557e08820dd34 |
|
MD5 | 7b8d14a8531a1d16e5800a280c960dc4 |
|
BLAKE2b-256 | ababee93bff03171ca129839f612ecf3012b445e4920a0401ad531d47f2e08ed |
Hashes for mypy_boto3_support-1.14.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6485f306ec9a7deeee45402353ea5548f60956dc265fcbe79270388aa3761d55 |
|
MD5 | 9301eaffbcae0cde486a18844c89ed1c |
|
BLAKE2b-256 | 2613927dbccd71cd51fc862b66d2163c5de88521840da29ee778fc6cd333c6a2 |