mypy-boto3-codebuild 1.13.26.0

Type annotations for boto3.CodeBuild 1.13.26 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-codebuild

• mypy-boto3-codebuild
  • How to use
  • Automated type discovery

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

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

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

How to use

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 for automated type discovery
python -m mypy_boto3

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

import boto3

from mypy_boto3_codebuild import CodeBuildClient

# Now mypy can check if your code is valid.
client: CodeBuildClient = boto3.client("codebuild")

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



# Annotated paginators are included as well

import mypy_boto3_codebuild.paginator as codebuild_paginators

describe_test_cases_paginator: codebuild_paginators.DescribeTestCasesPaginator = client.get_paginator("describe_test_cases")
list_builds_paginator: codebuild_paginators.ListBuildsPaginator = client.get_paginator("list_builds")
list_builds_for_project_paginator: codebuild_paginators.ListBuildsForProjectPaginator = client.get_paginator("list_builds_for_project")
list_projects_paginator: codebuild_paginators.ListProjectsPaginator = client.get_paginator("list_projects")
list_report_groups_paginator: codebuild_paginators.ListReportGroupsPaginator = client.get_paginator("list_report_groups")
list_reports_paginator: codebuild_paginators.ListReportsPaginator = client.get_paginator("list_reports")
list_reports_for_report_group_paginator: codebuild_paginators.ListReportsForReportGroupPaginator = client.get_paginator("list_reports_for_report_group")
list_shared_projects_paginator: codebuild_paginators.ListSharedProjectsPaginator = client.get_paginator("list_shared_projects")
list_shared_report_groups_paginator: codebuild_paginators.ListSharedReportGroupsPaginator = client.get_paginator("list_shared_report_groups")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_codebuild and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_codebuild as codebuild
from mypy_boto3_codebuild import CodeBuildClient

# with these
from mypy_boto3 import codebuild
from mypy_boto3.codebuild import CodeBuildClient