# mypy-boto3-codebuild
[![PyPI - mypy-boto3-codebuild](https://img.shields.io/pypi/v/mypy-boto3-codebuild.svg?color=blue)](https://pypi.org/project/mypy-boto3-codebuild)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-codebuild.svg?color=blue)](https://pypi.org/project/mypy-boto3-codebuild)
[![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.CodeBuild 1.17.24](https://boto3.amazonaws.com/v1/documentation/api/1.17.24/reference/services/codebuild.html#CodeBuild) 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.4.0](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-codebuild](#mypy-boto3-codebuild)
- [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 `CodeBuild` service.
```bash
python -m pip install boto3-stubs[codebuild]
```
## 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[codebuild]` in your environment: `python -m pip install 'boto3-stubs[codebuild]'`
Both type checking and auto-complete should work for `CodeBuild` service.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto-stubs[codebuild]` in your environment: `python -m pip install 'boto3-stubs[codebuild]'`
Both type checking and auto-complete should work for `CodeBuild` 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[codebuild]` in your environment: `python -m pip install 'boto3-stubs[codebuild]'`
- Run `mypy` as usual
Type checking should work for `CodeBuild` service.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto-stubs[codebuild]` in your environment: `python -m pip install 'boto3-stubs[codebuild]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for `CodeBuild` service.
No explicit type annotations required, write your `boto3` code as usual.
## Explicit type annotations
### Client annotations
`CodeBuildClient` provides annotations for `boto3.client("codebuild")`.
```python
import boto3
from mypy_boto3_codebuild import CodeBuildClient
client: CodeBuildClient = boto3.client("codebuild")
# 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: CodeBuildClient = session.client("codebuild")
```
### Paginators annotations
`mypy_boto3_codebuild.paginator` module contains type annotations for all paginators.
```python
from mypy_boto3_codebuild import CodeBuildClient
from mypy_boto3_codebuild.paginator import (
DescribeCodeCoveragesPaginator,
DescribeTestCasesPaginator,
ListBuildBatchesPaginator,
ListBuildBatchesForProjectPaginator,
ListBuildsPaginator,
ListBuildsForProjectPaginator,
ListProjectsPaginator,
ListReportGroupsPaginator,
ListReportsPaginator,
ListReportsForReportGroupPaginator,
ListSharedProjectsPaginator,
ListSharedReportGroupsPaginator,
)
client: CodeBuildClient = boto3.client("codebuild")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_code_coverages_paginator: DescribeCodeCoveragesPaginator = client.get_paginator("describe_code_coverages")
describe_test_cases_paginator: DescribeTestCasesPaginator = client.get_paginator("describe_test_cases")
list_build_batches_paginator: ListBuildBatchesPaginator = client.get_paginator("list_build_batches")
list_build_batches_for_project_paginator: ListBuildBatchesForProjectPaginator = client.get_paginator("list_build_batches_for_project")
list_builds_paginator: ListBuildsPaginator = client.get_paginator("list_builds")
list_builds_for_project_paginator: ListBuildsForProjectPaginator = client.get_paginator("list_builds_for_project")
list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects")
list_report_groups_paginator: ListReportGroupsPaginator = client.get_paginator("list_report_groups")
list_reports_paginator: ListReportsPaginator = client.get_paginator("list_reports")
list_reports_for_report_group_paginator: ListReportsForReportGroupPaginator = client.get_paginator("list_reports_for_report_group")
list_shared_projects_paginator: ListSharedProjectsPaginator = client.get_paginator("list_shared_projects")
list_shared_report_groups_paginator: ListSharedReportGroupsPaginator = client.get_paginator("list_shared_report_groups")
```
### Typed dictionations
`mypy_boto3_codebuild.type_defs` module contains structures and shapes assembled
to typed dictionaries for additional type checking.
```python
from mypy_boto3_codebuild.type_defs import (
BatchRestrictionsTypeDef,
BuildArtifactsTypeDef,
BuildBatchPhaseTypeDef,
BuildBatchTypeDef,
BuildGroupTypeDef,
BuildNotDeletedTypeDef,
BuildPhaseTypeDef,
BuildStatusConfigTypeDef,
BuildSummaryTypeDef,
BuildTypeDef,
CloudWatchLogsConfigTypeDef,
CodeCoverageReportSummaryTypeDef,
CodeCoverageTypeDef,
DebugSessionTypeDef,
EnvironmentImageTypeDef,
EnvironmentLanguageTypeDef,
EnvironmentPlatformTypeDef,
EnvironmentVariableTypeDef,
ExportedEnvironmentVariableTypeDef,
GitSubmodulesConfigTypeDef,
LogsConfigTypeDef,
LogsLocationTypeDef,
NetworkInterfaceTypeDef,
PhaseContextTypeDef,
ProjectArtifactsTypeDef,
ProjectBadgeTypeDef,
ProjectBuildBatchConfigTypeDef,
ProjectCacheTypeDef,
ProjectEnvironmentTypeDef,
ProjectFileSystemLocationTypeDef,
ProjectSourceTypeDef,
ProjectSourceVersionTypeDef,
ProjectTypeDef,
RegistryCredentialTypeDef,
ReportExportConfigTypeDef,
ReportGroupTrendStatsTypeDef,
ReportGroupTypeDef,
ReportTypeDef,
ReportWithRawDataTypeDef,
ResolvedArtifactTypeDef,
ResponseMetadata,
S3LogsConfigTypeDef,
S3ReportExportConfigTypeDef,
SourceAuthTypeDef,
SourceCredentialsInfoTypeDef,
TagTypeDef,
TestCaseTypeDef,
TestReportSummaryTypeDef,
VpcConfigTypeDef,
WebhookFilterTypeDef,
WebhookTypeDef,
PyPI 官网下载 | mypy-boto3-codebuild-1.17.24.0.tar.gz
版权申诉
128 浏览量
2022-01-28
15:16:22
上传
评论
收藏 19KB GZ 举报
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
最新资源
- 写入三菱plcD位寄存器的值
- 确保你的操作系统符合Docker的要求 Docker支持的操作系统包括Ubuntu、Debian、CentOS、Fedora和m
- 确保你的操作系统符合Docker的要求 Docker支持的操作系统包括Ubuntu、Debian、CentOS、Fedora和m
- HDMI 虚拟软件欺骗器
- 确保你的操作系统符合Docker的要求 Docker支持的操作系统包括Ubuntu、Debian、CentOS、Fedora和m
- 读取三菱PLC D位寄存器
- HDMI edid 编辑工具
- 要在你的计算机上安装Docker,你可以按照以下步骤进行:
- 要在你的计算机上安装Docker,你可以按照以下步骤进行:
- html加JavaScript进行表单验证
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈