Skip to content

Examples#

Index > CodeCommit > Examples

Auto-generated documentation for CodeCommit type annotations stubs module types-aiobotocore-codecommit.

Client#

Implicit type annotations#

Can be used with types-aioboto3[codecommit] package installed.

Write your CodeCommit code as usual, type checking and code completion should work out of the box.

# CodeCommitClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("codecommit") as client:  # (1)
    result = await client.associate_approval_rule_template_with_repository()  # (2)
  1. client: CodeCommitClient
  2. result: EmptyResponseMetadataTypeDef
# DescribePullRequestEventsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("codecommit") as client:  # (1)
    paginator = client.get_paginator("describe_pull_request_events")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: DescribePullRequestEventsPaginator
  3. item: DescribePullRequestEventsOutputTypeDef

Explicit type annotations#

With types-aioboto3-lite[codecommit] or a standalone types_aiobotocore_codecommit package, you have to explicitly specify client: CodeCommitClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# CodeCommitClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_codecommit.client import CodeCommitClient
from types_aiobotocore_codecommit.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_codecommit.type_defs import AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef


session = Session()

client: CodeCommitClient
async with session.client("codecommit") as client:  # (1)
    kwargs: AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.associate_approval_rule_template_with_repository(**kwargs)  # (3)
  1. client: CodeCommitClient
  2. kwargs: AssociateApprovalRuleTemplateWithRepositoryInputRequestTypeDef
  3. result: EmptyResponseMetadataTypeDef
# DescribePullRequestEventsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_codecommit.client import CodeCommitClient
from types_aiobotocore_codecommit.paginator import DescribePullRequestEventsPaginator
from types_aiobotocore_codecommit.type_defs import DescribePullRequestEventsOutputTypeDef


session = Session()

client: CodeCommitClient
async with session.client("codecommit") as client:  # (1)
    paginator: DescribePullRequestEventsPaginator = client.get_paginator("describe_pull_request_events")  # (2)
    async for item in paginator.paginate(...):
        item: DescribePullRequestEventsOutputTypeDef
        print(item)  # (3)
  1. client: CodeCommitClient
  2. paginator: DescribePullRequestEventsPaginator
  3. item: DescribePullRequestEventsOutputTypeDef