Type annotations for boto3.Connect 1.14.38 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-connect
Type annotations for boto3.Connect 1.14.38 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 Connect
service.
python -m pip install boto3-stubs[connect]
How to use
Client annotations
ConnectClient
provides annotations for boto3.client("connect")
.
import boto3
from mypy_boto3_connect import ConnectClient
from mypy_boto3_connect.paginator import (
GetMetricDataPaginator,
ListContactFlowsPaginator,
ListHoursOfOperationsPaginator,
ListPhoneNumbersPaginator,
ListQueuesPaginator,
ListRoutingProfilesPaginator,
ListSecurityProfilesPaginator,
ListUserHierarchyGroupsPaginator,
ListUsersPaginator,
)
from mypy_boto3_connect.type_defs import ContactFlowSummaryTypeDef, ...
client: ConnectClient = boto3.client("connect")
# 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: ConnectClient = session.client("connect")
Paginators annotations
mypy_boto3_connect.paginator
module contains type annotations for all paginators.
client: ConnectClient = boto3.client("connect")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
get_metric_data_paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data")
list_contact_flows_paginator: ListContactFlowsPaginator = client.get_paginator("list_contact_flows")
list_hours_of_operations_paginator: ListHoursOfOperationsPaginator = client.get_paginator("list_hours_of_operations")
list_phone_numbers_paginator: ListPhoneNumbersPaginator = client.get_paginator("list_phone_numbers")
list_queues_paginator: ListQueuesPaginator = client.get_paginator("list_queues")
list_routing_profiles_paginator: ListRoutingProfilesPaginator = client.get_paginator("list_routing_profiles")
list_security_profiles_paginator: ListSecurityProfilesPaginator = client.get_paginator("list_security_profiles")
list_user_hierarchy_groups_paginator: ListUserHierarchyGroupsPaginator = client.get_paginator("list_user_hierarchy_groups")
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
Typed dictionations
mypy_boto3_connect.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ContactFlowSummaryTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_connect
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("connect")
session_client = boto3.Session().client("connect")
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-connect-1.14.38.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02e354a338f0040d04365733c569d7592361209700f1294b40e2b2fd6b63f017 |
|
MD5 | 17c470be0b748410655c5ab1504b7440 |
|
BLAKE2b-256 | 7bf8965a6f7ceb94f1c2ebfc4f19d473735e5d008b525cef62b830d59bce9fc5 |
Hashes for mypy_boto3_connect-1.14.38.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c721c77c6ee00c99d39571d471c940d3ef0e83e0923e7674035d51dbedafcd5 |
|
MD5 | 0a75ccfc2a96c838f710cfeb936450d2 |
|
BLAKE2b-256 | 4af3c9f2ae33665525018890c42edec45b5e7c1f5998b8b60be210444bd76f0e |