Skip to main content

mypy-boto3-codebuild

PyPI - mypy-boto3-codebuild PyPI - Python Version Docs

boto3.typed

Type annotations for boto3.CodeBuild 1.17.19 service compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-buider 4.4.0.

More information can be found on boto3-stubs page.

See how it helps to find and fix potential bugs:

boto3-stubs demo

How to install

Install boto3-stubs for CodeBuild service.

python -m pip install boto3-stubs[codebuild]

Usage

VSCode

  • Install Python extension
  • Install Pylance extension
  • 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").

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.

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.

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,
    BatchDeleteBuildsOutputTypeDef,
    BatchGetBuildBatchesOutputTypeDef,
    BatchGetBuildsOutputTypeDef,
    BatchGetProjectsOutputTypeDef,
    BatchGetReportGroupsOutputTypeDef,
    BatchGetReportsOutputTypeDef,
    BuildBatchFilterTypeDef,
    CreateProjectOutputTypeDef,
    CreateReportGroupOutputTypeDef,
    CreateWebhookOutputTypeDef,
    DeleteBuildBatchOutputTypeDef,
    DeleteSourceCredentialsOutputTypeDef,
    DescribeCodeCoveragesOutputTypeDef,
    DescribeTestCasesOutputTypeDef,
    GetReportGroupTrendOutputTypeDef,
    GetResourcePolicyOutputTypeDef,
    ImportSourceCredentialsOutputTypeDef,
    ListBuildBatchesForProjectOutputTypeDef,
    ListBuildBatchesOutputTypeDef,
    ListBuildsForProjectOutputTypeDef,
    ListBuildsOutputTypeDef,
    ListCuratedEnvironmentImagesOutputTypeDef,
    ListProjectsOutputTypeDef,
    ListReportGroupsOutputTypeDef,
    ListReportsForReportGroupOutputTypeDef,
    ListReportsOutputTypeDef,
    ListSharedProjectsOutputTypeDef,
    ListSharedReportGroupsOutputTypeDef,
    ListSourceCredentialsOutputTypeDef,
    PaginatorConfigTypeDef,
    PutResourcePolicyOutputTypeDef,
    ReportFilterTypeDef,
    RetryBuildBatchOutputTypeDef,
    RetryBuildOutputTypeDef,
    StartBuildBatchOutputTypeDef,
    StartBuildOutputTypeDef,
    StopBuildBatchOutputTypeDef,
    StopBuildOutputTypeDef,
    TestCaseFilterTypeDef,
    UpdateProjectOutputTypeDef,
    UpdateReportGroupOutputTypeDef,
    UpdateWebhookOutputTypeDef,
)

def get_structure() -> BatchRestrictionsTypeDef:
    return {
      ...
    }

Metadata

Release files for mypy-boto3-codebuild 1.17.19.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mypy-boto3-codebuild 1.17.19.0
File Size Uploaded Provenance Actions
mypy-boto3-codebuild-1.17.19.0.tar.gz 19.7 kB Without provenance Details for mypy-boto3-codebuild-1.17.19.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mypy-boto3-codebuild 1.17.19.0
File Interpreter ABI Platform Actions
mypy_boto3_codebuild-1.17.19.0-py3-none-any.whl Python 3 none any Details for mypy_boto3_codebuild-1.17.19.0-py3-none-any.whl

Total release size: 46.3 kB

Release files / mypy-boto3-codebuild-1.17.19.0.tar.gz

Download URL mypy-boto3-codebuild-1.17.19.0.tar.gz
Size 19.7 kB
Tags Source
SHA-256 checksum
How to use checksums
087b2b4cfc61a097f2093c97bc9c23f581a21de73641f00e12d4d3f00f4d2de2
BLAKE2b-256 checksum
How to use checksums
b72b773c7a0299269d6075724256d18c1dc897f9a0fb60150c5fc4078f6bbe6c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

Release files / mypy_boto3_codebuild-1.17.19.0-py3-none-any.whl

Download URL mypy_boto3_codebuild-1.17.19.0-py3-none-any.whl
Size 26.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9481954597367513264bc461573efc6551e38690edead400618c9a08446d7593
BLAKE2b-256 checksum
How to use checksums
1b3fffd0c7195782072b6cbca91ad0e21a73b81b001a7e905d60358677cd2a39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

Security for mypy-boto3-codebuild 1.17.19.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.17.19.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page