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
|
# ==================================================================================================================== #
# _____ _ _ ____ _ ___ _ _ _ _ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ / ___| | |_ _| / \ | |__ ___| |_ _ __ __ _ ___| |_(_) ___ _ __ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` || | | | | | / _ \ | '_ \/ __| __| '__/ _` |/ __| __| |/ _ \| '_ \ #
# | |_) | |_| || | (_) | (_) | | | | | | (_| || |___| |___ | | / ___ \| |_) \__ \ |_| | | (_| | (__| |_| | (_) | | | | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____|_____|___/_/ \_\_.__/|___/\__|_| \__,_|\___|\__|_|\___/|_| |_| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# 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::
:mod:`~pyTooling.CLIAbstraction.BooleanFlag`
|rarr| For flags with a different pattern based on the boolean value itself.
:mod:`~pyTooling.CLIAbstraction.ValuedFlag`
|rarr| For flags with a value.
:class:`~pyTooling.CLIAbstraction.OptionalValuedFlag.OptionalValuedFlag`
|rarr| For flags that have an optional value.
"""
from typing import Any
from pyTooling.Decorators import export
from pyTooling.MetaClasses import abstractclass
from pyTooling.CLIAbstraction.Argument import NamedArgument
@export
@abstractclass
class FlagArgument(NamedArgument):
"""
Base-class for all Flag classes, which represents a simple flag argument like ``-v`` or ``--verbose``.
A simple flag is a single value (absent/present or off/on) with no additional data (value).
"""
@export
@abstractclass
class ShortFlag(FlagArgument, pattern="-{0}"):
"""
Represents a :class:`~pyTooling.CLIAbstraction.Flag.FlagArgument` argument with a single dash.
**Example:**
* ``-optimize``
"""
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: Optional, this pattern is used to format an argument. |br|
Default: ``"-{0}"``.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
@export
@abstractclass
class LongFlag(FlagArgument, pattern="--{0}"):
"""
Represents a :class:`~pyTooling.CLIAbstraction.Flag.FlagArgument` argument with a double dash.
**Example:**
* ``--optimize``
"""
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: Optional, this pattern is used to format an argument. |br|
Default: ``"--{0}"``.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
@export
@abstractclass
class WindowsFlag(FlagArgument, pattern="/{0}"):
"""
Represents a :class:`~pyTooling.CLIAbstraction.Flag.FlagArgument` argument with a single slash.
**Example:**
* ``/optimize``
"""
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: Optional, this pattern is used to format an argument. |br|
Default: ``"/{0}"``.
:param kwargs: Any keyword argument.
"""
kwargs["pattern"] = pattern
super().__init_subclass__(*args, **kwargs)
|