pyright-to-gitlab 1.0.1__py3-none-any.whl

pyright_to_gitlab-1.0.1.dist-info/METADATA

@@ -0,0 +1,59 @@
+Metadata-Version: 2.4
+Name: pyright-to-gitlab
+Version: 1.0.1
+Summary: Convert Pyright JSON output to GitLab CI/CD format
+Author: Micha Schöll
+License: MIT License
+        
+        Copyright (c) 2025 Micha Schöll
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+
+# pyright to gitlab
+Simple Python script to convert a pyright --outputjson to a gitlab code-quality report.
+
+## Usage
+Run the script with the path to the pyright output file:
+```shell
+$ pip install pyright-to-gitlab
+$  pyright . --outputjson | pyright-to-gitlab > code-quality.json 
+```
+
+Alternatively, the module can be called:
+```shell
+$ pip install pyright-to-gitlab
+$  pyright . --outputjson | python -m pyright_to_gitlab > code-quality.json 
+```
+### Custom path prefix
+The `--prefix` option adds a custom prefix to the file paths in the output. This is
+useful if the paths in the pyright output are not relative to the root of the repository.
+
+
+```shell
+$  pyright . --outputjson | pyright-to-gitlab --prefix my-app/ > code-quality.json 
+```
+
+## Testing
+To run the tests, execute
+```shell
+$ uv run pytest tests/
+```

pyright_to_gitlab-1.0.1.dist-info/RECORD

@@ -0,0 +1,6 @@
+pyright_to_gitlab.py,sha256=LbPxle60_JFBGMtPZszoNaFmnXEzfWBhc67PuZ1669g,2251
+pyright_to_gitlab-1.0.1.dist-info/METADATA,sha256=oztGH-gx0w-OAgVZ6_ezwqTHSAcXkAvhw-wnBLRxsew,2289
+pyright_to_gitlab-1.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyright_to_gitlab-1.0.1.dist-info/entry_points.txt,sha256=MbNff91bPuO2XhW0P03N9O1Z7xtlr3x9duU5BftRbZo,60
+pyright_to_gitlab-1.0.1.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
+pyright_to_gitlab-1.0.1.dist-info/RECORD,,

pyright_to_gitlab-1.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pyright_to_gitlab-1.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyrigh-to-gitlab = pyright_to_gitlab:main

pyright_to_gitlab-1.0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Micha Schöll
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyright_to_gitlab.py

@@ -0,0 +1,66 @@
+"""Convert pyright.json output to GitLab Code Quality report format."""
+
+import argparse
+import hashlib
+import json
+import sys
+from typing import cast
+
+
+def _pyright_to_gitlab(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.
+        This is useful if the application is in a subdirectory of the repository.
+    :return: JSON of issues in GitLab Code Quality report format.
+
+    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))
+
+    issues = []
+    for issue in data.get("generalDiagnostics", []):
+        file = issue["file"]
+        start, end = issue["range"]["start"], issue["range"]["end"]
+        rule = "pyright: " + issue.get("rule", "")
+        severity = "major" if issue["severity"] == "error" else "minor"
+        # unique fingerprint
+        fp_str = "--".join([str(start), str(end), rule])
+
+        issues.append(
+            {
+                "description": issue["message"],
+                "severity": severity,
+                "fingerprint": hashlib.sha3_224(fp_str.encode()).hexdigest(),
+                "check_name": rule,
+                "location": {
+                    "path": f"{prefix}{file}",
+                    "positions": {
+                        "begin": {"line": start["line"], "column": start["character"]},
+                        "end": {"line": end["line"], "column": end["character"]},
+                    },
+                },
+            }
+        )
+    return json.dumps(issues, indent=2)
+
+
+def main() -> None:
+    """Parse arguments and call the conversion function."""
+    parser = argparse.ArgumentParser(
+        description="Convert pyright.json to GitLab Code Quality report."
+    )
+    parser.add_argument(
+        "--prefix",
+        type=str,
+        default="",
+        help="Prefix to add to each file (default: empty string)",
+    )
+    args = parser.parse_args()
+
+    print(_pyright_to_gitlab(prefix=args.prefix))  # noqa: T201
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()