Coverage for tests/test_suggest_commands.py: 100%

1import typer 9 ctx1abcdefghi

2from typer.testing import CliRunner 9 ctx1abcdefghi

3 

4runner = CliRunner() 9 ctx1abcdefghi

5 

6 

7def test_typo_suggestion_enabled(): 9 ctx1abcdefghi

8 """Test that typo suggestions work when enabled""" 

9 app = typer.Typer() 9 ctx1abcdefghi

10 

11 @app.command() 9 ctx1abcdefghi

12 def create(): # pragma: no cover 9 ctx1abcdefghi

13 typer.echo("Creating...") 

14 

15 @app.command() 9 ctx1abcdefghi

16 def delete(): # pragma: no cover 9 ctx1abcdefghi

17 typer.echo("Deleting...") 

18 

19 result = runner.invoke(app, ["crate"]) 9 ctx1abcdefghi

20 assert result.exit_code != 0 9 ctx1abcdefghi

21 assert "No such command" in result.output 9 ctx1abcdefghi

22 assert "Did you mean 'create'?" in result.output 9 ctx1abcdefghi

23 

24 

25def test_typo_suggestion_multiple_matches(): 9 ctx1abcdefghi

26 """Test that multiple suggestions are shown when there are multiple close matches""" 

27 app = typer.Typer() 9 ctx1abcdefghi

28 

29 @app.command() 9 ctx1abcdefghi

30 def create(): # pragma: no cover 9 ctx1abcdefghi

31 typer.echo("Creating...") 

32 

33 @app.command() 9 ctx1abcdefghi

34 def createnew(): # pragma: no cover 9 ctx1abcdefghi

35 typer.echo("Creating new...") 

36 

37 result = runner.invoke(app, ["crate"]) 9 ctx1abcdefghi

38 assert result.exit_code != 0 9 ctx1abcdefghi

39 assert "No such command" in result.output 9 ctx1abcdefghi

40 assert "Did you mean" in result.output 9 ctx1abcdefghi

41 assert "create" in result.output and "createnew" in result.output 9 ctx1abcdefghi

42 

43 

44def test_typo_suggestion_no_matches(): 9 ctx1abcdefghi

45 """Test that no suggestions are shown when there are no close matches""" 

46 app = typer.Typer() 9 ctx1abcdefghi

47 

48 @app.command() 9 ctx1abcdefghi

49 def create(): # pragma: no cover 9 ctx1abcdefghi

50 typer.echo("Creating...") 

51 

52 @app.command() 9 ctx1abcdefghi

53 def delete(): # pragma: no cover 9 ctx1abcdefghi

54 typer.echo("Deleting...") 

55 

56 result = runner.invoke(app, ["xyz"]) 9 ctx1abcdefghi

57 assert result.exit_code != 0 9 ctx1abcdefghi

58 assert "No such command" in result.output 9 ctx1abcdefghi

59 assert "Did you mean" not in result.output 9 ctx1abcdefghi

60 

61 

62def test_typo_suggestion_exact_match_works(): 9 ctx1abcdefghi

63 """Test that exact matches still work normally""" 

64 app = typer.Typer() 9 ctx1abcdefghi

65 

66 @app.command() 9 ctx1abcdefghi

67 def create(): 9 ctx1abcdefghi

68 typer.echo("Creating...") 9 ctx1abcdefghi

69 

70 @app.command() 9 ctx1abcdefghi

71 def delete(): 9 ctx1abcdefghi

72 typer.echo("Deleting...") 9 ctx1abcdefghi

73 

74 result = runner.invoke(app, ["create"]) 9 ctx1abcdefghi

75 assert result.exit_code == 0 9 ctx1abcdefghi

76 assert "Creating..." in result.output 9 ctx1abcdefghi

77 

78 result = runner.invoke(app, ["delete"]) 9 ctx1abcdefghi

79 assert result.exit_code == 0 9 ctx1abcdefghi

80 assert "Deleting..." in result.output 9 ctx1abcdefghi

81 

82 

83def test_typo_suggestion_disabled(): 9 ctx1abcdefghi

84 """Test that typo suggestions can be explicitly disabled""" 

85 app = typer.Typer(suggest_commands=False) 9 ctx1abcdefghi

86 

87 @app.command() 9 ctx1abcdefghi

88 def create(): # pragma: no cover 9 ctx1abcdefghi

89 typer.echo("Creating...") 

90 

91 @app.command() 9 ctx1abcdefghi

92 def delete(): # pragma: no cover 9 ctx1abcdefghi

93 typer.echo("Deleting...") 

94 

95 result = runner.invoke(app, ["crate"]) 9 ctx1abcdefghi

96 assert result.exit_code != 0 9 ctx1abcdefghi

97 assert "No such command" in result.output 9 ctx1abcdefghi

98 assert "Did you mean" not in result.output 9 ctx1abcdefghi