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

{pyright_to_gitlab-1.1.0 → pyright_to_gitlab-1.3.0}/CHANGELOG.md

@@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Upcoming]
+### Changes
+- Minimum version is now 3.8.
+- Use TypedDict for Pyright and Gitlab issue handling.
+- Update test dependencies to latest. 
+
 ## [1.1.0] - 2025-06-03
 ### Added
 - Support for -i/--input and -o/--output options to specify input and output files.

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

@@ -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/README.md

@@ -0,0 +1,39 @@
+# pyright to gitlab
+
+[![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:
+```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 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
+```
+
+## Testing
+To run the tests, execute
+```shell
+$ uv run pytest tests/
+```

{pyright_to_gitlab-1.1.0 → pyright_to_gitlab-1.3.0}/pyproject.toml

@@ -1,18 +1,17 @@
 [project]
 name = "pyright-to-gitlab"
-version = "1.1.0"
+version = "1.3.0"
 description = "Convert Pyright JSON output to GitLab CI/CD format"
 readme = "README.md"
-requires-python = ">=3.6"
+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",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -32,7 +31,7 @@ repository = "https://github.com/schollm/pyright-to-gitlab/"
 pypi = "https://pypi.org/project/pyright-to-gitlab"
 
 [project.scripts]
-pyrigh-to-gitlab = 'pyright_to_gitlab:main'
+pyright-to-gitlab = 'pyright_to_gitlab:main'
 
 [build-system]
 requires = ["hatchling"]
@@ -40,6 +39,7 @@ build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/pyright_to_gitlab.py"]
+artifacts = ["src/py.typed"]
 
 [dependency-groups]
 dev = [
@@ -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.3.0/src/py.typed

@@ -0,0 +1,2 @@
+# Marker file for PEP 561
+# This package provides inline type annotations

pyright_to_gitlab-1.3.0/src/pyright_to_gitlab.py

@@ -0,0 +1,202 @@
+"""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 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.
+
+    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
+    """
+    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("""
+        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 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
+    cli()