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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
#
# Copyright (C) 2017 Codethink Limited
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
from typing import TYPE_CHECKING
from ..node import _assert_symbol_name
if TYPE_CHECKING:
from typing import Optional
# Shared symbols for validation purposes
#
OPTION_SYMBOLS = ["type", "description", "variable"]
# Option()
#
# An abstract class representing a project option.
#
# Concrete classes must be created to handle option types,
# the loaded project options is a collection of typed Option
# instances.
#
class Option:
# Subclasses use this to specify the type name used
# for the yaml format and error messages
OPTION_TYPE = None # type: Optional[str]
def __init__(self, name, definition, pool):
self.name = name
self.variable = None
self.value = None
self.pool = pool
self.load(definition)
# load()
#
# Loads the option attributes from the descriptions
# in the project.conf
#
# Args:
# node (dict): The loaded YAML dictionary describing
# the option
def load(self, node):
# We don't use the description, but we do require that options have a
# description.
node.get_str("description")
self.variable = node.get_str("variable", default=None)
# Assert valid symbol name for variable name
if self.variable is not None:
_assert_symbol_name(self.variable, "variable name", ref_node=node.get_node("variable"))
# load_value()
#
# Loads the value of the option in string form.
#
# Args:
# node (Mapping): The YAML loaded key/value dictionary
# to load the value from
# transform (callbable): Transform function for variable substitution
#
def load_value(self, node, *, transform=None):
pass # pragma: nocover
# set_value()
#
# Sets the value of an option from a string passed
# to buildstream on the command line
#
# Args:
# value (str): The value in string form
#
def set_value(self, value):
pass # pragma: nocover
# get_value()
#
# Gets the value of an option in string form, this
# is for the purpose of exporting option values to
# variables which must be in string form.
#
# Returns:
# (str): The value in string form
#
def get_value(self):
pass # pragma: nocover
# resolve()
#
# Called on each option once, after all configuration
# and cli options have been passed.
#
def resolve(self):
pass # pragma: nocover
|
