Setup CodSpeed (#104)

Co-authored-by: Amin Alaee <amin.alaee.zaviyeh@postnl.nl>

Author: codspeed-hq[bot]

.github/workflows/ci.yml

@@ -50,7 +50,7 @@ jobs:
         if: matrix.target == 'x86_64'
         run: |
           pip install uuid_utils --no-index --find-links dist --force-reinstall
-          pip install pytest
+          pip install pytest pytest-codspeed
           pytest -v .
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -86,9 +86,9 @@ jobs:
           install: |
             apt-get update
             apt-get install -y --no-install-recommends python3 python3-pip
-            pip3 install -U pip pytest
+            pip install pytest
           run: |
-            pip3 install uuid_utils --no-index --find-links dist/ --force-reinstall
+            pip install uuid_utils --no-index --find-links dist/ --force-reinstall
             pytest -v .
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -196,7 +196,7 @@ jobs:
       - name: Install and test uuid_utils
         run: |
           pip install uuid_utils --no-index --find-links dist --force-reinstall
-          pip install pytest
+          pip install pytest pytest-codspeed
           pytest -v .
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -232,7 +232,7 @@ jobs:
       - name: Install and test uuid_utils
         run: |
           pip install uuid_utils --no-index --find-links dist --force-reinstall
-          pip install pytest
+          pip install pytest pytest-codspeed
           pytest -v .
       - name: Upload wheels
         uses: actions/upload-artifact@v4
@@ -260,7 +260,17 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     if: "startsWith(github.ref, 'refs/tags/')"
-    needs: [lint, linux, linux-cross, musllinux, musllinux-cross, windows, macos, sdist]
+    needs:
+      [
+        lint,
+        linux,
+        linux-cross,
+        musllinux,
+        musllinux-cross,
+        windows,
+        macos,
+        sdist,
+      ]
     steps:
       - uses: actions/download-artifact@v4.1.8
         with:

.github/workflows/codspeed.yml

@@ -0,0 +1,39 @@
+name: CodSpeed
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  id-token: write
+
+env:
+  RUSTFLAGS: "--cfg uuid_unstable"
+
+jobs:
+  codspeed:
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+      - name: Build Python package with maturin
+        uses: PyO3/maturin-action@v1
+        with:
+          args: --release --out dist
+      - name: Install uuid_utils
+        run: pip install uuid_utils --no-index --find-links dist --force-reinstall
+      - name: Run benchmarks
+        uses: CodSpeedHQ/action@v4.5.2
+        with:
+          mode: simulation
+          run: pytest tests/test_benchmarks.py --codspeed

.gitignore

@@ -70,4 +70,5 @@ docs/_build/
 .python-version
 
 .ruff_cache
-.mypy_cache
+.mypy_cache
+.codspeed/

Makefile

@@ -6,8 +6,8 @@ build:
 
 .PHONY: format
 format:
-	ruff check --fix python/ tests/
 	ruff format python/ tests/
+	ruff check --fix python/ tests/
 	cargo fmt
 
 .PHONY: lint

README.md

@@ -4,6 +4,7 @@
 
 [![Package version](https://badge.fury.io/py/uuid-utils.svg)](https://pypi.org/project/uuid-utils/)
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/uuid-utils.svg?color=%2334D058)](https://pypi.org/project/uuid-utils)
+[![CodSpeed](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/aminalaee/uuid-utils?utm_source=badge)
 
 </div>
 
@@ -93,7 +94,7 @@ os.register_at_fork(uuid_utils.reseed_rng)
 ## Benchmarks
 
 |        Benchmark | Min     | Max     | Mean    | Min (+)         | Max (+)         | Mean (+)        |
-|------------------|---------|---------|---------|-----------------|-----------------|-----------------|
+|------------------|---------|---------|---------|-----------------|-----------------|--------------------|
 |          UUID v1 | 0.061   | 0.299   | 0.194   | 0.019 (3.3x)    | 0.019 (15.4x)   | 0.019 (10.1x)   |
 |          UUID v3 | 0.267   | 0.307   | 0.293   | 0.035 (7.6x)    | 0.041 (7.5x)    | 0.039 (7.5x)    |
 |          UUID v4 | 0.073   | 0.119   | 0.083   | 0.005 (15.2x)   | 0.005 (24.6x)   | 0.005 (17.1x)   |

requirements.txt

@@ -2,4 +2,5 @@ mkdocs==1.6.1
 mkdocs-material==9.5.34
 mypy==1.19.0
 pytest==9.0.1
+pytest-codspeed==4.2.0
 ruff==0.14.7

tests/test_benchmarks.py

@@ -0,0 +1,65 @@
+import pytest
+import uuid_utils
+
+pytest.importorskip("pytest_codspeed")
+
+
+@pytest.mark.benchmark
+def test_getnode() -> None:
+    uuid_utils.getnode()
+
+
+@pytest.mark.benchmark
+def test_uuid1_() -> None:
+    uuid_utils.uuid1()
+
+
+@pytest.mark.benchmark
+def test_uuid3() -> None:
+    uuid_utils.uuid3(namespace=uuid_utils.NAMESPACE_DNS, name="python.org")
+
+
+@pytest.mark.benchmark
+def test_uuid4() -> None:
+    uuid_utils.uuid4()
+
+
+@pytest.mark.benchmark
+def test_uuid5() -> None:
+    uuid_utils.uuid5(namespace=uuid_utils.NAMESPACE_DNS, name="python.org")
+
+
+@pytest.mark.benchmark
+def test_uuid6() -> None:
+    uuid_utils.uuid6()
+
+
+@pytest.mark.benchmark
+def test_uuid7() -> None:
+    uuid_utils.uuid7()
+
+
+@pytest.mark.benchmark
+def test_uuid8() -> None:
+    uuid_utils.uuid8(bytes=b"\x00" * 16)
+
+
+@pytest.mark.benchmark
+def test_uuid_from_hex() -> None:
+    uuid_utils.UUID("a8098c1a-f86e-11da-bd1a-00112444be1e")
+
+
+def test_uuid_from_bytes(benchmark) -> None:  # type: ignore[no-untyped-def]
+    hex_bytes = bytes.fromhex("a8098c1af86e11dabd1a00112444be1e")
+    benchmark(lambda: uuid_utils.UUID(bytes=hex_bytes))
+
+
+@pytest.mark.benchmark
+def test_uuid_from_int() -> None:
+    int_value = 223338299594506624080436508043913872926
+    uuid_utils.UUID(int=int_value)
+
+
+@pytest.mark.benchmark
+def test_uuid_from_fields_utils() -> None:
+    uuid_utils.UUID(fields=(2819197978, 63598, 4570, 189, 26, 73622928926))