Type annotations for boto3 RAM service

Warnings

• breaking Python 3.8 support has been removed in mypy-boto3-builder version 8.12.0 and later packages. Users on Python 3.8 will need to upgrade to Python 3.9+ or use an older version of mypy-boto3-ram.
  Fix: Upgrade your Python environment to 3.9 or higher.
• breaking TypeDef names were changed in mypy-boto3-builder 8.9.0. This includes shortening packed method argument TypeDefs (e.g., `CreateDistributionRequestRequestTypeDef` -> `CreateDistributionRequestTypeDef`) and moving `Extra` postfixes for conflicting names. Code relying on explicit TypeDef imports might break.
  Fix: Review and update explicit `TypeDef` imports in your codebase according to the new naming conventions. Refer to the specific service's documentation for updated TypeDef names.
• gotcha Mismatching versions of `boto3` and `mypy-boto3-ram` can lead to incorrect type hints or `mypy` errors. `mypy-boto3-ram` versions generally correspond to compatible `boto3` versions (e.g., `mypy-boto3-ram 1.42.59` is for `boto3 1.42.59`).
  Fix: Ensure that your `boto3` and `mypy-boto3-ram` package versions are aligned. For instance, install `boto3==1.42.59` alongside `mypy-boto3-ram==1.42.59`.
• gotcha While `mypy-boto3-ram` is a standalone package, for comprehensive `boto3` type-hinting, especially for `Session.client()` and `Session.resource()` overloads without explicit annotations, installing `boto3-stubs[ram]` is often recommended. Standalone packages might require more explicit type annotations in some IDEs.
  Fix: For the best experience with auto-discovery of types and IDE completion, consider installing `boto3-stubs` with the `ram` extra: `pip install 'boto3-stubs[ram]'`.
• gotcha Pylint might report 'undefined variable' errors when using `from typing import TYPE_CHECKING` blocks to conditionally import `mypy-boto3` types. This is a known issue with Pylint's interaction with `TYPE_CHECKING`.
  Fix: To resolve Pylint complaints, set the type aliases to `object` in the `else` branch of the `TYPE_CHECKING` block. For example: `if TYPE_CHECKING: from mypy_boto3_ram import RAMClient else: RAMClient = object`
• gotcha PyCharm users might experience slow performance or high CPU usage due to `Literal` overloads in `boto3-stubs` packages. The `lite` versions of the stubs are provided as a workaround.
  Fix: If experiencing PyCharm performance issues, consider uninstalling `mypy-boto3-ram` (or `boto3-stubs`) and installing the lite version: `pip install 'boto3-stubs-lite[ram]'`. Note that the lite version requires more explicit type annotations.

Install

• pip install mypy-boto3-ram Install standalone package
• pip install 'boto3-stubs[ram]' Install as part of boto3-stubs (recommended for full functionality)

Imports

• RAMClient

  from mypy_boto3_ram import RAMClient

  Type definitions for AWS service clients are provided by mypy-boto3-ram, not directly from boto3 or botocore.

Quickstart

This example demonstrates how to initialize a `RAMClient` with type annotations and use a basic operation like `list_resource_shares`. The type annotation ensures that `mypy` and IDEs provide correct autocompletion and type-checking for RAM service-specific methods and parameters.

import boto3
from mypy_boto3_ram import RAMClient
import os

def list_resource_shares_typed() -> None:
    # It's recommended to explicitly type the client for full type-checking benefits
    # Especially if not installing the full 'boto3-stubs' package
    client: RAMClient = boto3.client("ram", region_name=os.environ.get('AWS_REGION', 'us-east-1'))

    # The client methods are now fully type-checked
    response = client.list_resource_shares(resourceOwner='SELF')
    
    print("Resource Shares:")
    for share in response.get('resourceShares', []):
        print(f"  - {share['name']} ({share['status']})")

if __name__ == "__main__":
    # Ensure AWS credentials/config are set up, e.g., via environment variables or ~/.aws/credentials
    # For this example, we're using a dummy region name; replace with actual if needed.
    list_resource_shares_typed()