Skip to main content

Type annotations for boto3 CodePipeline 1.35.68 service generated with mypy-boto3-builder 8.3.1

Project description

mypy-boto3-codepipeline

PyPI - mypy-boto3-codepipeline PyPI - Python Version Docs PyPI - Downloads

boto3.typed

Type annotations for boto3 CodePipeline 1.35.68 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated by mypy-boto3-builder 8.3.1.

More information can be found on boto3-stubs page and in mypy-boto3-codepipeline docs.

See how it helps you find and fix potential bugs:

boto3-stubs demo

How to install

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CodePipeline.

From PyPI with pip

Install boto3-stubs for CodePipeline service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[codepipeline]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[codepipeline]'


# standalone installation
python -m pip install mypy-boto3-codepipeline

How to uninstall

python -m pip uninstall -y mypy-boto3-codepipeline

Usage

VSCode

python -m pip install 'boto3-stubs[codepipeline]'

Both type checking and code completion should now work. No explicit type annotations required, write your boto3 code as usual.

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use boto3-stubs-lite until the issue is resolved.

⚠️ If you experience slow performance and high CPU usage, try to disable PyCharm type checker and use mypy or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[codepipeline] in your environment:

python -m pip install 'boto3-stubs[codepipeline]'

Both type checking and code completion should now work.

Emacs

  • Install boto3-stubs with services you use in your environment:
python -m pip install 'boto3-stubs[codepipeline]'
(use-package lsp-pyright
  :ensure t
  :hook (python-mode . (lambda ()
                          (require 'lsp-pyright)
                          (lsp)))  ; or lsp-deferred
  :init (when (executable-find "python3")
          (setq lsp-pyright-python-executable-cmd "python3"))
  )
  • Make sure emacs uses the environment where you have installed boto3-stubs

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Sublime Text

  • Install boto3-stubs[codepipeline] with services you use in your environment:
python -m pip install 'boto3-stubs[codepipeline]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Other IDEs

Not tested, but as long as your IDE supports mypy or pyright, everything should work.

mypy

  • Install mypy: python -m pip install mypy
  • Install boto3-stubs[codepipeline] in your environment:
python -m pip install 'boto3-stubs[codepipeline]'

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

pyright

  • Install pyright: npm i -g pyright
  • Install boto3-stubs[codepipeline] in your environment:
python -m pip install 'boto3-stubs[codepipeline]'

Optionally, you can install boto3-stubs to typings directory.

Type checking should now work. No explicit type annotations required, write your boto3 code as usual.

Explicit type annotations

Client annotations

CodePipelineClient provides annotations for boto3.client("codepipeline").

from boto3.session import Session

from mypy_boto3_codepipeline import CodePipelineClient

client: CodePipelineClient = Session().client("codepipeline")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_codepipeline.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_codepipeline import CodePipelineClient
from mypy_boto3_codepipeline.paginator import (
    ListActionExecutionsPaginator,
    ListActionTypesPaginator,
    ListPipelineExecutionsPaginator,
    ListPipelinesPaginator,
    ListRuleExecutionsPaginator,
    ListTagsForResourcePaginator,
    ListWebhooksPaginator,
)

client: CodePipelineClient = Session().client("codepipeline")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
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_rule_executions_paginator: ListRuleExecutionsPaginator = client.get_paginator(
    "list_rule_executions"
)
list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
    "list_tags_for_resource"
)
list_webhooks_paginator: ListWebhooksPaginator = client.get_paginator("list_webhooks")

Literals

mypy_boto3_codepipeline.literals module contains literals extracted from shapes that can be used in user code for type checking.

Full list of CodePipeline Literals can be found in docs.

from mypy_boto3_codepipeline.literals import ActionCategoryType


def check_value(value: ActionCategoryType) -> bool: ...

Type definitions

mypy_boto3_codepipeline.type_defs module contains structures and shapes assembled to typed dictionaries and unions for additional type checking.

Full list of CodePipeline TypeDefs can be found in docs.

from mypy_boto3_codepipeline.type_defs import AWSSessionCredentialsTypeDef


def get_value() -> AWSSessionCredentialsTypeDef:
    return {...}

How it works

Fully automated mypy-boto3-builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers drop-in type annotations for you and makes sure that:

  • All available boto3 services are covered.
  • Each public class and method of every boto3 service gets valid type annotations extracted from botocore schemas.
  • Type annotations include up-to-date documentation.
  • Link to documentation is provided for every method.
  • Code is processed by ruff for readability.

What's new

Implemented features

  • Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
  • mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
  • Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
  • Generated TypeDefs for each service
  • Generated Literals for each service
  • Auto discovery of types for boto3.client and boto3.resource calls
  • Auto discovery of types for session.client and session.resource calls
  • Auto discovery of types for client.get_waiter and client.get_paginator calls
  • Auto discovery of types for ServiceResource and Resource collections
  • Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-codepipeline version is the same as related boto3 version and follows PEP 440 format.

Thank you

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.

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

mypy_boto3_codepipeline-1.35.68.tar.gz (36.0 kB view details)

Uploaded Source

Built Distribution

mypy_boto3_codepipeline-1.35.68-py3-none-any.whl (41.0 kB view details)

Uploaded Python 3

File details

Details for the file mypy_boto3_codepipeline-1.35.68.tar.gz.

File metadata

File hashes

Hashes for mypy_boto3_codepipeline-1.35.68.tar.gz
Algorithm Hash digest
SHA256 60eba48c85788eb0e9ae24f85f0bdd354d38a8dcf6db0a1d5fa82d5e93a75a42
MD5 aa56ffc74a8c8d93d94c88f0d2da71bc
BLAKE2b-256 4b41e37a96c2ece28199137f5fe9cceb6a51d6ed7be96a3248d159c20d799181

See more details on using hashes here.

File details

Details for the file mypy_boto3_codepipeline-1.35.68-py3-none-any.whl.

File metadata

File hashes

Hashes for mypy_boto3_codepipeline-1.35.68-py3-none-any.whl
Algorithm Hash digest
SHA256 debd5a6caad279c106e3d7a997f72ad94831bc372aab8d1982e6e1160a92e5e9
MD5 cb28022f2a90f27542debc4141717143
BLAKE2b-256 131d3a1e1f9b209eabbcb9a13be939421f4c40e0ff3e5356ef01f11f5ab57f9e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page