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
|
# ==================================================================================================================== #
# _ _ _ _ _ _ _ ____ #
# / \ | |_| |_ _ __(_) |__ _ _| |_ ___ ___ / \ _ __ __ _| _ \ __ _ _ __ ___ ___ #
# / _ \| __| __| '__| | '_ \| | | | __/ _ \/ __| / _ \ | '__/ _` | |_) / _` | '__/ __|/ _ \ #
# _ _ _ / ___ \ |_| |_| | | | |_) | |_| | || __/\__ \_ / ___ \| | | (_| | __/ (_| | | \__ \ __/ #
# (_|_|_)_/ \_\__|\__|_| |_|_.__/ \__,_|\__\___||___(_)_/ \_\_| \__, |_| \__,_|_| |___/\___| #
# |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2024 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2007-2016 Patrick Lehmann - Dresden, Germany #
# #
# 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 #
# ==================================================================================================================== #
#
from pathlib import Path
from typing import Type
try:
from pyTooling.Decorators import export
from pyTooling.Attributes.ArgParse import CommandLineArgument
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Attributes.ArgParse.Argument] Could not import from 'pyTooling.*'!")
try:
from Decorators import export
from Attributes.ArgParse import CommandLineArgument
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Attributes.ArgParse.Argument] Could not import directly!")
raise ex
@export
class DelimiterArgument(CommandLineArgument):
"""
Represents a delimiter symbol like ``--``.
"""
@export
class NamedArgument(CommandLineArgument):
"""
Base-class for all command line arguments with a name.
"""
@export
class ValuedArgument(CommandLineArgument):
"""
Base-class for all command line arguments with a value.
"""
class NamedAndValuedArgument(NamedArgument, ValuedArgument):
"""
Base-class for all command line arguments with a name and a value.
"""
class NamedTupledArgument(NamedArgument, ValuedArgument):
"""
Class and base-class for all TupleFlag classes, which represents an argument with separate value.
A tuple argument is a command line argument followed by a separate value. Name and value are passed as two arguments
to the executable.
**Example: **
* `width 100``
"""
@export
class PositionalArgument(ValuedArgument):
"""
Represents a simple string argument containing any information encoded in a string.
TODO
A list of strings is available as :class:`~pyTooling.Attribute.ArgParse.Argument.StringListArgument`.
"""
def __init__(self, dest: str, metaName: str, type: Type = str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
args = []
kwargs = {
"dest": dest,
"metavar": metaName,
"type": type,
"help": help
}
if optional:
kwargs["nargs"] = "?"
super().__init__(*args, **kwargs)
@export
class StringArgument(PositionalArgument):
"""
Represents a simple string argument.
A list of strings is available as :class:`~pyTooling.Attribute.ArgParse.Argument.StringListArgument`.
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, str, optional, help)
@export
class IntegerArgument(PositionalArgument):
"""
Represents an integer argument.
A list of strings is available as :class:`~pyTooling.Attribute.ArgParse.Argument.StringListArgument`.
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, int, optional, help)
@export
class FloatArgument(PositionalArgument):
"""
Represents a floating point number argument.
A list of strings is available as :class:`~pyTooling.Attribute.ArgParse.Argument.StringListArgument`.
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, float, optional, help)
# TODO: Add option to class if path should be checked for existence
@export
class PathArgument(PositionalArgument):
"""
Represents a single path argument.
A list of paths is available as :class:`~pyTooling.Attribute.ArgParse.Argument.PathListArgument`.
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, Path, optional, help)
@export
class ListArgument(ValuedArgument):
"""
Represents a list of string argument (:class:`~pyTooling.Attribute.ArgParse.Argument.StringArgument`).
"""
def __init__(self, dest: str, metaName: str, type: Type = str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
args = []
kwargs = {
"dest": dest,
"metavar": metaName,
"nargs": "*" if optional else "+",
"type": type,
"help": help
}
super().__init__(*args, **kwargs)
@export
class StringListArgument(ListArgument):
"""
Represents a list of string argument (:class:`~pyTooling.Attribute.ArgParse.Argument.StringArgument`).
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, str, optional, help)
@export
class IntegerListArgument(ListArgument):
"""
Represents a list of string argument (:class:`~pyTooling.Attribute.ArgParse.Argument.StringArgument`).
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, int, optional, help)
@export
class FloatListArgument(ListArgument):
"""
Represents a list of string argument (:class:`~pyTooling.Attribute.ArgParse.Argument.StringArgument`).
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, float, optional, help)
@export
class PathListArgument(ListArgument):
"""
Represents a list of path arguments (:class:`~pyTooling.Attribute.ArgParse.Argument.PathArgument`).
"""
def __init__(self, dest: str, metaName: str, optional: bool = False, help: str = "") -> None:
"""
The constructor expects positional (``*args``) and/or named parameters (``**kwargs``) which are passed without
modification to :meth:`~ArgumentParser.add_argument`.
"""
super().__init__(dest, metaName, Path, optional, help)
|