-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathschema.py
More file actions
82 lines (63 loc) · 2.36 KB
/
schema.py
File metadata and controls
82 lines (63 loc) · 2.36 KB
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
80
81
82
"""Project schema specifications"""
from abc import abstractmethod
from typing import Any, Protocol
class API(Protocol):
"""Project API specification"""
@abstractmethod
def info(self) -> dict[str, Any]:
"""Return project and template information.
Returns:
A dictionary with project metadata and template status.
"""
raise NotImplementedError()
@abstractmethod
def install(self, groups: list[str] | None = None) -> None:
"""Installs project dependencies
Args:
groups: Optional list of dependency groups to install
"""
raise NotImplementedError()
@abstractmethod
def update(self, groups: list[str] | None = None) -> None:
"""Updates project dependencies
Args:
groups: Optional list of dependency groups to update
"""
raise NotImplementedError()
@abstractmethod
def build(self, configuration: str | None = None) -> None:
"""Builds the project
Args:
configuration: Optional named configuration to use. Interpretation is generator-specific
(e.g. CMake preset name, Meson build directory).
"""
raise NotImplementedError()
@abstractmethod
def test(self, configuration: str | None = None) -> None:
"""Runs project tests
Args:
configuration: Optional named configuration to use. Interpretation is generator-specific.
"""
raise NotImplementedError()
@abstractmethod
def bench(self, configuration: str | None = None) -> None:
"""Runs project benchmarks
Args:
configuration: Optional named configuration to use. Interpretation is generator-specific.
"""
raise NotImplementedError()
@abstractmethod
def run(self, target: str, configuration: str | None = None) -> None:
"""Runs a built executable
Args:
target: The name of the build target to run
configuration: Optional named configuration to use. Interpretation is generator-specific.
"""
raise NotImplementedError()
@abstractmethod
def list_targets(self) -> list[str]:
"""Lists discovered build targets/executables.
Returns:
A list of target names found in the build directory.
"""
raise NotImplementedError()