Type annotations for boto3.CodePipeline 1.14.3 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-codepipeline
Type annotations for boto3.CodePipeline 1.14.3 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 CodePipeline
service.
python -m pip install boto3-stubs[codepipeline]
How to use
Client annotations
CodePipelineClient
provides annotations for boto3.client("codepipeline")
.
import boto3
from mypy_boto3_codepipeline import CodePipelineClient
from mypy_boto3_codepipeline.paginator import (
ListActionExecutionsPaginator,
ListActionTypesPaginator,
ListPipelineExecutionsPaginator,
ListPipelinesPaginator,
ListTagsForResourcePaginator,
ListWebhooksPaginator,
)
from mypy_boto3_codepipeline.type_defs import AWSSessionCredentialsTypeDef, ...
client: CodePipelineClient = boto3.client("codepipeline")
# 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: CodePipelineClient = session.client("codepipeline")
Paginators annotations
mypy_boto3_codepipeline.paginator
module contains type annotations for all paginators.
client: CodePipelineClient = boto3.client("codepipeline")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
list_action_executions_paginator: ListActionExecutionsPaginator = client.get_paginator("list_action_executions")
list_action_types_paginator: ListActionTypesPaginator = client.get_paginator("list_action_types")
list_pipeline_executions_paginator: ListPipelineExecutionsPaginator = client.get_paginator("list_pipeline_executions")
list_pipelines_paginator: ListPipelinesPaginator = client.get_paginator("list_pipelines")
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator("list_tags_for_resource")
list_webhooks_paginator: ListWebhooksPaginator = client.get_paginator("list_webhooks")
Typed dictionations
mypy_boto3_codepipeline.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> AWSSessionCredentialsTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_codepipeline
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("codepipeline")
session_client = boto3.Session().client("codepipeline")
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-codepipeline-1.14.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 313ffe0ec0a73042ea3598960fa5e26703788e4ef53c691559b624ab9c9bf374 |
|
MD5 | dada82bb7e446aaae546dba3cd93de80 |
|
BLAKE2b-256 | fb83d60ef20ab1e599d97f68ec648aeac3d33671e13eee25711b6ed041450e3d |
Hashes for mypy_boto3_codepipeline-1.14.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | be6f28fe35b49cf4f5c33ca798973eb165fa653f34ba43bd09f7c604217d3a25 |
|
MD5 | 03971e873632ea945fb8a0e00403d2ec |
|
BLAKE2b-256 | c911b573ad270d3018a88a7742bfc7ac823670351fb543eda831da504b7ba498 |