Type annotations for boto3.Neptune 1.14.26 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-neptune
Type annotations for boto3.Neptune 1.14.26 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 Neptune
service.
python -m pip install boto3-stubs[neptune]
How to use
Client annotations
NeptuneClient
provides annotations for boto3.client("neptune")
.
import boto3
from mypy_boto3_neptune import NeptuneClient
from mypy_boto3_neptune.paginator import (
DescribeDBClusterParameterGroupsPaginator,
DescribeDBClusterParametersPaginator,
DescribeDBClusterSnapshotsPaginator,
DescribeDBClustersPaginator,
DescribeDBEngineVersionsPaginator,
DescribeDBInstancesPaginator,
DescribeDBParameterGroupsPaginator,
DescribeDBParametersPaginator,
DescribeDBSubnetGroupsPaginator,
DescribeEngineDefaultParametersPaginator,
DescribeEventsPaginator,
DescribeEventSubscriptionsPaginator,
DescribeOrderableDBInstanceOptionsPaginator,
DescribePendingMaintenanceActionsPaginator,
)
from mypy_boto3_neptune.type_defs import AvailabilityZoneTypeDef, ...
from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter, DBInstanceDeletedWaiter
client: NeptuneClient = boto3.client("neptune")
# 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: NeptuneClient = session.client("neptune")
Paginators annotations
mypy_boto3_neptune.paginator
module contains type annotations for all paginators.
client: NeptuneClient = boto3.client("neptune")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
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_parameter_groups_paginator: DescribeDBParameterGroupsPaginator = client.get_paginator("describe_db_parameter_groups")
describe_db_parameters_paginator: DescribeDBParametersPaginator = client.get_paginator("describe_db_parameters")
describe_db_subnet_groups_paginator: DescribeDBSubnetGroupsPaginator = client.get_paginator("describe_db_subnet_groups")
describe_engine_default_parameters_paginator: DescribeEngineDefaultParametersPaginator = client.get_paginator("describe_engine_default_parameters")
describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator("describe_event_subscriptions")
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_neptune.waiter
module contains type annotations for all waiters.
client: NeptuneClient = boto3.client("neptune")
# 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_neptune.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_neptune
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("neptune")
session_client = boto3.Session().client("neptune")
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-neptune-1.14.26.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f3e9fb0d19f6aab888428e288e6e2e2b39a729994a2636046e21929099919e8 |
|
MD5 | dab90f7eda685b35f346f8b44fb864b6 |
|
BLAKE2b-256 | e5191ff589d67c73f13314f4cded01b05ecf1d77b2f6c947aad932ecd98ed069 |
Hashes for mypy_boto3_neptune-1.14.26.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 935816fe0662e5116500c1e754adbda33ef1f0da5ecc3674d508de59e82a6cca |
|
MD5 | fea03c3255c2bad4bdf6897c94f6df28 |
|
BLAKE2b-256 | 86d6c251bd6673e18b1e2c75e15fcd3e59541da17c3eb2f89c496e1040226762 |