mypy-boto3-pcs Type Stubs

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0. All generated `mypy-boto3` packages, including `mypy-boto3-pcs`, now require Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking In `mypy-boto3-builder` version 8.9.0, TypeDef names for packed method arguments were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`). This can cause type-checking errors if you were explicitly referencing the older, longer TypeDef names.
  Fix: Update your type annotations to use the new, shorter TypeDef names. Refer to the specific service documentation for the correct TypeDef names.
• gotcha `mypy-boto3-pcs` only provides type stubs, not the `boto3` library itself. You *must* install `boto3` separately for your code to function at runtime. The type stubs are solely for static analysis.
  Fix: Ensure `boto3` is installed in your environment: `pip install boto3`.
• gotcha While direct installation like `pip install mypy-boto3-pcs` works, for comprehensive `boto3` type-hinting across multiple services, the `boto3-stubs` package with extras (e.g., `pip install 'boto3-stubs[full]'` or `pip install 'boto3-stubs[pcs]'`) is often recommended as the primary entry point for type annotations. This ensures consistency and proper integration for all services you use.
  Fix: Consider `pip install 'boto3-stubs[pcs]'` instead of or in addition to `mypy-boto3-pcs` for better integration, especially if using multiple `boto3` services.
• deprecated Some AWS service names or their corresponding `mypy-boto3` stub packages may be deprecated or renamed over time, reflecting changes in the AWS SDK. For example, the `sms-voice` service was removed in `mypy-boto3-builder` 8.11.0, with `pinpoint-sms-voice` as its replacement.
  Fix: Always check the official `mypy-boto3` documentation or AWS service documentation for the latest service names and recommended alternatives if you encounter `ModuleNotFoundError` for a service stub.

Install

• pip install mypy-boto3-pcs boto3 Install with boto3

Imports

• ParallelComputingServiceClient

  from mypy_boto3_pcs.client import ParallelComputingServiceClient

  Import the client type for the ParallelComputingService for type hinting boto3 clients.
• ParallelComputingServiceClient

  import boto3
  from mypy_boto3_pcs.client import ParallelComputingServiceClient
  
  def get_pcs_client() -> ParallelComputingServiceClient:
      return boto3.client('pcs')

  Type hint the boto3 client creation. Direct import of the client type is for annotation, not runtime instantiation.

Quickstart

This quickstart demonstrates how to obtain a type-hinted `boto3` client for the ParallelComputingService using `mypy-boto3-pcs`. It emphasizes the need to install both `boto3` and the type stubs, and how to correctly annotate the client for static analysis.

import boto3
from mypy_boto3_pcs.client import ParallelComputingServiceClient
from os import environ

# Ensure boto3 is installed: pip install boto3 mypy-boto3-pcs

def get_pcs_client() -> ParallelComputingServiceClient:
    """Returns a type-hinted ParallelComputingService client."""
    # Boto3 client creation with type hint
    client: ParallelComputingServiceClient = boto3.client(
        'pcs',
        region_name=environ.get('AWS_REGION', 'us-east-1'),
        aws_access_key_id=environ.get('AWS_ACCESS_KEY_ID', ''),
        aws_secret_access_key=environ.get('AWS_SECRET_ACCESS_KEY', '')
    )
    return client

if __name__ == '__main__':
    pcs_client = get_pcs_client()
    # Now `pcs_client` has type hints for ParallelComputingService methods
    print(f"Client type: {type(pcs_client)}")
    # Example of a method call (replace with actual PCS method if needed)
    # This specific service 'pcs' is less common for simple public examples.
    # print(pcs_client.list_resources())