Skip to content

Commit d78e10d

Browse files
committed
tests: ignore docstring enforce jsons; better names
1 parent df4d6ab commit d78e10d

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,5 @@ ai_horde_codegen.py
159159
.codiumai.toml
160160

161161
.venv-*
162+
non_conforming_docstrings.json
163+
missing_original_docstrings.json

tests/test_verify_api_surface.py

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -237,14 +237,19 @@ def test_all_models_non_conforming_docstrings() -> None:
237237
map_to_dump[model.__name__] = {
238238
"new": new_docstring or "",
239239
}
240-
with open("docstrings.json", "w", encoding="utf-8") as f:
241-
json.dump(map_to_dump, f, indent=4)
242-
f.write("\n")
243240

244-
with open("missing_original_docstrings.json", "w", encoding="utf-8") as f:
245-
json.dump(missing_original_docstrings, f, indent=4)
246-
f.write("\n")
241+
if len(map_to_dump) > 0:
242+
with open("non_conforming_docstrings.json", "w", encoding="utf-8") as f:
243+
json.dump(map_to_dump, f, indent=4)
244+
f.write("\n")
245+
246+
if len(missing_original_docstrings) > 0:
247+
with open("missing_original_docstrings.json", "w", encoding="utf-8") as f:
248+
json.dump(missing_original_docstrings, f, indent=4)
249+
f.write("\n")
247250

248251
assert not non_conforming_docstrings, (
249-
"The following models have non-conforming docstrings: " f"{jsonified_non_conforming_docstrings}"
252+
"The following models have non-conforming docstrings: "
253+
f"{jsonified_non_conforming_docstrings}"
254+
"\n\nSee `non_conforming_docstrings.json` and `missing_original_docstrings.json` for more details."
250255
)

0 commit comments

Comments
 (0)