mypy-boto3-ecr 1.13.26.1

Type annotations for boto3.ECR 1.13.26 service, generated by mypy-boto3-buider 2.0.3

mypy-boto3-ecr

• mypy-boto3-ecr
  • How to use
  • Automated type discovery

Type annotations for boto3.ECR 1.13.26 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.3.

More information can be found on boto3-stubs page.

• mypy-boto3-ecr
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for ECR service.

python -m pip install boto3-stubs[ecr]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_ecr in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_ecr import ECRClient

# Now mypy can check if your code is valid.
client: ECRClient = boto3.client("ecr")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ECRClient = session.client("ecr")



# Waiters are also supported

import mypy_boto3_ecr.waiter as ecr_waiters

image_scan_complete_waiter: ecr_waiters.ImageScanCompleteWaiter = client.get_waiter("image_scan_complete")
lifecycle_policy_preview_complete_waiter: ecr_waiters.LifecyclePolicyPreviewCompleteWaiter = client.get_waiter("lifecycle_policy_preview_complete")


# Annotated paginators are included as well

import mypy_boto3_ecr.paginator as ecr_paginators

describe_image_scan_findings_paginator: ecr_paginators.DescribeImageScanFindingsPaginator = client.get_paginator("describe_image_scan_findings")
describe_images_paginator: ecr_paginators.DescribeImagesPaginator = client.get_paginator("describe_images")
describe_repositories_paginator: ecr_paginators.DescribeRepositoriesPaginator = client.get_paginator("describe_repositories")
get_lifecycle_policy_preview_paginator: ecr_paginators.GetLifecyclePolicyPreviewPaginator = client.get_paginator("get_lifecycle_policy_preview")
list_images_paginator: ecr_paginators.ListImagesPaginator = client.get_paginator("list_images")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_ecr and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_ecr as ecr
from mypy_boto3_ecr import ECRClient

# with these
from mypy_boto3 import ecr
from mypy_boto3.ecr import ECRClient