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
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ___ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| | |_ _| / \ | |__ ___| |_ _ __ __ _ ___| |_(_) ___ _ __ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | | | | | / _ \ | '_ \/ __| __| '__/ _` |/ __| __| |/ _ \| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |___| |___ | | / ___ \| |_) \__ \ |_| | | (_| | (__| |_| | (_) | | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|_____|___/_/ \_\_.__/|___/\__|_| \__,_|\___|\__|_|\___/|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# 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 #
# ==================================================================================================================== #
#
"""
This module implements command arguments. Usually, commands are mutually exclusive and the first argument in a list of
arguments to a program.
While commands can or cannot have prefix characters, they shouldn't be confused with flag arguments or string arguments.
**Example:**
* ``prog command -arg1 --argument2``
.. seealso::
* For simple flags (various formats). |br|
|rarr| :mod:`~pyTooling.CLIAbstraction.Flag`
* For string arguments. |br|
|rarr| :class:`~pyTooling.CLIAbstraction.Argument.StringArgument`
"""
from typing import Any, Self
try:
from pyTooling.Decorators import export
from pyTooling.CLIAbstraction.Argument import NamedArgument
except (ImportError, ModuleNotFoundError): # pragma: no cover
print("[pyTooling.Versioning] Could not import from 'pyTooling.*'!")
try:
from Decorators import export
from CLIAbstraction.Argument import NamedArgument
except (ImportError, ModuleNotFoundError) as ex: # pragma: no cover
print("[pyTooling.Versioning] Could not import directly!")
raise ex
# TODO: make this class abstract
@export
class CommandArgument(NamedArgument):
"""
Represents a command argument.
It is usually used to select a sub parser in a CLI argument parser or to hand over all following parameters to a
separate tool. An example for a command is 'checkout' in ``git.exe checkout``, which calls ``git-checkout.exe``.
**Example:**
* ``command``
"""
# 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 CommandArgument:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class ShortCommand(CommandArgument, pattern="-{0}"):
"""
Represents a command name with a single dash.
**Example:**
* ``-command``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "-{0}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"-{0}"``.
:param kwargs: Any keyword argument.
"""
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 ShortCommand:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class LongCommand(CommandArgument, pattern="--{0}"):
"""
Represents a command name with a double dash.
**Example:**
* ``--command``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "--{0}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"--{0}"``.
:param kwargs: Any keyword argument.
"""
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 LongCommand:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
@export
class WindowsCommand(CommandArgument, pattern="/{0}"):
"""
Represents a command name with a single slash.
**Example:**
* ``/command``
"""
def __init_subclass__(cls, *args: Any, pattern: str = "/{0}", **kwargs: Any) -> None:
"""
This method is called when a class is derived.
:param args: Any positional arguments.
:param pattern: This pattern is used to format an argument. |br|
Default: ``"/{0}"``.
:param kwargs: Any keyword argument.
"""
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 WindowsCommand:
raise TypeError(f"Class '{cls.__name__}' is abstract.")
return super().__new__(cls, *args, **kwargs)
|
