pyright-to-gitlab 1.2.0__tar.gz → 1.3.0__tar.gz

{pyright_to_gitlab-1.2.0 → pyright_to_gitlab-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyright-to-gitlab
-Version: 1.2.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/
@@ -52,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.2.0 → pyright_to_gitlab-1.3.0}/README.md

@@ -24,12 +24,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.2.0 → pyright_to_gitlab-1.3.0}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "pyright-to-gitlab"
-version = "1.2.0"
+version = "1.3.0"
 description = "Convert Pyright JSON output to GitLab CI/CD format"
 readme = "README.md"
 requires-python = ">=3.8"
 authors = [{ name = "Micha Schöll", email = "" }]
 license = "MIT"
 license-files = ["LICENSE"]
-keywords = [ "ci/cd", "pyright", 'gitlab' ]
+keywords = [ "ci/cd", "pyright", "gitlab" ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
@@ -59,7 +59,6 @@ ignore = [
     "D203",  # `incorrect-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible.
     "COM812", # Missing trailing comma in a single-line list - already applied by ruff format.
     "D205", # 1 blank line required between summary line and description: ruff format disagrees.
-
 ]
 
 [tool.ruff.lint.per-file-ignores]
@@ -68,6 +67,7 @@ ignore = [
     "S101", # asserts allowed in tests...
     "ARG", # Unused function args -> fixtures nevertheless are functionally relevant...
     "FBT", # Don't care about booleans as positional arguments in tests, e.g. via @pytest.mark.parametrize()
+    "PLR0913", # Too many arguments in test functions are sometimes necessary (e.g. via fixtures)
 ]
 
 [tool.pytest.ini_options]
@@ -78,4 +78,4 @@ addopts = """
   --cov-report=html:.out/coverage-html
   --cov-report term-missing
   --cov-branch
-"""
+"""

{pyright_to_gitlab-1.2.0 → pyright_to_gitlab-1.3.0}/src/pyright_to_gitlab.py

@@ -11,25 +11,25 @@ from typing import Literal, TextIO, TypedDict
 
 
 ### Typing for PyRight Issue
-class PyrightRangeElement(TypedDict):
+class PyrightRangeElement(TypedDict, total=False):
     """Pyright Range Element (part of Range)."""
 
     line: int
     character: int
 
 
-class PyrightRange(TypedDict):
+class PyrightRange(TypedDict, total=False):
     """Pyright Range (Part of Issue)."""
 
     start: PyrightRangeElement
     end: PyrightRangeElement
 
 
-class PyrightIssue(TypedDict):
+class PyrightIssue(TypedDict, total=False):
     """Single Pyright Issue.
 
-    Note: 'rule' field is optional in practice but marked as required in type hints.
-    Runtime code handles this with defensive .get() calls.
+    Note: total=False makes all fields optional. Runtime code handles this with
+    defensive .get() calls.
     """
 
     file: str
@@ -78,7 +78,7 @@ def _pyright_to_gitlab(input_: TextIO, prefix: str = "") -> str:
     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 string to prepend to each file path in the output.
+    :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.
@@ -87,6 +87,9 @@ def _pyright_to_gitlab(input_: TextIO, 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
     """
+    if prefix and not prefix.endswith("/"):
+        prefix += "/"
+
     try:
         data = json.load(input_)
     except json.JSONDecodeError as e:
@@ -116,22 +119,22 @@ def _pyright_issue_to_gitlab(issue: PyrightIssue, prefix: str) -> GitlabIssue:
     :param prefix: The path prefix.
     :returns: A gitlab single issue.
     """
-    start, end = (
-        issue.get("range", {}).get("start", {}),
-        issue.get("range", {}).get("end", {}),
-    )
+    range_ = issue.get("range", {})
+    start, end = (range_.get("start", {}), range_.get("end", {}))
     rule = "pyright: " + issue.get("rule", "unknown")
-    # Unique fingerprint including file path to prevent collisions across files
-    fp_str = "--".join([issue.get("file", "<anonymous>"), str(start), str(end), rule])
+    # 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=hashlib.sha3_224(fp_str.encode()).hexdigest(),
+        fingerprint=_hash(fingerprint),
         check_name=rule,
         location=GitlabIssueLocation(
-            path=f"{prefix}{issue['file']}" if "file" in issue else "<anonymous>",
+            path=f"{prefix}{issue.get('file', '<anonymous>')}",
             positions=GitlabIssuePositions(
                 begin=GitlabIssuePositionLocation(
                     line=start.get("line", 0), column=start.get("character", 0)
@@ -144,7 +147,16 @@ def _pyright_issue_to_gitlab(issue: PyrightIssue, prefix: str) -> GitlabIssue:
     )
 
 
-def main() -> None:
+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("""
@@ -178,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.2.0 → pyright_to_gitlab-1.3.0}/tests/test_main.py

@@ -9,9 +9,11 @@ from typing import TYPE_CHECKING
 if TYPE_CHECKING:
     from pathlib import Path
 
+from importlib.metadata import version
+
 import pytest
 
-from pyright_to_gitlab import main
+from pyright_to_gitlab import cli
 
 PYRIGHT = {
     "version": "1.1.385",
@@ -50,7 +52,7 @@ GITLAB = [
     {
         "check_name": "pyright: reportGeneralTypeIssues",
         "description": 'Message "foo"',
-        "fingerprint": "c07588a4b4ee16dee26d14c086857de5a86bb7034461cdad63f6397f",
+        "fingerprint": "023610260f7cb68cf03b7f5a1232b566",
         "location": {
             "path": "test1.py",
             "positions": {
@@ -63,7 +65,7 @@ GITLAB = [
     {
         "check_name": "pyright: reportInvalidTypeForm",
         "description": "Message bar",
-        "fingerprint": "d8bd498be79cb56d504196f52a1ba9bcd4e66635404629eda82e6be4",
+        "fingerprint": "2113f1d00f089646663709d55a111100",
         "location": {
             "path": "test2.py",
             "positions": {
@@ -92,7 +94,7 @@ def test(
     """Test that the pyright.json is converted to GitLab Code Quality report format."""
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     assert json.loads(captured.out) == gitlab
 
@@ -124,10 +126,20 @@ def test_input_output_file(
             output_file.as_posix(),
         ],
     )
-    main()
+    cli()
     assert json.loads(output_file.read_text("utf-8")) == gitlab
 
 
+@pytest.mark.parametrize(
+    ("prefix_input", "prefix_expected"),
+    [
+        ("", ""),
+        (".", "./"),
+        ("src/", "src/"),
+        ("src", "src/"),
+        ("..", "../"),
+    ],
+)
 @pytest.mark.parametrize(
     ("pyright", "gitlab"),
     [
@@ -138,21 +150,22 @@ def test_input_output_file(
 def test_prefix(
     monkeypatch: pytest.MonkeyPatch,
     capsys: pytest.CaptureFixture,
+    prefix_input: str,
+    prefix_expected: str,
     pyright: dict,
     gitlab: list[dict],
 ) -> None:
     """Test that the prefix is added to the file paths in the output."""
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
-    monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py", "--prefix", "prefix/"])
-    prefix = "prefix/"
-    main()
+    monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py", "--prefix", prefix_input])
+    cli()
     captured = capsys.readouterr()
     gitlab_with_prefix = [
         {
             **issue,
             "location": {
                 **issue["location"],
-                "path": f"{prefix}{issue['location']['path']}",
+                "path": f"{prefix_expected}{issue['location']['path']}",
             },
         }
         for issue in gitlab
@@ -166,7 +179,7 @@ def test_malformed_json(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
 
     with pytest.raises(ValueError, match="Invalid JSON input"):
-        main()
+        cli()
 
 
 def test_non_dict_json(monkeypatch: pytest.MonkeyPatch) -> None:
@@ -175,18 +188,31 @@ def test_non_dict_json(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
 
     with pytest.raises(TypeError, match="Input must be a JSON object"):
-        main()
+        cli()
 
 
-def test_warning_severity(
-    monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+@pytest.mark.parametrize(
+    ("severity_input", "severity_expected"),
+    [
+        ("error", "major"),
+        ("warning", "minor"),
+        ("information", "minor"),
+        ("", "minor"),
+        (None, "minor"),
+    ],
+)
+def test_severity(
+    severity_input: str | None,
+    severity_expected: str,
+    monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture,
 ) -> None:
     """Test that warning severity is mapped to 'minor'."""
     pyright = {
         "generalDiagnostics": [
             {
                 "file": "test.py",
-                "severity": "warning",
+                "severity": severity_input,
                 "message": "Test warning",
                 "range": {
                     "start": {"line": 1, "character": 0},
@@ -198,38 +224,11 @@ def test_warning_severity(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
-    captured = capsys.readouterr()
-    result = json.loads(captured.out)
-    assert len(result) == 1
-    assert result[0]["severity"] == "minor"
-
-
-def test_information_severity(
-    monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
-) -> None:
-    """Test that information severity is mapped to 'minor'."""
-    pyright = {
-        "generalDiagnostics": [
-            {
-                "file": "test.py",
-                "severity": "information",
-                "message": "Test info",
-                "range": {
-                    "start": {"line": 1, "character": 0},
-                    "end": {"line": 1, "character": 5},
-                },
-                "rule": "testRule",
-            }
-        ]
-    }
-    monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
-    monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
-    assert result[0]["severity"] == "minor"
+    assert result[0]["severity"] == severity_expected
 
 
 def test_missing_rule(
@@ -251,7 +250,7 @@ def test_missing_rule(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -265,7 +264,7 @@ def test_empty_diagnostics(
     pyright = {"generalDiagnostics": []}
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert result == []
@@ -278,7 +277,7 @@ def test_missing_general_diagnostics(
     pyright = {"version": "1.0", "summary": {}}
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert result == []
@@ -301,7 +300,7 @@ def test_missing_range_field(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -331,7 +330,7 @@ def test_missing_start_in_range(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -361,7 +360,7 @@ def test_missing_end_in_range(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -383,10 +382,7 @@ def test_missing_line_in_start(
                 "message": "Test error",
                 "rule": "testRule",
                 "range": {
-                    "start": {
-                        # Missing 'line' field
-                        "character": 10
-                    },
+                    "start": {"character": 10},  # Missing 'line' field
                     "end": {"line": 10, "character": 20},
                 },
             }
@@ -394,7 +390,7 @@ def test_missing_line_in_start(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -427,7 +423,7 @@ def test_missing_character_in_end(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -454,7 +450,7 @@ def test_missing_file_field(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -481,7 +477,7 @@ def test_missing_message_field(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert len(result) == 1
@@ -499,14 +495,14 @@ def test_completely_empty_issue(
     }
     monkeypatch.setattr("sys.stdin", io.StringIO(json.dumps(pyright)))
     monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py"])
-    main()
+    cli()
     captured = capsys.readouterr()
     result = json.loads(captured.out)
     assert result == [
         {
             "check_name": "pyright: unknown",
             "description": "",
-            "fingerprint": "751a157014b31820ec789f6f9cce28599122b8b56b628230f339ea2d",
+            "fingerprint": "dffaea5ca76e2b8d5ce64c938ce05945",
             "severity": "minor",
             "location": {
                 "path": "<anonymous>",
@@ -517,3 +513,14 @@ def test_completely_empty_issue(
             },
         }
     ]
+
+
+def test_version_flag(
+    monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture
+) -> None:
+    """Test that the --version flag outputs the correct version."""
+    monkeypatch.setattr("sys.argv", ["pyright_to_gitlab.py", "--version"])
+    with pytest.raises(SystemExit):
+        cli()
+    result = capsys.readouterr().out
+    assert result == f"pyright_to_gitlab.py {version('pyright-to-gitlab')}\n"

{pyright_to_gitlab-1.2.0 → pyright_to_gitlab-1.3.0}/uv.lock

@@ -435,7 +435,7 @@ wheels = [
 
 [[package]]
 name = "pyright-to-gitlab"
-version = "1.2.0"
+version = "1.3.0"
 source = { editable = "." }
 
 [package.dev-dependencies]