feat: compile to C

.circleci/config.yml

@@ -37,7 +37,7 @@ common: &common
         key: cache-v1-{{ arch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "setup.py" }}-{{ checksum "tox.ini" }}
 
 orbs:
-  win: circleci/windows@5.0.0
+  win: circleci/windows@5.1.0
 
 windows-wheel-steps:
   windows-wheel-setup: &windows-wheel-setup

.github/workflows/benchmark.yaml

@@ -0,0 +1,146 @@
+name: Pytest Benchmarks
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - '**.py'
+      - '.github/workflows/benchmark.yaml'
+      - 'pyproject.toml'
+      - 'setup.py'
+  push:
+    branches: [master]
+    paths:
+      - '**.py'
+      - '.github/workflows/benchmark.yaml'
+      - 'pyproject.toml'
+      - 'setup.py'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  benchmark:
+    name: Run Benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+          cache-dependency-path: |
+            setup.py
+            pyproject.toml
+
+      - name: Cache .mypy_cache
+        uses: actions/cache@v4
+        with:
+          path: .mypy_cache
+          key: mypy-cache-${{ runner.os }}-x64-${{ hashFiles('**/*.py', 'pyproject.toml') }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev] pytest-codspeed pytest-benchmark
+
+      - name: Remove Python files from test env
+        run: rm -r faster_hexbytes
+
+      - name: Run Pytest Benchmark & Save Output
+        run: pytest --benchmark-only --benchmark-json=benchmark.json benchmarks/
+
+      - name: Upload Pytest Benchmark Results
+        uses: actions/upload-artifact@v4
+        with:
+          name: pytest-benchmark-results
+          path: benchmark.json
+
+      - name: Parse Pytest Benchmark Output
+        run: python scripts/benchmark/parse_benchmark_output.py benchmark.json pytest_benchmark_results.json
+
+      - name: Compare Pytest Benchmark Results
+        run: python scripts/benchmark/compare_benchmark_results.py pytest_benchmark_results.json pytest_benchmark_diff.json
+
+      - name: Generate Markdown Benchmark Results
+        run: python scripts/benchmark/generate_benchmark_markdown.py
+
+      - name: Commit and Push Markdown Benchmark Results
+        continue-on-error: true
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git fetch origin ${{ github.head_ref || github.ref_name }}
+          git checkout ${{ github.head_ref || github.ref_name }}
+          git add benchmarks/results/*.md
+          if git diff --cached --quiet; then
+            echo "No changes to commit."
+          else
+            git commit -m "Update benchmark results [skip ci]"
+            git push origin HEAD:${{ github.head_ref || github.ref_name }}
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Markdown Benchmark Results
+        uses: actions/upload-artifact@v4
+        with:
+          name: markdown-benchmark-results
+          path: benchmarks/results/*.md
+
+      - name: Upload Pytest Benchmark Diff
+        uses: actions/upload-artifact@v4
+        with:
+          name: pytest-benchmark-diff
+          path: pytest_benchmark_diff.json
+
+      - name: Post Pytest Benchmark Diff as PR Comment
+        uses: actions/github-script@v8
+        with:
+          script: |
+            const fs = require('fs');
+            const diff = JSON.parse(fs.readFileSync('pytest_benchmark_diff.json', 'utf8'));
+            let body = '### Pytest Benchmark Diff\n\n';
+            const repo = `${context.repo.owner}/${context.repo.repo}`;
+            const branch = context.payload.pull_request ? context.payload.pull_request.head.ref : context.ref.replace('refs/heads/', '');
+            for (const [submodule, groupDiffs] of Object.entries(diff)) {
+              let submoduleFile = "unknown";
+              let benchmarkFile = "unknown";
+              const m = submodule.match(/^faster_hexbytes\.(.+)$/);
+              if (m) {
+                submoduleFile = `faster_hexbytes/${m[1]}.py`;
+                benchmarkFile = `benchmarks/test_${m[1]}_benchmarks.py`;
+              }
+              const submoduleUrl = `https://github.com/${repo}/blob/${branch}/${submoduleFile}`;
+              const benchmarkUrl = `https://github.com/${repo}/blob/${branch}/${benchmarkFile}`;
+              body += `#### [${submodule}](${submoduleUrl}) - [view benchmarks](${benchmarkUrl})\n`;
+              body += '| Function | Reference Mean | Faster Mean | % Change | Speedup (%) | x Faster | Faster |\n';
+              body += '|----------|---------------|-------------|----------|-------------|----------|--------|\n';
+              for (const [group, data] of Object.entries(groupDiffs).sort(([a], [b]) => a.localeCompare(b))) {
+                if (data.percent_change !== null && data.percent_change !== undefined) {
+                  let emoji = '➖';
+                  if (data.percent_change > 0) emoji = '✅';
+                  else if (data.percent_change < 0) emoji = '❌';
+                  const percentChange = data.percent_change !== undefined && data.percent_change !== null
+                    ? `${data.percent_change.toFixed(2)}%` : '';
+                  const speedupPercent = data.speedup_percent !== undefined && data.speedup_percent !== null
+                    ? `${data.speedup_percent.toFixed(2)}%` : '';
+                  const speedupX = data.speedup_x !== undefined && data.speedup_x !== null && isFinite(data.speedup_x)
+                    ? `${data.speedup_x.toFixed(2)}x` : '';
+                  body += `| \`${group}\` | ${data.reference_mean} | ${data.faster_mean} | ${percentChange} | ${speedupPercent} | ${speedupX} | ${emoji} |\n`;
+                } else if (data.note) {
+                  body += `| \`${group}\` |  |  |  |  |  | ➖ |\n`;
+                }
+              }
+              body += '\n';
+            }
+            github.rest.issues.createComment({
+              ...context.repo,
+              issue_number: context.issue.number,
+              body
+            });
+        if: github.event_name == 'pull_request'

.github/workflows/codspeed.yaml

@@ -0,0 +1,58 @@
+name: CodSpeed Benchmarks
+
+on:
+  pull_request:
+    branches: [master]
+    paths:
+      - '**.py'
+      - '.github/workflows/codspeed.yaml'
+      - 'pyproject.toml'
+      - 'setup.py'
+  push:
+    branches: [master]
+    paths:
+      - '**.py'
+      - '.github/workflows/codspeed.yaml'
+      - 'pyproject.toml'
+      - 'setup.py'
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  benchmark:
+    name: Run CodSpeed Benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+          cache: pip
+          cache-dependency-path: |
+            setup.py
+            pyproject.toml
+
+      - name: Cache .mypy_cache
+        uses: actions/cache@v4
+        with:
+          path: .mypy_cache
+          key: mypy-cache-${{ runner.os }}-x64-${{ hashFiles('**/*.py', 'pyproject.toml') }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .[dev] pytest-codspeed
+
+      - name: Remove Python files from test env
+        run: rm -r faster_hexbytes
+
+      - name: Run CodSpeed
+        uses: CodSpeedHQ/action@v4
+        with:
+          mode: instrumentation
+          run: pytest --codspeed -k "test_faster_" benchmarks/

.github/workflows/compile.yaml

@@ -0,0 +1,83 @@
+name: Compile
+
+on:
+  pull_request:
+    branches:
+      - master
+    paths-ignore:
+      - '.github/workflows/**'
+      - '!.github/workflows/compile.yaml'
+  push:
+    branches:
+      - master
+    paths-ignore:
+      - '.github/workflows/**'
+      - '!.github/workflows/compile.yaml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build-ubuntu:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          # Check out the PR branch
+          ref: ${{ github.head_ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+          cache: pip
+          cache-dependency-path: |
+            setup.py
+            pyproject.toml
+
+      - name: Cache .mypy_cache
+        uses: actions/cache@v4
+        with:
+          path: .mypy_cache
+          key: mypy-cache-${{ runner.os }}-x64-${{ hashFiles('**/*.py', 'pyproject.toml') }}
+
+      - name: Delete existing build files
+        run: rm -rf build
+
+      - name: Install Faster Hexbytes
+        env:
+          MYPYC_STRICT_DUNDER_TYPING: 1
+        run: pip install .
+
+      - name: Normalize C files for diffchecking
+        # This makes it much easier to diffcheck changes in the C files
+        run: |
+          # Insert DIFFCHECK_PLACEHOLDER macro at the top if not present
+          for f in build/*.c; do
+            if ! grep -q 'DIFFCHECK_PLACEHOLDER' "$f"; then
+              sed -i '1i#ifndef DIFFCHECK_PLACEHOLDER\n#define DIFFCHECK_PLACEHOLDER 0\n#endif' "$f"
+            fi
+          done
+          # Replace line number in CPy_AddTraceback with macro
+          sed -i 's/\(CPy_AddTraceback([^,]*, *[^,]*, *\)[0-9]\+\(, *[^)]*)\)/\1DIFFCHECK_PLACEHOLDER\2/g' build/*.c
+          # Replace index in CPyStatics[...] with macro
+          sed -i 's/CPyStatics\[[0-9]\+\]/CPyStatics[DIFFCHECK_PLACEHOLDER]/g' build/*.c
+
+      - name: Check for changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "changes_detected=true" >> $GITHUB_ENV
+          else
+            echo "changes_detected=false" >> $GITHUB_ENV
+          fi
+
+      - name: Commit changes
+        if: env.changes_detected == 'true'
+        run: |
+          git config --local user.name "github-actions[bot]"
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git add .
+          git commit -m "chore: compile C files for source control"
+          git push