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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyright-to-gitlab
-Version: 1.1.0
+Version: 1.3.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/
@@ -12,7 +12,6 @@ Keywords: ci/cd,gitlab,pyright
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
@@ -24,12 +23,21 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Testing
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 
 # pyright to gitlab
-Simple zero-dependency Python script to convert a pyright --outputjson to a gitlab 
-code-quality report.
+
+[![PyPI version](https://img.shields.io/pypi/v/pyright-to-gitlab.svg)](https://pypi.org/project/pyright-to-gitlab)
+[![Python versions](https://img.shields.io/pypi/pyversions/pyright-to-gitlab.svg)](https://pypi.org/project/pyright-to-gitlab)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![Typing: typed](https://img.shields.io/badge/typing-typed-blue.svg)](https://github.com/python/mypy)
+
+Simple Python tool to convert Pyright JSON output to GitLab Code Quality report format.
+
+**Zero runtime dependencies** - Pure Python implementation using only the standard library.
+
 
 ## Usage
 Run the script with the path to the pyright output file:
@@ -44,12 +52,12 @@ $ 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.
+The `--prefix` option adds a custom prefix path to the file paths in the output. This is
+useful for mono-repos, where the paths in the pyright output is not the repository root.
 
 
 ```shell
-$  pyright . --outputjson | pyright-to-gitlab --prefix my-app/ > code-quality.json 
+$  pyright . --outputjson | pyright-to-gitlab --prefix my-app > code-quality.json
 ```
 
 ## Testing

pyright_to_gitlab-1.3.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+pyright_to_gitlab.py,sha256=qqTJVAQ9OS44gj9L4KPpWDTliKNP39vEe27SZfxW_zY,6289
+pyright_to_gitlab-1.3.0.dist-info/METADATA,sha256=Q63XdhBtllH0kPKRUdcul0Y2jUHZVuQSm9AY7P_iDBs,2634
+pyright_to_gitlab-1.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+pyright_to_gitlab-1.3.0.dist-info/entry_points.txt,sha256=0RnHrvYlZf3zD9BRTVQL564gF_fSuwF5IP13OB18540,61
+pyright_to_gitlab-1.3.0.dist-info/licenses/LICENSE,sha256=tY29-MdtyUNoC3XN4IBzu_jxmb8U82z9UvLkQJuBiJM,1070
+pyright_to_gitlab-1.3.0.dist-info/RECORD,,

{pyright_to_gitlab-1.1.0.dist-info → pyright_to_gitlab-1.3.0.dist-info}/WHEEL

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

pyright_to_gitlab-1.3.0.dist-info/entry_points.txt

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

pyright_to_gitlab.py

@@ -1,53 +1,162 @@
 """Convert pyright.json output to GitLab Code Quality report format."""
 
+from __future__ import annotations
+
 import argparse
 import hashlib
 import json
 import sys
 import textwrap
-from typing import TextIO, cast
+from typing import Literal, TextIO, TypedDict
+
+
+### Typing for PyRight Issue
+class PyrightRangeElement(TypedDict, total=False):
+    """Pyright Range Element (part of Range)."""
+
+    line: int
+    character: int
+
+
+class PyrightRange(TypedDict, total=False):
+    """Pyright Range (Part of Issue)."""
+
+    start: PyrightRangeElement
+    end: PyrightRangeElement
+
+
+class PyrightIssue(TypedDict, total=False):
+    """Single Pyright Issue.
+
+    Note: total=False makes all fields optional. Runtime code handles this with
+    defensive .get() calls.
+    """
+
+    file: str
+    severity: Literal["error", "warning", "information"]
+    message: str
+    rule: str  # Optional in practice, handled via .get() at runtime
+    range: PyrightRange
+
+
+### Typing for Gitlab Issue
+class GitlabIssuePositionLocation(TypedDict):
+    """Single Gitlab Position (Part of Position)."""
+
+    line: int
+    column: int
+
+
+class GitlabIssuePositions(TypedDict):
+    """Gitlab ranged Position within a file (Part of Location)."""
+
+    begin: GitlabIssuePositionLocation
+    end: GitlabIssuePositionLocation
+
+
+class GitlabIssueLocation(TypedDict):
+    """Gitlab location (Part of Issue)."""
+
+    path: str
+    positions: GitlabIssuePositions
+
 
+class GitlabIssue(TypedDict):
+    """Single Gitlab Issue."""
 
+    description: str
+    severity: Literal["major", "minor"]
+    fingerprint: str
+    check_name: str
+    location: GitlabIssueLocation
+
+
+### Functions
 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.
+    Line numbers from Pyright are passed through unchanged (0-based per LSP spec).
+    GitLab expects the same format, so no conversion is needed.
+
+    :arg prefix: A path 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.
+    :raises ValueError: If input is not a JSON object.
+    :raises TypeError: If input JSON is not an object.
 
     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(input_))
-
-    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:
+    if prefix and not prefix.endswith("/"):
+        prefix += "/"
+
+    try:
+        data = json.load(input_)
+    except json.JSONDecodeError as e:
+        err_msg = f"Invalid JSON input: {e}"
+        raise ValueError(err_msg) from e
+
+    if not isinstance(data, dict):
+        err_msg = "Input must be a JSON object"
+        raise TypeError(err_msg)
+
+    return json.dumps(
+        [
+            _pyright_issue_to_gitlab(issue, prefix)
+            for issue in data.get("generalDiagnostics", [])
+        ],
+        indent=2,
+    )
+
+
+def _pyright_issue_to_gitlab(issue: PyrightIssue, prefix: str) -> GitlabIssue:
+    """Convert a single issue to gitlab.
+
+    Uses defensive .get() with defaults to handle missing optional fields.
+    File path defaults to '<anonymous>' and missing rule to 'unknown'.
+
+    :param issue: A pyright single issue.
+    :param prefix: The path prefix.
+    :returns: A gitlab single issue.
+    """
+    range_ = issue.get("range", {})
+    start, end = (range_.get("start", {}), range_.get("end", {}))
+    rule = "pyright: " + issue.get("rule", "unknown")
+    # Hash input must contain file, location and rule to generate a unique fingerprint.
+    # (This takes advantage of stable dict order).
+    fingerprint = f"{issue.get('file', '<anonymous>')}--{range_}--{rule}"
+
+    return GitlabIssue(
+        description=issue.get("message", ""),
+        # Map 'error' to 'major', all others, including empty, to 'minor'
+        severity="major" if issue.get("severity") == "error" else "minor",
+        # Any hash function really works, does not have to be cryptographic.
+        fingerprint=_hash(fingerprint),
+        check_name=rule,
+        location=GitlabIssueLocation(
+            path=f"{prefix}{issue.get('file', '<anonymous>')}",
+            positions=GitlabIssuePositions(
+                begin=GitlabIssuePositionLocation(
+                    line=start.get("line", 0), column=start.get("character", 0)
+                ),
+                end=GitlabIssuePositionLocation(
+                    line=end.get("line", 0), column=end.get("character", 0)
+                ),
+            ),
+        ),
+    )
+
+
+def _hash(data: str) -> str:
+    """Generate an (non-secure) hash of the given data string.
+
+    :param data: The input string to hash.
+    :returns: The hexadecimal representation of the MD5 hash.
+    """
+    return hashlib.new("md5", data.encode(), usedforsecurity=False).hexdigest()
+
+
+def cli() -> None:
     """Parse arguments and call the conversion function."""
     parser = argparse.ArgumentParser(
         description=textwrap.dedent("""
@@ -81,12 +190,13 @@ def main() -> None:
         "--prefix",
         type=str,
         default="",
-        help="Prefix to add to each file entry. This can be used if pyright is run"
+        help="Prefix path to add to each file entry. This can be used if pyright is run"
         " from a subdirectory of the repository. (default: empty string)",
     )
+    parser.add_argument("--version", action="version", version="%(prog)s 1.3.0")
     args = parser.parse_args()
     args.output.write(_pyright_to_gitlab(input_=args.input, prefix=args.prefix))
 
 
 if __name__ == "__main__":  # pragma: no cover
-    main()
+    cli()

pyright_to_gitlab-1.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-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-1.1.0.dist-info/entry_points.txt

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