Type annotations for boto3.CodeBuild 1.14.31 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codebuild
Type annotations for boto3.CodeBuild 1.14.31 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.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 CodeBuild
service.
python -m pip install boto3-stubs[codebuild]
How to use
Client annotations
CodeBuildClient
provides annotations for boto3.client("codebuild")
.
import boto3
from mypy_boto3_codebuild import CodeBuildClient
from mypy_boto3_codebuild.paginator import (
DescribeTestCasesPaginator,
ListBuildsForProjectPaginator,
ListBuildsPaginator,
ListProjectsPaginator,
ListReportGroupsPaginator,
ListReportsForReportGroupPaginator,
ListReportsPaginator,
ListSharedProjectsPaginator,
ListSharedReportGroupsPaginator,
)
from mypy_boto3_codebuild.type_defs import BuildArtifactsTypeDef, ...
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.
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_test_cases_paginator: DescribeTestCasesPaginator = client.get_paginator("describe_test_cases")
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.
def get_structure() -> BuildArtifactsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codebuild
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
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("codebuild")
session_client = boto3.Session().client("codebuild")
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-codebuild-1.14.31.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 282f77f2ed8764827b1f764b5194bb52df06e442f543a6c63859e1306c3e575b |
|
MD5 | e4e0e8966cb71871bfd549d9148f06b7 |
|
BLAKE2b-256 | d75c496695e920088746fb015678736cfd173d5179bb2fbd3413ac158a791ea0 |
Hashes for mypy_boto3_codebuild-1.14.31.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b3a6d01ee793c8235bac1a514e690f2b81f87b76772524d15c4ef9ec308d450 |
|
MD5 | 19d888791e389fd77cf677417ab33c4e |
|
BLAKE2b-256 | 07898933fdb6269fd8d758bf5190e0861524c40cd27a1a0fdc66ffe06c841828 |