Coverage for tests/test_docs_cleanup.py: 100%

36 statements  

« prev     ^ index     » next       coverage.py v7.17.2, created at 2026-11-16 00:02 +0000

1from pathlib import Path 1ABCDEFGHIJKLM

2 

3import pytest 1ABCDEFGHIJKLM

4 

5from scripts.docs import remove_unused_docs_src 1ABCDEFGHIJKLM

6 

7 

8def create_files(paths: set[str]) -> None: 1ABCDEFGHIJKLM

9 for path_str in paths: 1anbocpdqerfsgthuivjwkxlymz

10 path = Path(path_str) 1anbocpdqerfsgthuivjwkxlymz

11 path.parent.mkdir(parents=True, exist_ok=True) 1anbocpdqerfsgthuivjwkxlymz

12 path.write_text("# Example code\n", encoding="utf-8") 1anbocpdqerfsgthuivjwkxlymz

13 

14 

15def include_file(path: str) -> None: 1ABCDEFGHIJKLM

16 doc = Path("docs/en/docs/tutorial.md") 1anbocpdqerfsgthuivjwkxlymz

17 doc.parent.mkdir(parents=True, exist_ok=True) 1anbocpdqerfsgthuivjwkxlymz

18 doc.write_text("{* " + path + " *}\n", encoding="utf-8") 1anbocpdqerfsgthuivjwkxlymz

19 

20 

21@pytest.mark.parametrize( 1ABCDEFGHIJKLM

22 "names", 

23 [ 

24 ("tutorial001", "tutorial001_non_an"), 

25 ("tutorial001", "tutorial001_an"), 

26 ("tutorial001_py310", "tutorial001_non_an_py310"), 

27 ("tutorial001_py310", "tutorial001_an_py310"), 

28 ( 

29 "tutorial001_py310", 

30 "tutorial001_an_py310", 

31 "tutorial001_py314", 

32 "tutorial001_an_py314", 

33 ), 

34 ( 

35 "tutorial001_py311", 

36 "tutorial001_non_an_py311", 

37 "tutorial001_py314", 

38 "tutorial001_non_an_py314", 

39 ), 

40 ("tutorial001_py311", "tutorial001_py314"), 

41 ("tutorial_another", "tutorial_another_non_an"), 

42 ], 

43) 

44@pytest.mark.parametrize("preferred", [0, 1]) 1ABCDEFGHIJKLM

45def test_keep_file_variants( 1ABCDEFGHIJKLM

46 tmp_path: Path, 

47 monkeypatch: pytest.MonkeyPatch, 

48 names: tuple[str, ...], 

49 preferred: int, 

50) -> None: 

51 monkeypatch.chdir(tmp_path) 1nopqrstuvwxyz

52 kept = {f"docs_src/tutorial/topic/{name}.py" for name in names} 1nopqrstuvwxyz

53 unused = { 1nopqrstuvwxyz

54 "docs_src/tutorial/topic/tutorial002.py", 

55 "docs_src/tutorial/topic/tutorial001_extra.py", 

56 } 

57 create_files(kept | unused) 1nopqrstuvwxyz

58 include_file(f"docs_src/tutorial/topic/{names[preferred]}.py") 1nopqrstuvwxyz

59 

60 remove_unused_docs_src() 1nopqrstuvwxyz

61 

62 assert {path.as_posix() for path in Path("docs_src").rglob("*.py")} == kept 1nopqrstuvwxyz

63 

64 

65@pytest.mark.parametrize( 1ABCDEFGHIJKLM

66 "names", 

67 [ 

68 ("tutorial001", "tutorial001_non_an"), 

69 ("tutorial001", "tutorial001_an"), 

70 ( 

71 "tutorial001_py310", 

72 "tutorial001_an_py310", 

73 "tutorial001_py314", 

74 "tutorial001_an_py314", 

75 ), 

76 ( 

77 "tutorial001_py311", 

78 "tutorial001_non_an_py311", 

79 "tutorial001_py314", 

80 "tutorial001_non_an_py314", 

81 ), 

82 ], 

83) 

84@pytest.mark.parametrize("preferred", [0, 1]) 1ABCDEFGHIJKLM

85@pytest.mark.parametrize("included", ["main.py", "routers/items.py", "__init__.py"]) 1ABCDEFGHIJKLM

86@pytest.mark.parametrize( 1ABCDEFGHIJKLM

87 "topic", ["tutorial/code_structure", "tutorial/fastapi/app_testing"] 

88) 

89def test_keep_entire_variant_packages( 1ABCDEFGHIJKLM

90 tmp_path: Path, 

91 monkeypatch: pytest.MonkeyPatch, 

92 names: tuple[str, ...], 

93 preferred: int, 

94 included: str, 

95 topic: str, 

96) -> None: 

97 monkeypatch.chdir(tmp_path) 1abcdefghijklm

98 kept = { 1abcdefghijklm

99 f"docs_src/{topic}/{name}/{module}" 

100 for name in names 

101 for module in ( 

102 "__init__.py", 

103 "main.py", 

104 "config.py", 

105 "routers/items.py", 

106 "routers/utils.py", 

107 "empty_package/__init__.py", 

108 ) 

109 } 

110 kept.add(f"docs_src/{topic}/{names[1]}/variant_only.py") 1abcdefghijklm

111 unused = { 1abcdefghijklm

112 f"docs_src/{topic}/tutorial002/main.py", 

113 f"docs_src/{topic}/tutorial002/__init__.py", 

114 f"docs_src/{topic}/tutorial002/empty_package/__init__.py", 

115 f"docs_src/{topic}/tutorial002/routers/items.py", 

116 } 

117 create_files(kept | unused) 1abcdefghijklm

118 include_file(f"docs_src/{topic}/{names[preferred]}/{included}") 1abcdefghijklm

119 

120 remove_unused_docs_src() 1abcdefghijklm

121 

122 assert {path.as_posix() for path in Path("docs_src").rglob("*.py")} == kept 1abcdefghijklm

123 assert not Path(f"docs_src/{topic}/tutorial002").exists() 1abcdefghijklm