snakemake-interface-executor-plugins/snakemake_interface_executor_plugins/workflow.py at a98cff145620d011492e39815b785c29109e3546 · snakemake/snakemake-interface-executor-plugins · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
__author__ = "Johannes Köster"
__copyright__ = "Copyright 2023, Johannes Köster"
__email__ = "johannes.koester@uni-due.de"
__license__ = "MIT"

from abc import ABC, abstractmethod
from typing import Optional

from snakemake_interface_executor_plugins.cli import (
    SpawnedJobArgsFactoryExecutorInterface,
)
from snakemake_interface_executor_plugins.dag import DAGExecutorInterface
from snakemake_interface_executor_plugins.persistence import (
    PersistenceExecutorInterface,
)
from snakemake_interface_executor_plugins.registry.plugin import Plugin

from snakemake_interface_executor_plugins.scheduler import JobSchedulerExecutorInterface
from snakemake_interface_executor_plugins.settings import (
    DeploymentSettingsExecutorInterface,
    ExecutionSettingsExecutorInterface,
    GroupSettingsExecutorInterface,
    RemoteExecutionSettingsExecutorInterface,
    StorageSettingsExecutorInterface,
)


class WorkflowExecutorInterface(ABC):
    @property
    @abstractmethod
    def dag(self) -> DAGExecutorInterface: ...

    @property
    @abstractmethod
    def spawned_job_args_factory(self) -> SpawnedJobArgsFactoryExecutorInterface: ...

    @property
    @abstractmethod
    def execution_settings(self) -> ExecutionSettingsExecutorInterface: ...

    @property
    @abstractmethod
    def remote_execution_settings(self) -> RemoteExecutionSettingsExecutorInterface: ...

    @property
    @abstractmethod
    def storage_settings(self) -> StorageSettingsExecutorInterface: ...

    @property
    @abstractmethod
    def deployment_settings(self) -> DeploymentSettingsExecutorInterface: ...

    @property
    @abstractmethod
    def group_settings(self) -> GroupSettingsExecutorInterface: ...

    @property
    @abstractmethod
    def executor_plugin(self) -> Optional[Plugin]: ...

    @property
    @abstractmethod
    def resource_scopes(self): ...

    @property
    @abstractmethod
    def main_snakefile(self): ...

    @property
    @abstractmethod
    def persistence(self) -> PersistenceExecutorInterface: ...

    @property
    @abstractmethod
    def workdir_init(self): ...

    @property
    @abstractmethod
    def scheduler(self) -> JobSchedulerExecutorInterface: ...