Type annotations for boto3.CodePipeline 1.14.0 service, generated by mypy-boto3-buider 2.1.0
Project description
mypy-boto3-codepipeline
Type annotations for boto3.CodePipeline 1.14.0 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.1.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
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.
from mypy_boto3_codepipeline import CodePipelineClient
from mypy_boto3_codepipeline.paginator import (
ListActionExecutionsPaginator,
ListActionTypesPaginator,
ListPipelineExecutionsPaginator,
ListPipelinesPaginator,
ListTagsForResourcePaginator,
ListWebhooksPaginator,
)
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.
from mypy_boto3_codepipeline.type_defs import AWSSessionCredentialsTypeDef, ...
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
import boto3
# 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c9cb8a8a4ae48bd6e8119a4ec048ca9b3b408406eb43e3948a454569bb374ce |
|
MD5 | b8a9fe9c499d86fba476e11deaa95e45 |
|
BLAKE2b-256 | 0ffaa5a646d734dd8186024eaa12b349cb15daf088b11a3b13ce563b4e2bcf74 |
Hashes for mypy_boto3_codepipeline-1.14.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73ae29b78794cece8b57063f13556593d0c6587044442061d5fb190e9b056b09 |
|
MD5 | 6479905e0b2ea916561a4a6385cc24bf |
|
BLAKE2b-256 | 3f1b7ffd88190c2c546b1a93c07d8fd33f3ee5720d97ca9541aa8648ff07392f |