mypy-boto3-codebuild 1.13.24.1

Type annotations for boto3.CodeBuild 1.13.24 service, generated by mypy-boto3-buider 1.1.0

mypy-boto3-codebuild

Type annotations for boto3.CodeBuild 1.13.24 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.1.0.

More information can be found on boto3-stubs page.

• mypy-boto3-codebuild
  • How to use
    • Type checking
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for CodeBuild service.

python -m pip install boto3-stubs[codebuild]

# update installed packages index
mypy_boto3

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import codebuild
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_codebuild as codebuild

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("codebuild")
client: codebuild.CodeBuildClient = boto3.client("codebuild")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: codebuild.CodeBuildClient = session.client("codebuild")


# Paginators need type annotation on creation
describe_test_cases_paginator: codebuild.DescribeTestCasesPaginator = client.get_paginator("describe_test_cases")
list_builds_paginator: codebuild.ListBuildsPaginator = client.get_paginator("list_builds")
list_builds_for_project_paginator: codebuild.ListBuildsForProjectPaginator = client.get_paginator("list_builds_for_project")
list_projects_paginator: codebuild.ListProjectsPaginator = client.get_paginator("list_projects")
list_report_groups_paginator: codebuild.ListReportGroupsPaginator = client.get_paginator("list_report_groups")
list_reports_paginator: codebuild.ListReportsPaginator = client.get_paginator("list_reports")
list_reports_for_report_group_paginator: codebuild.ListReportsForReportGroupPaginator = client.get_paginator("list_reports_for_report_group")
list_shared_projects_paginator: codebuild.ListSharedProjectsPaginator = client.get_paginator("list_shared_projects")
list_shared_report_groups_paginator: codebuild.ListSharedReportGroupsPaginator = client.get_paginator("list_shared_report_groups")

How it works

Fully automated builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a drop-in type annotations for you and makes sure that:

• All available boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.