1 central run_pylint script.

Author: HenrZu

.github/actions/test-pylint/action.yml

@@ -13,6 +13,8 @@ runs:
         sudo apt-get -qq update
         sudo apt-get -qq -y install python3-pip gnupg
         python -m pip install --upgrade pip
+    # Pylint runs against the prebuilt wheels in pycode/wheelhouse/*cp311*.
+    # So, use current latest supported Python version.
     - name: Set up Python 3.11
       uses: actions/setup-python@v5
       with:
@@ -30,14 +32,8 @@ runs:
     - name: Run pylint
       shell: bash
       run: |
-        cd pycode/memilio-${{ inputs.package }}
-        mkdir -p build_pylint
-        if [ -f tools/run_pylint.py ]; then
-          python tools/run_pylint.py
-        else
-          python -m pylint --rcfile=../pylintrc --load-plugins=pylint_json2html --output-format=jsonextended memilio/ > build_pylint/pylint_extended.json || true
-        fi
-        pylint-json2html -f jsonextended -o build_pylint/pylint.html < build_pylint/pylint_extended.json
+        python pycode/tools/run_pylint.py --package-dir memilio-${{ inputs.package }}
+        pylint-json2html -f jsonextended -o pycode/memilio-${{ inputs.package }}/build_pylint/pylint.html < pycode/memilio-${{ inputs.package }}/build_pylint/pylint_extended.json
     - name: Upload Pylint Report
       uses: actions/upload-artifact@v4
       with:

docs/source/python/python_packages.rst

@@ -171,10 +171,11 @@ Run pylint with the commands in the package folder
 
 .. code-block:: console
 
-    python tools/run_pylint.py
+    python ../tools/run_pylint.py
     pylint-json2html -f jsonextended -o build_pylint/pylint.html < build_pylint/pylint_extended.json
 
-Packages without the helper script can run pylint directly, for example ``python -m pylint memilio``.
+From the repository root you can also target a package explicitly, for example
+``python pycode/tools/run_pylint.py --package-dir memilio-plot``.
 
 Pylint report for actual master:
 

pycode/memilio-epidata/README.rst

@@ -116,7 +116,7 @@ Run pylint with the commands
 
 .. code:: sh
 
-    python tools/run_pylint.py
+    python ../tools/run_pylint.py
     pylint-json2html -f jsonextended -o build_pylint/pylint.html < build_pylint/pylint_extended.json
 
 Pylint report for actual master:

pycode/memilio-epidata/tools/run_pylint.py

@@ -104,7 +104,7 @@ Run pylint with the commands
 
 .. code:: sh
 
-    python tools/run_pylint.py
+    python ../tools/run_pylint.py
     pylint-json2html -f jsonextended -o build_pylint/pylint.html < build_pylint/pylint_extended.json
 
 Pylint report for actual master:

pycode/memilio-plot/README.md

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+"""Run pylint for a given memilio package and write the jsonextended report."""
+
+from __future__ import annotations
+
+import argparse
+import subprocess
+import sys
+from pathlib import Path
+
+
+def parse_args(pycode_root: Path) -> argparse.Namespace:
+    parser = argparse.ArgumentParser(
+        description="Run pylint for a specific memilio pycode package."
+    )
+    parser.add_argument(
+        "--package-dir",
+        help="Directory name under pycode/ (e.g. memilio-epidata).",
+    )
+    args = parser.parse_args()
+
+    # if package_dir is given, use it directly
+    if args.package_dir:
+        return args
+
+    # If no package dir is provided, try to infer it from the current working directory
+    # Used, when the script is called from inside pycode/<package>/...
+    try:
+        relative = Path.cwd().resolve().relative_to(pycode_root)
+    except ValueError:
+        parser.error(
+            "--package-dir is required when not running from inside pycode/<package>"
+        )
+
+    if not relative.parts:
+        parser.error(
+            "--package-dir is required when not running from inside pycode/<package>"
+        )
+
+    args.package_dir = relative.parts[0]
+    return args
+
+
+def main() -> int:
+    repo_root = Path(__file__).resolve().parents[2]
+    pycode_root = repo_root / "pycode"
+    args = parse_args(pycode_root)
+    package_dir = pycode_root / args.package_dir
+
+    if not package_dir.is_dir():
+        sys.stderr.write(f"Package directory not found: {package_dir}\n")
+        return 1
+
+    rcfile = pycode_root / "pylintrc"
+    if not rcfile.is_file():
+        sys.stderr.write(f"Cannot find pylintrc at {rcfile}\n")
+        return 1
+
+    build_dir = package_dir / "build_pylint"
+    build_dir.mkdir(exist_ok=True)
+    output_file = build_dir / "pylint_extended.json"
+
+    cmd = [
+        sys.executable,
+        "-m",
+        "pylint",
+        "--rcfile",
+        str(rcfile),
+        "--load-plugins",
+        "pylint_json2html",
+        "--output-format=jsonextended",
+        "memilio/",
+    ]
+
+    with output_file.open("w", encoding="utf-8") as stream:
+        result = subprocess.run(
+            cmd,
+            cwd=package_dir,
+            stdout=stream,
+            stderr=subprocess.PIPE,
+            text=True,
+            check=False,
+        )
+
+    if result.stderr:
+        sys.stderr.write(result.stderr)
+
+    if result.returncode:
+        sys.stderr.write(
+            f"pylint exited with {result.returncode}; "
+            f"see {output_file} for details.\n"
+        )
+
+    # Always exit 0 so CI can upload and publish the report even when pylint fails.
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())