Coverage for tests / test_annotated.py: 100%

1import sys 8 ctx1acdhefbg

2from pathlib import Path 8 ctx1acdhefbg

3from typing import Annotated 8 ctx1acdhefbg

4 

5import typer 8 ctx1acdhefbg

6from typer.testing import CliRunner 8 ctx1acdhefbg

7 

8from .utils import needs_py310 8 ctx1acdhefbg

9 

10runner = CliRunner() 8 ctx1acdhefbg

11 

12 

13def test_annotated_argument_with_default(): 8 ctx1acdhefbg

14 app = typer.Typer() 8 ctx1acdhefbg

15 

16 @app.command() 8 ctx1acdhefbg

17 def cmd(val: Annotated[int, typer.Argument()] = 0): 8 ctx1acdhefbg

18 print(f"hello {val}") 8 ctx1acdhefbg

19 

20 result = runner.invoke(app) 8 ctx1acdhefbg

21 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

22 assert "hello 0" in result.output 8 ctx1acdhefbg

23 

24 result = runner.invoke(app, ["42"]) 8 ctx1acdhefbg

25 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

26 assert "hello 42" in result.output 8 ctx1acdhefbg

27 

28 

29@needs_py310 8 ctx1acdhefbg

30def test_annotated_argument_in_string_type_with_default(): 8 ctx1acdhefbg

31 app = typer.Typer() 7 ctx1acdefbg

32 

33 @app.command() 7 ctx1acdefbg

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

35 print(f"hello {val}") 7 ctx1acdefbg

36 

37 result = runner.invoke(app) 7 ctx1acdefbg

38 assert result.exit_code == 0, result.output 7 ctx1acdefbg

39 assert "hello 0" in result.output 7 ctx1acdefbg

40 

41 result = runner.invoke(app, ["42"]) 7 ctx1acdefbg

42 assert result.exit_code == 0, result.output 7 ctx1acdefbg

43 assert "hello 42" in result.output 7 ctx1acdefbg

44 

45 

46def test_annotated_argument_with_default_factory(): 8 ctx1acdhefbg

47 app = typer.Typer() 8 ctx1acdhefbg

48 

49 def make_string(): 8 ctx1acdhefbg

50 return "I made it" 8 ctx1acdhefbg

51 

52 @app.command() 8 ctx1acdhefbg

53 def cmd(val: Annotated[str, typer.Argument(default_factory=make_string)]): 8 ctx1acdhefbg

54 print(val) 8 ctx1acdhefbg

55 

56 result = runner.invoke(app) 8 ctx1acdhefbg

57 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

58 assert "I made it" in result.output 8 ctx1acdhefbg

59 

60 result = runner.invoke(app, ["overridden"]) 8 ctx1acdhefbg

61 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

62 assert "overridden" in result.output 8 ctx1acdhefbg

63 

64 

65def test_annotated_option_with_argname_doesnt_mutate_multiple_calls(): 8 ctx1acdhefbg

66 app = typer.Typer() 8 ctx1acdhefbg

67 

68 @app.command() 8 ctx1acdhefbg

69 def cmd(force: Annotated[bool, typer.Option("--force")] = False): 8 ctx1acdhefbg

70 if force: 8 ctx1acdhefbg

71 print("Forcing operation") 8 ctx1acdhefbg

72 else: 

73 print("Not forcing") 8 ctx1acdhefbg

74 

75 result = runner.invoke(app) 8 ctx1acdhefbg

76 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

77 assert "Not forcing" in result.output 8 ctx1acdhefbg

78 

79 result = runner.invoke(app, ["--force"]) 8 ctx1acdhefbg

80 assert result.exit_code == 0, result.output 8 ctx1acdhefbg

81 assert "Forcing operation" in result.output 8 ctx1acdhefbg

82 

83 

84def test_annotated_custom_path(): 8 ctx1acdhefbg

85 app = typer.Typer() 8 ctx1acdhefbg

86 

87 class CustomPath(Path): 8 ctx1acdhefbg

88 # Subclassing Path was not fully supported before 3.12 

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

90 if sys.version_info < (3, 12): 8 ctx1acdhefbg

91 _flavour = type(Path())._flavour 3 ctx1ahb

92 

93 @app.command() 8 ctx1acdhefbg

94 def custom_parser( 8 ctx1acdhefbg

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

96 ): 

97 assert isinstance(my_path, CustomPath) 8 ctx1acdhefbg

98 

99 result = runner.invoke(app, "/some/quirky/path/implementation") 8 ctx1acdhefbg

100 assert result.exit_code == 0 8 ctx1acdhefbg