Install non-editable versions in CI (#17121)

Co-authored-by: zzstoatzz <thrast36@gmail.com>
PrefectHQ · Feb 14, 2025 · cb5ea1f · cb5ea1f
1 parent dd73214
commit cb5ea1f
Show file tree

Hide file tree

Showing 12 changed files with 183 additions and 2,367 deletions.
diff --git a/.github/workflows/benchmarks.yaml b/.github/workflows/benchmarks.yaml
@@ -62,7 +62,7 @@ jobs:
 
       - name: Start server
         run: |
-          PREFECT_HOME=$(pwd) prefect server start&
+          PREFECT_HOME=$(pwd) uv run prefect server start&
           PREFECT_API_URL="http://127.0.0.1:4200/api" ./scripts/wait-for-server.py
 
           # TODO: Replace `wait-for-server` with dedicated command
@@ -89,7 +89,7 @@ jobs:
           sanitized_uniquename="${uniquename//[^a-zA-Z0-9_\-]/_}"
 
           PREFECT_API_URL="http://127.0.0.1:4200/api" \
-          python -m benches \
+          uv run python -m benches \
           --ignore=benches/bench_import.py \
           --timeout=180 \
           --benchmark-save="${sanitized_uniquename}" \

diff --git a/.github/workflows/codspeed-benchmarks.yaml b/.github/workflows/codspeed-benchmarks.yaml
@@ -48,7 +48,7 @@ jobs:
 
       - name: Start server
         run: |
-          PREFECT_HOME=$(pwd) prefect server start&
+          PREFECT_HOME=$(pwd) uv run prefect server start&
           PREFECT_API_URL="http://127.0.0.1:4200/api" ./scripts/wait-for-server.py
 
           # TODO: Replace `wait-for-server` with dedicated command

diff --git a/.github/workflows/python-tests.yaml b/.github/workflows/python-tests.yaml
@@ -112,14 +112,26 @@ jobs:
           persist-credentials: false
           fetch-depth: 0
 
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v5
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        id: setup_python
         with:
           python-version: ${{ matrix.python-version }}
-          enable-cache: true
 
-      - name: Install the project
-        run: uv sync --compile-bytecode
+      - name: UV Cache
+        # Manually cache the uv cache directory
+        # until setup-python supports it:
+        # https://github.com/actions/setup-python/issues/822
+        uses: actions/cache@v4
+        id: cache-uv
+        with:
+          path: ~/.cache/uv
+          key: uvcache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ hashFiles('pyproject.toml') }}
+
+      - name: Install packages
+        run: |
+          pip install --upgrade uv
+          uv export --no-group benchmark | uv pip install --upgrade --system --requirements=-
 
       - name: Start database container
         if: ${{ startsWith(matrix.database, 'postgres') }}
@@ -158,7 +170,7 @@ jobs:
 
       - name: Run tests
         run: |
-          uv run pytest ${{ matrix.test-type.modules }} \
+          pytest ${{ matrix.test-type.modules }} \
           --numprocesses auto \
           --maxprocesses 6 \
           --dist worksteal \
@@ -206,11 +218,21 @@ jobs:
         with:
           driver-opts: image=moby/buildkit:v0.12.5
 
-      - name: Install uv and set the python version
-        uses: astral-sh/setup-uv@v5
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        id: setup_python
         with:
           python-version: ${{ matrix.python-version }}
-          enable-cache: true
+
+      - name: UV Cache
+        # Manually cache the uv cache directory
+        # until setup-python supports it:
+        # https://github.com/actions/setup-python/issues/822
+        uses: actions/cache@v4
+        id: cache-uv
+        with:
+          path: ~/.cache/uv
+          key: uvcache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ hashFiles('requirements-client.txt', 'requirements.txt', 'requirements-dev.txt') }}
 
       - name: Get image tag
         id: get_image_tag
@@ -250,8 +272,10 @@ jobs:
           docker load --input /tmp/image.tar
           docker run --rm prefecthq/prefect-dev:${{ steps.get_image_tag.outputs.image_tag }} prefect version
 
-      - name: Install the project
-        run: uv sync --compile-bytecode
+      - name: Install packages
+        run: |
+          python -m pip install -U uv
+          uv pip install --upgrade --system -e .[dev]
 
       - name: Start database container
         if: ${{ startsWith(matrix.database, 'postgres') }}
@@ -298,14 +322,31 @@ jobs:
 
       - name: Run tests
         run: |
-          uv run pytest tests --ignore=tests/typesafety \
+          echo "Using COVERAGE_FILE=$COVERAGE_FILE"
+          pytest tests --ignore=tests/typesafety \
           --numprocesses auto \
           --maxprocesses 6 \
           --dist worksteal \
           --disable-docker-image-builds \
           --only-service docker \
           --durations 26 \
 
+      - name: Create and Upload failure flag
+        if: ${{ failure() }}
+        id: create_failure_flag
+        run: |
+          sanitized_name="${{ matrix.python-version }}-${{ matrix.database }}"
+          sanitized_name="${sanitized_name//:/-}"
+          echo "Failure in $sanitized_name" > "${sanitized_name}-failure.txt"
+          echo "artifact_name=${sanitized_name}-failure" >> $GITHUB_OUTPUT
+
+      - name: Upload failure flag
+        if: ${{ failure() }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.create_failure_flag.outputs.artifact_name }}
+          path: "${{ steps.create_failure_flag.outputs.artifact_name }}.txt"
+
       - name: Check database container
         # Only applicable for Postgres, but we want this to run even when tests fail
         if: always()
@@ -325,15 +366,30 @@ jobs:
         persist-credentials: false
         fetch-depth: 0
 
-    - name: Install uv and set the python version
+    - name: Set up uv
       uses: astral-sh/setup-uv@v5
+
+    - name: Set up Python 3.12
+      uses: actions/setup-python@v5
+      id: setup_python
+      with:
+        python-version: 3.12
+
+    - name: UV Cache
+      # Manually cache the uv cache directory
+      # until setup-python supports it:
+      # https://github.com/actions/setup-python/issues/822
+      uses: actions/cache@v4
+      id: cache-uv
       with:
-        python-version: "3.12"
-        enable-cache: true
+        path: ~/.cache/uv
+        key: uvcache-${{ runner.os }}-${{ steps.setup_python.outputs.python-version }}-${{ hashFiles('requirements-client.txt', 'requirements.txt', 'requirements-dev.txt') }}
 
-    - name: Install the project
-      run: uv sync --compile-bytecode
+    - name: Install packages
+      run: |
+        uv export --no-group benchmark | uv pip install --upgrade --system --requirements=-
 
     - name: Run tests
       run: |
-         uv run pytest tests/typesafety --disable-docker-image-builds
+        pytest tests/typesafety \
+        --disable-docker-image-builds
diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml
@@ -41,7 +41,7 @@ jobs:
           enable-cache: true
 
       - name: Install the project
-        run: uv sync --compile-bytecode
+        run: uv sync --compile-bytecode --no-editable
 
       - name: Setup NodeJS
         uses: actions/setup-node@v4
@@ -72,7 +72,7 @@ jobs:
           enable-cache: true
 
       - name: Install the project
-        run:  uv sync --compile-bytecode
+        run: uv sync --compile-bytecode --no-editable
 
       - name: Run type completeness check
         run: >-

diff --git a/.gitignore b/.gitignore
@@ -7,9 +7,12 @@ __pycache__/
 build/
 dist/
 sdist/
+# We likely ought to eventually include uv.lock
 uv.lock
 
-# We likely ought to eventually include uv.lock
+# Build metadata
+src/prefect/_build_info.py
+src/prefect/_version.py
 
 # Test artifacts
 .benchmarks/

diff --git a/old-sqlite.Dockerfile b/old-sqlite.Dockerfile
@@ -22,6 +22,7 @@ RUN uv build --sdist --wheel --out-dir dist && \
 
 # Final image
 FROM python:3.9-slim
+COPY --from=python-builder /bin/uv /bin/uv
 
 # Accept SQLite version as build argument
 ARG SQLITE_VERSION="3310100"

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [build-system]
-requires = ["setuptools>=65.6.3"]
-build-backend = "setuptools.build_meta"
+requires = ["hatchling", "versioningit"]
+build-backend = "hatchling.build"
 
 [project]
 name = "prefect"
@@ -192,11 +192,33 @@ dev = [
     "opentelemetry-instrumentation>=0.48b0,<1.0.0",
     "opentelemetry-instrumentation-logging>=0.48b0,<1.0.0",
     "opentelemetry-test-utils>=0.48b0,<1.0.0",
-    "versioneer>=0.20.0",
 ]
 
-benchmark = ["pytest-benchmark>=5.1.0", "pytest-codspeed>=2.2.1"]
+benchmark = [
+    "pytest-benchmark>=5.1.0",
+    "pytest-codspeed>=2.2.1",
+]
+
+[tool.hatch.version]
+source = "versioningit"
+
+[tool.versioningit.vcs]
+match = ["[0-9]*.[0-9]*.[0-9]*", "[0-9]*.[0-9]*.[0-9]*.dev[0-9]*"]
+
+[tool.versioningit.write]
+method = { module = "write_build_info", value = "write_build_info", module-dir = "tools" }
+path = "src/prefect/_build_info.py"
+
+[tool.versioningit.format]
+distance = "{base_version}+{distance}.{vcs}{rev}"
+dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+distance-dirty = "{base_version}+{distance}.{vcs}{rev}.dirty"
+
+[tool.hatch.build]
+artifacts = ["src/prefect/_build_info.py"]
 
+[tool.hatch.build.targets.sdist]
+include = ["/src/prefect", "/README.md", "/LICENSE", "/pyproject.toml"]
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]

diff --git a/src/prefect/__init__.py b/src/prefect/__init__.py
@@ -3,7 +3,7 @@
 # Setup version and path constants
 
 import sys
-from . import _version
+from . import _build_info
 import importlib
 import pathlib
 from typing import TYPE_CHECKING, Any, Optional, TypedDict, cast
@@ -24,11 +24,11 @@
         unmapped,
         serve,
         aserve,
-        deploy,
         pause_flow_run,
         resume_flow_run,
         suspend_flow_run,
     )
+    from prefect.deployments.runner import deploy
 
     __spec__: ModuleSpec
 
@@ -41,8 +41,17 @@ class VersionInfo(TypedDict("_FullRevisionId", {"full-revisionid": str})):
         date: Optional[str]
 
 
-__version_info__: "VersionInfo" = cast("VersionInfo", _version.get_versions())
-__version__ = __version_info__["version"]
+__version__ = _build_info.__version__
+__version_info__: "VersionInfo" = cast(
+    "VersionInfo",
+    {
+        "version": __version__,
+        "date": _build_info.__build_date__,
+        "full-revisionid": _build_info.__git_commit__,
+        "error": None,
+        "dirty": _build_info.__dirty__,
+    },
+)
 
 # The absolute path to this module
 __module_path__: pathlib.Path = pathlib.Path(__file__).parent
@@ -56,12 +65,12 @@ class VersionInfo(TypedDict("_FullRevisionId", {"full-revisionid": str})):
 # The absolute path to the built UI within the Python module
 __ui_static_path__: pathlib.Path = __module_path__ / "server" / "ui"
 
-del _version, pathlib
+del _build_info, pathlib
 
 _public_api: dict[str, tuple[Optional[str], str]] = {
     "allow_failure": (__spec__.parent, ".main"),
     "aserve": (__spec__.parent, ".main"),
-    "deploy": (__spec__.parent, ".main"),
+    "deploy": (__spec__.parent, ".deployments.runner"),
     "flow": (__spec__.parent, ".main"),
     "Flow": (__spec__.parent, ".main"),
     "get_client": (__spec__.parent, ".main"),

diff --git a/src/prefect/main.py b/src/prefect/main.py
@@ -1,6 +1,5 @@
 # Import user-facing API
 from typing import Any
-from prefect.deployments import deploy
 from prefect.states import State
 from prefect.logging import get_run_logger
 from prefect.flows import FlowDecorator, flow, Flow, serve, aserve
@@ -77,7 +76,6 @@
     "unmapped",
     "serve",
     "aserve",
-    "deploy",
     "pause_flow_run",
     "resume_flow_run",
     "suspend_flow_run",