Merge pull request #11 from kaitj/ci/benchmark

Ci/benchmark

Author: kaitj

.github/workflows/benchmark.yaml

@@ -0,0 +1,39 @@
+name: Benchmark
+
+on:
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  benchmark:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          submodules: true
+      - uses: astral-sh/setup-uv@v8.1.0
+      - run: uv sync --frozen --all-extras
+      - name: Run benchmarks
+        id: run-benchmarks
+        run: |
+          uv run python scripts/benchmark.py --branch ${{ github.sha }}
+      - uses: actions/upload-artifact@v7
+        with:
+          name: benchmark-${{ matrix.target.name }}
+          path: ${{ steps.run-benchmarks.outputs.report_file }}
+
+  # report:
+  #   needs: [benchmark]
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v6
+  #     - uses: astral-sh/setup-uv@v8.1.0
+  #     - run: uv sync --group "benchmark"
+  #     - uses: actions/download-artifact@v8
+  #       with:
+  #         pattern: benchmark-*
+  #     - name: Generate report
+  #       run: |
+  #         uv run .github/scripts/compare_benchmarks.py \
+  #           --output benchmarks.md \
+  #           --pattern benchmark-*.json

.github/workflows/ci.yaml

@@ -42,19 +42,19 @@ jobs:
           python-version: ${{ matrix.python-version }}
       - run: uv sync --all-extras
 
-      - name: Run tests without cloudpathlib
+      - name: Run non-cloud tests
         run: |
           uv run pytest \
-            -m "not cloud" \
+            -m "not cloud and not benchmark" \
             --junitxml=pytest-cloudless.xml \
             --cov-report=xml:coverage.xml \
-            --cov bids2table \
+            --cov=bids2table \
             tests
 
-      - name: Run tests with cloudpathlib
+      - name: Run cloud tests
         run: |
           uv run pytest \
-            -m "cloud" \
+            -m "cloud and not benchmark" \
             --junitxml=pytest-cloud.xml \
             --cov-report=xml:coverage.xml \
             --cov=bids2table \

.gitignore

@@ -26,6 +26,7 @@ htmlcov
 
 # Local data and scratch
 .scratch
+benchmarks/
 
 # Local virtual environment
 .venv

pyproject.toml

@@ -37,8 +37,10 @@ pybids = ["pandas>=2.0.0"]
 [dependency-groups]
 dev = [
     "pdoc>=16.0.0",
+    "polars>=1.40.1",
     "pre-commit>=4.6.0",
     "pytest>=9.0.3",
+    "pytest-benchmark>=5.2.3",
     "pytest-cov>=7.1.0",
     "ruff>=0.15.13",
 ]
@@ -68,4 +70,8 @@ lint.extend-select = ["I"]
 [tool.pytest.ini_options]
 log_cli = true
 log_cli_level = "INFO"
-markers = ["cloud: Tests requiring cloud group dependencies"]
+addopts = "--import-mode=importlib"
+markers = [
+    "benchmark: Tests used for benchmarking",
+    "cloud: Tests requiring cloud group dependencies",
+]