Coverage for tests / test_annotated.py: 100%

1import sys 7 ctx1acdebfg

2from pathlib import Path 7 ctx1acdebfg

3from typing import Annotated 7 ctx1acdebfg

4 

5import pytest 7 ctx1acdebfg

6import typer 7 ctx1acdebfg

7from typer.testing import CliRunner 7 ctx1acdebfg

8 

9runner = CliRunner() 7 ctx1acdebfg

10 

11 

12def test_annotated_argument_with_default(): 7 ctx1acdebfg

13 app = typer.Typer() 7 ctx1acdebfg

14 

15 @app.command() 7 ctx1acdebfg

16 def cmd(val: Annotated[int, typer.Argument()] = 0): 7 ctx1acdebfg

17 print(f"hello {val}") 7 ctx1acdebfg

18 

19 result = runner.invoke(app) 7 ctx1acdebfg

20 assert result.exit_code == 0, result.output 7 ctx1acdebfg

21 assert "hello 0" in result.output 7 ctx1acdebfg

22 

23 result = runner.invoke(app, ["42"]) 7 ctx1acdebfg

24 assert result.exit_code == 0, result.output 7 ctx1acdebfg

25 assert "hello 42" in result.output 7 ctx1acdebfg

26 

27 

28def test_annotated_argument_in_string_type_with_default(): 7 ctx1acdebfg

29 app = typer.Typer() 7 ctx1acdebfg

30 

31 @app.command() 7 ctx1acdebfg

32 def cmd(val: "Annotated[int, typer.Argument()]" = 0): 7 ctx1acdebfg

33 print(f"hello {val}") 7 ctx1acdebfg

34 

35 result = runner.invoke(app) 7 ctx1acdebfg

36 assert result.exit_code == 0, result.output 7 ctx1acdebfg

37 assert "hello 0" in result.output 7 ctx1acdebfg

38 

39 result = runner.invoke(app, ["42"]) 7 ctx1acdebfg

40 assert result.exit_code == 0, result.output 7 ctx1acdebfg

41 assert "hello 42" in result.output 7 ctx1acdebfg

42 

43 

44def test_annotated_argument_with_default_factory(): 7 ctx1acdebfg

45 app = typer.Typer() 7 ctx1acdebfg

46 

47 def make_string(): 7 ctx1acdebfg

48 return "I made it" 7 ctx1acdebfg

49 

50 @app.command() 7 ctx1acdebfg

51 def cmd(val: Annotated[str, typer.Argument(default_factory=make_string)]): 7 ctx1acdebfg

52 print(val) 7 ctx1acdebfg

53 

54 result = runner.invoke(app) 7 ctx1acdebfg

55 assert result.exit_code == 0, result.output 7 ctx1acdebfg

56 assert "I made it" in result.output 7 ctx1acdebfg

57 

58 result = runner.invoke(app, ["overridden"]) 7 ctx1acdebfg

59 assert result.exit_code == 0, result.output 7 ctx1acdebfg

60 assert "overridden" in result.output 7 ctx1acdebfg

61 

62 

63def test_annotated_option_with_argname_doesnt_mutate_multiple_calls(): 7 ctx1acdebfg

64 app = typer.Typer() 7 ctx1acdebfg

65 

66 @app.command() 7 ctx1acdebfg

67 def cmd(force: Annotated[bool, typer.Option("--force")] = False): 7 ctx1acdebfg

68 if force: 7 ctx1acdebfg

69 print("Forcing operation") 7 ctx1acdebfg

70 else: 

71 print("Not forcing") 7 ctx1acdebfg

72 

73 result = runner.invoke(app) 7 ctx1acdebfg

74 assert result.exit_code == 0, result.output 7 ctx1acdebfg

75 assert "Not forcing" in result.output 7 ctx1acdebfg

76 

77 result = runner.invoke(app, ["--force"]) 7 ctx1acdebfg

78 assert result.exit_code == 0, result.output 7 ctx1acdebfg

79 assert "Forcing operation" in result.output 7 ctx1acdebfg

80 

81 

82def test_annotated_custom_path(): 7 ctx1acdebfg

83 app = typer.Typer() 7 ctx1acdebfg

84 

85 class CustomPath(Path): 7 ctx1acdebfg

86 # Subclassing Path was not fully supported before 3.12 

87 # https://docs.python.org/3.12/whatsnew/3.12.html 

88 if sys.version_info < (3, 12): 7 ctx1acdebfg

89 _flavour = type(Path())._flavour 2 ctx1ab

90 

91 @app.command() 7 ctx1acdebfg

92 def custom_parser( 7 ctx1acdebfg

93 my_path: Annotated[CustomPath, typer.Argument(parser=CustomPath)], 

94 ): 

95 assert isinstance(my_path, CustomPath) 7 ctx1acdebfg

96 

97 result = runner.invoke(app, "/some/quirky/path/implementation") 7 ctx1acdebfg

98 assert result.exit_code == 0 7 ctx1acdebfg

99 

100 

101def test_annotated_option_invalid(): 7 ctx1acdebfg

102 app = typer.Typer() 7 ctx1acdebfg

103 

104 @app.command() 7 ctx1acdebfg

105 def cmd(value: Annotated[str, typer.Option(..., "foo-bar")]): 7 ctx1acdebfg

106 print(value) # pragma: no cover 

107 

108 with pytest.raises(ValueError, match="Invalid start character for option"): 7 ctx1acdebfg

109 runner.invoke(app, ["--help"], catch_exceptions=False) 7 ctx1acdebfg