Coverage for pyTooling/Attributes/ArgParse/Flag.py: 100%

1# ==================================================================================================================== # 

2# _ _ _ _ _ _ _ ____ # 

3# / \ | |_| |_ _ __(_) |__ _ _| |_ ___ ___ / \ _ __ __ _| _ \ __ _ _ __ ___ ___ # 

4# / _ \| __| __| '__| | '_ \| | | | __/ _ \/ __| / _ \ | '__/ _` | |_) / _` | '__/ __|/ _ \ # 

5# _ _ _ / ___ \ |_| |_| | | | |_) | |_| | || __/\__ \_ / ___ \| | | (_| | __/ (_| | | \__ \ __/ # 

6# (_|_|_)_/ \_\__|\__|_| |_|_.__/ \__,_|\__\___||___(_)_/ \_\_| \__, |_| \__,_|_| |___/\___| # 

7# |___/ # 

8# ==================================================================================================================== # 

9# Authors: # 

10# Patrick Lehmann # 

11# # 

12# License: # 

13# ==================================================================================================================== # 

14# Copyright 2017-2026 Patrick Lehmann - Bötzingen, Germany # 

15# Copyright 2007-2016 Patrick Lehmann - Dresden, Germany # 

16# # 

17# Licensed under the Apache License, Version 2.0 (the "License"); # 

18# you may not use this file except in compliance with the License. # 

19# You may obtain a copy of the License at # 

20# # 

21# http://www.apache.org/licenses/LICENSE-2.0 # 

22# # 

23# Unless required by applicable law or agreed to in writing, software # 

24# distributed under the License is distributed on an "AS IS" BASIS, # 

25# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # 

26# See the License for the specific language governing permissions and # 

27# limitations under the License. # 

28# # 

29# SPDX-License-Identifier: Apache-2.0 # 

30# ==================================================================================================================== # 

31# 

32""" 

33Attributes describing switch arguments - options without a value, like ``--verbose``. 

34 

35A switch is ``True`` when it appears on the command line and ``False`` otherwise. 

36""" 

37from typing import Optional as Nullable 

38 

39from pyTooling.Decorators import export 

40from pyTooling.Attributes.ArgParse.Argument import NamedArgument 

41 

42 

43@export 

44class FlagArgument(NamedArgument): 

45 """ 

46 Defines a switch argument like ``--help``. 

47 

48 Some of the named parameters passed to :meth:`~ArgumentParser.add_argument` are predefined (or overwritten) to create 

49 a boolean parameter passed to the registered handler method. The boolean parameter is ``True`` if the switch argument 

50 is present in the commandline arguments, otherwise ``False``. 

51 """ 

52 

53 def __init__(self, short: Nullable[str] = None, long: Nullable[str] = None, dest: Nullable[str] = None, help: Nullable[str] = None) -> None: 

54 """ 

55 Initializes a flag argument. 

56 

57 .. admonition:: ArgParse parameterization 

58 

59 :meth:`~argparse.ArgumentParser.add_argument` is called with the option strings from ``short`` and ``long`` 

60 as positional parameters, and with these named parameters: 

61 

62 * ``dest=dest`` 

63 * ``action="store_const"`` 

64 * ``const=True`` 

65 * ``default=False`` 

66 * ``help=help`` 

67 

68 ``action="store_const"`` with ``const=True`` and ``default=False`` is what makes the handler method receive a 

69 boolean. 

70 

71 :param short: Optional, short option name including the dash, e.g. ``"-v"``. Default: ``None``. 

72 :param long: Optional, long option name including the dashes, e.g. ``"--verbose"``. Default: ``None``. 

73 :param dest: Name the parsed value is stored under in the :class:`~argparse.Namespace`, and the name the handler 

74 method reads it by. 

75 :param help: Optional, help text shown for this argument in the help page. Default: ``None``. 

76 """ 

77 args = [] 

78 if short is not None: 

79 args.append(short) 

80 

81 if long is not None: 

82 args.append(long) 

83 

84 kwargs = { 

85 "dest": dest, 

86 "action": "store_const", 

87 "const": True, 

88 "default": False, 

89 "help": help, 

90 } 

91 super().__init__(*args, **kwargs) 

92 

93 

94@export 

95class ShortFlag(FlagArgument): 

96 """Defines a switch argument in short form like ``-v``.""" 

97 

98 def __init__(self, short: Nullable[str] = None, dest: Nullable[str] = None, help: Nullable[str] = None) -> None: 

99 """ 

100 Initialize a switch argument in its short form. 

101 

102 :param short: Optional, short form of the option, including its dash, e.g. :pycode:`short="-v"`. 

103 :param dest: Optional, name of the parameter the parsed value is passed to the handler method as. 

104 :param help: Optional, help text of the option, displayed in the help page. 

105 """ 

106 super().__init__(short=short, dest=dest, help=help) 

107 

108 

109@export 

110class LongFlag(FlagArgument): 

111 """Defines a switch argument in long form like ``--verbose``.""" 

112 

113 def __init__(self, long: Nullable[str] = None, dest: Nullable[str] = None, help: Nullable[str] = None) -> None: 

114 """ 

115 Initialize a switch argument in its long form. 

116 

117 :param long: Optional, long form of the option, including its dashes, e.g. :pycode:`long="--verbose"`. 

118 :param dest: Optional, name of the parameter the parsed value is passed to the handler method as. 

119 :param help: Optional, help text of the option, displayed in the help page. 

120 """ 

121 super().__init__(long=long, dest=dest, help=help)