ci: add codspeed benchmarking (#105)

.github/workflows/codspeed.yml

@@ -0,0 +1,28 @@
+name: codspeed-benchmarks
+
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+  # `workflow_dispatch` allows CodSpeed to trigger backtest
+  # performance analysis in order to generate initial data.
+  workflow_dispatch:
+
+jobs:
+  benchmarks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+
+      - name: Install dependencies
+        run: pip install .[dev]
+
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v2
+        with:
+          token: ${{ secrets.CODSPEED_TOKEN }}
+          run: pytest --codspeed

iterpy/test_iter.py

@@ -1,5 +1,7 @@
 from collections.abc import Sequence
 
+import pytest
+
 from iterpy._iter import Iter
 
 
@@ -103,6 +105,12 @@ def test_flatten():
     assert result.to_list() == [1, 2, 3, 4]
 
 
+@pytest.mark.benchmark()
+def test_benchmark_large_flattening():
+    test_input = Iter(range(100_000)).map(lambda x: Iter([x]))
+    assert test_input.flatten().to_list() == list(range(100_000))
+
+
 class TestFlattenTypes:
     """Intentionally not parametrised so we can manually specify the return type hints and they can be checked by pyright"""
 

pyproject.toml

@@ -25,6 +25,7 @@ dev = [
   "pytest-cov==4.1.0",
   "pytest-xdist==3.5.0",
   "pytest-sugar==1.0.0",
+  "pytest-codspeed",
   "diff-cover==8.0.3",
   "ruff==0.2.0",
 ]