Coverage for tests / test_suggest_commands.py: 100%

1import typer 8 ctx1abcdefgh

2from typer.testing import CliRunner 8 ctx1abcdefgh

3 

4runner = CliRunner() 8 ctx1abcdefgh

5 

6 

7def test_typo_suggestion_enabled(): 8 ctx1abcdefgh

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

9 app = typer.Typer() 8 ctx1abcdefgh

10 

11 @app.command() 8 ctx1abcdefgh

12 def create(): # pragma: no cover 8 ctx1abcdefgh

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

14 

15 @app.command() 8 ctx1abcdefgh

16 def delete(): # pragma: no cover 8 ctx1abcdefgh

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

18 

19 result = runner.invoke(app, ["crate"]) 8 ctx1abcdefgh

20 assert result.exit_code != 0 8 ctx1abcdefgh

21 assert "No such command" in result.output 8 ctx1abcdefgh

22 assert "Did you mean 'create'?" in result.output 8 ctx1abcdefgh

23 

24 

25def test_typo_suggestion_multiple_matches(): 8 ctx1abcdefgh

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

27 app = typer.Typer() 8 ctx1abcdefgh

28 

29 @app.command() 8 ctx1abcdefgh

30 def create(): # pragma: no cover 8 ctx1abcdefgh

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

32 

33 @app.command() 8 ctx1abcdefgh

34 def createnew(): # pragma: no cover 8 ctx1abcdefgh

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

36 

37 result = runner.invoke(app, ["crate"]) 8 ctx1abcdefgh

38 assert result.exit_code != 0 8 ctx1abcdefgh

39 assert "No such command" in result.output 8 ctx1abcdefgh

40 assert "Did you mean" in result.output 8 ctx1abcdefgh

41 assert "create" in result.output and "createnew" in result.output 8 ctx1abcdefgh

42 

43 

44def test_typo_suggestion_no_matches(): 8 ctx1abcdefgh

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

46 app = typer.Typer() 8 ctx1abcdefgh

47 

48 @app.command() 8 ctx1abcdefgh

49 def create(): # pragma: no cover 8 ctx1abcdefgh

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

51 

52 @app.command() 8 ctx1abcdefgh

53 def delete(): # pragma: no cover 8 ctx1abcdefgh

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

55 

56 result = runner.invoke(app, ["xyz"]) 8 ctx1abcdefgh

57 assert result.exit_code != 0 8 ctx1abcdefgh

58 assert "No such command" in result.output 8 ctx1abcdefgh

59 assert "Did you mean" not in result.output 8 ctx1abcdefgh

60 

61 

62def test_typo_suggestion_exact_match_works(): 8 ctx1abcdefgh

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

64 app = typer.Typer() 8 ctx1abcdefgh

65 

66 @app.command() 8 ctx1abcdefgh

67 def create(): 8 ctx1abcdefgh

68 typer.echo("Creating...") 8 ctx1abcdefgh

69 

70 @app.command() 8 ctx1abcdefgh

71 def delete(): 8 ctx1abcdefgh

72 typer.echo("Deleting...") 8 ctx1abcdefgh

73 

74 result = runner.invoke(app, ["create"]) 8 ctx1abcdefgh

75 assert result.exit_code == 0 8 ctx1abcdefgh

76 assert "Creating..." in result.output 8 ctx1abcdefgh

77 

78 result = runner.invoke(app, ["delete"]) 8 ctx1abcdefgh

79 assert result.exit_code == 0 8 ctx1abcdefgh

80 assert "Deleting..." in result.output 8 ctx1abcdefgh

81 

82 

83def test_typo_suggestion_disabled(): 8 ctx1abcdefgh

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

85 app = typer.Typer(suggest_commands=False) 8 ctx1abcdefgh

86 

87 @app.command() 8 ctx1abcdefgh

88 def create(): # pragma: no cover 8 ctx1abcdefgh

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

90 

91 @app.command() 8 ctx1abcdefgh

92 def delete(): # pragma: no cover 8 ctx1abcdefgh

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

94 

95 result = runner.invoke(app, ["crate"]) 8 ctx1abcdefgh

96 assert result.exit_code != 0 8 ctx1abcdefgh

97 assert "No such command" in result.output 8 ctx1abcdefgh

98 assert "Did you mean" not in result.output 8 ctx1abcdefgh