mypy-boto3-codecommit 1.12.24.0

Type annotations for boto3.CodeCommit 1.12.24 service, generated by mypy-boto3-buider 1.0.5

mypy-boto3-codecommit

Type annotations for boto3.CodeCommit 1.12.24 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.0.5.

More information can be found on boto3-stubs page.

• mypy-boto3-codecommit
  • 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 CodeCommit service.

python -m pip install boto3-stubs[mypy-boto3-codecommit]

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

import boto3

from mypy_boto3 import codecommit
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_codecommit as codecommit

# 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("codecommit")
client: codecommit.CodeCommitClient = boto3.client("codecommit")

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


# Paginators need type annotation on creation
describe_pull_request_events_paginator: codecommit.DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")
get_comments_for_compared_commit_paginator: codecommit.GetCommentsForComparedCommitPaginator = client.get_paginator("get_comments_for_compared_commit")
get_comments_for_pull_request_paginator: codecommit.GetCommentsForPullRequestPaginator = client.get_paginator("get_comments_for_pull_request")
get_differences_paginator: codecommit.GetDifferencesPaginator = client.get_paginator("get_differences")
list_branches_paginator: codecommit.ListBranchesPaginator = client.get_paginator("list_branches")
list_pull_requests_paginator: codecommit.ListPullRequestsPaginator = client.get_paginator("list_pull_requests")
list_repositories_paginator: codecommit.ListRepositoriesPaginator = client.get_paginator("list_repositories")

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.