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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
# MIT License
#
# Copyright The SCons Foundation
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""Variable type for package Variables.
To be used whenever a 'package' may be enabled/disabled and the
package path may be specified.
Given these options ::
x11=no (disables X11 support)
x11=yes (will search for the package installation dir)
x11=/usr/local/X11 (will check this path for existence)
Can be used as a replacement for autoconf's ``--with-xxx=yyy`` ::
opts = Variables()
opts.Add(
PackageVariable(
key='x11',
help='use X11 installed here (yes = search some places)',
default='yes'
)
)
env = Environment(variables=opts)
if env['x11'] is True:
dir = ... # search X11 in some standard places ...
env['x11'] = dir
if env['x11']:
... # build with x11 ...
"""
from __future__ import annotations
import os
import functools
from typing import Callable
import SCons.Errors
__all__ = ['PackageVariable',]
ENABLE_STRINGS = ('1', 'yes', 'true', 'on', 'enable', 'search')
DISABLE_STRINGS = ('0', 'no', 'false', 'off', 'disable')
def _converter(val: str | bool, default: str) -> str | bool:
"""Convert a package variable.
Returns *val* if it looks like a path string, and ``False`` if it
is a disabling string. If *val* is an enabling string, returns
*default* unless *default* is an enabling or disabling string,
in which case ignore *default* and return ``True``.
.. versionchanged: 4.9.0
Now returns the default in case of a truthy value, matching what the
public documentation always claimed, except if the default looks
like one of the true/false strings.
"""
if isinstance(val, bool):
# check for non-subst case, so we don't lower() a bool.
lval = str(val).lower()
else:
lval = val.lower()
if lval in DISABLE_STRINGS:
return False
if lval in ENABLE_STRINGS:
# Can't return the default if it is one of the enable/disable strings;
# test code expects a bool.
if default in ENABLE_STRINGS:
return True
else:
return default
return val
def _validator(key: str, val, env, searchfunc) -> None:
"""Validate package variable for valid path.
Checks that if a path is given as the value, that pathname actually exists.
"""
if env[key] is True:
# NOTE: searchfunc is not in the documentation.
if searchfunc:
env[key] = searchfunc(key, val)
# TODO: need to check path, or be sure searchfunc raises.
elif env[key] and not os.path.exists(val):
msg = f'Path does not exist for variable {key!r}: {val!r}'
raise SCons.Errors.UserError(msg) from None
# lint: W0622: Redefining built-in 'help' (redefined-builtin)
def PackageVariable(
key: str, help: str, default, searchfunc: Callable | None = None
) -> tuple[str, str, str, Callable, Callable]:
"""Return a tuple describing a package list SCons Variable.
The input parameters describe a 'package list' variable. Returns
a tuple with the correct converter and validator appended.
The result is usable as input to :meth:`~SCons.Variables.Variables.Add`.
A 'package list' variable may be specified as a truthy string from
:const:`ENABLE_STRINGS`, a falsy string from
:const:`DISABLE_STRINGS`, or as a pathname string.
This information is appended to *help* using only one string
each for truthy/falsy.
"""
help = '\n '.join((help, f'( yes | no | /path/to/{key} )'))
validator = functools.partial(_validator, searchfunc=searchfunc)
converter = functools.partial(_converter, default=default)
return key, help, default, validator, converter
# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4:
|
