ci: pin actions to v5/v6 to silence Node 20 deprecation; ruff: add explicit [tool.ruff.format] with line-ending=lf; reformat python/ to satisfy format check (12 files normalized after recent edits)

qectorlab · qectorlab · commit 12cc963ef0ac · 2026-07-07T12:25:20.000-04:00
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -36,7 +36,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Inject Rust source
         env:
@@ -52,7 +52,7 @@ jobs:
             echo "SKIP_BUILD=0" >> "$GITHUB_ENV"
           fi
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         if: env.SKIP_BUILD == '0'
         with:
           python-version: ${{ matrix.python-version }}
@@ -83,7 +83,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Inject Rust source
         env:
@@ -100,7 +100,7 @@ jobs:
             echo "SKIP_BUILD=0" >> "$GITHUB_ENV"
           fi
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         if: env.SKIP_BUILD == '0'
         with:
           python-version: ${{ matrix.python-version }}
@@ -131,7 +131,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Inject Rust source
         env:
@@ -147,7 +147,7 @@ jobs:
             echo "SKIP_BUILD=0" >> "$GITHUB_ENV"
           fi
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         if: env.SKIP_BUILD == '0'
         with:
           python-version: ${{ matrix.python-version }}
@@ -177,7 +177,7 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Inject Rust source
         env:
@@ -193,7 +193,7 @@ jobs:
             echo "SKIP_BUILD=0" >> "$GITHUB_ENV"
           fi
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v6
         if: env.SKIP_BUILD == '0'
         with:
           python-version: ${{ matrix.python-version }}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -20,8 +20,8 @@ jobs:
     name: ruff-and-mypy
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: "3.12"
       - name: Install linting tools
@@ -52,7 +52,7 @@ jobs:
     runs-on: ubuntu-latest
     continue-on-error: true
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: Build Docker image (Rust source stub -- expected failure)
         run: docker build -t qector-decoder-test:ci . || echo "::warning::Docker build failed (stub src -- expected)"
 
@@ -67,8 +67,8 @@ jobs:
       matrix:
         python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - uses: actions/checkout@v5
+      - uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install from PyPI
diff --git a/pyproject.toml b/pyproject.toml
@@ -129,6 +129,13 @@ ignore_missing_imports = true
 line-length = 120
 target-version = "py39"
 
+[tool.ruff.format]
+# Ensure consistent formatting on Linux CI runners (LF) even when edited on Windows.
+line-ending = "lf"
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+
 [tool.ruff.lint]
 # E702: semicolons used intentionally for chained one-liners in plotting helpers.
 # E731: lambda assignments used for compact callback tables in a few helpers.
diff --git a/python/qector_decoder_v3/backend.py b/python/qector_decoder_v3/backend.py
@@ -17,8 +17,8 @@
 >>> from qector_decoder_v3.backend import AutoDecoder
 >>> code = codes.rotated_surface_code(7)
 >>> dec = AutoDecoder(code.check_to_qubits, code.n_qubits)
->>> dec.calibrate()                      # optional: tune the GPU threshold
->>> out = dec.batch_decode(syndromes)    # picks CPU / Rayon / GPU automatically
+>>> dec.calibrate()  # optional: tune the GPU threshold
+>>> out = dec.batch_decode(syndromes)  # picks CPU / Rayon / GPU automatically
 >>> dec.diagnostics()
 """
 
diff --git a/python/qector_decoder_v3/belief_matching.py b/python/qector_decoder_v3/belief_matching.py
@@ -24,9 +24,9 @@
 -------
 >>> import stim
 >>> from qector_decoder_v3.belief_matching import BeliefMatching
->>> dem = stim.Circuit.generated("surface_code:rotated_memory_x", distance=5,
-...        rounds=5, after_clifford_depolarization=0.005).detector_error_model(
-...        decompose_errors=True)
+>>> dem = stim.Circuit.generated(
+...     "surface_code:rotated_memory_x", distance=5, rounds=5, after_clifford_depolarization=0.005
+... ).detector_error_model(decompose_errors=True)
 >>> bm = BeliefMatching.from_detector_error_model(dem)
 >>> predicted_observables = bm.decode_batch(detection_events)
 """
diff --git a/python/qector_decoder_v3/bp_cupy.py b/python/qector_decoder_v3/bp_cupy.py
@@ -35,8 +35,7 @@
 -------
 >>> from qector_decoder_v3 import codes
 >>> from qector_decoder_v3.bp_cupy import batched_bp_decode
->>> cx, _ = codes.bivariate_bicycle_code(6, 6, [("x", 3), ("y", 1), ("y", 2)],
-...                                             [("y", 3), ("x", 1), ("x", 2)])
+>>> cx, _ = codes.bivariate_bicycle_code(6, 6, [("x", 3), ("y", 1), ("y", 2)], [("y", 3), ("x", 1), ("x", 2)])
 >>> H = cx.parity_check_matrix()
 >>> import numpy as np
 >>> errs = (np.random.default_rng(0).random((128, 72)) < 0.05).astype(np.uint8)
diff --git a/python/qector_decoder_v3/bposd.py b/python/qector_decoder_v3/bposd.py
@@ -15,8 +15,7 @@
 -------
 >>> from qector_decoder_v3 import codes
 >>> from qector_decoder_v3.bposd import BpOsdDecoder
->>> cx, cz = codes.bivariate_bicycle_code(6, 6, [("x",3),("y",1),("y",2)],
-...                                              [("y",3),("x",1),("x",2)])
+>>> cx, cz = codes.bivariate_bicycle_code(6, 6, [("x", 3), ("y", 1), ("y", 2)], [("y", 3), ("x", 1), ("x", 2)])
 >>> dec = BpOsdDecoder(cx.parity_check_matrix(), error_rate=0.05, osd_order=0)
 >>> correction = dec.decode(syndrome)
 """
diff --git a/python/qector_decoder_v3/dem.py b/python/qector_decoder_v3/dem.py
@@ -23,8 +23,8 @@
 Example
 -------
 >>> from qector_decoder_v3 import dem
->>> model = dem.load_dem_file("circuit.dem")     # or dem.from_stim(dem_object)
->>> code = model.to_code()                         # a codes.Code
+>>> model = dem.load_dem_file("circuit.dem")  # or dem.from_stim(dem_object)
+>>> code = model.to_code()  # a codes.Code
 >>> decoder = model.make_decoder("sparse_blossom")
 >>> correction = decoder.decode(syndrome)
 >>> logical_pred = model.predicted_observables(correction)
diff --git a/python/qector_decoder_v3/gpu_backend.py b/python/qector_decoder_v3/gpu_backend.py
@@ -26,11 +26,11 @@
 Example
 -------
 >>> from qector_decoder_v3 import gpu_backend as gb
->>> xp = gb.get_array_module(prefer_gpu=True)      # cupy if usable, else numpy
->>> dev = gb.to_device([1, 0, 1, 1])               # host -> device (counted)
->>> gb.is_on_gpu(dev)                               # True iff really on the GPU
->>> host = gb.to_host(dev)                          # device -> host (counted)
->>> gb.get_backend().summary()                      # one-glance capability report
+>>> xp = gb.get_array_module(prefer_gpu=True)  # cupy if usable, else numpy
+>>> dev = gb.to_device([1, 0, 1, 1])  # host -> device (counted)
+>>> gb.is_on_gpu(dev)  # True iff really on the GPU
+>>> host = gb.to_host(dev)  # device -> host (counted)
+>>> gb.get_backend().summary()  # one-glance capability report
 """
 
 from __future__ import annotations
diff --git a/python/qector_decoder_v3/qiskit_plugin.py b/python/qector_decoder_v3/qiskit_plugin.py
@@ -10,7 +10,7 @@
     from qector_decoder_v3.qiskit_plugin import decode_qiskit_result, create_qiskit_decoder
 
     decoder = create_qiskit_decoder(code_distance=5)
-    result = job.result()           # qiskit.result.Result
+    result = job.result()  # qiskit.result.Result
     decoded = decoder(result)
 
 Usage (sans Qiskit — mode dict brut) ::
diff --git a/python/qector_decoder_v3/result.py b/python/qector_decoder_v3/result.py
@@ -15,9 +15,9 @@
 >>> code = codes.repetition_code(9)
 >>> s = code.syndrome(code.random_error(0.1))
 >>> res = decode_with_diagnostics(code, s, kind="blossom")
->>> res.correction            # uint8 vector
->>> res.sparse_indices        # nonzero qubit indices
->>> res.bit_packed            # np.packbits view
+>>> res.correction  # uint8 vector
+>>> res.sparse_indices  # nonzero qubit indices
+>>> res.bit_packed  # np.packbits view
 >>> res.to_json()
 """
 
diff --git a/python/qector_decoder_v3/routing.py b/python/qector_decoder_v3/routing.py
@@ -46,7 +46,7 @@
 >>> from qector_decoder_v3 import codes
 >>> ar = routing.AutoRouter(priority="accuracy")
 >>> code = codes.rotated_surface_code(5)
->>> corr = ar.decode(code, syndrome)          # picks BlossomDecoder, decodes
+>>> corr = ar.decode(code, syndrome)  # picks BlossomDecoder, decodes
 >>> ar.explain(code)["decoder"]
 'BlossomDecoder'
 """
diff --git a/python/qector_decoder_v3/sinter_compat.py b/python/qector_decoder_v3/sinter_compat.py
@@ -13,7 +13,8 @@
 >>> from qector_decoder_v3.sinter_compat import qector_sinter_decoders
 >>> tasks = [sinter.Task(circuit=c, json_metadata={"d": d}) for ...]
 >>> samples = sinter.collect(
-...     num_workers=4, tasks=tasks,
+...     num_workers=4,
+...     tasks=tasks,
 ...     decoders=["qector_belief"],
 ...     custom_decoders=qector_sinter_decoders(),
 ... )
diff --git a/python/qector_decoder_v3/workbench.py b/python/qector_decoder_v3/workbench.py
@@ -25,9 +25,9 @@
 -------
 >>> from qector_decoder_v3.workbench import Workbench
 >>> wb = Workbench()
->>> art = wb.run_benchmark({"code": "rotated_surface", "distances": [3, 5],
-...                         "decoders": ["blossom"], "trials": 500})
->>> wb.export_json(art, "out.json"); wb.export_csv(art, "out.csv")
+>>> art = wb.run_benchmark({"code": "rotated_surface", "distances": [3, 5], "decoders": ["blossom"], "trials": 500})
+>>> wb.export_json(art, "out.json")
+... wb.export_csv(art, "out.csv")
 """
 
 from __future__ import annotations
