cursus.mods.exe_doc.base

Base classes and interfaces for execution document generation.

This module defines the base interfaces that all execution document helpers must implement.

class ExecutionDocumentHelper[source]

Bases: ABC

Base class for execution document helpers.

abstractmethod can_handle_step(step_name, config)[source]

Check if this helper can handle the given step.

Parameters:

  • step_name (str) – Name of the step

  • config (Any) – Configuration object for the step

Returns:

True if this helper can process the step, False otherwise

Return type:

bool

abstractmethod extract_step_config(step_name, config)[source]

Extract step configuration for execution document.

Parameters:

  • step_name (str) – Name of the step

  • config (Any) – Configuration object for the step

Returns:

Dictionary containing the step configuration for execution document

Return type:

Dict[str, Any]

exception ExecutionDocumentGenerationError[source]

Bases: Exception

Base exception for execution document generation errors.

exception ConfigurationNotFoundError[source]

Bases: ExecutionDocumentGenerationError

Raised when configuration cannot be found for a step.

exception UnsupportedStepTypeError[source]

Bases: ExecutionDocumentGenerationError

Raised when step type is not supported for execution document generation.