[ci] Add workflow to check python code formatting.

Signed-off-by: boschmitt <[email protected]>

Author: boschmitt

.github/workflows/pr_sanity_checks.yaml

@@ -20,6 +20,8 @@ jobs:
     outputs:
       check-cpp: ${{ steps.filter.outputs.check-cpp }}
       check-all-cpp: ${{ steps.filter.outputs.check-all-cpp }}
+      check-python: ${{ steps.filter.outputs.check-python }}
+      check-all-python: ${{ steps.filter.outputs.check-all-python }}
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -32,13 +34,16 @@ jobs:
         with:
           filters: |
             check-all-cpp:
-              - '.github/workflows/pr_sanity_checks.yaml'
               - '.clang-format'
             check-cpp:
               - '**/*.cpp'
               - '**/*.h'
+            check-all-python:
+              - '.style.yapf'
+            check-python:
+              - '**/*.py'
 
-  check-clang-format:
+  check-cpp:
     name: Check C++ code formatting
     needs: [check-changes]
     if: needs.check-changes.outputs.check-cpp == 'true' || needs.check-changes.outputs.check-all-cpp == 'true'
@@ -85,8 +90,7 @@ jobs:
           git fetch --recurse-submodules=no origin ${{ github.base_ref }}
           DIFF_COMMIT_SHA=$(git rev-parse origin/${{ github.base_ref }})
 
-          git config clangFormat.binary clang-format-$LLVM_VERSION
-          if ! git clang-format $DIFF_COMMIT_SHA; then
+          if ! git clang-format-$LLVM_VERSION $DIFF_COMMIT_SHA; then
             git diff --ignore-submodules > clang-format.patch
             echo "🟥 Clang-format found formatting problems (check the uploaded artifact)." >> $GITHUB_STEP_SUMMARY
             exit 1
@@ -102,3 +106,92 @@ jobs:
           name: clang-format-patch
           path: clang-*.patch
 
+  check-python:
+    name: Check Python code formatting
+    needs: [check-changes]
+    if: needs.check-changes.outputs.check-python == 'true' || needs.check-changes.outputs.check-all-python == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          set-safe-directory: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install YAPF
+        run: pip install yapf
+
+      - name: YAPF all things
+        if: needs.check-changes.outputs.check-all-python == 'true'
+        run: |
+          git ls-files '*.py' | xargs yapf -i
+
+          if ! git diff --exit-code; then
+            git diff --ignore-submodules > yapf-format.patch
+            echo "🟥 YAPF found formatting problems (check the uploaded artifact)." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+          echo "🟩 YAPF found no formatting problems" >> $GITHUB_STEP_SUMMARY
+          exit 0
+
+      - name: YAPF changed files
+        if: needs.check-changes.outputs.check-all-python != 'true'
+        run: |
+          # We did a shallow clone, and thus we need to make sure to fetch the base
+          # commit.
+          git fetch --recurse-submodules=no origin ${{ github.base_ref }}
+          DIFF_COMMIT_SHA=$(git rev-parse origin/${{ github.base_ref }})
+
+          git diff --diff-filter=d $DIFF_COMMIT_SHA -- '*.py' | yapf-diff --i
+
+          if ! git diff --exit-code; then
+            git diff --ignore-submodules > yapf-format.patch
+            echo "🟥 YAPF found formatting problems (check the uploaded artifact)." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+          echo "🟩 YAPF found no formatting problems" >> $GITHUB_STEP_SUMMARY
+          exit 0
+
+      - name: Upload format patch
+        uses: actions/upload-artifact@v4
+        continue-on-error: true
+        if: ${{ failure() }}
+        with:
+          name: yapf-format-patch
+          path: yapf-*.patch
+
+  # This job is used for branch protection checks.
+  verify:
+    name: Sanity check PR
+    if: ${{ always() }}
+    needs:
+      - check-cpp
+      - check-python
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check results
+        run: |
+          status="success"
+
+          check_result() {
+            name=$1
+            result=$2
+
+            # NOTE: "skipped" is considered success.
+            if [[  "$result" == "failure" || "$result" == "cancelled" ]]; then
+              echo "$name job failed"
+
+              status="failed"
+            fi
+          }
+
+          check_result "check-cpp"    "${{needs.check-cpp.result}}"
+          check_result "check-python" "${{needs.check-python.result}}"
+
+          if [[ "$status" != "success" ]]; then
+            exit 1
+          fi

libs/qec/lib/decoder.cpp

@@ -29,7 +29,8 @@ decoder_result decoder::decode(const cudaqx::tensor<uint8_t> &syndrome) {
   // Check tensor is of order-1
   // If order >1, we could check that other modes are of dim = 1 such that
   // n x 1, or 1 x n tensors are still valid.
-  if (syndrome.rank() != 1) {
+  if (syndrome.rank() != 1)
+  {
     throw std::runtime_error("Decode requires rank-1 tensors");
   }
   std::vector<float_t> soft_syndrome(syndrome.shape()[0]);

libs/qec/python/cudaq_qec/patch.py

@@ -11,7 +11,7 @@
 
 @dataclass
 class patch:
-    """A logical qubit patch representation for surface code quantum error correction.
+    """A logical qubit patch representation for surface code quantum error correction. 
     
     This class represents a logical qubit encoded in a 2D patch, containing
     data qubits and both X and Z ancilla qubits arranged in a 2D lattice pattern.