mypy-boto3-codecommit 1.13.26.1

Type annotations for boto3.CodeCommit 1.13.26 service, generated by mypy-boto3-buider 2.0.3

mypy-boto3-codecommit

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

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

Generated by mypy-boto3-buider 2.0.3.

More information can be found on boto3-stubs page.

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

python -m pip install boto3-stubs[codecommit]

# update installed packages index for automated type discovery
python -m mypy_boto3

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

import boto3

from mypy_boto3_codecommit import CodeCommitClient

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

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



# Annotated paginators are included as well

import mypy_boto3_codecommit.paginator as codecommit_paginators

describe_pull_request_events_paginator: codecommit_paginators.DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")
get_comments_for_compared_commit_paginator: codecommit_paginators.GetCommentsForComparedCommitPaginator = client.get_paginator("get_comments_for_compared_commit")
get_comments_for_pull_request_paginator: codecommit_paginators.GetCommentsForPullRequestPaginator = client.get_paginator("get_comments_for_pull_request")
get_differences_paginator: codecommit_paginators.GetDifferencesPaginator = client.get_paginator("get_differences")
list_branches_paginator: codecommit_paginators.ListBranchesPaginator = client.get_paginator("list_branches")
list_pull_requests_paginator: codecommit_paginators.ListPullRequestsPaginator = client.get_paginator("list_pull_requests")
list_repositories_paginator: codecommit_paginators.ListRepositoriesPaginator = client.get_paginator("list_repositories")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_codecommit 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_codecommit as codecommit
from mypy_boto3_codecommit import CodeCommitClient

# with these
from mypy_boto3 import codecommit
from mypy_boto3.codecommit import CodeCommitClient