Type annotations for boto3.WorkMail 1.14.36 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-workmail
Type annotations for boto3.WorkMail 1.14.36 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 WorkMail
service.
python -m pip install boto3-stubs[workmail]
How to use
Client annotations
WorkMailClient
provides annotations for boto3.client("workmail")
.
import boto3
from mypy_boto3_workmail import WorkMailClient
from mypy_boto3_workmail.paginator import (
ListAliasesPaginator,
ListGroupMembersPaginator,
ListGroupsPaginator,
ListMailboxPermissionsPaginator,
ListOrganizationsPaginator,
ListResourceDelegatesPaginator,
ListResourcesPaginator,
ListUsersPaginator,
)
from mypy_boto3_workmail.type_defs import AccessControlRuleTypeDef, ...
client: WorkMailClient = boto3.client("workmail")
# 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: WorkMailClient = session.client("workmail")
Paginators annotations
mypy_boto3_workmail.paginator
module contains type annotations for all paginators.
client: WorkMailClient = boto3.client("workmail")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
list_group_members_paginator: ListGroupMembersPaginator = client.get_paginator("list_group_members")
list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
list_mailbox_permissions_paginator: ListMailboxPermissionsPaginator = client.get_paginator("list_mailbox_permissions")
list_organizations_paginator: ListOrganizationsPaginator = client.get_paginator("list_organizations")
list_resource_delegates_paginator: ListResourceDelegatesPaginator = client.get_paginator("list_resource_delegates")
list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
Typed dictionations
mypy_boto3_workmail.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AccessControlRuleTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_workmail
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("workmail")
session_client = boto3.Session().client("workmail")
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-workmail-1.14.36.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd96b0ca2681cf1f2ee08a8cf709d700beb9d0a7793d928e806209981efbae55 |
|
MD5 | 370970088f11439cd0407e7eb8bddb54 |
|
BLAKE2b-256 | 4a8a3ede4ec4370d88471a9215f620543a865b1c4d3109d661d49a3dd52ed739 |
Hashes for mypy_boto3_workmail-1.14.36.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dadc86ecbe1c2bec01d727d142bd5318977f0dd7664820d1cf03dbeec246a241 |
|
MD5 | 202c100cb6197bcbd6f6ff3992e5de68 |
|
BLAKE2b-256 | 6a43644fe7d12232dfb7f9df5512a7917090b381c3d7dee83af6648e8c11ca97 |