Coverage for klayout_pex/util/argparse_helpers.py: 85%

1#! /usr/bin/env python3 

2# 

3# -------------------------------------------------------------------------------- 

4# SPDX-FileCopyrightText: 2024 Martin Jan Köhler and Harald Pretl 

5# Johannes Kepler University, Institute for Integrated Circuits. 

6# 

7# This file is part of KPEX  

8# (see https://github.com/martinjankoehler/klayout-pex). 

9# 

10# This program is free software: you can redistribute it and/or modify 

11# it under the terms of the GNU General Public License as published by 

12# the Free Software Foundation, either version 3 of the License, or 

13# (at your option) any later version. 

14# 

15# This program is distributed in the hope that it will be useful, 

16# but WITHOUT ANY WARRANTY; without even the implied warranty of 

17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 

18# GNU General Public License for more details. 

19# 

20# You should have received a copy of the GNU General Public License 

21# along with this program. If not, see <http://www.gnu.org/licenses/>. 

22# SPDX-License-Identifier: GPL-3.0-or-later 

23# -------------------------------------------------------------------------------- 

24# 

25 

26import argparse 

27from enum import Enum, StrEnum 

28from typing import * 

29 

30 

31def render_enum_help(topic: str, 

32 enum_cls: Type[Enum], 

33 print_default: bool = True, 

34 lowercase_strenum: bool = False) -> str: 

35 def canonic_string(name: str, member: str) -> str: 

36 if issubclass(enum_cls, StrEnum): 

37 if name.lower() == 'default': 

38 return 'default' 

39 return member.lower() if lowercase_strenum else member 

40 return name.lower() 

41 if not hasattr(enum_cls, 'DEFAULT'): 

42 print_default = False 

43 case_list = [f"'{canonic_string(name, member)}'" 

44 for name, member in enum_cls.__members__.items() 

45 if name.lower() != 'default'] 

46 enum_help = f"{topic} ∈ \u007b{', '.join(case_list)}\u007d" 

47 if print_default: 

48 default_case: enum_cls = getattr(enum_cls, 'DEFAULT') 

49 if issubclass(enum_cls, StrEnum): 

50 default_value: str = default_case.value 

51 if lowercase_strenum: 

52 default_value = default_value.lower() 

53 else: 

54 default_value = default_case.name.lower() 

55 enum_help += f".\nDefaults to '{default_value}'" 

56 return enum_help 

57 

58 

59def true_or_false(arg) -> bool: 

60 if isinstance(arg, bool): 

61 return arg 

62 

63 match str(arg).lower(): 

64 case 'yes' | 'true' | 't' | 'y' | 1: 

65 return True 

66 case 'no' | 'false' | 'f' | 'n' | 0: 

67 return False 

68 case _: 

69 raise argparse.ArgumentTypeError('Boolean value expected.')