diff options
author | CoprDistGit <infra@openeuler.org> | 2023-04-11 08:31:59 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-04-11 08:31:59 +0000 |
commit | 640a26fbc8195e13fda0a334516dc69f1eede940 (patch) | |
tree | 581879013c151d0e4f994bdeef2a17146127a9c2 | |
parent | 110b68113db442e32b4dc63fe73f80127e3110b5 (diff) |
automatic import of python-mypy-boto3-neptune
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-mypy-boto3-neptune.spec | 2125 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 2127 insertions, 0 deletions
@@ -0,0 +1 @@ +/mypy-boto3-neptune-1.26.95.tar.gz diff --git a/python-mypy-boto3-neptune.spec b/python-mypy-boto3-neptune.spec new file mode 100644 index 0000000..83ffd76 --- /dev/null +++ b/python-mypy-boto3-neptune.spec @@ -0,0 +1,2125 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-neptune +Version: 1.26.95 +Release: 1 +Summary: Type annotations for boto3.Neptune 1.26.95 service generated with mypy-boto3-builder 7.13.0 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/5c/b0/bf67de641e65ee79a2d5c89aaa5c07537b543f1cb28c81127dbd9d1c9f50/mypy-boto3-neptune-1.26.95.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-neptune"></a> + +# mypy-boto3-neptune + +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-neptune) + + + +Type annotations for +[boto3.Neptune 1.26.95](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune.html#Neptune) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-neptune docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-neptune](#mypy-boto3-neptune) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Neptune`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Neptune` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[neptune]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[neptune]' + + +# standalone installation +python -m pip install mypy-boto3-neptune +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-neptune +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[neptune]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[neptune]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`NeptuneClient` provides annotations for `boto3.client("neptune")`. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient + +client: NeptuneClient = Session().client("neptune") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_neptune.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.paginator import ( + DescribeDBClusterEndpointsPaginator, + DescribeDBClusterParameterGroupsPaginator, + DescribeDBClusterParametersPaginator, + DescribeDBClusterSnapshotsPaginator, + DescribeDBClustersPaginator, + DescribeDBEngineVersionsPaginator, + DescribeDBInstancesPaginator, + DescribeDBParameterGroupsPaginator, + DescribeDBParametersPaginator, + DescribeDBSubnetGroupsPaginator, + DescribeEngineDefaultParametersPaginator, + DescribeEventSubscriptionsPaginator, + DescribeEventsPaginator, + DescribeGlobalClustersPaginator, + DescribeOrderableDBInstanceOptionsPaginator, + DescribePendingMaintenanceActionsPaginator, +) + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_db_cluster_endpoints_paginator: DescribeDBClusterEndpointsPaginator = client.get_paginator( + "describe_db_cluster_endpoints" +) +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_global_clusters_paginator: DescribeGlobalClustersPaginator = client.get_paginator( + "describe_global_clusters" +) +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") +) +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_neptune.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter, DBInstanceDeletedWaiter + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +db_instance_available_waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available") +db_instance_deleted_waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_neptune.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_neptune.literals import ( + ApplyMethodType, + DBInstanceAvailableWaiterName, + DBInstanceDeletedWaiterName, + DescribeDBClusterEndpointsPaginatorName, + DescribeDBClusterParameterGroupsPaginatorName, + DescribeDBClusterParametersPaginatorName, + DescribeDBClusterSnapshotsPaginatorName, + DescribeDBClustersPaginatorName, + DescribeDBEngineVersionsPaginatorName, + DescribeDBInstancesPaginatorName, + DescribeDBParameterGroupsPaginatorName, + DescribeDBParametersPaginatorName, + DescribeDBSubnetGroupsPaginatorName, + DescribeEngineDefaultParametersPaginatorName, + DescribeEventSubscriptionsPaginatorName, + DescribeEventsPaginatorName, + DescribeGlobalClustersPaginatorName, + DescribeOrderableDBInstanceOptionsPaginatorName, + DescribePendingMaintenanceActionsPaginatorName, + SourceTypeType, + NeptuneServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ApplyMethodType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_neptune.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_neptune.type_defs import ( + AddRoleToDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionMessageRequestTypeDef, + EventSubscriptionTypeDef, + ResponseMetadataTypeDef, + TagTypeDef, + ApplyPendingMaintenanceActionMessageRequestTypeDef, + AvailabilityZoneTypeDef, + CharacterSetTypeDef, + CloudwatchLogsExportConfigurationTypeDef, + PendingCloudwatchLogsExportsTypeDef, + DBClusterParameterGroupTypeDef, + DBClusterSnapshotTypeDef, + DBParameterGroupTypeDef, + ServerlessV2ScalingConfigurationTypeDef, + CreateGlobalClusterMessageRequestTypeDef, + DBClusterEndpointTypeDef, + DBClusterMemberTypeDef, + DBClusterOptionGroupStatusTypeDef, + ParameterTypeDef, + DBClusterRoleTypeDef, + DBClusterSnapshotAttributeTypeDef, + ServerlessV2ScalingConfigurationInfoTypeDef, + VpcSecurityGroupMembershipTypeDef, + TimezoneTypeDef, + UpgradeTargetTypeDef, + DBInstanceStatusInfoTypeDef, + DBParameterGroupStatusTypeDef, + DBSecurityGroupMembershipTypeDef, + DomainMembershipTypeDef, + EndpointTypeDef, + OptionGroupMembershipTypeDef, + DeleteDBClusterEndpointMessageRequestTypeDef, + DeleteDBClusterMessageRequestTypeDef, + DeleteDBClusterParameterGroupMessageRequestTypeDef, + DeleteDBClusterSnapshotMessageRequestTypeDef, + DeleteDBInstanceMessageRequestTypeDef, + DeleteDBParameterGroupMessageRequestTypeDef, + DeleteDBSubnetGroupMessageRequestTypeDef, + DeleteEventSubscriptionMessageRequestTypeDef, + DeleteGlobalClusterMessageRequestTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeDBClusterSnapshotAttributesMessageRequestTypeDef, + WaiterConfigTypeDef, + DescribeGlobalClustersMessageRequestTypeDef, + DescribeValidDBInstanceModificationsMessageRequestTypeDef, + DoubleRangeTypeDef, + EventCategoriesMapTypeDef, + EventTypeDef, + FailoverDBClusterMessageRequestTypeDef, + FailoverGlobalClusterMessageRequestTypeDef, + GlobalClusterMemberTypeDef, + ModifyDBClusterEndpointMessageRequestTypeDef, + ModifyDBClusterSnapshotAttributeMessageRequestTypeDef, + ModifyDBSubnetGroupMessageRequestTypeDef, + ModifyEventSubscriptionMessageRequestTypeDef, + ModifyGlobalClusterMessageRequestTypeDef, + PendingMaintenanceActionTypeDef, + PromoteReadReplicaDBClusterMessageRequestTypeDef, + RangeTypeDef, + RebootDBInstanceMessageRequestTypeDef, + RemoveFromGlobalClusterMessageRequestTypeDef, + RemoveRoleFromDBClusterMessageRequestTypeDef, + RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef, + RemoveTagsFromResourceMessageRequestTypeDef, + StartDBClusterMessageRequestTypeDef, + StopDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionResultTypeDef, + CreateDBClusterEndpointOutputTypeDef, + CreateEventSubscriptionResultTypeDef, + DBClusterParameterGroupNameMessageTypeDef, + DBParameterGroupNameMessageTypeDef, + DeleteDBClusterEndpointOutputTypeDef, + DeleteEventSubscriptionResultTypeDef, + EmptyResponseMetadataTypeDef, + EventSubscriptionsMessageTypeDef, + ModifyDBClusterEndpointOutputTypeDef, + ModifyEventSubscriptionResultTypeDef, + RemoveSourceIdentifierFromSubscriptionResultTypeDef, + AddTagsToResourceMessageRequestTypeDef, + CopyDBClusterParameterGroupMessageRequestTypeDef, + CopyDBClusterSnapshotMessageRequestTypeDef, + CopyDBParameterGroupMessageRequestTypeDef, + CreateDBClusterEndpointMessageRequestTypeDef, + CreateDBClusterParameterGroupMessageRequestTypeDef, + CreateDBClusterSnapshotMessageRequestTypeDef, + CreateDBInstanceMessageRequestTypeDef, + CreateDBParameterGroupMessageRequestTypeDef, + CreateDBSubnetGroupMessageRequestTypeDef, + CreateEventSubscriptionMessageRequestTypeDef, + TagListMessageTypeDef, + OrderableDBInstanceOptionTypeDef, + SubnetTypeDef, + ModifyDBInstanceMessageRequestTypeDef, + ClusterPendingModifiedValuesTypeDef, + PendingModifiedValuesTypeDef, + CopyDBClusterParameterGroupResultTypeDef, + CreateDBClusterParameterGroupResultTypeDef, + DBClusterParameterGroupsMessageTypeDef, + CopyDBClusterSnapshotResultTypeDef, + CreateDBClusterSnapshotResultTypeDef, + DBClusterSnapshotMessageTypeDef, + DeleteDBClusterSnapshotResultTypeDef, + CopyDBParameterGroupResultTypeDef, + CreateDBParameterGroupResultTypeDef, + DBParameterGroupsMessageTypeDef, + CreateDBClusterMessageRequestTypeDef, + ModifyDBClusterMessageRequestTypeDef, + RestoreDBClusterFromSnapshotMessageRequestTypeDef, + RestoreDBClusterToPointInTimeMessageRequestTypeDef, + DBClusterEndpointMessageTypeDef, + DBClusterParameterGroupDetailsTypeDef, + DBParameterGroupDetailsTypeDef, + EngineDefaultsTypeDef, + ModifyDBClusterParameterGroupMessageRequestTypeDef, + ModifyDBParameterGroupMessageRequestTypeDef, + ResetDBClusterParameterGroupMessageRequestTypeDef, + ResetDBParameterGroupMessageRequestTypeDef, + DBClusterSnapshotAttributesResultTypeDef, + DBEngineVersionTypeDef, + DescribeDBClusterEndpointsMessageRequestTypeDef, + DescribeDBClusterParameterGroupsMessageRequestTypeDef, + DescribeDBClusterParametersMessageRequestTypeDef, + DescribeDBClusterSnapshotsMessageRequestTypeDef, + DescribeDBClustersMessageRequestTypeDef, + DescribeDBEngineVersionsMessageRequestTypeDef, + DescribeDBInstancesMessageRequestTypeDef, + DescribeDBParameterGroupsMessageRequestTypeDef, + DescribeDBParametersMessageRequestTypeDef, + DescribeDBSubnetGroupsMessageRequestTypeDef, + DescribeEngineDefaultClusterParametersMessageRequestTypeDef, + DescribeEngineDefaultParametersMessageRequestTypeDef, + DescribeEventCategoriesMessageRequestTypeDef, + DescribeEventSubscriptionsMessageRequestTypeDef, + DescribeEventsMessageRequestTypeDef, + DescribeOrderableDBInstanceOptionsMessageRequestTypeDef, + DescribePendingMaintenanceActionsMessageRequestTypeDef, + ListTagsForResourceMessageRequestTypeDef, + DescribeDBClusterEndpointsMessageDescribeDBClusterEndpointsPaginateTypeDef, + DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef, + DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef, + DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef, + DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef, + DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef, + DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef, + DescribeDBParameterGroupsMessageDescribeDBParameterGroupsPaginateTypeDef, + DescribeDBParametersMessageDescribeDBParametersPaginateTypeDef, + DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef, + DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef, + DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef, + DescribeEventsMessageDescribeEventsPaginateTypeDef, + DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef, + DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef, + DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef, + DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef, + DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef, + EventCategoriesMessageTypeDef, + EventsMessageTypeDef, + GlobalClusterTypeDef, + ResourcePendingMaintenanceActionsTypeDef, + ValidStorageOptionsTypeDef, + OrderableDBInstanceOptionsMessageTypeDef, + DBSubnetGroupTypeDef, + DBClusterTypeDef, + DescribeEngineDefaultClusterParametersResultTypeDef, + DescribeEngineDefaultParametersResultTypeDef, + DescribeDBClusterSnapshotAttributesResultTypeDef, + ModifyDBClusterSnapshotAttributeResultTypeDef, + DBEngineVersionMessageTypeDef, + CreateGlobalClusterResultTypeDef, + DeleteGlobalClusterResultTypeDef, + FailoverGlobalClusterResultTypeDef, + GlobalClustersMessageTypeDef, + ModifyGlobalClusterResultTypeDef, + RemoveFromGlobalClusterResultTypeDef, + ApplyPendingMaintenanceActionResultTypeDef, + PendingMaintenanceActionsMessageTypeDef, + ValidDBInstanceModificationsMessageTypeDef, + CreateDBSubnetGroupResultTypeDef, + DBInstanceTypeDef, + DBSubnetGroupMessageTypeDef, + ModifyDBSubnetGroupResultTypeDef, + CreateDBClusterResultTypeDef, + DBClusterMessageTypeDef, + DeleteDBClusterResultTypeDef, + FailoverDBClusterResultTypeDef, + ModifyDBClusterResultTypeDef, + PromoteReadReplicaDBClusterResultTypeDef, + RestoreDBClusterFromSnapshotResultTypeDef, + RestoreDBClusterToPointInTimeResultTypeDef, + StartDBClusterResultTypeDef, + StopDBClusterResultTypeDef, + DescribeValidDBInstanceModificationsResultTypeDef, + CreateDBInstanceResultTypeDef, + DBInstanceMessageTypeDef, + DeleteDBInstanceResultTypeDef, + ModifyDBInstanceResultTypeDef, + RebootDBInstanceResultTypeDef, +) + + +def get_structure() -> AddRoleToDBClusterMessageRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-neptune` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-neptune +Summary: Type annotations for boto3.Neptune 1.26.95 service generated with mypy-boto3-builder 7.13.0 +Provides: python-mypy-boto3-neptune +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-neptune +<a id="mypy-boto3-neptune"></a> + +# mypy-boto3-neptune + +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-neptune) + + + +Type annotations for +[boto3.Neptune 1.26.95](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune.html#Neptune) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-neptune docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-neptune](#mypy-boto3-neptune) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Neptune`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Neptune` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[neptune]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[neptune]' + + +# standalone installation +python -m pip install mypy-boto3-neptune +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-neptune +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[neptune]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[neptune]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`NeptuneClient` provides annotations for `boto3.client("neptune")`. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient + +client: NeptuneClient = Session().client("neptune") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_neptune.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.paginator import ( + DescribeDBClusterEndpointsPaginator, + DescribeDBClusterParameterGroupsPaginator, + DescribeDBClusterParametersPaginator, + DescribeDBClusterSnapshotsPaginator, + DescribeDBClustersPaginator, + DescribeDBEngineVersionsPaginator, + DescribeDBInstancesPaginator, + DescribeDBParameterGroupsPaginator, + DescribeDBParametersPaginator, + DescribeDBSubnetGroupsPaginator, + DescribeEngineDefaultParametersPaginator, + DescribeEventSubscriptionsPaginator, + DescribeEventsPaginator, + DescribeGlobalClustersPaginator, + DescribeOrderableDBInstanceOptionsPaginator, + DescribePendingMaintenanceActionsPaginator, +) + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_db_cluster_endpoints_paginator: DescribeDBClusterEndpointsPaginator = client.get_paginator( + "describe_db_cluster_endpoints" +) +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_global_clusters_paginator: DescribeGlobalClustersPaginator = client.get_paginator( + "describe_global_clusters" +) +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") +) +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_neptune.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter, DBInstanceDeletedWaiter + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +db_instance_available_waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available") +db_instance_deleted_waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_neptune.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_neptune.literals import ( + ApplyMethodType, + DBInstanceAvailableWaiterName, + DBInstanceDeletedWaiterName, + DescribeDBClusterEndpointsPaginatorName, + DescribeDBClusterParameterGroupsPaginatorName, + DescribeDBClusterParametersPaginatorName, + DescribeDBClusterSnapshotsPaginatorName, + DescribeDBClustersPaginatorName, + DescribeDBEngineVersionsPaginatorName, + DescribeDBInstancesPaginatorName, + DescribeDBParameterGroupsPaginatorName, + DescribeDBParametersPaginatorName, + DescribeDBSubnetGroupsPaginatorName, + DescribeEngineDefaultParametersPaginatorName, + DescribeEventSubscriptionsPaginatorName, + DescribeEventsPaginatorName, + DescribeGlobalClustersPaginatorName, + DescribeOrderableDBInstanceOptionsPaginatorName, + DescribePendingMaintenanceActionsPaginatorName, + SourceTypeType, + NeptuneServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ApplyMethodType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_neptune.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_neptune.type_defs import ( + AddRoleToDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionMessageRequestTypeDef, + EventSubscriptionTypeDef, + ResponseMetadataTypeDef, + TagTypeDef, + ApplyPendingMaintenanceActionMessageRequestTypeDef, + AvailabilityZoneTypeDef, + CharacterSetTypeDef, + CloudwatchLogsExportConfigurationTypeDef, + PendingCloudwatchLogsExportsTypeDef, + DBClusterParameterGroupTypeDef, + DBClusterSnapshotTypeDef, + DBParameterGroupTypeDef, + ServerlessV2ScalingConfigurationTypeDef, + CreateGlobalClusterMessageRequestTypeDef, + DBClusterEndpointTypeDef, + DBClusterMemberTypeDef, + DBClusterOptionGroupStatusTypeDef, + ParameterTypeDef, + DBClusterRoleTypeDef, + DBClusterSnapshotAttributeTypeDef, + ServerlessV2ScalingConfigurationInfoTypeDef, + VpcSecurityGroupMembershipTypeDef, + TimezoneTypeDef, + UpgradeTargetTypeDef, + DBInstanceStatusInfoTypeDef, + DBParameterGroupStatusTypeDef, + DBSecurityGroupMembershipTypeDef, + DomainMembershipTypeDef, + EndpointTypeDef, + OptionGroupMembershipTypeDef, + DeleteDBClusterEndpointMessageRequestTypeDef, + DeleteDBClusterMessageRequestTypeDef, + DeleteDBClusterParameterGroupMessageRequestTypeDef, + DeleteDBClusterSnapshotMessageRequestTypeDef, + DeleteDBInstanceMessageRequestTypeDef, + DeleteDBParameterGroupMessageRequestTypeDef, + DeleteDBSubnetGroupMessageRequestTypeDef, + DeleteEventSubscriptionMessageRequestTypeDef, + DeleteGlobalClusterMessageRequestTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeDBClusterSnapshotAttributesMessageRequestTypeDef, + WaiterConfigTypeDef, + DescribeGlobalClustersMessageRequestTypeDef, + DescribeValidDBInstanceModificationsMessageRequestTypeDef, + DoubleRangeTypeDef, + EventCategoriesMapTypeDef, + EventTypeDef, + FailoverDBClusterMessageRequestTypeDef, + FailoverGlobalClusterMessageRequestTypeDef, + GlobalClusterMemberTypeDef, + ModifyDBClusterEndpointMessageRequestTypeDef, + ModifyDBClusterSnapshotAttributeMessageRequestTypeDef, + ModifyDBSubnetGroupMessageRequestTypeDef, + ModifyEventSubscriptionMessageRequestTypeDef, + ModifyGlobalClusterMessageRequestTypeDef, + PendingMaintenanceActionTypeDef, + PromoteReadReplicaDBClusterMessageRequestTypeDef, + RangeTypeDef, + RebootDBInstanceMessageRequestTypeDef, + RemoveFromGlobalClusterMessageRequestTypeDef, + RemoveRoleFromDBClusterMessageRequestTypeDef, + RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef, + RemoveTagsFromResourceMessageRequestTypeDef, + StartDBClusterMessageRequestTypeDef, + StopDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionResultTypeDef, + CreateDBClusterEndpointOutputTypeDef, + CreateEventSubscriptionResultTypeDef, + DBClusterParameterGroupNameMessageTypeDef, + DBParameterGroupNameMessageTypeDef, + DeleteDBClusterEndpointOutputTypeDef, + DeleteEventSubscriptionResultTypeDef, + EmptyResponseMetadataTypeDef, + EventSubscriptionsMessageTypeDef, + ModifyDBClusterEndpointOutputTypeDef, + ModifyEventSubscriptionResultTypeDef, + RemoveSourceIdentifierFromSubscriptionResultTypeDef, + AddTagsToResourceMessageRequestTypeDef, + CopyDBClusterParameterGroupMessageRequestTypeDef, + CopyDBClusterSnapshotMessageRequestTypeDef, + CopyDBParameterGroupMessageRequestTypeDef, + CreateDBClusterEndpointMessageRequestTypeDef, + CreateDBClusterParameterGroupMessageRequestTypeDef, + CreateDBClusterSnapshotMessageRequestTypeDef, + CreateDBInstanceMessageRequestTypeDef, + CreateDBParameterGroupMessageRequestTypeDef, + CreateDBSubnetGroupMessageRequestTypeDef, + CreateEventSubscriptionMessageRequestTypeDef, + TagListMessageTypeDef, + OrderableDBInstanceOptionTypeDef, + SubnetTypeDef, + ModifyDBInstanceMessageRequestTypeDef, + ClusterPendingModifiedValuesTypeDef, + PendingModifiedValuesTypeDef, + CopyDBClusterParameterGroupResultTypeDef, + CreateDBClusterParameterGroupResultTypeDef, + DBClusterParameterGroupsMessageTypeDef, + CopyDBClusterSnapshotResultTypeDef, + CreateDBClusterSnapshotResultTypeDef, + DBClusterSnapshotMessageTypeDef, + DeleteDBClusterSnapshotResultTypeDef, + CopyDBParameterGroupResultTypeDef, + CreateDBParameterGroupResultTypeDef, + DBParameterGroupsMessageTypeDef, + CreateDBClusterMessageRequestTypeDef, + ModifyDBClusterMessageRequestTypeDef, + RestoreDBClusterFromSnapshotMessageRequestTypeDef, + RestoreDBClusterToPointInTimeMessageRequestTypeDef, + DBClusterEndpointMessageTypeDef, + DBClusterParameterGroupDetailsTypeDef, + DBParameterGroupDetailsTypeDef, + EngineDefaultsTypeDef, + ModifyDBClusterParameterGroupMessageRequestTypeDef, + ModifyDBParameterGroupMessageRequestTypeDef, + ResetDBClusterParameterGroupMessageRequestTypeDef, + ResetDBParameterGroupMessageRequestTypeDef, + DBClusterSnapshotAttributesResultTypeDef, + DBEngineVersionTypeDef, + DescribeDBClusterEndpointsMessageRequestTypeDef, + DescribeDBClusterParameterGroupsMessageRequestTypeDef, + DescribeDBClusterParametersMessageRequestTypeDef, + DescribeDBClusterSnapshotsMessageRequestTypeDef, + DescribeDBClustersMessageRequestTypeDef, + DescribeDBEngineVersionsMessageRequestTypeDef, + DescribeDBInstancesMessageRequestTypeDef, + DescribeDBParameterGroupsMessageRequestTypeDef, + DescribeDBParametersMessageRequestTypeDef, + DescribeDBSubnetGroupsMessageRequestTypeDef, + DescribeEngineDefaultClusterParametersMessageRequestTypeDef, + DescribeEngineDefaultParametersMessageRequestTypeDef, + DescribeEventCategoriesMessageRequestTypeDef, + DescribeEventSubscriptionsMessageRequestTypeDef, + DescribeEventsMessageRequestTypeDef, + DescribeOrderableDBInstanceOptionsMessageRequestTypeDef, + DescribePendingMaintenanceActionsMessageRequestTypeDef, + ListTagsForResourceMessageRequestTypeDef, + DescribeDBClusterEndpointsMessageDescribeDBClusterEndpointsPaginateTypeDef, + DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef, + DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef, + DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef, + DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef, + DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef, + DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef, + DescribeDBParameterGroupsMessageDescribeDBParameterGroupsPaginateTypeDef, + DescribeDBParametersMessageDescribeDBParametersPaginateTypeDef, + DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef, + DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef, + DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef, + DescribeEventsMessageDescribeEventsPaginateTypeDef, + DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef, + DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef, + DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef, + DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef, + DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef, + EventCategoriesMessageTypeDef, + EventsMessageTypeDef, + GlobalClusterTypeDef, + ResourcePendingMaintenanceActionsTypeDef, + ValidStorageOptionsTypeDef, + OrderableDBInstanceOptionsMessageTypeDef, + DBSubnetGroupTypeDef, + DBClusterTypeDef, + DescribeEngineDefaultClusterParametersResultTypeDef, + DescribeEngineDefaultParametersResultTypeDef, + DescribeDBClusterSnapshotAttributesResultTypeDef, + ModifyDBClusterSnapshotAttributeResultTypeDef, + DBEngineVersionMessageTypeDef, + CreateGlobalClusterResultTypeDef, + DeleteGlobalClusterResultTypeDef, + FailoverGlobalClusterResultTypeDef, + GlobalClustersMessageTypeDef, + ModifyGlobalClusterResultTypeDef, + RemoveFromGlobalClusterResultTypeDef, + ApplyPendingMaintenanceActionResultTypeDef, + PendingMaintenanceActionsMessageTypeDef, + ValidDBInstanceModificationsMessageTypeDef, + CreateDBSubnetGroupResultTypeDef, + DBInstanceTypeDef, + DBSubnetGroupMessageTypeDef, + ModifyDBSubnetGroupResultTypeDef, + CreateDBClusterResultTypeDef, + DBClusterMessageTypeDef, + DeleteDBClusterResultTypeDef, + FailoverDBClusterResultTypeDef, + ModifyDBClusterResultTypeDef, + PromoteReadReplicaDBClusterResultTypeDef, + RestoreDBClusterFromSnapshotResultTypeDef, + RestoreDBClusterToPointInTimeResultTypeDef, + StartDBClusterResultTypeDef, + StopDBClusterResultTypeDef, + DescribeValidDBInstanceModificationsResultTypeDef, + CreateDBInstanceResultTypeDef, + DBInstanceMessageTypeDef, + DeleteDBInstanceResultTypeDef, + ModifyDBInstanceResultTypeDef, + RebootDBInstanceResultTypeDef, +) + + +def get_structure() -> AddRoleToDBClusterMessageRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-neptune` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-neptune +Provides: python3-mypy-boto3-neptune-doc +%description help +<a id="mypy-boto3-neptune"></a> + +# mypy-boto3-neptune + +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://pypi.org/project/mypy-boto3-neptune) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-neptune) + + + +Type annotations for +[boto3.Neptune 1.26.95](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/neptune.html#Neptune) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-neptune docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-neptune](#mypy-boto3-neptune) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `Neptune`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `Neptune` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[neptune]' + + +# Lite version does not provide session.client/resource overloads +# it is more RAM-friendly, but requires explicit type annotations +python -m pip install 'boto3-stubs-lite[neptune]' + + +# standalone installation +python -m pip install mypy-boto3-neptune +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-neptune +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[neptune]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[neptune]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[neptune]` in your environment: + +```bash +python -m pip install 'boto3-stubs[neptune]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`NeptuneClient` provides annotations for `boto3.client("neptune")`. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient + +client: NeptuneClient = Session().client("neptune") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_neptune.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.paginator import ( + DescribeDBClusterEndpointsPaginator, + DescribeDBClusterParameterGroupsPaginator, + DescribeDBClusterParametersPaginator, + DescribeDBClusterSnapshotsPaginator, + DescribeDBClustersPaginator, + DescribeDBEngineVersionsPaginator, + DescribeDBInstancesPaginator, + DescribeDBParameterGroupsPaginator, + DescribeDBParametersPaginator, + DescribeDBSubnetGroupsPaginator, + DescribeEngineDefaultParametersPaginator, + DescribeEventSubscriptionsPaginator, + DescribeEventsPaginator, + DescribeGlobalClustersPaginator, + DescribeOrderableDBInstanceOptionsPaginator, + DescribePendingMaintenanceActionsPaginator, +) + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +describe_db_cluster_endpoints_paginator: DescribeDBClusterEndpointsPaginator = client.get_paginator( + "describe_db_cluster_endpoints" +) +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_global_clusters_paginator: DescribeGlobalClustersPaginator = client.get_paginator( + "describe_global_clusters" +) +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") +) +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_neptune.waiter` module contains type annotations for all waiters. + +```python +from boto3.session import Session + +from mypy_boto3_neptune import NeptuneClient +from mypy_boto3_neptune.waiter import DBInstanceAvailableWaiter, DBInstanceDeletedWaiter + +client: NeptuneClient = Session().client("neptune") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +db_instance_available_waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available") +db_instance_deleted_waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_neptune.literals` module contains literals extracted from shapes +that can be used in user code for type checking. + +```python +from mypy_boto3_neptune.literals import ( + ApplyMethodType, + DBInstanceAvailableWaiterName, + DBInstanceDeletedWaiterName, + DescribeDBClusterEndpointsPaginatorName, + DescribeDBClusterParameterGroupsPaginatorName, + DescribeDBClusterParametersPaginatorName, + DescribeDBClusterSnapshotsPaginatorName, + DescribeDBClustersPaginatorName, + DescribeDBEngineVersionsPaginatorName, + DescribeDBInstancesPaginatorName, + DescribeDBParameterGroupsPaginatorName, + DescribeDBParametersPaginatorName, + DescribeDBSubnetGroupsPaginatorName, + DescribeEngineDefaultParametersPaginatorName, + DescribeEventSubscriptionsPaginatorName, + DescribeEventsPaginatorName, + DescribeGlobalClustersPaginatorName, + DescribeOrderableDBInstanceOptionsPaginatorName, + DescribePendingMaintenanceActionsPaginatorName, + SourceTypeType, + NeptuneServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + WaiterName, + RegionName, +) + + +def check_value(value: ApplyMethodType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_neptune.type_defs` module contains structures and shapes assembled +to typed dictionaries for additional type checking. + +```python +from mypy_boto3_neptune.type_defs import ( + AddRoleToDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionMessageRequestTypeDef, + EventSubscriptionTypeDef, + ResponseMetadataTypeDef, + TagTypeDef, + ApplyPendingMaintenanceActionMessageRequestTypeDef, + AvailabilityZoneTypeDef, + CharacterSetTypeDef, + CloudwatchLogsExportConfigurationTypeDef, + PendingCloudwatchLogsExportsTypeDef, + DBClusterParameterGroupTypeDef, + DBClusterSnapshotTypeDef, + DBParameterGroupTypeDef, + ServerlessV2ScalingConfigurationTypeDef, + CreateGlobalClusterMessageRequestTypeDef, + DBClusterEndpointTypeDef, + DBClusterMemberTypeDef, + DBClusterOptionGroupStatusTypeDef, + ParameterTypeDef, + DBClusterRoleTypeDef, + DBClusterSnapshotAttributeTypeDef, + ServerlessV2ScalingConfigurationInfoTypeDef, + VpcSecurityGroupMembershipTypeDef, + TimezoneTypeDef, + UpgradeTargetTypeDef, + DBInstanceStatusInfoTypeDef, + DBParameterGroupStatusTypeDef, + DBSecurityGroupMembershipTypeDef, + DomainMembershipTypeDef, + EndpointTypeDef, + OptionGroupMembershipTypeDef, + DeleteDBClusterEndpointMessageRequestTypeDef, + DeleteDBClusterMessageRequestTypeDef, + DeleteDBClusterParameterGroupMessageRequestTypeDef, + DeleteDBClusterSnapshotMessageRequestTypeDef, + DeleteDBInstanceMessageRequestTypeDef, + DeleteDBParameterGroupMessageRequestTypeDef, + DeleteDBSubnetGroupMessageRequestTypeDef, + DeleteEventSubscriptionMessageRequestTypeDef, + DeleteGlobalClusterMessageRequestTypeDef, + FilterTypeDef, + PaginatorConfigTypeDef, + DescribeDBClusterSnapshotAttributesMessageRequestTypeDef, + WaiterConfigTypeDef, + DescribeGlobalClustersMessageRequestTypeDef, + DescribeValidDBInstanceModificationsMessageRequestTypeDef, + DoubleRangeTypeDef, + EventCategoriesMapTypeDef, + EventTypeDef, + FailoverDBClusterMessageRequestTypeDef, + FailoverGlobalClusterMessageRequestTypeDef, + GlobalClusterMemberTypeDef, + ModifyDBClusterEndpointMessageRequestTypeDef, + ModifyDBClusterSnapshotAttributeMessageRequestTypeDef, + ModifyDBSubnetGroupMessageRequestTypeDef, + ModifyEventSubscriptionMessageRequestTypeDef, + ModifyGlobalClusterMessageRequestTypeDef, + PendingMaintenanceActionTypeDef, + PromoteReadReplicaDBClusterMessageRequestTypeDef, + RangeTypeDef, + RebootDBInstanceMessageRequestTypeDef, + RemoveFromGlobalClusterMessageRequestTypeDef, + RemoveRoleFromDBClusterMessageRequestTypeDef, + RemoveSourceIdentifierFromSubscriptionMessageRequestTypeDef, + RemoveTagsFromResourceMessageRequestTypeDef, + StartDBClusterMessageRequestTypeDef, + StopDBClusterMessageRequestTypeDef, + AddSourceIdentifierToSubscriptionResultTypeDef, + CreateDBClusterEndpointOutputTypeDef, + CreateEventSubscriptionResultTypeDef, + DBClusterParameterGroupNameMessageTypeDef, + DBParameterGroupNameMessageTypeDef, + DeleteDBClusterEndpointOutputTypeDef, + DeleteEventSubscriptionResultTypeDef, + EmptyResponseMetadataTypeDef, + EventSubscriptionsMessageTypeDef, + ModifyDBClusterEndpointOutputTypeDef, + ModifyEventSubscriptionResultTypeDef, + RemoveSourceIdentifierFromSubscriptionResultTypeDef, + AddTagsToResourceMessageRequestTypeDef, + CopyDBClusterParameterGroupMessageRequestTypeDef, + CopyDBClusterSnapshotMessageRequestTypeDef, + CopyDBParameterGroupMessageRequestTypeDef, + CreateDBClusterEndpointMessageRequestTypeDef, + CreateDBClusterParameterGroupMessageRequestTypeDef, + CreateDBClusterSnapshotMessageRequestTypeDef, + CreateDBInstanceMessageRequestTypeDef, + CreateDBParameterGroupMessageRequestTypeDef, + CreateDBSubnetGroupMessageRequestTypeDef, + CreateEventSubscriptionMessageRequestTypeDef, + TagListMessageTypeDef, + OrderableDBInstanceOptionTypeDef, + SubnetTypeDef, + ModifyDBInstanceMessageRequestTypeDef, + ClusterPendingModifiedValuesTypeDef, + PendingModifiedValuesTypeDef, + CopyDBClusterParameterGroupResultTypeDef, + CreateDBClusterParameterGroupResultTypeDef, + DBClusterParameterGroupsMessageTypeDef, + CopyDBClusterSnapshotResultTypeDef, + CreateDBClusterSnapshotResultTypeDef, + DBClusterSnapshotMessageTypeDef, + DeleteDBClusterSnapshotResultTypeDef, + CopyDBParameterGroupResultTypeDef, + CreateDBParameterGroupResultTypeDef, + DBParameterGroupsMessageTypeDef, + CreateDBClusterMessageRequestTypeDef, + ModifyDBClusterMessageRequestTypeDef, + RestoreDBClusterFromSnapshotMessageRequestTypeDef, + RestoreDBClusterToPointInTimeMessageRequestTypeDef, + DBClusterEndpointMessageTypeDef, + DBClusterParameterGroupDetailsTypeDef, + DBParameterGroupDetailsTypeDef, + EngineDefaultsTypeDef, + ModifyDBClusterParameterGroupMessageRequestTypeDef, + ModifyDBParameterGroupMessageRequestTypeDef, + ResetDBClusterParameterGroupMessageRequestTypeDef, + ResetDBParameterGroupMessageRequestTypeDef, + DBClusterSnapshotAttributesResultTypeDef, + DBEngineVersionTypeDef, + DescribeDBClusterEndpointsMessageRequestTypeDef, + DescribeDBClusterParameterGroupsMessageRequestTypeDef, + DescribeDBClusterParametersMessageRequestTypeDef, + DescribeDBClusterSnapshotsMessageRequestTypeDef, + DescribeDBClustersMessageRequestTypeDef, + DescribeDBEngineVersionsMessageRequestTypeDef, + DescribeDBInstancesMessageRequestTypeDef, + DescribeDBParameterGroupsMessageRequestTypeDef, + DescribeDBParametersMessageRequestTypeDef, + DescribeDBSubnetGroupsMessageRequestTypeDef, + DescribeEngineDefaultClusterParametersMessageRequestTypeDef, + DescribeEngineDefaultParametersMessageRequestTypeDef, + DescribeEventCategoriesMessageRequestTypeDef, + DescribeEventSubscriptionsMessageRequestTypeDef, + DescribeEventsMessageRequestTypeDef, + DescribeOrderableDBInstanceOptionsMessageRequestTypeDef, + DescribePendingMaintenanceActionsMessageRequestTypeDef, + ListTagsForResourceMessageRequestTypeDef, + DescribeDBClusterEndpointsMessageDescribeDBClusterEndpointsPaginateTypeDef, + DescribeDBClusterParameterGroupsMessageDescribeDBClusterParameterGroupsPaginateTypeDef, + DescribeDBClusterParametersMessageDescribeDBClusterParametersPaginateTypeDef, + DescribeDBClusterSnapshotsMessageDescribeDBClusterSnapshotsPaginateTypeDef, + DescribeDBClustersMessageDescribeDBClustersPaginateTypeDef, + DescribeDBEngineVersionsMessageDescribeDBEngineVersionsPaginateTypeDef, + DescribeDBInstancesMessageDescribeDBInstancesPaginateTypeDef, + DescribeDBParameterGroupsMessageDescribeDBParameterGroupsPaginateTypeDef, + DescribeDBParametersMessageDescribeDBParametersPaginateTypeDef, + DescribeDBSubnetGroupsMessageDescribeDBSubnetGroupsPaginateTypeDef, + DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef, + DescribeEventSubscriptionsMessageDescribeEventSubscriptionsPaginateTypeDef, + DescribeEventsMessageDescribeEventsPaginateTypeDef, + DescribeGlobalClustersMessageDescribeGlobalClustersPaginateTypeDef, + DescribeOrderableDBInstanceOptionsMessageDescribeOrderableDBInstanceOptionsPaginateTypeDef, + DescribePendingMaintenanceActionsMessageDescribePendingMaintenanceActionsPaginateTypeDef, + DescribeDBInstancesMessageDBInstanceAvailableWaitTypeDef, + DescribeDBInstancesMessageDBInstanceDeletedWaitTypeDef, + EventCategoriesMessageTypeDef, + EventsMessageTypeDef, + GlobalClusterTypeDef, + ResourcePendingMaintenanceActionsTypeDef, + ValidStorageOptionsTypeDef, + OrderableDBInstanceOptionsMessageTypeDef, + DBSubnetGroupTypeDef, + DBClusterTypeDef, + DescribeEngineDefaultClusterParametersResultTypeDef, + DescribeEngineDefaultParametersResultTypeDef, + DescribeDBClusterSnapshotAttributesResultTypeDef, + ModifyDBClusterSnapshotAttributeResultTypeDef, + DBEngineVersionMessageTypeDef, + CreateGlobalClusterResultTypeDef, + DeleteGlobalClusterResultTypeDef, + FailoverGlobalClusterResultTypeDef, + GlobalClustersMessageTypeDef, + ModifyGlobalClusterResultTypeDef, + RemoveFromGlobalClusterResultTypeDef, + ApplyPendingMaintenanceActionResultTypeDef, + PendingMaintenanceActionsMessageTypeDef, + ValidDBInstanceModificationsMessageTypeDef, + CreateDBSubnetGroupResultTypeDef, + DBInstanceTypeDef, + DBSubnetGroupMessageTypeDef, + ModifyDBSubnetGroupResultTypeDef, + CreateDBClusterResultTypeDef, + DBClusterMessageTypeDef, + DeleteDBClusterResultTypeDef, + FailoverDBClusterResultTypeDef, + ModifyDBClusterResultTypeDef, + PromoteReadReplicaDBClusterResultTypeDef, + RestoreDBClusterFromSnapshotResultTypeDef, + RestoreDBClusterToPointInTimeResultTypeDef, + StartDBClusterResultTypeDef, + StopDBClusterResultTypeDef, + DescribeValidDBInstanceModificationsResultTypeDef, + CreateDBInstanceResultTypeDef, + DBInstanceMessageTypeDef, + DeleteDBInstanceResultTypeDef, + ModifyDBInstanceResultTypeDef, + RebootDBInstanceResultTypeDef, +) + + +def get_structure() -> AddRoleToDBClusterMessageRequestTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-neptune` version is the same as related `boto3` version and follows +[PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_neptune/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-neptune-1.26.95 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-neptune -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.95-1 +- Package Spec generated @@ -0,0 +1 @@ +bcc44a803c11799d807be364757af7ce mypy-boto3-neptune-1.26.95.tar.gz |