mypy-boto3-codepipeline: Type Annotations for boto3 CodePipeline

1.42.3 · active · verified Sat Apr 11

This library provides type annotations (stubs) for the `boto3` AWS CodePipeline client. It enables static type checking for `boto3` usage with tools like `mypy`, enhancing developer productivity and catching potential errors at compile time. Maintained by the `mypy-boto3-builder` project, it receives frequent updates to align with new `boto3` releases and `botocore` service definitions.

Warnings

breaking Python 3.8 support was removed and packages migrated to PEP 561.
Fix: Upgrade your Python environment to 3.9 or newer. Ensure your `mypy` configuration is up-to-date and correctly identifies installed PEP 561 stubs.
gotcha This package provides *only* type annotations (stubs) for boto3.
Fix: You must install the `boto3` library (e.g., `pip install boto3`) separately for your code to run at runtime. `mypy-boto3-codepipeline` does not include the runtime library.
gotcha For optimal type checking, align `mypy-boto3-codepipeline` with your `boto3` runtime version.
Fix: While `mypy-boto3` stubs generally work with a range of `boto3` versions, minor API discrepancies might exist between highly mismatched versions. Keep both `boto3` and `mypy-boto3-codepipeline` updated to their latest compatible versions for the best experience.
gotcha Use `if TYPE_CHECKING:` guards for stub imports to avoid runtime overhead.
Fix: Wrap your `from mypy_boto3_codepipeline.client import ...` and `from mypy_boto3_codepipeline.type_defs import ...` imports within `if TYPE_CHECKING:` blocks. This ensures that the potentially large stub modules are only imported by type checkers and not during actual program execution, improving runtime performance.

Install

pip install mypy-boto3-codepipeline Install package
pip install boto3 mypy Install runtime and type checker

Imports

CodePipelineClient
```
from mypy_boto3_codepipeline.client import CodePipelineClient
```
Type stubs are separate packages and not part of the `boto3` runtime imports. Use `TYPE_CHECKING` to guard stub imports for runtime efficiency.
ListPipelinesOutputTypeDef
```
from mypy_boto3_codepipeline.type_defs import ListPipelinesOutputTypeDef
```
Imports specific TypeDefs for precise type hinting of API responses.

Quickstart

This quickstart demonstrates how to use `mypy-boto3-codepipeline` to add static type checking to your `boto3` CodePipeline client interactions. The `TYPE_CHECKING` guard ensures that the stub imports are only processed by type checkers like `mypy` and are not loaded during runtime, improving application startup performance.

import boto3
from typing import TYPE_CHECKING, List, Dict, Any

# Guard type imports for runtime efficiency
if TYPE_CHECKING:
    from mypy_boto3_codepipeline.client import CodePipelineClient
    from mypy_boto3_codepipeline.type_defs import ListPipelinesOutputTypeDef
    
def get_codepipeline_pipelines() -> List[str]:
    # The actual runtime client from boto3
    client: CodePipelineClient = boto3.client("codepipeline")

    # The type checker knows the methods available on 'client'
    response: ListPipelinesOutputTypeDef = client.list_pipelines()
    
    pipeline_names = [
        p['name'] for p in response.get("pipelines", [])
        if 'name' in p and isinstance(p['name'], str)
    ]
    print(f"CodePipeline Pipelines: {pipeline_names}")
    return pipeline_names

if __name__ == "__main__":
    # This example does not require specific credentials beyond default AWS configuration.
    # Ensure boto3 is configured (e.g., via AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, 
    # or ~/.aws/credentials, or IAM roles).
    try:
        pipelines = get_codepipeline_pipelines()
    except Exception as e:
        print(f"Error fetching CodePipeline pipelines: {e}")
        print("Please ensure your AWS credentials and region are configured.")

view raw JSON →