Type annotations for boto3.DocDB 1.13.26 service, generated by mypy-boto3-buider 2.0.3
Project description
mypy-boto3-docdb
Type annotations for boto3.DocDB 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.3.
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]
# update installed packages index for automated type discovery
python -m mypy_boto3
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")
Automated type discovery
mypy_boto3
package can generate index for mypy_boto3_docdb
and other installed services.
# Run this command when you add or remove service packages
python -m mypy_boto3
Generated index provides overloads for boto3.client
and boto3.service
,
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 carefullyVSCode
does not currently support function overloads
Also, generated index allows you to import types from mypy_boto3
:
# you can replace imports
import mypy_boto3_docdb as docdb
from mypy_boto3_docdb import DocDBClient
# with these
from mypy_boto3 import docdb
from mypy_boto3.docdb import DocDBClient
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.13.26.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5f962180450a86038a27d454939cb540bbe990f1490cbdcfa7eb867eb87ef4c |
|
MD5 | cb78c49679e2cc3d0b4e2c0f3841e5a7 |
|
BLAKE2b-256 | 382dc472cdd3a9fadc8ad9ebbe4db1d79f9f67712637215996947151b8ab3275 |
Hashes for mypy_boto3_docdb-1.13.26.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de777c1de306129d5676b8d885b62d48f4be3c55a588ccffe050a45d9c943e88 |
|
MD5 | cc0e060c5712a65f3a12aa78551cafff |
|
BLAKE2b-256 | 0ee667a2898ccfcc9cd174d9d9c0cbd6faef0bad231a8edc7e6f787dd987e766 |