Type annotations for boto3.DocDB 1.14.52 service, generated by mypy-boto3-buider 2.4.0
Project description
mypy-boto3-docdb
Type annotations for boto3.DocDB 1.14.52 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.4.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 DocDB
service.
python -m pip install boto3-stubs[docdb]
How to use
Client annotations
DocDBClient
provides annotations for boto3.client("docdb")
.
import boto3
from mypy_boto3_docdb import DocDBClient
from mypy_boto3_docdb.paginator import (
DescribeCertificatesPaginator,
DescribeDBClusterParameterGroupsPaginator,
DescribeDBClusterParametersPaginator,
DescribeDBClusterSnapshotsPaginator,
DescribeDBClustersPaginator,
DescribeDBEngineVersionsPaginator,
DescribeDBInstancesPaginator,
DescribeDBSubnetGroupsPaginator,
DescribeEventsPaginator,
DescribeOrderableDBInstanceOptionsPaginator,
DescribePendingMaintenanceActionsPaginator,
)
from mypy_boto3_docdb.type_defs import AvailabilityZoneTypeDef, ...
from mypy_boto3_docdb.waiter import DBInstanceAvailableWaiter, DBInstanceDeletedWaiter
client: DocDBClient = boto3.client("docdb")
# 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: DocDBClient = session.client("docdb")
Paginators annotations
mypy_boto3_docdb.paginator
module contains type annotations for all paginators.
client: DocDBClient = boto3.client("docdb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator("describe_certificates")
describe_db_cluster_parameter_groups_paginator: DescribeDBClusterParameterGroupsPaginator = client.get_paginator("describe_db_cluster_parameter_groups")
describe_db_cluster_parameters_paginator: DescribeDBClusterParametersPaginator = client.get_paginator("describe_db_cluster_parameters")
describe_db_cluster_snapshots_paginator: DescribeDBClusterSnapshotsPaginator = client.get_paginator("describe_db_cluster_snapshots")
describe_db_clusters_paginator: DescribeDBClustersPaginator = client.get_paginator("describe_db_clusters")
describe_db_engine_versions_paginator: DescribeDBEngineVersionsPaginator = client.get_paginator("describe_db_engine_versions")
describe_db_instances_paginator: DescribeDBInstancesPaginator = client.get_paginator("describe_db_instances")
describe_db_subnet_groups_paginator: DescribeDBSubnetGroupsPaginator = client.get_paginator("describe_db_subnet_groups")
describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_db_instance_options_paginator: DescribeOrderableDBInstanceOptionsPaginator = client.get_paginator("describe_orderable_db_instance_options")
describe_pending_maintenance_actions_paginator: DescribePendingMaintenanceActionsPaginator = client.get_paginator("describe_pending_maintenance_actions")
Waiters annotations
mypy_boto3_docdb.waiter
module contains type annotations for all waiters.
client: DocDBClient = boto3.client("docdb")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
db_instance_available_waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")
db_instance_deleted_waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted")
Typed dictionations
mypy_boto3_docdb.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AvailabilityZoneTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_docdb
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("docdb")
session_client = boto3.Session().client("docdb")
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-docdb-1.14.52.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8e38c5d80381806104346c74442f796f2ecb42d70b2e502b508734eef7122eda |
|
MD5 | 033f2e01ef6978b7609e37114039cfe5 |
|
BLAKE2b-256 | d414d110c000322feac0713fc10ae3a8cf421dc4b7d8417c0298510c1c58ef33 |
Hashes for mypy_boto3_docdb-1.14.52.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ffc04ee9a7150c57a7618e6b5283b4bc38bfcd0aef404cdeccedc199bd29daf |
|
MD5 | b425b3a1726a5f396c15558e3c8bbecf |
|
BLAKE2b-256 | 7295b5bc6114ee09694359ff8b062d91afd0e6789e8464034e7f586f2552ced0 |