Merge remote-tracking branch 'origin/move-to-uv' into move-to-uv

Author: coretl

.devcontainer/devcontainer.json

@@ -8,13 +8,28 @@
     "remoteEnv": {
         // Allow X11 apps to run inside the container
         "DISPLAY": "${localEnv:DISPLAY}",
-        "PATH": "${containerEnv:PATH}:/workspaces/${localWorkspaceFolderBasename}/.venv/bin"
+        // We put venv on a different volume to cache so have to copy
+        "UV_LINK_MODE": "copy",
+        // Do the equivalent of "activate" the venv so we don't have to "uv run" everything
+        "PATH": "/workspaces/${localWorkspaceFolderBasename}/.venv/bin:${containerEnv:PATH}"
     },
     "customizations": {
         "vscode": {
             // Set *default* container specific settings.json values on container create.
             "settings": {
-                "python.defaultInterpreterPath": "/venv/bin/python"
+                "python.defaultInterpreterPath": "/workspaces/${localWorkspaceFolderBasename}/.venv/bin/python",
+                "python.terminal.activateEnvInCurrentTerminal": false,
+                "python.terminal.activateEnvironment": false,
+                "python.testing.unittestEnabled": false,
+                "python.testing.pytestEnabled": true,
+                "editor.formatOnSave": true,
+                "editor.codeActionsOnSave": {
+                    "source.organizeImports": "explicit"
+                },
+                "remote.autoForwardPorts": false,
+                "[python]": {
+                    "editor.defaultFormatter": "charliermarsh.ruff"
+                }
             },
             // Add the IDs of extensions you want installed when the container is created.
             "extensions": [
@@ -28,26 +43,35 @@
             ]
         }
     },
-    "features": {
-        // add in eternal history and other bash features
-        "ghcr.io/diamondlightsource/devcontainer-features/bash-config:1": {}
-    },
-    // Create the config folder for the bash-config feature
-    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/bash-config",
+    // Create the config folder for the bash-config feature and uv cache
+    "initializeCommand": "mkdir -p ${localEnv:HOME}/.config/terminal-config ${localEnv:HOME}/.cache/uv",
     "runArgs": [
         // Allow the container to access the host X11 display and EPICS CA
         "--net=host",
         // Make sure SELinux does not disable with access to host filesystems like tmp
         "--security-opt=label=disable"
     ],
     "mounts": [
+        // Mount in the user terminal config folder so it can be edited
+        {
+            "source": "${localEnv:HOME}/.config/terminal-config",
+            "target": "/user-terminal-config",
+            "type": "bind"
+        },
+        // Keep a persistent cross container cache for uv
+        {
+            "source": "${localEnv:HOME}/.cache/uv",
+            "target": "/root/.cache/uv",
+            "type": "bind"
+        },
+        // Use a volume mount for the uv venv so it is local to the container
         {
             "target": "/workspaces/${localWorkspaceFolderBasename}/.venv",
             "type": "volume"
         }
     ],
     // Mount the parent as /workspaces so we can pip install peers as editable
     "workspaceMount": "source=${localWorkspaceFolder}/..,target=/workspaces,type=bind",
-    // After the container is created, install the uv env
-    "postCreateCommand": "uv venv --seed && uv sync --locked && pre-commit install"
+    // After the container is created, install the python project in editable form
+    "postCreateCommand": "uv sync && uv run pre-commit install"
 }

.github/actions/install_requirements/action.yml

@@ -1,12 +1,12 @@
 name: Install requirements
-description: Install a version of python then call pip install and report what was installed
+description: Install uv, use it to install dependencies and report what was installed
 inputs:
   python-version:
     description: Python version to install, default is from Dockerfile
     default: "dev"
-  pip-install:
-    description: Parameters to pass to uv pip install
-    default: "$([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e .[dev]"
+  uv-sync:
+    description: Parameters to pass to uv sync
+    default: "--locked"
 
 runs:
   using: composite
@@ -22,24 +22,17 @@ runs:
       shell: bash
 
     - name: Install uv and set the python version
-      uses: astral-sh/setup-uv@v5
+      uses: astral-sh/setup-uv@v6
       with:
         python-version: ${{ env.PYTHON_VERSION }}
         enable-cache: true
         cache-dependency-glob: "uv.lock"
+        activate-environment: true
 
     - name: Install packages
-      run: uv pip install ${{ inputs.pip-install }}
+      run: uv sync ${{ inputs.uv-sync }}
       shell: bash
 
     - name: Report what was installed
-      run: uv pip list
-      shell: bash
-
-    - name: Add venv path to Github environment
-      run: echo "VENV_PATH=.venv" >> $GITHUB_ENV
-      shell: bash
-
-    - name: Add venv path to Github Path
-      run: echo "${{ env.VENV_PATH }}/bin:$PATH" >> $GITHUB_PATH
+      run: uv pip freeze
       shell: bash

.github/workflows/_dist.yml

@@ -17,14 +17,22 @@ jobs:
           export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) &&
           pipx run build
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Build sdist and wheel
+        run: >
+          export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) &&
+          uvx --from build pyproject-build
+
       - name: Upload sdist and wheel as artifacts
         uses: actions/upload-artifact@v4
         with:
           name: dist
           path: dist
 
       - name: Check for packaging errors
-        run: pipx run twine check --strict dist/*
+        run: uvx twine check --strict dist/*
 
       - name: Install produced wheel
         run: python -m pip install dist/*.whl

Dockerfile

@@ -1,11 +1,3 @@
-# The devcontainer should use the developer target and run as root with podman
-# or docker with user namespaces.
-ARG PYTHON_VERSION=3.11
-FROM python:${PYTHON_VERSION} AS developer
-
-# Use this version of uv
-ARG UV_VERSION=0.7.4
-
-# Install uv using the official image
-# See https://docs.astral.sh/uv/guides/integration/docker/#installing-uv
-COPY --from=ghcr.io/astral-sh/uv:${UV_VERSION} /uv /uvx /bin/
+# The developer stage is used as a devcontainer including dev versions
+# of the build dependencies
+FROM ghcr.io/diamondlightsource/ubuntu-devcontainer:noble AS developer

pyproject.toml

@@ -18,7 +18,7 @@ dev = [
     "sphinx-autobuild",
     "sphinx-copybutton",
     "sphinx-design",
-    "tox-uv",
+    "tox-direct",
     "twine>=6.1.0",
 ]
 

template/Dockerfile.jinja

@@ -32,30 +32,22 @@ COPY . /workspaces/{{ repo_name }}
 WORKDIR /workspaces/{{ repo_name }}
 RUN chmod o+wrX . && touch dev-requirements.txt && pip install -c dev-requirements.txt .
 
-{% if docker_debug %}
-FROM build AS debug
-
-{% if git_platform=="github.com" %}
-# Set origin to use ssh
-RUN git remote set-url origin git@github.com:{{github_org}}/{{repo_name}}.git
-{% endif %}
-
-# For this pod to understand finding user information from LDAP
-RUN apt update
-RUN DEBIAN_FRONTEND=noninteractive apt install libnss-ldapd -y
-RUN sed -i 's/files/ldap files/g' /etc/nsswitch.conf
+# Install the project's dependencies using the lockfile and settings
+RUN --mount=type=cache,target=/root/.cache/uv \
+    --mount=type=bind,source=uv.lock,target=uv.lock \
+    --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
+    uv sync --locked --no-install-project --no-dev
 
-# Make editable and debuggable
-RUN pip install debugpy
-RUN pip install -e .
+# Then, add the rest of the project source code and install it
+# Installing separately from its dependencies allows optimal layer caching
+COPY . /assets/
+RUN --mount=type=cache,target=/root/.cache/uv \
+    uv sync --locked --no-dev
 
-# Alternate entrypoint to allow devcontainer to attach
-ENTRYPOINT [ "/bin/bash", "-c", "--" ]
-CMD [ "while true; do sleep 30; done;" ]
+# The runtime stage installs runtime deps then copies in built assets
+# This time we remove the apt lists to save disk space
+FROM ubuntu:noble as runtime
 
-{% endif %}
-# The runtime stage copies the built venv into a slim runtime container
-FROM python:${PYTHON_VERSION}-slim AS runtime
 # Add apt-get system dependecies for runtime here if needed
 
 # We need to keep the venv at the same absolute path as in the build stage

template/pyproject.toml.jinja

@@ -37,6 +37,7 @@ dev = [
     {% endif %}"tox-direct",
     "twine",
     "types-mock",
+    "uv~=0.7.0",
 ]
 
 [project.scripts]
@@ -49,9 +50,6 @@ GitHub = "{{ repo_url }}"
 email = "{{ author_email }}"
 name = "{{ author_name }}"
 
-[tool.uv]
-default-groups = []
-
 [tool.setuptools_scm]
 version_file = "src/{{ package_name }}/_version.py"
 {% if type_checker=="pyright" %}

tests/test_example.py

@@ -38,11 +38,16 @@ def run_pipe(cmd: str, cwd=None):
 
 def make_venv(project_path: Path) -> callable:
     venv_path = project_path / ".venv"
-    run_pipe(f"uv venv {venv_path}")
     run = functools.partial(run_pipe, cwd=str(project_path))
-    # install to this env (hence the -p)
-    run(f"uv pip install -e .[dev] -p {venv_path}/bin/python")
-    # run("ls -la .venv/bin >&2")
+    run("uv sync")  # Create a lockfile and install packages
+
+    for exe_path in [
+        venv_path / "bin" / "tox",
+        venv_path / "bin" / "python",
+        venv_path / "bin" / "uv",
+    ]:
+        assert exe_path.exists(), f"UV created a venv but did not install {exe_path}"
+
     return run
 
 
@@ -60,8 +65,8 @@ def test_template_defaults(tmp_path: Path):
         # Only run linkcheck if not on a tag, as the CI might not have pushed
         # the docs for this tag yet, so we will fail
         run(".venv/bin/tox -p -e docs -- -b linkcheck")
-    run(".venv/bin/uv pip install build twine")
-    run(".venv/bin/python -m build")
+    run(".venv/bin/uv pip install twine")
+    run(".venv/bin/uv build")
     run(".venv/bin/twine check --strict dist/*")