mypy-boto3-ecr 1.12.26.0

Type annotations for boto3.ECR 1.12.26 service, generated by mypy-boto3-buider 1.0.5

mypy-boto3-ecr

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

Generated by mypy-boto3-buider 1.0.5.

More information can be found on boto3-stubs page.

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

How to use

Type checking

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

Install boto3-stubs for ECR service.

python -m pip install boto3-stubs[mypy-boto3-ecr]

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

import boto3

from mypy_boto3 import ecr
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_ecr as ecr

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("ecr")
client: ecr.ECRClient = boto3.client("ecr")

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


# Waiters need type annotation on creation
image_scan_complete_waiter: ecr.ImageScanCompleteWaiter = client.get_waiter("image_scan_complete")
lifecycle_policy_preview_complete_waiter: ecr.LifecyclePolicyPreviewCompleteWaiter = client.get_waiter("lifecycle_policy_preview_complete")

# Paginators need type annotation on creation
describe_image_scan_findings_paginator: ecr.DescribeImageScanFindingsPaginator = client.get_paginator("describe_image_scan_findings")
describe_images_paginator: ecr.DescribeImagesPaginator = client.get_paginator("describe_images")
describe_repositories_paginator: ecr.DescribeRepositoriesPaginator = client.get_paginator("describe_repositories")
get_lifecycle_policy_preview_paginator: ecr.GetLifecyclePolicyPreviewPaginator = client.get_paginator("get_lifecycle_policy_preview")
list_images_paginator: ecr.ListImagesPaginator = client.get_paginator("list_images")

How it works

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

• All available boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.