mypy-boto3-pi Type Stubs

Warnings

• breaking Python 3.8 support has been removed. All `mypy-boto3` packages now require Python 3.9 or newer.
  Fix: Upgrade your Python environment to 3.9 or higher. For example, `pyenv install 3.9.19` or similar.
• breaking Type definition (TypeDef) naming conventions were changed for consistency. For example, `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`. This affects all service packages.
  Fix: Review your code for explicitly imported TypeDefs and update their names according to the new, shorter convention. Your IDE should highlight these errors.
• gotcha This package (`mypy-boto3-pi`) provides only type stubs. It does not include the `boto3` runtime library itself. You must install `boto3` separately for your code to actually interact with AWS services.
  Fix: Always install both `boto3` and the specific `mypy-boto3-*` stub package: `pip install boto3 mypy-boto3-pi`.
• gotcha Service names within AWS (and thus boto3) can change or be deprecated. For example, the `sms-voice` service was removed and replaced by `pinpoint-sms-voice` (mypy-boto3-builder 8.11.0). If a service client fails to resolve types, verify its current name.
  Fix: Consult the official AWS Boto3 documentation for the current service names and use the correct string in `boto3.client('service-name')`.
• gotcha The `mypy-boto3` project migrated to PEP 561 compliant packages. While generally seamless, if you have complex `mypy` configurations (e.g., `MYPYPATH` environment variables) or are using older `mypy` versions, you might encounter issues with stub discovery.
  Fix: Ensure `mypy` is up-to-date (`pip install --upgrade mypy`). If issues persist, simplify your `mypy` configuration and rely on standard package installation paths.

Install

• pip install mypy-boto3-pi boto3 Install stubs and boto3

Imports

• PIClient

  from mypy_boto3_pi.client import PIClient

• GetDimensionKeyDetailsResponseTypeDef

  from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsResponseTypeDef

• boto3

  import boto3

  mypy-boto3-pi provides stubs for boto3, not a separate runtime library. You import boto3 and mypy uses the stubs implicitly.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-pi` for type-hinting your `boto3` PI client. The stubs allow `mypy` and IDEs to provide accurate type information for client methods and their return types, improving code quality and reducing runtime errors. Remember to replace placeholder values like 'your-db-instance-id' and ensure you have valid AWS credentials configured.

import boto3
from mypy_boto3_pi.client import PIClient
from mypy_boto3_pi.type_defs import GetDimensionKeyDetailsResponseTypeDef
from typing import TYPE_CHECKING

# Boto3 client without type hints (mypy will infer if stubs are installed)
client = boto3.client('pi')
print(f"Client type (runtime): {type(client)}")

# Type-hinted client for better IDE support and static analysis
pi_client: PIClient = boto3.client('pi')

# Example usage with type-hinted response
# This call requires valid AWS credentials configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION_NAME env vars)
# and an existing DB instance identifier.
# Replace 'db-instance-id' with a real instance if running.
if TYPE_CHECKING:
    # Define a dummy response for type checking only
    dummy_response: GetDimensionKeyDetailsResponseTypeDef = {
        'AlignedEndTime': '', 'AlignedStartTime': '', 'Keys': []
    }

try:
    response: GetDimensionKeyDetailsResponseTypeDef = pi_client.get_dimension_key_details(
        ServiceType='RDS',
        Identifier='your-db-instance-id',
        Group='DB_INSTANCE',
        GroupIdentifier='your-db-instance-id'
    )
    print("Successfully called get_dimension_key_details (types applied).")
    # Further processing with type-hinted response
except Exception as e:
    print(f"Could not call AWS PI service: {e}. Ensure 'your-db-instance-id' is valid and credentials are set.")

# Accessing fields with type safety
# if response and response['Keys']:
#     print(response['Keys'][0]['Dimensions'])