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
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ___ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| | |_ _| / \ | |__ ___| |_ _ __ __ _ ___| |_(_) ___ _ __ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | | | | | / _ \ | '_ \/ __| __| '__/ _` |/ __| __| |/ _ \| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |___| |___ | | / ___ \| |_) \__ \ |_| | | (_| | (__| |_| | (_) | | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|_____|___/_/ \_\_.__/|___/\__|_| \__,_|\___|\__|_|\___/|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2024 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 #
# ==================================================================================================================== #
#
"""
List of valued flags are argument lists where each item is a valued flag (See
:mod:`~pyTooling.CLIAbstraction.ValuedFlag.ValuedFlag`).
Each list item gets translated into a ``***ValuedFlag``, with the same flag name, but differing values.
.. seealso::
* For single valued flags. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.ValuedFlag`
* For list of strings. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.Argument.StringListArgument`
* For list of paths. |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.Argument.PathListArgument`
"""
from typing import List, Union, Iterable, cast, Any
try:
from pyTooling.Decorators import export
from pyTooling.CLIAbstraction.Argument import ValueT, NamedAndValuedArgument
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Versioning] Could not import from 'pyTooling.*'!")
try:
from Decorators import export
from CLIAbstraction.Argument import ValueT, NamedAndValuedArgument
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Versioning] Could not import directly!")
raise ex
@export
class ValuedFlagList(NamedAndValuedArgument, pattern="{0}={1}"):
"""
Class and base-class for all ValuedFlagList classes, which represents a list of valued flags.
Each list element gets translated to a valued flag using the pattern for formatting.
See :mod:`~pyTooling.CLIAbstraction.ValuedFlag` for more details on valued flags.
**Example:**
* ``file=file1.log file=file2.log``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "{0}={1}", **kwargs: Any):
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
def __new__(cls, *args: Any, **kwargs: Any):
if cls is ValuedFlagList:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
def __init__(self, value: List[ValueT]) -> None:
super().__init__(list(value))
@property
def Value(self) -> List[str]:
"""
Get the internal value.
:return: Internal value.
"""
return self._value
@Value.setter
def Value(self, values: Iterable[str]) -> None:
"""
Set the internal value.
:param values: List of values to set.
:raises ValueError: If a list element is not o type :class:`str`.
"""
innerList = cast(list, self._value)
innerList.clear()
for value in values:
if not isinstance(value, str):
raise TypeError(f"Value contains elements which are not of type 'str'.")
innerList.append(value)
def AsArgument(self) -> Union[str, Iterable[str]]:
if self._name is None:
raise ValueError(f"") # XXX: add message
return [self._pattern.format(self._name, value) for value in self._value]
def __str__(self) -> str:
"""
Return a string representation of this argument instance.
:return: Space separated sequence of arguments formatted and each enclosed in double quotes.
"""
return " ".join([f"\"{value}\"" for value in self.AsArgument()])
def __repr__(self) -> str:
"""
Return a string representation of this argument instance.
:return: Comma separated sequence of arguments formatted and each enclosed in double quotes.
"""
return ", ".join([f"\"{value}\"" for value in self.AsArgument()])
@export
class ShortValuedFlagList(ValuedFlagList, pattern="-{0}={1}"):
"""
Represents a :py:class:`ValuedFlagArgument` with a single dash.
**Example:**
* ``-file=file1.log -file=file2.log``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "-{0}={1}", **kwargs: Any):
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
def __new__(cls, *args: Any, **kwargs: Any):
if cls is ShortValuedFlagList:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class LongValuedFlagList(ValuedFlagList, pattern="--{0}={1}"):
"""
Represents a :py:class:`ValuedFlagArgument` with a double dash.
**Example:**
* ``--file=file1.log --file=file2.log``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "--{0}={1}", **kwargs: Any):
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
def __new__(cls, *args: Any, **kwargs: Any):
if cls is LongValuedFlagList:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class WindowsValuedFlagList(ValuedFlagList, pattern="/{0}:{1}"):
"""
Represents a :py:class:`ValuedFlagArgument` with a single slash.
**Example:**
* ``/file:file1.log /file:file2.log``
"""
# TODO: Is it possible to copy the doc-string from super?
def __init_subclass__(cls, *args: Any, pattern: str = "/{0}:{1}", **kwargs: Any):
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
def __new__(cls, *args: Any, **kwargs: Any):
if cls is WindowsValuedFlagList:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
|