mypy-boto3-ecr-public Type Annotations

1.42.3 · active · verified Sat Apr 11

mypy-boto3-ecr-public provides static type annotations for the boto3 ECR Public service. It's part of the `boto3-stubs` project, generated by `mypy-boto3-builder` version 8.12.0, ensuring compatibility with boto3 1.42.3. The library enables robust type checking with tools like mypy and pyright, and enhances IDE features such as auto-completion and type hints for AWS service clients. It is actively maintained with releases frequently synchronized with boto3 updates.

Warnings

breaking Support for Python 3.8 and older versions has been removed. The library now requires Python 3.9 or newer.
Fix: Upgrade your Python environment to 3.9 or newer.
breaking The package structure has migrated to PEP 561 compliance. While this generally improves compatibility, ensure your type checker is up-to-date and configured correctly.
Fix: Update your type checker (e.g., mypy, pyright) to the latest version and verify your configuration. No direct code change is typically required unless you had custom type-stub handling.
breaking TypeDef naming conventions for packed method arguments and conflicting names have changed. For example, `CreateDistributionRequestRequestTypeDef` might become `CreateDistributionRequestTypeDef`, and `Extra` postfixes were moved.
Fix: Review and update `TypedDict` imports and usage in your code if you were relying on specific generated TypeDef names.
gotcha This library provides *type stubs* only. You must also install `boto3` (e.g., `pip install boto3`) for your code to run at runtime and interact with AWS.
Fix: Ensure `boto3` is installed in your environment alongside `mypy-boto3-ecr-public`.
gotcha PyCharm users might experience slow performance or high CPU usage due to Literal overloads. The project maintainers recommend using `boto3-stubs-lite` or disabling PyCharm's type checker in such cases.
Fix: Consider `pip install boto3-stubs-lite[ecr-public]` for a lighter version, or configure PyCharm to use external type checkers like mypy/pyright instead of its built-in one for this library.

Install

pip install mypy-boto3-ecr-public Install standalone package
pip install 'boto3-stubs[ecr-public]' Install as part of boto3-stubs

Imports

ECRPublicClient
```
from mypy_boto3_ecr_public.client import ECRPublicClient
```
The type stubs are provided by the mypy_boto3_ecr_public package, not directly by boto3 itself. While boto3.client("ecr-public") works at runtime, for type checking you explicitly import the stub client type.
DescribeImageTagsPaginator
```
from mypy_boto3_ecr_public.paginator import DescribeImageTagsPaginator
```
Import specific paginator types for type hinting.
RepositoryScanningConfigurationFailureTypeDef
```
from mypy_boto3_ecr_public.type_defs import RepositoryScanningConfigurationFailureTypeDef
```
Import specific TypedDicts for request/response bodies.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-ecr-public` to get type annotations for the ECR Public client and list public repositories. It shows explicit type hinting for the boto3 client.

import boto3
from mypy_boto3_ecr_public.client import ECRPublicClient
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    # Only import for type checking, avoid runtime dependency if not strictly needed
    # Or, rely on the installed mypy-boto3-ecr-public for runtime type discovery
    pass

def list_public_repositories(region: str = "us-east-1") -> None:
    client: ECRPublicClient = boto3.client("ecr-public", region_name=region)
    try:
        response = client.describe_repositories()
        print(f"Public ECR Repositories in {region}:")
        for repo in response.get("repositories", []):
            print(f"  - {repo['repositoryName']} (URI: {repo['repositoryUri']})")
    except Exception as e:
        print(f"Error listing repositories: {e}")

if __name__ == "__main__":
    # Note: AWS credentials (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION)
    # or ~/.aws/credentials are required for boto3 to function.
    list_public_repositories()

view raw JSON →