mypy-boto3-eks-auth type annotations

Warnings

• breaking Python 3.8 support has been removed since `mypy-boto3-builder` version 8.12.0. Users must use Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or later.
• breaking Packages migrated to PEP 561 standard with `mypy-boto3-builder` version 8.12.0. This might affect how static analysis tools (like mypy) discover and utilize the stub files, especially in complex project setups.
  Fix: Ensure your `mypy` configuration is up-to-date and correctly pointing to `site-packages` for stub discovery. In most cases, `mypy` should handle this automatically.
• breaking TypeDef names were changed for clarity and to resolve conflicts in `mypy-boto3-builder` version 8.9.0. If you explicitly imported TypeDefs, their names might have changed (e.g., `CreateDistributionRequestRequestTypeDef` to `CreateDistributionRequestTypeDef`, or `Extra` postfix moved).
  Fix: Review your code for direct `from mypy_boto3_service.type_defs import ...` imports and update TypeDef names according to the latest package structure.
• gotcha This package provides *type stubs* for `boto3`. You must also install `boto3` itself for your code to run at runtime.
  Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
• gotcha These type annotations are only effective when used with a static type checker like `mypy`. Without running `mypy`, you will not get the benefits of type checking.
  Fix: Install `mypy` (`pip install mypy`) and integrate it into your development workflow (e.g., `mypy your_script.py`).

Install

• pip install mypy-boto3-eks-auth Install package

Imports

• EKSAuthClient

  from mypy_boto3_eks_auth.client import EKSAuthClient

  Used to type-hint the boto3 EKSAuth client.
• GetTokenResponseTypeDef

  from mypy_boto3_eks_auth.type_defs import GetTokenResponseTypeDef

  Example of importing a specific response TypeDef for granular type-hinting.

Quickstart

Demonstrates how to type-hint a `boto3` EKSAuth client using `mypy-boto3-eks-auth` for static analysis. It shows importing the client type and a response type, and type-hinting a client and its method call. Note that runtime execution of `get_token` requires valid AWS credentials and an existing EKS cluster.

import boto3
from mypy_boto3_eks_auth.client import EKSAuthClient
from mypy_boto3_eks_auth.type_defs import GetTokenResponseTypeDef
import os

# Type-hint the boto3 client directly for static analysis
eks_auth_client: EKSAuthClient = boto3.client(
    "eks-auth",
    aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', 'DUMMY_KEY'),
    aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', 'DUMMY_SECRET'),
    region_name=os.environ.get('AWS_REGION', 'us-west-2') # EKS is region-specific
)

print(f"Client object type: {type(eks_auth_client)}")

# Demonstrating a method call that mypy would type-check.
# This call requires a valid EKS cluster name and proper AWS credentials to succeed at runtime.
# For quickstart, we wrap it in a try-except as it might fail without real setup.
cluster_name = os.environ.get('EKS_CLUSTER_NAME', 'your-eks-cluster-name')

try:
    # This will likely result in an authentication/authorization error without real AWS credentials
    # and a valid EKS cluster configured.
    response: GetTokenResponseTypeDef = eks_auth_client.get_token(clusterName=cluster_name)
    print(f"Successfully called get_token (type checked):")
    print(f"  Token expiry: {response.get('expiration', 'N/A')}")
except Exception as e:
    print(f"Error calling get_token (expected without real setup or valid cluster): {e}")

# To verify type checking, you would run `mypy your_script_name.py`