lpcore.abc.analysis のソースコード

from typing import Any, ClassVar

from lpcore import TaskStatus
from lpcore.abc.task import Task




class Analysis(Task):
    """解析を行うタスクの基底クラス．
    
    Args:
        parameters (dict[str, Any], optional): 解析の初期化時のパラメタ．
            パラメタは， :attr:`parameters_required` で指定されたパラメタと一致する必要がある．
            デフォルト値は None．
        child_tasks (dict[str, Any], optional): 子タスク．
            子タスクは， :attr:`child_tasks_required` で指定されたタスクと一致する必要がある．
            デフォルト値は None．
        name (str, optional): 解析の名前．
            デフォルト値は None．
    """

    returned_data_required: ClassVar[dict[str, Any]] = {}



    def execute(self, **kwargs: Any) -> dict[str, Any]:
        """解析を実行するメソッド．

        Returns:
            tuple[TaskStatus, dict[str, Any]]: 解析の実行結果．
        """

        result: dict[str, Any] = super().execute(**kwargs)

        self.validate_parameters(result, self.returned_data_required, "returned_data")

        return result