Type annotations for boto3.CodeCommit 1.14.4 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codecommit
Type annotations for boto3.CodeCommit 1.14.4 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for CodeCommit
service.
python -m pip install boto3-stubs[codecommit]
How to use
Client annotations
CodeCommitClient
provides annotations for boto3.client("codecommit")
.
import boto3
from mypy_boto3_codecommit import CodeCommitClient
from mypy_boto3_codecommit.paginator import (
DescribePullRequestEventsPaginator,
GetCommentsForComparedCommitPaginator,
GetCommentsForPullRequestPaginator,
GetDifferencesPaginator,
ListBranchesPaginator,
ListPullRequestsPaginator,
ListRepositoriesPaginator,
)
from mypy_boto3_codecommit.type_defs import ApprovalRuleEventMetadataTypeDef, ...
client: CodeCommitClient = boto3.client("codecommit")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: CodeCommitClient = session.client("codecommit")
Paginators annotations
mypy_boto3_codecommit.paginator
module contains type annotations for all paginators.
client: CodeCommitClient = boto3.client("codecommit")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_pull_request_events_paginator: DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")
get_comments_for_compared_commit_paginator: GetCommentsForComparedCommitPaginator = client.get_paginator("get_comments_for_compared_commit")
get_comments_for_pull_request_paginator: GetCommentsForPullRequestPaginator = client.get_paginator("get_comments_for_pull_request")
get_differences_paginator: GetDifferencesPaginator = client.get_paginator("get_differences")
list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches")
list_pull_requests_paginator: ListPullRequestsPaginator = client.get_paginator("list_pull_requests")
list_repositories_paginator: ListRepositoriesPaginator = client.get_paginator("list_repositories")
Typed dictionations
mypy_boto3_codecommit.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ApprovalRuleEventMetadataTypeDef:
return {
...
}
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
# 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.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5036910e5619f55a979ed78cb897b1d7bfa87b39639ce7eea7f566f79edb932 |
|
MD5 | 93a26eef2e5728fa8c6df557fed37473 |
|
BLAKE2b-256 | c3e7b683d90859132470b221a69c29aa54ba27be80658e2f451e52b403d25e8e |
Hashes for mypy_boto3_codecommit-1.14.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c210cc71dafbbf94bcfe20effa0f7a57a63621f807819b1a06051abf2d92db73 |
|
MD5 | a0e5441fbf3902b82987828c0bd5fa08 |
|
BLAKE2b-256 | 0fc060705e6af0ddc65beff855db472910a8b53083e8d7005a7106fc93fe353e |