types-aiobotocore-ecr-public

PyPI - types-aiobotocore-ecr-public PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for aiobotocore ECRPublic 3.8.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.12.0.

More information can be found on types-aiobotocore page and in types-aiobotocore-ecr-public docs.

See how it helps you find and fix potential bugs:

types-boto3 demo

How to install

Generate locally (recommended)

You can generate type annotations for aiobotocore package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'aiobotocore==3.8.0' mypy-boto3-builder
  2. Select aiobotocore AWS SDK.
  3. Add ECRPublic service.
  4. Use provided commands to install generated packages.

From PyPI with pip

Install types-aiobotocore for ECRPublic service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[ecr-public]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[ecr-public]'

# standalone installation
python -m pip install types-aiobotocore-ecr-public

How to uninstall

python -m pip uninstall -y types-aiobotocore-ecr-public

Usage

VSCode

python -m pip install 'types-aiobotocore[ecr-public]'

Both type checking and code completion should now work. No explicit type annotations required, write your aiobotocore code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use types-aiobotocore-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace types-aiobotocore with types-aiobotocore-lite:

pip uninstall types-aiobotocore
pip install types-aiobotocore-lite

Install types-aiobotocore[ecr-public] in your environment:

python -m pip install 'types-aiobotocore[ecr-public]'

Both type checking and code completion should now work.

Emacs

  • Install types-aiobotocore with services you use in your environment:
python -m pip install 'types-aiobotocore[ecr-public]'

(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed types-aiobotocore

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Sublime Text

  • Install types-aiobotocore[ecr-public] with services you use in your environment:
python -m pip install 'types-aiobotocore[ecr-public]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install types-aiobotocore[ecr-public] in your environment:
python -m pip install 'types-aiobotocore[ecr-public]'

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install types-aiobotocore[ecr-public] in your environment:
python -m pip install 'types-aiobotocore[ecr-public]'

Optionally, you can install types-aiobotocore to typings directory.

Type checking should now work. No explicit type annotations required, write your aiobotocore code as usual.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid types-aiobotocore-ecr-public dependency in production. However, there is an issue in pylint that it complains about undefined variables. To fix it, set all types to object in non-TYPE_CHECKING mode.

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
    from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
    from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
else:
    EC2Client = object
    EC2ServiceResource = object
    BundleTaskCompleteWaiter = object
    DescribeVolumesPaginator = object

...

Explicit type annotations

Client annotations

ECRPublicClient provides annotations for session.create_client("ecr-public").

from aiobotocore.session import get_session

from types_aiobotocore_ecr_public import ECRPublicClient

session = get_session()
async with session.create_client("ecr-public") as client:
    client: ECRPublicClient
    # now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

types_aiobotocore_ecr_public.paginator module contains type annotations for all paginators.

from aiobotocore.session import get_session

from types_aiobotocore_ecr_public import ECRPublicClient
from types_aiobotocore_ecr_public.paginator import (
    DescribeImageTagsPaginator,
    DescribeImagesPaginator,
    DescribeRegistriesPaginator,
    DescribeRepositoriesPaginator,
)

session = get_session()
async with session.create_client("ecr-public") as client:
    client: ECRPublicClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    describe_image_tags_paginator: DescribeImageTagsPaginator = client.get_paginator(
        "describe_image_tags"
    )
    describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
    describe_registries_paginator: DescribeRegistriesPaginator = client.get_paginator(
        "describe_registries"
    )
    describe_repositories_paginator: DescribeRepositoriesPaginator = client.get_paginator(
        "describe_repositories"
    )

Literals

types_aiobotocore_ecr_public.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of ECRPublic Literals can be found in docs.

from types_aiobotocore_ecr_public.literals import DescribeImageTagsPaginatorName


def check_value(value: DescribeImageTagsPaginatorName) -> bool: ...

Type definitions

types_aiobotocore_ecr_public.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of ECRPublic TypeDefs can be found in docs.

# TypedDict usage example
from types_aiobotocore_ecr_public.type_defs import AuthorizationDataTypeDef


def get_value() -> AuthorizationDataTypeDef:
    return {
        "authorizationToken": ...,
    }

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for aiobotocore updates. It delivers drop-in type annotations for you and makes sure that:

  • All available aiobotocore services are covered.
  • Each public class and method of every aiobotocore service gets valid type annotations extracted from botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

types-aiobotocore-ecr-public version is the same as related aiobotocore version and follows Python Packaging version specifiers.

Thank you

Documentation

All services type annotations can be found in aiobotocore docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.9.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for vemel from gravatar.com vemel

Credits

PyPI data
Data sourced directly from PyPI's database.

Author: Vlad Emelianov

License expression

MIT
View SPDX License List

Requires

Python >=3.9

Tags

aiobotocore ecr-public aiobotocore-stubs type-annotations mypy typeshed autocomplete

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

types_aiobotocore_ecr_public-3.8.0.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

types_aiobotocore_ecr_public-3.8.0-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file types_aiobotocore_ecr_public-3.8.0.tar.gz.

File metadata

File hashes

Hashes for types_aiobotocore_ecr_public-3.8.0.tar.gz
Algorithm Hash digest
SHA256 e368d8e579ee0521e7f94a1da854c3b0ed884975b7264b49ef1e84ce4f911d44
MD5 335d48bf31cbf75a695cbc47a124c816
BLAKE2b-256 ad6577180991a98e42e1b693e9dd5fb498d3fb4bfb4158dea09e284dbfded84c

See more details on using hashes here.

File details

Details for the file types_aiobotocore_ecr_public-3.8.0-py3-none-any.whl.

File metadata

File hashes

Hashes for types_aiobotocore_ecr_public-3.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0cc742ba41b9979117cd5cd3c9ea3d0e52c906339a1def18745836b0595bcfd
MD5 64745a73810c3e2f2d9f48baf5e6b0f5
BLAKE2b-256 839b906f3f13c1433c5bcd7173e67c7952777d940fc178736eef3e6bea8bae4b

See more details on using hashes here.

Release history Release notifications | RSS feed

3.9.0

2 files

This release

3.8.0 This release

2 files

3.7.0

2 files

3.6.0

2 files

3.5.0

2 files

3.4.0

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.26.0

2 files

2.25.2

2 files

2.25.1

2 files

2.25.0

2 files

2.24.3

2 files

2.24.2

2 files

2.24.1

2 files

2.24.0

2 files

2.23.2

2 files

2.23.1

2 files

2.23.0

2 files

2.22.0

2 files

2.21.1

2 files

2.21.0

2 files

Pre-release

2.20.1.dev0

2 files

2.20.0

2 files

2.19.0

2 files

2.18.0

2 files

2.17.0

2 files

2.16.1

2 files

2.16.0

2 files

2.15.2

2 files

2.15.1

2 files

2.15.0

2 files

2.14.0

2 files

2.13.3

2 files

2.13.2

2 files

2.13.1

2 files

2.13.0

2 files

2.12.3

2 files

2.12.2

2 files

2.12.1

2 files

2.12.0

2 files

2.11.2

2 files

2.11.1

2 files

2.11.0

2 files

2.9.1

2 files

2.9.0

2 files

2.8.0

2 files

2.7.0

2 files

2.6.0

2 files

2.5.4

2 files

2.5.2.post3

2 files

2.5.2.post2

2 files

2.5.2.post1

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0.post1

2 files

2.5.0

2 files

2.4.2.post3

2 files

2.4.2.post2

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0.post1

2 files

2.4.0

2 files

2.3.4.post3

2 files

2.3.4.post2

2 files

2.3.4.post1

2 files

2.3.4

2 files

2.3.3

2 files

2.3.2

2 files

2.3.1

2 files

2.3.0

2 files

2.2.0.post2

2 files

2.2.0.post1

2 files

2.2.0

2 files

2.1.1.post1

2 files

2.1.1

2 files

2.1.0.post1

2 files

2.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page