Merge pull request #65 from codecov/joseph/add-interface

feat: add pyi file for type hints in python
codecov · Jan 9, 2025 · 190bbc8 · 190bbc8
2 parents cc76ca7 + bfadc7a
commit 190bbc8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/py.typed b/py.typed
diff --git a/test_results_parser.pyi b/test_results_parser.pyi
@@ -0,0 +1,20 @@
+from typing import TypedDict, Literal
+
+class Testrun(TypedDict):
+    name: str
+    classname: str
+    duration: float | None
+    outcome: Literal["pass", "failure", "skip", "error"]
+    testsuite: str
+    failure_message: str | None
+    filename: str | None
+    build_url: str | None
+    computed_name: str | None
+
+
+class ParsingInfo(TypedDict):
+    framework: Literal["Pytest", "Jest", "Vitest", "PHPUnit"]
+    testruns: list[Testrun]
+
+
+def parse_raw_upload(raw_upload_bytes: bytes) -> tuple[list[ParsingInfo], bytes]: ...