<a id="mypy-boto3-ecr"></a>
# mypy-boto3-ecr
[![PyPI - mypy-boto3-ecr](https://img.shields.io/pypi/v/mypy-boto3-ecr.svg?color=blue)](https://pypi.org/project/mypy-boto3-ecr)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ecr.svg?color=blue)](https://pypi.org/project/mypy-boto3-ecr)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
[![PyPI - Downloads](https://img.shields.io/pypi/dw/mypy-boto3-ecr?color=blue)](https://pypistats.org/packages/mypy-boto3-ecr)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.ECR 1.17.91](https://boto3.amazonaws.com/v1/documentation/api/1.17.91/reference/services/ecr.html#ECR)
service compatible with [VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright) and other tools.
Generated by
[mypy-boto3-buider 4.17.0](https://github.com/vemel/mypy_boto3_builder).
More information can be found on
[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
[mypy-boto3-ecr docs](https://vemel.github.io/boto3_stubs_docs/mypy_boto3_ecr/)
See how it helps to find and fix potential bugs:
![boto3-stubs demo](https://github.com/vemel/mypy_boto3_builder/raw/master/demo.gif)
- [mypy-boto3-ecr](#mypy-boto3-ecr)
- [How to install](#how-to-install)
- [Usage](#usage)
- [VSCode](#vscode)
- [PyCharm](#pycharm)
- [Other IDEs](#other-ides)
- [mypy](#mypy)
- [pyright](#pyright)
- [Explicit type annotations](#explicit-type-annotations)
- [Client annotations](#client-annotations)
- [Paginators annotations](#paginators-annotations)
- [Waiters annotations](#waiters-annotations)
- [Literals](#literals)
- [Typed dictionaries](#typed-dictionaries)
- [Versioning](#versioning)
- [Documentation](#documentation)
- [Support and contributing](#support-and-contributing)
<a id="how-to-install"></a>
## How to install
Install `boto3-stubs` for `ECR` service.
```bash
python -m pip install boto3-stubs[ecr]
```
<a id="usage"></a>
## Usage
<a id="vscode"></a>
### VSCode
- Install
[Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install
[Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto-stubs[ecr]` in your environment:
`python -m pip install 'boto3-stubs[ecr]'`
Both type checking and auto-complete should work for `ECR` service. No explicit
type annotations required, write your `boto3` code as usual.
<a id="pycharm"></a>
### PyCharm
- Install `boto-stubs[ecr]` in your environment:
`python -m pip install 'boto3-stubs[ecr]'`
Both type checking and auto-complete should work for `ECR` service. No explicit
type annotations required, write your `boto3` code as usual. Auto-complete can
be slow on big projects or if you have a lot of installed `boto3-stubs`
submodules.
<a id="other-ides"></a>
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything
should work.
<a id="mypy"></a>
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[ecr]` in your environment:
`python -m pip install 'boto3-stubs[ecr]'`
- Run `mypy` as usual
Type checking should work for `ECR` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="pyright"></a>
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[ecr]` in your environment:
`python -m pip install 'boto3-stubs[ecr]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `ECR` service. No explicit type annotations
required, write your `boto3` code as usual.
<a id="explicit-type-annotations"></a>
## Explicit type annotations
<a id="client-annotations"></a>
### Client annotations
`ECRClient` provides annotations for `boto3.client("ecr")`.
```python
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")
```
<a id="paginators-annotations"></a>
### Paginators annotations
`mypy_boto3_ecr.paginator` module contains type annotations for all paginators.
```python
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")
```
<a id="waiters-annotations"></a>
### Waiters annotations
`mypy_boto3_ecr.waiter` module contains type annotations for all waiters.
```python
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")
```
<a id="literals"></a>
### Literals
`mypy_boto3_ecr.literals` module contains literals extracted from shapes that
can be used in user code for type checking.
```python
from mypy_boto3_ecr.literals import (
DescribeImageScanFindingsPaginatorName,
DescribeImagesPaginatorName,
DescribeRepositoriesPaginatorName,
EncryptionTypeType,
FindingSeverityType,
GetLifecyclePolicyPreviewPaginatorName,
ImageActionTypeType,
ImageFailureCodeType,
ImageScanCompleteWaiterName,
ImageTagMutabilityType,
LayerAvailabilityType,
LayerFailureCodeType,
LifecyclePolicyPreviewCompleteWaiterName,
LifecyclePolicyPreviewStatusType,
ListImagesPaginatorName,
ScanStatusType,
TagStatusType,
)
def check_value(value: DescribeImageScanFindingsPaginatorName) -> bool:
...
```
<a id="typed-dictionaries"></a>
### Typed dictionaries
`mypy_boto3_ecr.type_defs` module contains structures and shapes assembled to
typed dictionaries for additional type checking.
```python
from mypy_boto3_ecr.type_defs import (
AttributeTypeDef,
AuthorizationDataTypeDef,
BatchCheckLayerAvailabilityResponseTypeDef,
BatchDeleteImageResponseTypeDef,
BatchGetImageResponseTypeDef,
CompleteLayerUploadResponseTypeDef,
CreateRepositoryResponseTypeDef,
DeleteLifecyclePolicyResponseTypeDef,
DeleteRegistryPolicyResponseTypeDef,
DeleteRepositoryPolicyResponseTypeDef,
DeleteRepositoryResponseTypeDef,
DescribeImageScanFindingsResponseTypeDef,
DescribeImagesFilterTypeDef,
DescribeImagesResponseTypeDef,
DescribeRegistryResponseTypeDef,
DescribeRepos
没有合适的资源?快使用搜索试试~ 我知道了~
PyPI 官网下载 | mypy-boto3-ecr-1.17.91.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 86 浏览量
2022-01-13
13:23:09
上传
评论
收藏 15KB GZ 举报
温馨提示
共25个文件
py:9个
pyi:6个
txt:4个
资源来自pypi官网。 资源全名:mypy-boto3-ecr-1.17.91.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-ecr-1.17.91.tar.gz (25个子文件)
mypy-boto3-ecr-1.17.91
PKG-INFO 14KB
mypy_boto3_ecr.egg-info
PKG-INFO 14KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 647B
top_level.txt 15B
dependency_links.txt 1B
mypy_boto3_ecr
type_defs.py 16KB
py.typed 0B
waiter.py 3KB
type_defs.pyi 16KB
literals.py 2KB
client.py 25KB
__main__.py 709B
waiter.pyi 3KB
__init__.py 2KB
client.pyi 25KB
paginator.pyi 6KB
paginator.py 6KB
version.py 55B
literals.pyi 2KB
__init__.pyi 2KB
setup.cfg 38B
setup.py 2KB
README.md 10KB
共 25 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功