mypy-boto3-datapipeline Type Stubs

Warnings

• breaking Python 3.8 support was removed for `mypy-boto3-builder` in version 8.12.0. Consequently, `mypy-boto3-datapipeline` versions built with this builder (e.g., 1.42.3 and newer) require Python 3.9 or higher.
  Fix: Upgrade your Python environment to 3.9 or newer.
• breaking With `mypy-boto3-builder` 8.9.0, some `TypeDef` names were shortened (e.g., `CreateDistributionRequestRequestTypeDef` became `CreateDistributionRequestTypeDef`) or adjusted for conflicts (e.g., `CreateDistributionExtraRequestTypeDef` to `CreateDistributionRequestExtraTypeDef`). If you explicitly import and use these type definitions, your code might break.
  Fix: Update your import paths and `TypeDef` names according to the latest generated stubs. Consult the specific `type_defs.pyi` for the correct names.
• gotcha These packages provide only type stubs for `boto3`. The `boto3` library itself is a separate runtime dependency and must be installed alongside `mypy-boto3-datapipeline` for your code to execute.
  Fix: Ensure both `boto3` and `mypy-boto3-datapipeline` are installed (e.g., `pip install boto3 mypy-boto3-datapipeline`).
• gotcha mypy-boto3 packages are exclusively for static type checking (e.g., with MyPy or Pyright) and do not modify the runtime behavior of the `boto3` library. They are purely for design-time analysis and do not need to be imported at runtime.
  Fix: Use type imports (`from typing import TYPE_CHECKING`) for explicit type hints to avoid unnecessary runtime imports.

Install

• pip install boto3 mypy-boto3-datapipeline Install boto3 and its DataPipeline stubs

Imports

• DataPipelineClient

  from mypy_boto3_datapipeline.client import DataPipelineClient

  For explicit type hinting of the boto3 DataPipeline client object.
• Client via boto3.client

  import boto3
  from typing import TYPE_CHECKING
  
  if TYPE_CHECKING:
      from mypy_boto3_datapipeline.client import DataPipelineClient
  
  def get_datapipeline_client() -> DataPipelineClient:
      return boto3.client('datapipeline')

  The most common usage pattern. Mypy picks up the stubs automatically when `boto3` is used.
• CreatePipelineInputRequestTypeDef

  from mypy_boto3_datapipeline.type_defs import CreatePipelineInputRequestTypeDef

  For explicit type hinting of service-specific request dictionaries.

Quickstart

This quickstart demonstrates how to initialize a `boto3` DataPipeline client and leverage `mypy-boto3-datapipeline` type stubs for static analysis. It shows the common pattern of obtaining a client via `boto3.client` and how to use `TYPE_CHECKING` for explicit type hints without runtime impact. Ensure both `boto3` and `mypy-boto3-datapipeline` are installed for this example to run and be type-checked.

import boto3
from typing import TYPE_CHECKING

# Ensure both boto3 and mypy-boto3-datapipeline are installed:
# pip install boto3 mypy-boto3-datapipeline

if TYPE_CHECKING:
    # Import the client type for explicit type hints within type-checking blocks
    from mypy_boto3_datapipeline.client import DataPipelineClient

# Obtain a DataPipeline client. Mypy will use the installed stubs for type checking.
datapipeline_client: DataPipelineClient = boto3.client("datapipeline")

print("Attempting to list DataPipeline pipelines:")
try:
    response = datapipeline_client.list_pipelines()
    pipelines = response.get("pipelineIdList", [])
    if pipelines:
        print(f"Found {len(pipelines)} pipelines:")
        for pipeline_info in pipelines:
            # Type checkers will enforce that 'id' and 'name' exist and are strings
            print(f"- ID: {pipeline_info['id']}, Name: {pipeline_info['name']}")
    else:
        print("No DataPipeline pipelines found in this AWS account/region.")
except datapipeline_client.exceptions.ClientError as e:
    print(f"AWS Client Error: {e}")
except Exception as e:
    print(f"An unexpected error occurred: {e}")

# Mypy will now correctly check types for datapipeline_client methods.
# For example, calling a non-existent method like 'datapipeline_client.non_existent_method()'
# would raise a Mypy error during static analysis.