pyright-to-gitlab 1.0.1__tar.gz

pyright_to_gitlab-1.0.1/.github/workflows/python.yml

@@ -0,0 +1,92 @@
+name: Python Application
+
+on: [push]
+
+jobs:
+  testing:
+     name: Testing
+     uses: ./.github/workflows/testing.yml
+
+  build:
+    name: Build package 📦
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Build package
+        run: uv build
+      - name: Upload dist-build
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    needs: [testing]
+    if: success() && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pyright-to-gitlab
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: >-
+      Sign the Python 🐍 distribution 📦 with Sigstore
+      and upload them to GitHub Release
+    needs: [testing]
+    if: success() && startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write  # IMPORTANT: mandatory for making GitHub Releases
+      id-token: write  # IMPORTANT: mandatory for sigstore
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Sign the dists with Sigstore
+        uses: sigstore/gh-action-sigstore-python@v3.0.0
+        with:
+          inputs: >-
+            ./dist/*.tar.gz
+            ./dist/*.whl
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: >-
+          gh release create
+          '${{ github.ref_name }}'
+          --repo '${{ github.repository }}'
+          --notes "" || echo "Release already exists, continuing to sign artifacts."
+      - name: Upload artifact signatures to GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        # Upload to GitHub Release using the `gh` CLI.
+        # `dist/` contains the built packages and the
+        # sigstore-produced signatures and certificates.
+        run: >-
+          gh release upload --clobber
+          '${{ github.ref_name }}' dist/**
+          --repo '${{ github.repository }}'
+          

pyright_to_gitlab-1.0.1/.github/workflows/testing.yml

@@ -0,0 +1,72 @@
+name: Testing
+
+on:
+  workflow_call:
+
+jobs:
+  lint-typing:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install project dependencies
+        run: uv sync
+      - name: 'Type check'
+        run: uv run pyright src
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/ruff-action@v3
+        with:
+          src: "./src"
+          args: "check"
+      - name: 'Ruff format check'
+        run: ruff format --check
+      - name: 'Ruff check'
+        run: ruff check
+  test:
+    name: 🐍
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        python-version: ["3.12"]
+        # Add all python versions for ubuntu.
+        include:
+          - os: "ubuntu-latest"
+            python-version: "3.8"
+          - os: "ubuntu-latest"
+            python-version: "3.10"
+          - os: "ubuntu-latest"
+            python-version: "3.11"
+          - os: "ubuntu-latest"
+            python-version: "3.13"
+            coverage: true
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install dependencies
+        run: uv sync
+      - name: Run pytest
+        run: |
+          echo ${{ github.ref }}
+          uv run --python ${{ matrix.python-version }} pytest tests/
+      - name: Code Coverage Summary Report
+        if: matrix.coverage==true
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: '.out/coverage*.xml'
+          badge: true
+          format: 'markdown'
+          output: 'both'
+          thresholds: '75 98'
+      - name: Write to Job Summary
+        if: matrix.coverage==true
+        run: cat code-coverage-results.md >> $GITHUB_STEP_SUMMARY

pyright_to_gitlab-1.0.1/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+.idea/**
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+**/.out/**
+.python-version
+**/.coverage
+# Virtual environments
+.venv

pyright_to_gitlab-1.0.1/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Upcoming]
+
+## [1.0.0] - 2025-06-02
+Initial release.

pyright_to_gitlab-1.0.1/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-1.0.1/PKG-INFO

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

@@ -0,0 +1,29 @@
+# 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/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "pyright-to-gitlab"
+version = "1.0.1"
+description = "Convert Pyright JSON output to GitLab CI/CD format"
+readme = "README.md"
+requires-python = ">=3.6"
+authors = [
+    { name = "Micha Schöll", email = "" }
+]
+license = { file = "LICENSE" }
+[project.scripts]
+pyrigh-to-gitlab = 'pyright_to_gitlab:main'
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyright_to_gitlab.py"]
+
+[dependency-groups]
+dev = [
+    "pyright>=0.0.13.post0",
+    "pytest>=7.0.1",
+    "pytest-cov>=4.0.0",
+    "ruff>=0.0.17",
+]
+
+[tool.ruff]
+line-length = 88
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D213",  #  `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible.
+    "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]
+"tests/**/*.py" = [
+    # at least this three should be fine in tests:
+    "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()
+]
+
+[tool.pytest.ini_options]
+addopts = """
+  --junit-xml=.out/junit-pytest.xml
+  --cov=pyright_to_gitlab
+  --cov-report=xml:.out/coverage.xml
+  --cov-report=html:.out/coverage-html
+  --cov-report term-missing
+  --cov-branch
+"""

pyright_to_gitlab-1.0.1/src/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()

pyright_to_gitlab-1.0.1/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for the pyright_to_gitlab module."""

pyright_to_gitlab-1.0.1/tests/test_main.py

@@ -0,0 +1,125 @@
+"""Tests for the pyright_to_gitlab module."""
+
+from __future__ import annotations
+
+import io
+import json
+
+import pytest
+
+from pyright_to_gitlab import main
+
+PYRIGHT = {
+    "version": "1.1.385",
+    "time": "1748865254393",
+    "generalDiagnostics": [
+        {
+            "file": "test1.py",
+            "severity": "error",
+            "message": 'Message "foo"',
+            "range": {
+                "start": {"line": 101, "character": 27},
+                "end": {"line": 101, "character": 35},
+            },
+            "rule": "reportGeneralTypeIssues",
+        },
+        {
+            "file": "test2.py",
+            "severity": "error",
+            "message": "Message bar",
+            "range": {
+                "start": {"line": 130, "character": 18},
+                "end": {"line": 130, "character": 24},
+            },
+            "rule": "reportInvalidTypeForm",
+        },
+    ],
+    "summary": {
+        "filesAnalyzed": 3,
+        "errorCount": 2,
+        "warningCount": 0,
+        "informationCount": 0,
+        "timeInSec": 0.200,
+    },
+}
+GITLAB = [
+    {
+        "check_name": "pyright: reportGeneralTypeIssues",
+        "description": 'Message "foo"',
+        "fingerprint": "636af0d195f1115a2100087f399ea9759e20a6bf30494b881653eb7b",
+        "location": {
+            "path": "test1.py",
+            "positions": {
+                "begin": {"column": 27, "line": 101},
+                "end": {"column": 35, "line": 101},
+            },
+        },
+        "severity": "major",
+    },
+    {
+        "check_name": "pyright: reportInvalidTypeForm",
+        "description": "Message bar",
+        "fingerprint": "b0678d27f9d033a7176fcaf13dcfd449a7ec9cff211484ff730b32b2",
+        "location": {
+            "path": "test2.py",
+            "positions": {
+                "begin": {"column": 18, "line": 130},
+                "end": {"column": 24, "line": 130},
+            },
+        },
+        "severity": "major",
+    },
+]
+
+
+@pytest.mark.parametrize(
+    ("pyright", "gitlab"),
+    [
+        ({}, []),  # Empty input should yield empty output
+        (PYRIGHT, GITLAB),
+    ],
+)
+def test(
+    monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture,
+    pyright: dict,
+    gitlab: list[dict],
+) -> None:
+    """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()
+    captured = capsys.readouterr()
+    assert json.loads(captured.out) == gitlab
+
+
+@pytest.mark.parametrize(
+    ("pyright", "gitlab"),
+    [
+        ({}, []),  # Empty input should yield empty output
+        (PYRIGHT, GITLAB),
+    ],
+)
+def test_prefix(
+    monkeypatch: pytest.MonkeyPatch,
+    capsys: pytest.CaptureFixture,
+    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()
+    captured = capsys.readouterr()
+    gitlab_with_prefix = [
+        {
+            **issue,
+            "location": {
+                **issue["location"],
+                "path": f"{prefix}{issue['location']['path']}",
+            },
+        }
+        for issue in gitlab
+    ]
+    assert json.loads(captured.out) == gitlab_with_prefix