Coverage for tests / test_annotated.py: 100%

1import sys 7 ctx1acdefbg

2from pathlib import Path 7 ctx1acdefbg

3from typing import Annotated 7 ctx1acdefbg

4 

5import typer 7 ctx1acdefbg

6from typer.testing import CliRunner 7 ctx1acdefbg

7 

8runner = CliRunner() 7 ctx1acdefbg

9 

10 

11def test_annotated_argument_with_default(): 7 ctx1acdefbg

12 app = typer.Typer() 7 ctx1acdefbg

13 

14 @app.command() 7 ctx1acdefbg

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

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

17 

18 result = runner.invoke(app) 7 ctx1acdefbg

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

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

21 

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

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

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

25 

26 

27def test_annotated_argument_in_string_type_with_default(): 7 ctx1acdefbg

28 app = typer.Typer() 7 ctx1acdefbg

29 

30 @app.command() 7 ctx1acdefbg

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

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

33 

34 result = runner.invoke(app) 7 ctx1acdefbg

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

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

37 

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

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

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

41 

42 

43def test_annotated_argument_with_default_factory(): 7 ctx1acdefbg

44 app = typer.Typer() 7 ctx1acdefbg

45 

46 def make_string(): 7 ctx1acdefbg

47 return "I made it" 7 ctx1acdefbg

48 

49 @app.command() 7 ctx1acdefbg

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

51 print(val) 7 ctx1acdefbg

52 

53 result = runner.invoke(app) 7 ctx1acdefbg

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

55 assert "I made it" in result.output 7 ctx1acdefbg

56 

57 result = runner.invoke(app, ["overridden"]) 7 ctx1acdefbg

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

59 assert "overridden" in result.output 7 ctx1acdefbg

60 

61 

62def test_annotated_option_with_argname_doesnt_mutate_multiple_calls(): 7 ctx1acdefbg

63 app = typer.Typer() 7 ctx1acdefbg

64 

65 @app.command() 7 ctx1acdefbg

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

67 if force: 7 ctx1acdefbg

68 print("Forcing operation") 7 ctx1acdefbg

69 else: 

70 print("Not forcing") 7 ctx1acdefbg

71 

72 result = runner.invoke(app) 7 ctx1acdefbg

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

74 assert "Not forcing" in result.output 7 ctx1acdefbg

75 

76 result = runner.invoke(app, ["--force"]) 7 ctx1acdefbg

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

78 assert "Forcing operation" in result.output 7 ctx1acdefbg

79 

80 

81def test_annotated_custom_path(): 7 ctx1acdefbg

82 app = typer.Typer() 7 ctx1acdefbg

83 

84 class CustomPath(Path): 7 ctx1acdefbg

85 # Subclassing Path was not fully supported before 3.12 

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

87 if sys.version_info < (3, 12): 7 ctx1acdefbg

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

89 

90 @app.command() 7 ctx1acdefbg

91 def custom_parser( 7 ctx1acdefbg

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

93 ): 

94 assert isinstance(my_path, CustomPath) 7 ctx1acdefbg

95 

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

97 assert result.exit_code == 0 7 ctx1acdefbg