mypy-boto3-mediastore

Warnings

• breaking Support for Python 3.8 has been removed in `mypy-boto3-builder` version 8.12.0 and later, affecting packages built with it, including `mypy-boto3-mediastore`. Ensure your project uses Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer. Consider using `pyenv` or similar tools for managing Python versions.
• breaking TypeDef naming conventions were changed in `mypy-boto3-builder` version 8.9.0. This might affect direct imports of specific `TypeDef` classes (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`).
  Fix: Review and update any direct `import` statements for `TypeDef` classes to match the new, often shorter, naming conventions.
• gotcha This package provides *only* type stubs. You must install the actual `boto3` library to use AWS services at runtime. `mypy-boto3-mediastore` will be automatically detected by `mypy` (PEP 561 compliant) if both are installed in the same environment.
  Fix: Always include `boto3` in your project's dependencies alongside `mypy-boto3-mediastore` (e.g., `pip install boto3 mypy-boto3-mediastore`).
• gotcha While `mypy` often automatically infers types, explicit type annotations for `boto3.client` and similar calls (e.g., `client: MediaStoreClient = session.client('mediastore')`) are highly recommended for better IDE auto-completion and more robust type checking, especially with versions like `boto3-stubs-lite` which do not provide `session.client/resource` overloads.
  Fix: Add explicit type annotations when initializing boto3 clients or resources, such as `client: MediaStoreClient = session.client('mediastore')`.

Install

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

Imports

• MediaStoreClient

  from mypy_boto3_mediastore import MediaStoreClient

• ContainerTypeDef

  from mypy_boto3_mediastore.type_defs import ContainerTypeDef

• ListContainersPaginator

  from mypy_boto3_mediastore.paginator import ListContainersPaginator

• ContainerLevelMetricsType

  from mypy_boto3_mediastore.literals import ContainerLevelMetricsType

Quickstart

This quickstart demonstrates how to use `mypy-boto3-mediastore` for type-hinting a boto3 MediaStore client. It shows explicit type annotation for the client and the return type of a method call. To verify type checking, ensure `mypy` is installed and run `mypy` on the script.

import os
import boto3
from mypy_boto3_mediastore import MediaStoreClient
from mypy_boto3_mediastore.type_defs import ContainerTypeDef

def list_mediastore_containers(client: MediaStoreClient) -> list[ContainerTypeDef]:
    """Lists MediaStore containers and returns typed responses."""
    response = client.list_containers()
    containers = response.get('Containers', [])
    print(f"Found {len(containers)} MediaStore containers.")
    for container in containers:
        print(f"  Container Name: {container.get('Name')}, Status: {container.get('Status')}")
    return containers

if __name__ == "__main__":
    # Ensure AWS credentials are configured (e.g., via environment variables or ~/.aws/credentials)
    session = boto3.Session(region_name=os.environ.get('AWS_REGION', 'us-east-1'))
    mediastore_client: MediaStoreClient = session.client('mediastore')
    
    print("Listing MediaStore containers...")
    containers = list_mediastore_containers(mediastore_client)
    
    # Example of accessing a typed attribute (mypy would check this)
    if containers:
        first_container_arn: str = containers[0]['ARN']
        print(f"First container ARN: {first_container_arn}")

    # To run static analysis:
    # pip install mypy
    # mypy your_script_name.py