Merge pull request #813 from pyathena-dev/feat/812-benchmark-workspace

Manage the benchmark project as a uv workspace member

Author: laughingman7743

.github/workflows/benchmarks.yaml

@@ -13,6 +13,7 @@ on:
       - 'benchmarks/**'
       - 'pyathena/**'
       - 'pyproject.toml'
+      - 'uv.lock'
       - 'justfile'
       - '.github/workflows/benchmarks.yaml'
 
@@ -24,6 +25,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       AWS_EC2_METADATA_DISABLED: 'true'
+      UV_PROJECT_ENVIRONMENT: ${{ github.workspace }}/benchmarks/.venv
     steps:
       - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
@@ -36,7 +38,7 @@ jobs:
       - uses: taiki-e/install-action@7a79fe8c3a13344501c80d99cae481c1c9085912 # v2.81.10
         with:
           tool: just
-      - run: uv sync --project benchmarks --locked
+      - run: uv sync --package pyathena-benchmarks --locked
       - run: just benchmark test
       - name: Build only the main distribution
         run: uv build -v

benchmarks/README.md

@@ -34,30 +34,33 @@ Neither workload converts every library's output into a common Python object rep
 
 ## Dependencies and local checks
 
-The benchmark is an independent, non-packaged uv project for Python 3.12.
-Its lockfile and virtual environment are separate from the parent project; PyAthena is an editable path dependency on the parent checkout.
+The benchmark is a non-packaged member of the repository's uv workspace and runs on Python 3.12.
+It shares the root `uv.lock` with PyAthena, which it uses from the workspace checkout.
+Locally and in CI, its virtual environment is `benchmarks/.venv`, separate from the root `.venv`.
+On the EC2 instance, the dedicated checkout's root `/opt/pyathena/.venv` holds the benchmark environment.
 The root `uv build -v` still builds only PyAthena, including a wheel built from its sdist.
-Benchmark dependencies do not become PyAthena runtime dependencies.
+Benchmark dependencies do not become PyAthena runtime dependencies, and `uv sync --group dev` at the root does not install them.
 
 From the repository root:
 
 ```bash
-uv sync --project benchmarks --locked
 just benchmark lint
 just benchmark test
 ```
 
+The recipes select `benchmarks/.venv` and Python 3.12, and sync that environment from the locked workspace.
 The tests use local data, fake AWS clients, and child processes.
 They do not execute Athena queries or create AWS resources.
 `just benchmark format` formats the benchmark separately from the parent project.
-After changing dependencies, extras, or dependency groups in either `pyproject.toml`, run `just benchmark lock` and commit `benchmarks/uv.lock`.
-The benchmark lock includes metadata for its editable parent dependency; CI intentionally rejects a stale lock.
+After changing dependencies, extras, or dependency groups in either `pyproject.toml`, run `uv lock` at the repository root and commit `uv.lock`.
 
 Commands below run from `benchmarks/`.
+Set the environment variables first; without them, uv uses the root `.venv`.
 `plan` and `report` do not contact AWS or require `.env`.
 
 ```bash
 cd benchmarks
+export UV_PROJECT_ENVIRONMENT="$PWD/.venv" UV_PYTHON=3.12
 uv run --locked python -m pyathena_bench plan --suite single --scale small
 ```
 
@@ -95,8 +98,8 @@ The instance can write only to its scratch bucket and database, and can query th
 The supplied template assumes ordinary IAM access and SSE-S3 source objects; Lake Formation restrictions or a customer-managed KMS key require corresponding grants before execution.
 
 The deployment identity needs permission to create these resources and pass the instance role.
-Use an immutable, remotely accessible commit that contains this directory and its lockfile.
-Bootstrap checks out that commit, installs pinned uv and Python versions, and runs `uv sync --locked --no-dev`.
+Use an immutable, remotely accessible commit that contains this directory and the root `uv.lock`.
+Bootstrap checks out that commit, installs pinned uv and Python versions, and runs `uv sync --locked --no-dev` for the benchmark into `/opt/pyathena/.venv`.
 It signals setup completion to CloudFormation but does not prepare data or start measurements.
 The EC2 commands use `--no-sync` to reuse this verified environment; they do not revalidate the lockfile on every invocation.
 

benchmarks/pyathena_bench/cases.py

@@ -47,7 +47,9 @@ def matrix(settings: Settings, suite: str, shape: str) -> list[Case]:
             cases.extend(Case(family, api, arraysize=a, shape=shape) for a in arraysizes)
             if family in {"pandas", "arrow", "polars"}:
                 for transport in ("csv", "unload"):
-                    chunks = [None] if family == "arrow" else [None, *settings.chunksizes]
+                    chunks: list[int | None] = (
+                        [None] if family == "arrow" else [None, *settings.chunksizes]
+                    )
                     for chunk in chunks:
                         reason = None
                         if family == "pandas" and transport == "unload" and chunk:

benchmarks/pyathena_bench/runner.py

@@ -269,7 +269,7 @@ def environment(settings: Settings) -> dict[str, Any]:
         "cpu_count": psutil.cpu_count(),
         "memory_bytes": psutil.virtual_memory().total,
         "dependencies": {d.metadata["Name"]: d.version for d in importlib.metadata.distributions()},
-        "lock_sha256": hashlib.sha256((root / "benchmarks/uv.lock").read_bytes()).hexdigest(),
+        "lock_sha256": hashlib.sha256((root / "uv.lock").read_bytes()).hexdigest(),
         "settings": asdict(settings),
     }
 

benchmarks/pyproject.toml

@@ -9,23 +9,24 @@
 name = "pyathena-benchmarks"
 version = "0.1.0"
 description = "Reproducible Athena cursor measurements"
-requires-python = ">=3.12,<3.13"
+# The workspace lock covers the root's Python range; benchmark runs use Python 3.12.
+requires-python = ">=3.10"
 classifiers = ["Private :: Do Not Upload"]
 dependencies = [
     "PyAthena[pandas,arrow,polars]",
     "awswrangler>=3.17,<4",
-    "polars>=1.37",
+    "polars",
     "psutil>=7,<8",
 ]
 
 [tool.uv]
 package = false
 
 [tool.uv.sources]
-pyathena = { path = "..", editable = true }
+pyathena = { workspace = true }
 
 [dependency-groups]
-dev = ["pytest>=8", "pytest-asyncio>=1", "mypy>=1.19", "types-psutil", "cfn-lint>=1"]
+dev = ["pytest>=8", "pytest-asyncio>=1", "mypy", "types-psutil", "cfn-lint>=1"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]