Type annotations for boto3.DocDB 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-docdb
Type annotations for boto3.DocDB 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
How to use
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for DocDB
service.
python -m pip install boto3-stubs[docdb]
Use boto3
with mypy_boto3_docdb
in your project and enjoy type checking and auto-complete.
import boto3
from mypy_boto3_docdb import DocDBClient
# Now mypy can check if your code is valid.
client: DocDBClient = boto3.client("docdb")
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: DocDBClient = session.client("docdb")
# Waiters are also supported
import mypy_boto3_docdb.waiter as docdb_waiters
db_instance_available_waiter: docdb_waiters.DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")
db_instance_deleted_waiter: docdb_waiters.DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted")
# Annotated paginators are included as well
import mypy_boto3_docdb.paginator as docdb_paginators
describe_db_clusters_paginator: docdb_paginators.DescribeDBClustersPaginator = client.get_paginator("describe_db_clusters")
describe_db_engine_versions_paginator: docdb_paginators.DescribeDBEngineVersionsPaginator = client.get_paginator("describe_db_engine_versions")
describe_db_instances_paginator: docdb_paginators.DescribeDBInstancesPaginator = client.get_paginator("describe_db_instances")
describe_db_subnet_groups_paginator: docdb_paginators.DescribeDBSubnetGroupsPaginator = client.get_paginator("describe_db_subnet_groups")
describe_events_paginator: docdb_paginators.DescribeEventsPaginator = client.get_paginator("describe_events")
describe_orderable_db_instance_options_paginator: docdb_paginators.DescribeOrderableDBInstanceOptionsPaginator = client.get_paginator("describe_orderable_db_instance_options")
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
import boto3
# 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.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dba76373392450f4247e0a0b3cd3bfe04288bacd9f4e0ea0098ce55adcb595bc |
|
MD5 | bd10dedca02ce615499685f37f70127a |
|
BLAKE2b-256 | 4d6439ee1e56b8169297ba0df9bf3104af9ec300c54061a05b875cbc358c3bab |
Hashes for mypy_boto3_docdb-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1530b2c9bd4709cfcf00be05602108c567b05300856f276cf895fa8370f39252 |
|
MD5 | 3822e9aff21145a03531f071ed542e45 |
|
BLAKE2b-256 | ef230d95bf748b043f058dfc0c7ee8d8cbc19be65664f424b12e0086f493a9d9 |