Coverage for typer / completion.py: 100%

1import os 7 ctx1abcdefg

2import sys 7 ctx1abcdefg

3from collections.abc import MutableMapping 7 ctx1abcdefg

4from typing import Any 7 ctx1abcdefg

5 

6import click 7 ctx1abcdefg

7 

8from ._completion_classes import completion_init 7 ctx1abcdefg

9from ._completion_shared import Shells, _get_shell_name, get_completion_script, install 7 ctx1abcdefg

10from .models import ParamMeta 7 ctx1abcdefg

11from .params import Option 7 ctx1abcdefg

12from .utils import get_params_from_function 7 ctx1abcdefg

13 

14_click_patched = False 7 ctx1abcdefg

15 

16 

17def get_completion_inspect_parameters() -> tuple[ParamMeta, ParamMeta]: 7 ctx1abcdefg

18 completion_init() 7 ctx1abcdefg

19 test_disable_detection = os.getenv("_TYPER_COMPLETE_TEST_DISABLE_SHELL_DETECTION") 7 ctx1abcdefg

20 if not test_disable_detection: 7 ctx1abcdefg

21 parameters = get_params_from_function(_install_completion_placeholder_function) 7 ctx1abcdefg

22 else: 

23 parameters = get_params_from_function( 7 ctx1abcdefg

24 _install_completion_no_auto_placeholder_function 

25 ) 

26 install_param, show_param = parameters.values() 7 ctx1abcdefg

27 return install_param, show_param 7 ctx1abcdefg

28 

29 

30def install_callback(ctx: click.Context, param: click.Parameter, value: Any) -> Any: 7 ctx1abcdefg

31 if not value or ctx.resilient_parsing: 7 ctx1abcdefg

32 return value # pragma: no cover 7 ctx1abcdefg

33 if isinstance(value, str): 7 ctx1abcdefg

34 shell, path = install(shell=value) 7 ctx1abcdefg

35 else: 

36 shell, path = install() 7 ctx1abcdefg

37 click.secho(f"{shell} completion installed in {path}", fg="green") 7 ctx1abcdefg

38 click.echo("Completion will take effect once you restart the terminal") 7 ctx1abcdefg

39 sys.exit(0) 7 ctx1abcdefg

40 

41 

42def show_callback(ctx: click.Context, param: click.Parameter, value: Any) -> Any: 7 ctx1abcdefg

43 if not value or ctx.resilient_parsing: 7 ctx1abcdefg

44 return value # pragma: no cover 7 ctx1abcdefg

45 prog_name = ctx.find_root().info_name 7 ctx1abcdefg

46 assert prog_name 7 ctx1abcdefg

47 complete_var = "_{}_COMPLETE".format(prog_name.replace("-", "_").upper()) 7 ctx1abcdefg

48 shell = "" 7 ctx1abcdefg

49 test_disable_detection = os.getenv("_TYPER_COMPLETE_TEST_DISABLE_SHELL_DETECTION") 7 ctx1abcdefg

50 if isinstance(value, str): 7 ctx1abcdefg

51 shell = value 7 ctx1abcdefg

52 elif not test_disable_detection: 7 ctx1abcdefg

53 detected_shell = _get_shell_name() 7 ctx1abcdefg

54 if detected_shell is not None: 7 ctx1abcdefg

55 shell = detected_shell 7 ctx1abcdefg

56 script_content = get_completion_script( 7 ctx1abcdefg

57 prog_name=prog_name, complete_var=complete_var, shell=shell 

58 ) 

59 click.echo(script_content) 7 ctx1abcdefg

60 sys.exit(0) 7 ctx1abcdefg

61 

62 

63# Create a fake command function to extract the completion parameters 

64def _install_completion_placeholder_function( 7 ctx1abcdefg

65 install_completion: bool = Option( 

66 None, 

67 "--install-completion", 

68 callback=install_callback, 

69 expose_value=False, 

70 help="Install completion for the current shell.", 

71 ), 

72 show_completion: bool = Option( 

73 None, 

74 "--show-completion", 

75 callback=show_callback, 

76 expose_value=False, 

77 help="Show completion for the current shell, to copy it or customize the installation.", 

78 ), 

79) -> Any: 

80 pass # pragma: no cover 

81 

82 

83def _install_completion_no_auto_placeholder_function( 7 ctx1abcdefg

84 install_completion: Shells = Option( 

85 None, 

86 callback=install_callback, 

87 expose_value=False, 

88 help="Install completion for the specified shell.", 

89 ), 

90 show_completion: Shells = Option( 

91 None, 

92 callback=show_callback, 

93 expose_value=False, 

94 help="Show completion for the specified shell, to copy it or customize the installation.", 

95 ), 

96) -> Any: 

97 pass # pragma: no cover 

98 

99 

100# Re-implement Click's shell_complete to add error message with: 

101# Invalid completion instruction 

102# To use 7.x instruction style for compatibility 

103# And to add extra error messages, for compatibility with Typer in previous versions 

104# This is only called in new Command method, only used by Click 8.x+ 

105def shell_complete( 7 ctx1abcdefg

106 cli: click.Command, 

107 ctx_args: MutableMapping[str, Any], 

108 prog_name: str, 

109 complete_var: str, 

110 instruction: str, 

111) -> int: 

112 import click 7 ctx1abcdefg

113 import click.shell_completion 7 ctx1abcdefg

114 

115 if "_" not in instruction: 7 ctx1abcdefg

116 click.echo("Invalid completion instruction.", err=True) 7 ctx1abcdefg

117 return 1 7 ctx1abcdefg

118 

119 # Click 8 changed the order/style of shell instructions from e.g. 

120 # source_bash to bash_source 

121 # Typer override to preserve the old style for compatibility 

122 # Original in Click 8.x commented: 

123 # shell, _, instruction = instruction.partition("_") 

124 instruction, _, shell = instruction.partition("_") 7 ctx1abcdefg

125 # Typer override end 

126 

127 comp_cls = click.shell_completion.get_completion_class(shell) 7 ctx1abcdefg

128 

129 if comp_cls is None: 7 ctx1abcdefg

130 click.echo(f"Shell {shell} not supported.", err=True) 7 ctx1abcdefg

131 return 1 7 ctx1abcdefg

132 

133 comp = comp_cls(cli, ctx_args, prog_name, complete_var) 7 ctx1abcdefg

134 

135 if instruction == "source": 7 ctx1abcdefg

136 click.echo(comp.source()) 7 ctx1abcdefg

137 return 0 7 ctx1abcdefg

138 

139 # Typer override to print the completion help msg with Rich 

140 if instruction == "complete": 7 ctx1abcdefg

141 click.echo(comp.complete()) 7 ctx1abcdefg

142 return 0 7 ctx1abcdefg

143 # Typer override end 

144 

145 click.echo(f'Completion instruction "{instruction}" not supported.', err=True) 7 ctx1abcdefg

146 return 1 7 ctx1abcdefg