# mypy-boto3-codecommit
[![PyPI - mypy-boto3-codecommit](https://img.shields.io/pypi/v/mypy-boto3-codecommit.svg?color=blue)](https://pypi.org/project/mypy-boto3-codecommit)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-codecommit.svg?color=blue)](https://pypi.org/project/mypy-boto3-codecommit)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue)](https://mypy-boto3-builder.readthedocs.io/)
![boto3.typed](https://github.com/vemel/mypy_boto3_builder/raw/master/logo.png)
Type annotations for
[boto3.CodeCommit 1.16.54](https://boto3.amazonaws.com/v1/documentation/api/1.16.54/reference/services/codecommit.html#CodeCommit) 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.3.1](https://github.com/vemel/mypy_boto3_builder).
More information can be found on [boto3-stubs](https://pypi.org/project/boto3-stubs/) page.
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-codecommit](#mypy-boto3-codecommit)
- [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)
- [Service Resource annotations](#service-resource-annotations)
- [Other resources annotations](#other-resources-annotations)
- [Collections annotations](#collections-annotations)
- [Typed dictionations](#typed-dictionations)
## How to install
Install `boto3-stubs` for `CodeCommit` service.
```bash
python -m pip install boto3-stubs[codecommit]
```
## Usage
### 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[codecommit]` in your environment: `python -m pip install 'boto3-stubs[codecommit]'`
Both type checking and auto-complete should work for `CodeCommit` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[codecommit]` in your environment: `python -m pip install 'boto3-stubs[codecommit]'`
Both type checking and auto-complete should work for `CodeCommit` 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.
### Other IDEs
Not tested, but as long as your IDE support `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto-stubs[codecommit]` in your environment: `python -m pip install 'boto3-stubs[codecommit]'`
- Run `mypy` as usual
Type checking should work for `CodeCommit` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[codecommit]` in your environment: `python -m pip install 'boto3-stubs[codecommit]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CodeCommit` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CodeCommitClient` provides annotations for `boto3.client("codecommit")`.
```python
import boto3
from mypy_boto3_codecommit import CodeCommitClient
client: CodeCommitClient = boto3.client("codecommit")
# 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: CodeCommitClient = session.client("codecommit")
```
### Paginators annotations
`mypy_boto3_codecommit.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_codecommit import CodeCommitClient
from mypy_boto3_codecommit.paginator import (
DescribePullRequestEventsPaginator,
GetCommentsForComparedCommitPaginator,
GetCommentsForPullRequestPaginator,
GetDifferencesPaginator,
ListBranchesPaginator,
ListPullRequestsPaginator,
ListRepositoriesPaginator,
)
client: CodeCommitClient = boto3.client("codecommit")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_pull_request_events_paginator: DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")
get_comments_for_compared_commit_paginator: GetCommentsForComparedCommitPaginator = client.get_paginator("get_comments_for_compared_commit")
get_comments_for_pull_request_paginator: GetCommentsForPullRequestPaginator = client.get_paginator("get_comments_for_pull_request")
get_differences_paginator: GetDifferencesPaginator = client.get_paginator("get_differences")
list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches")
list_pull_requests_paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
```
### Typed dictionations
`mypy_boto3_codecommit.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_codecommit.type_defs import (
ApprovalRuleEventMetadataTypeDef,
ApprovalRuleOverriddenEventMetadataTypeDef,
ApprovalRuleTemplateTypeDef,
ApprovalRuleTypeDef,
ApprovalStateChangedEventMetadataTypeDef,
ApprovalTypeDef,
BatchAssociateApprovalRuleTemplateWithRepositoriesErrorTypeDef,
BatchAssociateApprovalRuleTemplateWithRepositoriesOutputTypeDef,
BatchDescribeMergeConflictsErrorTypeDef,
BatchDescribeMergeConflictsOutputTypeDef,
BatchDisassociateApprovalRuleTemplateFromRepositoriesErrorTypeDef,
BatchDisassociateApprovalRuleTemplateFromRepositoriesOutputTypeDef,
BatchGetCommitsErrorTypeDef,
BatchGetCommitsOutputTypeDef,
BatchGetRepositoriesOutputTypeDef,
BlobMetadataTypeDef,
BranchInfoTypeDef,
CommentsForComparedCommitTypeDef,
CommentsForPullRequestTypeDef,
CommentTypeDef,
CommitTypeDef,
ConflictMetadataTypeDef,
ConflictResolutionTypeDef,
ConflictTypeDef,
CreateApprovalRuleTemplateOutputTypeDef,
CreateCommitOutputTypeDef,
CreatePullRequestApprovalRuleOutputTypeDef,
CreatePullRequestOutputTypeDef,
CreateRepositoryOutputTypeDef,
CreateUnreferencedMergeCommitOutputTypeDef,
DeleteApprovalRuleTemplateOutputTypeDef,
DeleteBranchOutputTypeDef,
DeleteCommentContentOutputTypeDef,
DeleteFileEntryTypeDef,
DeleteFileOutputTypeDef,
DeletePullRequestApprovalRuleOutputTypeDef,
DeleteRepositoryOutputTypeDef,
DescribeMergeConflictsOutputTypeDef,
DescribePullRequestEventsOutputTypeDef,
DifferenceTypeDef,
EvaluatePullRequestApprovalRulesOutputTypeDef,
EvaluationTypeDef,
FileMetadataTypeDef,
FileModesTypeDef,
FileSizesTypeDef,
FileTypeDef,
FolderTypeDef,
GetApprovalRuleTemplateOutputTypeDef,
GetBlobOutputTypeDef,
GetBranchOutputTypeDef,
GetCommentOutputTypeDef,
GetCommentReactionsOutputTypeDef,
GetCommentsForComparedCommitOutputTypeDef,
GetCommentsForPullRequestOutputTypeDef,
GetCommitOutputTypeDef,
GetDifferencesOutputType
没有合适的资源?快使用搜索试试~ 我知道了~
PyPI 官网下载 | mypy-boto3-codecommit-1.16.54.0.tar.gz
1.该资源内容由用户上传,如若侵权请联系客服进行举报
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
2.虚拟产品一经售出概不退款(资源遇到问题,请及时私信上传者)
版权申诉
0 下载量 32 浏览量
2022-02-10
16:17:04
上传
评论
收藏 29KB GZ 举报
温馨提示
共21个文件
py:7个
pyi:4个
txt:4个
资源来自pypi官网。 资源全名:mypy-boto3-codecommit-1.16.54.0.tar.gz
资源推荐
资源详情
资源评论
收起资源包目录
mypy-boto3-codecommit-1.16.54.0.tar.gz (21个子文件)
mypy-boto3-codecommit-1.16.54.0
PKG-INFO 14KB
mypy_boto3_codecommit.egg-info
PKG-INFO 14KB
requires.txt 45B
not-zip-safe 1B
SOURCES.txt 660B
top_level.txt 22B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
README.md 10KB
mypy_boto3_codecommit
type_defs.py 44KB
py.typed 0B
type_defs.pyi 44KB
client.py 52KB
__main__.py 400B
__init__.py 2KB
client.pyi 52KB
paginator.pyi 8KB
paginator.py 8KB
version.py 57B
__init__.pyi 2KB
共 21 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功