Coverage for tests / test_tutorial / test_commands / test_help / test_tutorial005.py: 100%

47 statements  

« prev     ^ index     » next       coverage.py v7.13.1, created at 2026-11-18 11:12 +0000

1import importlib 1abcdefghij

2import os 1abcdefghij

3import subprocess 1abcdefghij

4import sys 1abcdefghij

5from types import ModuleType 1abcdefghij

6 

7import pytest 1abcdefghij

8from typer.testing import CliRunner 1abcdefghij

9 

10runner = CliRunner() 1abcdefghij

11 

12 

13@pytest.fixture( 1abcdefghij

14 name="mod", 

15 params=[ 

16 pytest.param("tutorial005_non_an"), 

17 pytest.param("tutorial005"), 

18 ], 

19) 

20def get_mod(request: pytest.FixtureRequest) -> ModuleType: 1abcdefghij

21 module_name = f"docs_src.commands.help.{request.param}" 1abcdefghij

22 mod = importlib.import_module(module_name) 1abcdefghij

23 return mod 1abcdefghij

24 

25 

26def test_help(mod: ModuleType): 1abcdefghij

27 result = runner.invoke(mod.app, ["--help"]) 1abcdefghij

28 assert result.exit_code == 0 1abcdefghij

29 assert "create" in result.output 1abcdefghij

30 assert "Create a new shiny user. ✨" in result.output 1abcdefghij

31 assert "delete" in result.output 1abcdefghij

32 assert "Delete a user with username." in result.output 1abcdefghij

33 assert "Some internal utility function to create." not in result.output 1abcdefghij

34 assert "Some internal utility function to delete." not in result.output 1abcdefghij

35 

36 

37def test_help_create(mod: ModuleType): 1abcdefghij

38 result = runner.invoke(mod.app, ["create", "--help"]) 1abcdefghij

39 assert result.exit_code == 0 1abcdefghij

40 assert "Create a new shiny user. ✨" in result.output 1abcdefghij

41 assert "The username to be created" in result.output 1abcdefghij

42 assert "Learn more at the Typer docs website" in result.output 1abcdefghij

43 assert "Some internal utility function to create." not in result.output 1abcdefghij

44 

45 

46def test_help_delete(mod: ModuleType): 1abcdefghij

47 result = runner.invoke(mod.app, ["delete", "--help"]) 1abcdefghij

48 assert result.exit_code == 0 1abcdefghij

49 assert "Delete a user with username." in result.output 1abcdefghij

50 assert "The username to be deleted" in result.output 1abcdefghij

51 assert "Force the deletion 💥" in result.output 1abcdefghij

52 assert "Some internal utility function to delete." not in result.output 1abcdefghij

53 

54 

55def test_create(mod: ModuleType): 1abcdefghij

56 result = runner.invoke(mod.app, ["create", "Camila"]) 1abcdefghij

57 assert result.exit_code == 0 1abcdefghij

58 assert "Creating user: Camila" in result.output 1abcdefghij

59 

60 

61def test_delete(mod: ModuleType): 1abcdefghij

62 result = runner.invoke(mod.app, ["delete", "Camila"]) 1abcdefghij

63 assert result.exit_code == 0 1abcdefghij

64 assert "Deleting user: Camila" in result.output 1abcdefghij

65 

66 

67def test_script(mod: ModuleType): 1abcdefghij

68 result = subprocess.run( 1abcdefghij

69 [sys.executable, "-m", "coverage", "run", mod.__file__, "--help"], 

70 capture_output=True, 

71 encoding="utf-8", 

72 env={**os.environ, "PYTHONIOENCODING": "utf-8"}, 

73 ) 

74 assert "Usage" in result.stdout 1abcdefghij