mypy-boto3-neptunedata Type Annotations

Warnings

• breaking Support for Python 3.8 was removed. Projects requiring type annotations for `boto3` will need to upgrade to Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher. For older Python versions, use an older `mypy-boto3-neptunedata` release (e.g., from builder < 8.12.0).
• breaking The builder migrated to PEP 561 compliant packages. While beneficial, this might impact how `mypy` or other tooling discovers and processes these stubs if they relied on specific older package structures or `mypy` configurations.
  Fix: Ensure your `mypy` and environment are up-to-date. If issues arise, verify `mypy`'s `package_data` or `namespace_packages` configuration.
• breaking TypeDefs for packed method arguments use shorter names if possible, and conflicting TypeDef `Extra` postfix moved to the end. This can break code that directly imported or referenced these specific TypeDef names.
  Fix: Review your code for direct imports of specific `*_RequestTypeDef` or `*_ExtraRequestTypeDef` names and adjust to the new naming conventions if they clash. Consult the generated stub files for the correct names.
• gotcha This library provides type stubs only. You must also install the `boto3` runtime library for your application to function at runtime. `mypy-boto3-neptunedata` is not a replacement for `boto3`.
  Fix: Ensure `pip install boto3` is part of your project's dependencies.
• gotcha For optimal type checking accuracy, the `mypy-boto3-neptunedata` package version should ideally align closely with your installed `boto3` version. Significant version mismatches can lead to incorrect type hints due to API differences.
  Fix: Regularly update both `boto3` and `mypy-boto3-neptunedata` to their latest compatible versions. The `mypy-boto3` documentation often provides guidance on version compatibility.

Install

• pip install mypy-boto3-neptunedata Install service stubs
• pip install boto3 Install runtime dependency (if not already present)
• pip install mypy Install type checker (if not already present)

Imports

• NeptuneDataClient

  from mypy_boto3_neptunedata.client import NeptuneDataClient

  The typed client must be imported from the mypy-boto3 package, not directly from boto3's runtime package.
• ListGremlinQueriesOutputTypeDef

  from mypy_boto3_neptunedata.type_defs import ListGremlinQueriesOutputTypeDef

  Type definitions are specific to the mypy-boto3 stubs and reside in the .type_defs submodule.

Quickstart

This quickstart demonstrates how to initialize a type-hinted `boto3` client for the NeptuneData service and use it with type-safe operations. It highlights how response structures are automatically typed, allowing for static analysis by `mypy`. Remember that `boto3` itself needs to be installed, and AWS credentials configured for actual execution.

import boto3
from mypy_boto3_neptunedata.client import NeptuneDataClient
from mypy_boto3_neptunedata.type_defs import (
    ListGremlinQueriesOutputTypeDef,
    GremlinQueryStatusTypeDef
)
import os

def get_neptune_query_status() -> ListGremlinQueriesOutputTypeDef:
    """
    Demonstrates using typed boto3 client for NeptuneData service.
    Requires 'boto3' and 'mypy-boto3-neptunedata' installed.
    """
    # Create a typed NeptuneData client
    client: NeptuneDataClient = boto3.client(
        "neptunedata",
        region_name=os.environ.get("AWS_REGION", "us-east-1")
    )

    # Example: List active Gremlin queries
    # The return type will be correctly inferred as ListGremlinQueriesOutputTypeDef
    response = client.list_gremlin_queries(
        includeWaitingQueries=True
    )

    # Type checking ensures correct access to dictionary keys and values
    for query in response.get("queries", []):
        status: GremlinQueryStatusTypeDef = query.get("status")
        query_id: str = query.get("queryId")
        print(f"Query ID: {query_id}, Status: {status}")

    return response

# To type-check this code, run `mypy your_script.py`
# To run this code, ensure AWS credentials are configured for your environment.
# if __name__ == "__main__":
#     try:
#         result = get_neptune_query_status()
#         print(f"Listed {len(result.get('queries', []))} queries.")
#     except Exception as e:
#         print(f"Error calling NeptuneData: {e}")