Type annotations for boto3.CodeCommit 1.14.0 service, generated by mypy-boto3-buider 2.0.4
Project description
mypy-boto3-codecommit
Type annotations for boto3.CodeCommit 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.0.4.
More information can be found on boto3-stubs page.
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]
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")
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codecommit
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
import boto3
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("codecommit")
session_client = boto3.Session().client("codecommit")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-codecommit-1.14.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 932d633a5f4db140a414fc2748e6661a06907a1f93c743820bfbc6b5e8f353ed |
|
MD5 | b4f27f7002ab7f44308a9d7b27bdabe8 |
|
BLAKE2b-256 | a63c35307fe219a133e39b1e5b1a9d5859d0ad782ed639cec61382930db1ebdb |
Hashes for mypy_boto3_codecommit-1.14.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55660b08f1c7d130ad65f559e51be4171fc7def43e5aa741b8bf00aa3d1e25e8 |
|
MD5 | 0fafa7ec7e18a76425a844b23b10e9fa |
|
BLAKE2b-256 | 24f61c87641a372993483997c001c0e927aa0c74a8e8f16c7f3f21781b0f3c07 |