Type annotations for boto3.DocDB 1.14.6 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-docdb
Type annotations for boto3.DocDB 1.14.6 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 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 (
DescribeDBClustersPaginator,
DescribeDBEngineVersionsPaginator,
DescribeDBInstancesPaginator,
DescribeDBSubnetGroupsPaginator,
DescribeEventsPaginator,
DescribeOrderableDBInstanceOptionsPaginator,
)
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_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")
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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 962dae54b856989436ab40f4b6fbf3302f274caea06c04dc8e4a1f307adff002 |
|
MD5 | 188e9329308c7c8eb42d2e1c2e58c88d |
|
BLAKE2b-256 | 1f508ece8d7f1f98bce93f05a829612ac73ca0d6b5ce1fd5949bba32b66bcb24 |
Hashes for mypy_boto3_docdb-1.14.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 814851e4ee1967ab08ad81b7c5aaa5d5436da2385dcc124c1b6c9edb5a9ab6ee |
|
MD5 | 695621c7b34c932d91d1b0bac131bb0f |
|
BLAKE2b-256 | dd44086b9c17e914108dd734325f34d836b440c040c32359cbe46088789d81a1 |