pjkm.core.tasks.base

Base task interface and decorator for lightweight task registration.

Classes

BaseTask

Abstract base class for all pjkm tasks.

Module Contents

class pjkm.core.tasks.base.BaseTask

Bases: abc.ABC

Abstract base class for all pjkm tasks.

id: str

phase: pjkm.core.models.task.Phase

depends_on: list[str] = []

description: str = ''

should_run(ctx)

Override to conditionally skip this task based on context.

Parameters:

ctx (pjkm.core.engine.task_context.TaskContext)

Return type:

bool

abstractmethod execute(ctx)

Run the task and return its result.

Parameters:

ctx (pjkm.core.engine.task_context.TaskContext)

Return type:

pjkm.core.models.task.TaskResult

skip_result()

Return a skip result for this task.

Return type:

pjkm.core.models.task.TaskResult

success_result(message='', files_created=None, files_modified=None, duration_ms=0.0)

Parameters:

• message (str)

• files_created (list[str] | None)

• files_modified (list[str] | None)

• duration_ms (float)

Return type:

pjkm.core.models.task.TaskResult

failure_result(message, duration_ms=0.0)

Parameters:

• message (str)

• duration_ms (float)

Return type:

pjkm.core.models.task.TaskResult