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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ___ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| | |_ _| / \ | |__ ___| |_ _ __ __ _ ___| |_(_) ___ _ __ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | | | | | / _ \ | '_ \/ __| __| '__/ _` |/ __| __| |/ _ \| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |___| |___ | | / ___ \| |_) \__ \ |_| | | (_| | (__| |_| | (_) | | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|_____|___/_/ \_\_.__/|___/\__|_| \__,_|\___|\__|_|\___/|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2026 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2014-2016 Technische Universität Dresden - Germany, Chair of VLSI-Design, Diagnostics and Architecture #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
Flag arguments represent simple boolean values by being present or absent.
.. seealso::
* For flags with different pattern based on the boolean value itself. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.BooleanFlag`
* For flags with a value. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.ValuedFlag`
* For flags that have an optional value. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.NamedOptionalValuedFlag`
"""
from typing import Union, Iterable, Dict, cast, Any, Optional as Nullable, Self
try:
from pyTooling.Decorators import export
from pyTooling.Common import getFullyQualifiedName
from pyTooling.CLIAbstraction.Argument import NamedAndValuedArgument
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Versioning] Could not import from 'pyTooling.*'!")
try:
from Decorators import export
from Common import getFullyQualifiedName
from CLIAbstraction.Argument import NamedAndValuedArgument
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Versioning] Could not import directly!")
raise ex
@export
class NamedKeyValuePairsArgument(NamedAndValuedArgument, pattern="{0}{1}={2}"):
"""
Class and base-class for all KeyValueFlag classes, which represents a flag argument with key and value
(key-value-pairs).
An optional valued flag is a flag name followed by a value. The default delimiter sign is equal (``=``). Name and
value are passed as one argument to the executable even if the delimiter sign is a whitespace character. If the value
is None, no delimiter sign and value is passed.
**Example:**
* ``-gWidth=100``
"""
def __init_subclass__(cls, *args: Any, name: Nullable[str] = None, pattern: str = "{0}{1}={2}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param name: Name of the CLI argument.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"{0}{1}={2}"``.
:param kwargs: Any keyword argument.
"""
kwargs["name"] = name
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
# TODO: the whole class should be marked as abstract
# TODO: a decorator should solve the issue and overwrite the __new__ method with that code
def __new__(cls, *args: Any, **kwargs: Any) -> Self:
"""
Check if this class was directly instantiated without being derived to a subclass. If so, raise an error.
:param args: Any positional arguments.
:param kwargs: Any keyword arguments.
:raises TypeError: When this class gets directly instantiated without being derived to a subclass.
"""
if cls is NamedKeyValuePairsArgument:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
def __init__(self, keyValuePairs: Dict[str, str]) -> None:
super().__init__({})
for key, value in keyValuePairs.items():
if not isinstance(key, str):
ex = TypeError(f"Parameter 'keyValuePairs' contains a pair, where the key is not of type 'str'.")
ex.add_note(f"Got type '{getFullyQualifiedName(key)}'.")
raise ex
elif not isinstance(value, str):
ex = TypeError(f"Parameter 'keyValuePairs' contains a pair, where the value is not of type 'str'.")
ex.add_note(f"Got type '{getFullyQualifiedName(value)}'.")
raise ex
self._value[key] = value
@property
def Value(self) -> Dict[str, str]:
"""
Get the internal value.
:return: Internal value.
"""
return self._value
@Value.setter
def Value(self, keyValuePairs: Dict[str, str]) -> None:
"""
Set the internal value.
:param keyValuePairs: Value to set.
:raises ValueError: If value to set is None.
"""
innerDict = cast(Dict[str, str], self._value)
innerDict.clear()
for key, value in keyValuePairs.items():
if not isinstance(key, str):
ex = TypeError(f"Parameter 'keyValuePairs' contains a pair, where the key is not of type 'str'.")
ex.add_note(f"Got type '{getFullyQualifiedName(key)}'.")
raise ex
elif not isinstance(value, str):
ex = TypeError(f"Parameter 'keyValuePairs' contains a pair, where the value is not of type 'str'.")
ex.add_note(f"Got type '{getFullyQualifiedName(value)}'.")
raise ex
innerDict[key] = value
def AsArgument(self) -> Union[str, Iterable[str]]:
"""
Convert this argument instance to a string representation with proper escaping using the matching pattern based on
the internal name.
:return: Formatted argument.
:raises ValueError: If internal name is None.
"""
if self._name is None:
raise ValueError(f"Internal value '_name' is None.")
return [self._pattern.format(self._name, key, value) for key, value in self._value.items()]
@export
class ShortKeyValueFlag(NamedKeyValuePairsArgument, pattern="-{0}{1}={2}"):
"""
Represents a :py:class:`NamedKeyValueFlagArgument` with a single dash in front of the switch name.
**Example:**
* ``-DDEBUG=TRUE``
"""
def __init_subclass__(cls, *args: Any, name: Nullable[str] = None, pattern: str = "-{0}{1}={2}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param name: Name of the CLI argument.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"-{0}{1}={2}"``.
:param kwargs: Any keyword argument.
"""
kwargs["name"] = name
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
# TODO: the whole class should be marked as abstract
# TODO: a decorator should solve the issue and overwrite the __new__ method with that code
def __new__(cls, *args: Any, **kwargs: Any) -> Self:
"""
Check if this class was directly instantiated without being derived to a subclass. If so, raise an error.
:param args: Any positional arguments.
:param kwargs: Any keyword arguments.
:raises TypeError: When this class gets directly instantiated without being derived to a subclass.
"""
if cls is ShortKeyValueFlag:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class LongKeyValueFlag(NamedKeyValuePairsArgument, pattern="--{0}{1}={2}"):
"""
Represents a :py:class:`NamedKeyValueFlagArgument` with a double dash in front of the switch name.
**Example:**
* ``--DDEBUG=TRUE``
"""
def __init_subclass__(cls, *args: Any, name: Nullable[str] = None, pattern: str = "--{0}{1}={2}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param name: Name of the CLI argument.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"--{0}{1}={2}"``.
:param kwargs: Any keyword argument.
"""
kwargs["name"] = name
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
# TODO: the whole class should be marked as abstract
# TODO: a decorator should solve the issue and overwrite the __new__ method with that code
def __new__(cls, *args: Any, **kwargs: Any) -> Self:
"""
Check if this class was directly instantiated without being derived to a subclass. If so, raise an error.
:param args: Any positional arguments.
:param kwargs: Any keyword arguments.
:raises TypeError: When this class gets directly instantiated without being derived to a subclass.
"""
if cls is LongKeyValueFlag:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class WindowsKeyValueFlag(NamedKeyValuePairsArgument, pattern="/{0}:{1}={2}"):
"""
Represents a :py:class:`NamedKeyValueFlagArgument` with a double dash in front of the switch name.
**Example:**
* ``--DDEBUG=TRUE``
"""
def __init_subclass__(cls, *args: Any, name: Nullable[str] = None, pattern: str = "/{0}:{1}={2}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param name: Name of the CLI argument.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"/{0}:{1}={2}"``.
:param kwargs: Any keyword argument.
"""
kwargs["name"] = name
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
# TODO: the whole class should be marked as abstract
# TODO: a decorator should solve the issue and overwrite the __new__ method with that code
def __new__(cls, *args: Any, **kwargs: Any) -> Self:
"""
Check if this class was directly instantiated without being derived to a subclass. If so, raise an error.
:param args: Any positional arguments.
:param kwargs: Any keyword arguments.
:raises TypeError: When this class gets directly instantiated without being derived to a subclass.
"""
if cls is LongKeyValueFlag:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
|
