Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/click/__init__.py: 85%

1""" 

2Click is a simple Python module inspired by the stdlib optparse to make 

3writing command line scripts fun. Unlike other modules, it's based 

4around a simple API that does not come with too much magic and is 

5composable. 

6""" 

7 

8from __future__ import annotations 

9 

10from .core import Argument as Argument 

11from .core import Command as Command 

12from .core import CommandCollection as CommandCollection 

13from .core import Context as Context 

14from .core import Group as Group 

15from .core import Option as Option 

16from .core import Parameter as Parameter 

17from .core import ParameterSource as ParameterSource 

18from .decorators import argument as argument 

19from .decorators import command as command 

20from .decorators import confirmation_option as confirmation_option 

21from .decorators import group as group 

22from .decorators import help_option as help_option 

23from .decorators import make_pass_decorator as make_pass_decorator 

24from .decorators import option as option 

25from .decorators import pass_context as pass_context 

26from .decorators import pass_obj as pass_obj 

27from .decorators import password_option as password_option 

28from .decorators import version_option as version_option 

29from .exceptions import Abort as Abort 

30from .exceptions import BadArgumentUsage as BadArgumentUsage 

31from .exceptions import BadOptionUsage as BadOptionUsage 

32from .exceptions import BadParameter as BadParameter 

33from .exceptions import ClickException as ClickException 

34from .exceptions import FileError as FileError 

35from .exceptions import MissingParameter as MissingParameter 

36from .exceptions import NoSuchOption as NoSuchOption 

37from .exceptions import UsageError as UsageError 

38from .formatting import HelpFormatter as HelpFormatter 

39from .formatting import wrap_text as wrap_text 

40from .globals import get_current_context as get_current_context 

41from .termui import clear as clear 

42from .termui import confirm as confirm 

43from .termui import echo_via_pager as echo_via_pager 

44from .termui import edit as edit 

45from .termui import getchar as getchar 

46from .termui import launch as launch 

47from .termui import pause as pause 

48from .termui import progressbar as progressbar 

49from .termui import prompt as prompt 

50from .termui import secho as secho 

51from .termui import style as style 

52from .termui import unstyle as unstyle 

53from .types import BOOL as BOOL 

54from .types import Choice as Choice 

55from .types import DateTime as DateTime 

56from .types import File as File 

57from .types import FLOAT as FLOAT 

58from .types import FloatRange as FloatRange 

59from .types import INT as INT 

60from .types import IntRange as IntRange 

61from .types import ParamType as ParamType 

62from .types import Path as Path 

63from .types import STRING as STRING 

64from .types import Tuple as Tuple 

65from .types import UNPROCESSED as UNPROCESSED 

66from .types import UUID as UUID 

67from .utils import echo as echo 

68from .utils import format_filename as format_filename 

69from .utils import get_app_dir as get_app_dir 

70from .utils import get_binary_stream as get_binary_stream 

71from .utils import get_text_stream as get_text_stream 

72from .utils import open_file as open_file 

73 

74 

75def __getattr__(name: str) -> object: 

76 import warnings 

77 

78 if name == "BaseCommand": 

79 from .core import _BaseCommand 

80 

81 warnings.warn( 

82 "'BaseCommand' is deprecated and will be removed in Click 9.0. Use" 

83 " 'Command' instead.", 

84 DeprecationWarning, 

85 stacklevel=2, 

86 ) 

87 return _BaseCommand 

88 

89 if name == "MultiCommand": 

90 from .core import _MultiCommand 

91 

92 warnings.warn( 

93 "'MultiCommand' is deprecated and will be removed in Click 9.0. Use" 

94 " 'Group' instead.", 

95 DeprecationWarning, 

96 stacklevel=2, 

97 ) 

98 return _MultiCommand 

99 

100 if name == "OptionParser": 

101 from .parser import _OptionParser 

102 

103 warnings.warn( 

104 "'OptionParser' is deprecated and will be removed in Click 9.0. The" 

105 " old parser is available in 'optparse'.", 

106 DeprecationWarning, 

107 stacklevel=2, 

108 ) 

109 return _OptionParser 

110 

111 if name == "__version__": 

112 import importlib.metadata 

113 import warnings 

114 

115 warnings.warn( 

116 "The '__version__' attribute is deprecated and will be removed in" 

117 " Click 9.1. Use feature detection or" 

118 " 'importlib.metadata.version(\"click\")' instead.", 

119 DeprecationWarning, 

120 stacklevel=2, 

121 ) 

122 return importlib.metadata.version("click") 

123 

124 raise AttributeError(name)