Skip to content

Dependency Injection

Overview

Pipelex uses dependency injection to manage service dependencies and make components more modular and testable. The system allows you to customize and extend Pipelex's functionality by injecting your own implementations of various services.

Injection Methods

There are two main ways to inject custom implementations:

1. During Initialization

from pipelex import Pipelex

pipelex = Pipelex(
    template_provider=MyTemplateProvider(),
    llm_model_provider=MyLLMProvider(),
    plugin_manager=MyPluginManager(),
    inference_manager=MyInferenceManager(),
    pipeline_tracker=MyPipelineTracker(),
    activity_manager=MyActivityManager(),
    reporting_delegate=MyReportingDelegate()
)

pipelex.setup(
    secrets_provider=MySecretsProvider(),
    content_generator=MyContentGenerator(),
    pipe_router=MyPipeRouter()
)

2. Through the Hub

from pipelex.hub import PipelexHub

hub = PipelexHub()
hub.set_template_provider(MyTemplateProvider())
hub.set_llm_models_provider(MyLLMProvider())
hub.set_plugin_manager(MyPluginManager())
# ... and so on for other components

NoOp Implementations

Some components have "NoOp" (No Operation) implementations that are used when the feature is disabled:

  • ReportingNoOp: Used when reporting is disabled
  • PipelineTrackerNoOp: Used when pipeline tracking is disabled
  • ActivityManagerNoOp: Used when activity tracking is disabled

These NoOp implementations implement the same protocol but do nothing, allowing the system to function without the specific feature.

Protocol Compliance

All custom implementations MUST:

  1. Implement ALL methods defined in their respective protocols
  2. Match the exact method signatures (parameter names and types)
  3. Follow the protocol's documented behavior
  4. Handle errors appropriately
  5. Clean up resources when needed

Feature Flags

Some components are controlled by feature flags in the configuration:

  • is_reporting_enabled: Controls Reporting system
  • is_pipeline_tracking_enabled: Controls Pipeline Tracking
  • is_activity_tracking_enabled: Controls Activity Tracking

When a feature is disabled, the corresponding NoOp implementation is used automatically.

Available Injectable Components

Pipelex supports injection of the following components:

  1. Template Provider (TemplateLibrary)

    • Protocol: TemplateLibraryProtocol
    • Default: TemplateLibrary
    • Details

  2. LLM Model Provider (LLMModelLibrary)

    • Protocol: LLMModelLibraryProtocol
    • Default: LLMModelLibrary
    • Details

  3. Plugin Manager (PluginManager)

    • Protocol: PluginManagerProtocol
    • Default: PluginManager
    • Details

  4. Inference Manager (InferenceManager)

    • Protocol: InferenceManagerProtocol
    • Default: InferenceManager
    • Details

  5. Reporting Delegate (ReportingManager)

    • Protocol: ReportingProtocol
    • Default: ReportingManager or ReportingNoOp if disabled
    • Details

  6. Pipeline Tracker (PipelineTracker)

    • Protocol: PipelineTrackerProtocol
    • Default: PipelineTracker or PipelineTrackerNoOp if disabled
    • Details

  7. Activity Manager (ActivityManager)

    • Protocol: ActivityManagerProtocol
    • Default: ActivityManager or ActivityManagerNoOp if disabled
    • Details

  8. Secrets Provider (EnvSecretsProvider)

    • Protocol: SecretsProviderProtocol
    • Default: EnvSecretsProvider
    • Details

  9. Content Generator (ContentGenerator)

    • Protocol: ContentGeneratorProtocol
    • Default: ContentGenerator
    • Details

  10. Pipe Router (PipeRouter)

    • Protocol: PipeRouterProtocol
    • Default: PipeRouter
    • Details

Best Practices

⚠️ Under construction