Type annotations for boto3.DAX 1.14.51 service, generated by mypy-boto3-buider 2.3.1
Project description
mypy-boto3-dax
Type annotations for boto3.DAX 1.14.51 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.3.1.
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 DAX
service.
python -m pip install boto3-stubs[dax]
How to use
Client annotations
DAXClient
provides annotations for boto3.client("dax")
.
import boto3
from mypy_boto3_dax import DAXClient
from mypy_boto3_dax.paginator import (
DescribeClustersPaginator,
DescribeDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeParameterGroupsPaginator,
DescribeParametersPaginator,
DescribeSubnetGroupsPaginator,
ListTagsPaginator,
)
from mypy_boto3_dax.type_defs import ClusterTypeDef, ...
client: DAXClient = boto3.client("dax")
# 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: DAXClient = session.client("dax")
Paginators annotations
mypy_boto3_dax.paginator
module contains type annotations for all paginators.
client: DAXClient = boto3.client("dax")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_clusters_paginator: DescribeClustersPaginator = client.get_paginator("describe_clusters")
describe_default_parameters_paginator: DescribeDefaultParametersPaginator = client.get_paginator("describe_default_parameters")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_parameter_groups_paginator: DescribeParameterGroupsPaginator = client.get_paginator("describe_parameter_groups")
describe_parameters_paginator: DescribeParametersPaginator = client.get_paginator("describe_parameters")
describe_subnet_groups_paginator: DescribeSubnetGroupsPaginator = client.get_paginator("describe_subnet_groups")
list_tags_paginator: ListTagsPaginator = client.get_paginator("list_tags")
Typed dictionations
mypy_boto3_dax.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ClusterTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_dax
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("dax")
session_client = boto3.Session().client("dax")
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_dax-1.14.51.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ad7ebaf3319843db6c82a116ce83a1fe917e30e631450ef6b346ed1bab8685f |
|
MD5 | 854401f2f2c2762365e65e237e78c177 |
|
BLAKE2b-256 | 354e8cff845d2fa28cfaad396945cfcd9b32bfa0bfd411e6b7a1c34170a4df32 |