Coverage for pyTooling/Attributes/ArgParse/ValuedFlag.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 options carrying a value, like ``--count=25``. 

34""" 

35from typing import Optional as Nullable 

36 

37from pyTooling.Decorators import export 

38from pyTooling.Attributes.ArgParse.Argument import NamedAndValuedArgument 

39 

40 

41@export 

42class ValuedFlag(NamedAndValuedArgument): 

43 """ 

44 Defines a switch argument like ``--count=25``. 

45 

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

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

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

49 """ 

50 

51 def __init__(self, short: Nullable[str] = None, long: Nullable[str] = None, dest: Nullable[str] = None, metaName: Nullable[str] = None, optional: bool = False, help: Nullable[str] = None) -> None: 

52 """ 

53 The constructor expects positional (``*args``), the destination parameter name ``dest`` and/or named parameters 

54 (``**kwargs``) which are passed to :meth:`~ArgumentParser.add_argument`. 

55 

56 To implement a switch argument, the following named parameters are predefined: 

57 

58 * ``action="store_const"`` 

59 * ``const=True`` 

60 * ``default=False`` 

61 

62 This implements a boolean parameter passed to the handler method. 

63 """ 

64 args = [] 

65 if short is not None: 

66 args.append(short) 

67 if long is not None: 

68 args.append(long) 

69 

70 kwargs = { 

71 "dest": dest, 

72 "metavar": metaName, 

73 "default": None, 

74 "help": help, 

75 "required": not optional 

76 } 

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

78 

79 

80@export 

81class ShortValuedFlag(ValuedFlag): 

82 """Defines a switch argument with a value in short form like ``-c=25``.""" 

83 

84 def __init__(self, short: Nullable[str] = None, dest: Nullable[str] = None, metaName: Nullable[str] = None, optional: bool = False, help: Nullable[str] = None) -> None: 

85 """ 

86 Initialize a switch argument with a value in its short form. 

87 

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

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

90 :param metaName: Optional, name of the value in the help page. 

91 :param optional: Optional, if ``True``, the option may be omitted. 

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

93 """ 

94 super().__init__(short, None, dest, metaName, optional, help) 

95 

96 

97@export 

98class LongValuedFlag(ValuedFlag): 

99 """Defines a switch argument with a value in long form like ``--count=25``.""" 

100 

101 def __init__(self, long: Nullable[str] = None, dest: Nullable[str] = None, metaName: Nullable[str] = None, optional: bool = False, help: Nullable[str] = None) -> None: 

102 """ 

103 Initialize a switch argument with a value in its long form. 

104 

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

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

107 :param metaName: Optional, name of the value in the help page. 

108 :param optional: Optional, if ``True``, the option may be omitted. 

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

110 """ 

111 super().__init__(None, long, dest, metaName, optional, help)