Type annotations for boto3.ECR 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-ecr
Type annotations for boto3.ECR 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ECR
service.
python -m pip install boto3-stubs[ecr]
How to use
Client annotations
ECRClient
provides annotations for boto3.client("ecr")
.
import boto3
from mypy_boto3_ecr import ECRClient
client: ECRClient = boto3.client("ecr")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ECRClient = session.client("ecr")
Paginators annotations
mypy_boto3_ecr.paginator
module contains type annotations for all paginators.
from mypy_boto3_ecr import ECRClient
from mypy_boto3_ecr.paginator import (
DescribeImageScanFindingsPaginator,
DescribeImagesPaginator,
DescribeRepositoriesPaginator,
GetLifecyclePolicyPreviewPaginator,
ListImagesPaginator,
)
client: ECRClient = boto3.client("ecr")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_image_scan_findings_paginator: DescribeImageScanFindingsPaginator = client.get_paginator("describe_image_scan_findings")
describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
describe_repositories_paginator: DescribeRepositoriesPaginator = client.get_paginator("describe_repositories")
get_lifecycle_policy_preview_paginator: GetLifecyclePolicyPreviewPaginator = client.get_paginator("get_lifecycle_policy_preview")
list_images_paginator: ListImagesPaginator = client.get_paginator("list_images")
Waiters annotations
mypy_boto3_ecr.waiter
module contains type annotations for all waiters.
from mypy_boto3_ecr import ECRClient
from mypy_boto3_ecr.waiter import (
ImageScanCompleteWaiter,
LifecyclePolicyPreviewCompleteWaiter,
)
client: ECRClient = boto3.client("ecr")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
image_scan_complete_waiter: ImageScanCompleteWaiter = client.get_waiter("image_scan_complete")
lifecycle_policy_preview_complete_waiter: LifecyclePolicyPreviewCompleteWaiter = client.get_waiter("lifecycle_policy_preview_complete")
Typed dictionations
mypy_boto3_ecr.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
from mypy_boto3_ecr.type_defs import AttributeTypeDef, ...
def get_structure() -> AttributeTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_ecr
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("ecr")
session_client = boto3.Session().client("ecr")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy_boto3_ecr-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3edd79d192d49ae8dd389a01ccfde21c602d564c97fdd7f1d9771011dd6d3692 |
|
MD5 | bc3c67e984ff00f016e7b6126eab236b |
|
BLAKE2b-256 | 3bbb937468cef8fe2d1c680be6a84a36211161a89932c7fd40fd295cd4f6df19 |