pyright-to-gitlab 1.0.2__py3-none-any.whl → 1.1.0__py3-none-any.whl

{pyright_to_gitlab-1.0.2.dist-info → pyright_to_gitlab-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyright-to-gitlab
-Version: 1.0.2
+Version: 1.1.0
 Summary: Convert Pyright JSON output to GitLab CI/CD format
 Project-URL: homepage, https://github.com/schollm/pyright-to-gitlab/
 Project-URL: repository, https://github.com/schollm/pyright-to-gitlab/

pyright_to_gitlab-1.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pyright_to_gitlab.py,sha256=i_54FlXg4RD1_1dr5Kq6onIAua2zRsi9hs_uejB_SK0,3150
+pyright_to_gitlab-1.1.0.dist-info/METADATA,sha256=9WGRB8rUH9ylhs98la_TMihlgQ6VNBe_gTAtrFOGjJk,2034
+pyright_to_gitlab-1.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyright_to_gitlab-1.1.0.dist-info/entry_points.txt,sha256=MbNff91bPuO2XhW0P03N9O1Z7xtlr3x9duU5BftRbZo,60
+pyright_to_gitlab-1.1.0.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
+pyright_to_gitlab-1.1.0.dist-info/RECORD,,

pyright_to_gitlab.py

@@ -4,10 +4,11 @@ import argparse
 import hashlib
 import json
 import sys
-from typing import cast
+import textwrap
+from typing import TextIO, cast
 
 
-def _pyright_to_gitlab(prefix: str = "") -> str:
+def _pyright_to_gitlab(input_: TextIO, prefix: str = "") -> str:
     """Convert pyright.json output to GitLab Code Quality report format.
 
     :arg prefix: A string to prepend to each file path in the output.
@@ -17,7 +18,7 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
     Pyright format at https://github.com/microsoft/pyright/blob/main/docs/command-line.md
     Gitlab format at https://docs.gitlab.com/ci/testing/code_quality/#code-quality-report-format
     """
-    data = cast("dict", json.load(sys.stdin))
+    data = cast("dict", json.load(input_))
 
     issues = []
     for issue in data.get("generalDiagnostics", []):
@@ -49,17 +50,42 @@ def _pyright_to_gitlab(prefix: str = "") -> str:
 def main() -> None:
     """Parse arguments and call the conversion function."""
     parser = argparse.ArgumentParser(
-        description="Convert pyright.json to GitLab Code Quality report."
+        description=textwrap.dedent("""
+        Convert pyright.json to GitLab Code Quality report.
+        By default, reads from stdin and writes to stdout."""),
+        epilog=textwrap.dedent(
+            """
+
+        Example usage:
+        > python pyright . --outputjson | pyright-to-gitlab > gitlab_code_quality.json
+        > pyright-to-gitlab -i pyright.json -o gitlab_code_quality.json
+        """
+        ),
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-i",
+        "--input",
+        type=argparse.FileType("r"),
+        default=sys.stdin,
+        help="Input file (default: stdin)",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        type=argparse.FileType("w"),
+        default=sys.stdout,
+        help="Output file (default: stdout)",
     )
     parser.add_argument(
         "--prefix",
         type=str,
         default="",
-        help="Prefix to add to each file (default: empty string)",
+        help="Prefix to add to each file entry. This can be used if pyright is run"
+        " from a subdirectory of the repository. (default: empty string)",
     )
     args = parser.parse_args()
-
-    print(_pyright_to_gitlab(prefix=args.prefix))  # noqa: T201
+    args.output.write(_pyright_to_gitlab(input_=args.input, prefix=args.prefix))
 
 
 if __name__ == "__main__":  # pragma: no cover

pyright_to_gitlab-1.0.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-pyright_to_gitlab.py,sha256=LbPxle60_JFBGMtPZszoNaFmnXEzfWBhc67PuZ1669g,2251
-pyright_to_gitlab-1.0.2.dist-info/METADATA,sha256=zxP5XyJcirFWi-yPy09oPOgHM0fkF1eVeg-eHxMhxnM,2034
-pyright_to_gitlab-1.0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-pyright_to_gitlab-1.0.2.dist-info/entry_points.txt,sha256=MbNff91bPuO2XhW0P03N9O1Z7xtlr3x9duU5BftRbZo,60
-pyright_to_gitlab-1.0.2.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
-pyright_to_gitlab-1.0.2.dist-info/RECORD,,