Install & Compatibility
Where this runs
tested against v1.43.28 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.910 runs
installs and imports cleanly · install 0.0s · import 0.000s · 20MB
glibcpy 3.10–3.910 runs
installs and imports cleanly · install 3.4s · import 0.000s · 21MB
18MB installed
● package 18MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
NeptuneClient
✓ from mypy_boto3_neptune import NeptuneClient
✗ from mypy_boto3_neptune import NeptuneClient
This quickstart demonstrates how to obtain a type-hinted AWS Neptune client using `boto3` and `mypy-boto3-neptune`. The `TYPE_CHECKING` block ensures that the type import is only used during static analysis, avoiding runtime dependencies. The client will automatically use AWS credentials configured in your environment.
import boto3
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from mypy_boto3_neptune.client import NeptuneClient
def get_neptune_client() -> NeptuneClient:
"""Gets a typed Neptune client."""
# boto3 automatically picks up credentials from environment variables or ~/.aws/credentials
client: NeptuneClient = boto3.client("neptune")
return client
if __name__ == "__main__":
neptune_client = get_neptune_client()
# Example usage (uncomment to run, requires AWS credentials)
# try:
# response = neptune_client.describe_db_instances()
# print("Neptune DB Instances:")
# for db_instance in response.get("DBInstances", []):
# print(f"- {db_instance['DBInstanceIdentifier']}")
# except Exception as e:
# print(f"Error describing DB instances: {e}")
print(f"Successfully retrieved Neptune client: {neptune_client.__class__.__name__}")
Debug
Known issues
breakingStarting with `mypy-boto3-builder` version 8.12.0 (which generates these stubs), Python 3.8 is no longer supported. Projects must use Python 3.9 or newer.fixUpgrade your Python environment to 3.9 or later. If you need Python 3.8 support, pin `mypy-boto3-builder` to `<8.12.0` and ensure your `mypy-boto3-neptune` version is compatible with an older builder.
affects: mypy-boto3-builder >=8.12.0 (affects all generated stubs)
breakingThe `mypy-boto3-builder` (from version 8.12.0) migrated to PEP 561 package format, which may change how some environments or older type checkers discover and interpret the stubs. Ensure your type checker is up-to-date.fixUpdate your type checker (e.g., `mypy`) to a recent version. If encountering issues, verify package installation and type checker configuration.
affects: mypy-boto3-builder >=8.12.0 (affects all generated stubs)
gotchaFor optimal autocomplete and type checking in some IDEs (like older VSCode or PyCharm without the `mypy` plugin configured optimally), explicit type annotations for `boto3.client()` and `boto3.resource()` calls are highly recommended or even necessary.fixAlways use explicit type annotations, e.g., `client: NeptuneClient = boto3.client("neptune")`, as shown in the quickstart. affects: All versions
gotchaPylint might report `undefined variable` warnings when using `TYPE_CHECKING` guards. This is a known compatibility issue.fixTo fix this, set all type-imported variables to `object` in the `else` block of your `TYPE_CHECKING` guard: `if TYPE_CHECKING: from mypy_boto3_neptune.client import NeptuneClient else: NeptuneClient = object`.
affects: All versions with Pylint
breakingIn `mypy-boto3-builder` 8.9.0, there were breaking changes to the naming conventions of TypeDefs (e.g., shorter names for packed method arguments, `Extra` postfix moved to the end). This could affect users who directly import and use generated TypeDefs.fixReview your code for direct imports of TypeDefs and update their names according to the new conventions as needed.
affects: mypy-boto3-builder >=8.9.0 (affects generated TypeDefs)
Upgrade
Version history
1.43.28latest on PyPI · released Jun 11, 2026
Audit
Dependencies
boto3requiredProvides runtime functionality; mypy-boto3-neptune provides type hints for this library.
mypy-boto3-builderoptionalThe tool used to generate these type annotations; relevant if generating stubs locally or understanding versioning.