Coverage for pyTooling / Attributes / ArgParse / KeyValueFlag.py: 48%

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# 

32from typing import Optional as Nullable 

33 

34from pyTooling.Decorators import export 

35from pyTooling.Attributes.ArgParse.Argument import NamedAndValuedArgument 

36 

37 

38@export 

39class NamedKeyValuePairsArgument(NamedAndValuedArgument): 

40 """ 

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

42 

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

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

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

46 """ 

47 

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

49 """ 

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

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

52 

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

54 

55 * ``action="store_const"`` 

56 * ``const=True`` 

57 * ``default=False`` 

58 

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

60 """ 

61 args = [] 

62 if short is not None: 

63 args.append(short) 

64 if long is not None: 

65 args.append(long) 

66 

67 kwargs = { 

68 "dest": dest, 

69 "action": "store_const", 

70 "const": True, 

71 "default": False, 

72 "help": help, 

73 } 

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

75 

76 

77@export 

78class ShortKeyValueFlag(NamedKeyValuePairsArgument): 

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

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

81 

82 

83@export 

84class LongKeyValueFlag(NamedKeyValuePairsArgument): 

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

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