Merge pull request #42 from DavidCEllis/use-local-uv

Use user's installation of `uv` if it exists

Author: DavidCEllis

src/ducktools/env/scripts/get_pip.py

@@ -62,17 +62,17 @@ def as_version(self):
 
 # This is mostly kept for testing.
 PREVIOUS_PIP = PipZipapp(
-    version_str="24.2",
-    sha3_256="8dc4860613c47cb2e5e55c7e1ecf4046abe18edca083073d51f1720011bed6ea",
-    source_url="zipapp/pip-24.2.pyz",
-)
-
-LATEST_PIP = PipZipapp(
     version_str="24.3.1",
     sha3_256="6dd95ab685d00abada578f2744f2b235faf5876d3f3468f0756e2b78bce050f1",
     source_url="zipapp/pip-24.3.1.pyz"
 )
 
+LATEST_PIP = PipZipapp(
+    version_str="25.0.1",
+    sha3_256="eff93cf5d562974c1e6fff03c3d48c4b08bf5c5be8ceb315dc8b6ffe21860cb4",
+    source_url="zipapp/pip-25.0.1.pyz"
+)
+
 
 def is_pip_outdated(
     paths: ManagedPaths,
@@ -105,10 +105,13 @@ def download_pip(
     with _laz.urlopen(url) as f:
         data = f.read()
 
+    dl_hash = _laz.hashlib.sha3_256(data).hexdigest()
     # Check hash matches
-    if _laz.hashlib.sha3_256(data).hexdigest() != latest_version.sha3_256:
+    if dl_hash != latest_version.sha3_256:
         raise InvalidPipDownload(
-            "The checksum of the downloaded PIP binary did not match the expected value."
+            "The checksum of the downloaded PIP binary did not match the expected value.\n"
+            f"Expected: {latest_version.sha3_256}\n"
+            f"Received: {dl_hash}"
         )
 
     # Make directory if it does not exist

src/ducktools/env/scripts/get_uv.py

@@ -29,13 +29,86 @@
 from ..platform_paths import ManagedPaths
 
 
-uv_versionspec = ">=0.4.25"
+uv_versionspec = ">=0.6.5"
+uv_versionre = r"^uv (?P<uv_ver>\d+\.\d+\.\d+)"
 
 uv_download = "bin/uv.exe" if sys.platform == "win32" else "bin/uv"
 
 
+def download_uv(paths: ManagedPaths):
+    # Just the code to download UV from PyPI if it is otherwise unavailable
+    pip_install = retrieve_pip(paths=paths)
+
+    log("Downloading UV from PyPi")
+    with paths.build_folder() as build_folder:
+
+        install_folder = os.path.join(build_folder, "uv")
+
+        uv_dl = os.path.join(install_folder, uv_download)
+
+        pip_command = [
+            sys.executable,
+            pip_install,
+            "--disable-pip-version-check",
+            "install",
+            "-q",
+            f"uv{uv_versionspec}",
+            "--only-binary=:all:",
+            "--target",
+            install_folder,
+        ]
+
+        # Download UV with pip - handles getting the correct platform version
+        try:
+            _laz.subprocess.run(
+                pip_command,
+                check=True,
+            )
+        except _laz.subprocess.CalledProcessError as e:
+            log(f"UV download failed: {e}")
+            uv_path = None
+        else:
+            # Copy the executable out of the pip install
+            _laz.shutil.copy(uv_dl, paths.uv_executable)
+            uv_path = paths.uv_executable
+
+            version_command = [uv_path, "-V"]
+            version_output = _laz.subprocess.run(version_command, capture_output=True, text=True)
+            ver_match = _laz.re.match(uv_versionre, version_output.stdout.strip())
+            if ver_match:
+                uv_version = ver_match.group("uv_ver")
+                with open(f"{uv_path}.version", 'w') as ver_file:
+                    ver_file.write(uv_version)
+            else:
+                log(f"Unexpected UV version output {version_output.stdout!r}")
+                uv_path = None
+
+    return uv_path
+
+
+def get_local_uv():
+    uv_path = _laz.shutil.which("uv")
+    if uv_path:
+        try:
+            version_output = _laz.subprocess.run([uv_path, "-V"], capture_output=True, text=True)
+        except (FileNotFoundError, _laz.subprocess.CalledProcessError):
+            return None
+
+        ver_match = _laz.re.match(uv_versionre, version_output.stdout.strip())
+        if ver_match:
+            uv_version = ver_match.group("uv_ver")
+            if uv_version not in _laz.SpecifierSet(uv_versionspec):
+                log(
+                    f"Local uv install version {uv_version!r} "
+                    f"does not satisfy the ducktools.env specifier {uv_versionspec!r}"
+                )
+                return None
+
+    return uv_path
+
+
 def retrieve_uv(paths: ManagedPaths, reinstall: bool = False) -> str | None:
-    uv_path = None
+    uv_path = get_local_uv()
 
     if os.path.exists(paths.uv_executable):
         uv_path = paths.uv_executable
@@ -48,46 +121,7 @@ def retrieve_uv(paths: ManagedPaths, reinstall: bool = False) -> str | None:
             uv_path = None
 
     if uv_path is None:
-        pip_install = retrieve_pip(paths=paths)
-
-        log("Downloading UV from PyPi")
-        with paths.build_folder() as build_folder:
-
-            install_folder = os.path.join(build_folder, "uv")
-
-            uv_dl = os.path.join(install_folder, uv_download)
-
-            pip_command = [
-                sys.executable,
-                pip_install,
-                "--disable-pip-version-check",
-                "install",
-                "-q",
-                f"uv{uv_versionspec}",
-                "--only-binary=:all:",
-                "--target",
-                install_folder,
-            ]
-
-            # Download UV with pip - handles getting the correct platform version
-            try:
-                _laz.subprocess.run(
-                    pip_command,
-                    check=True,
-                )
-            except _laz.subprocess.CalledProcessError as e:
-                log(f"UV download failed: {e}")
-                uv_path = None
-            else:
-                # Copy the executable out of the pip install
-                _laz.shutil.copy(uv_dl, paths.uv_executable)
-                uv_path = paths.uv_executable
-
-                version_command = [uv_path, "-V"]
-                version_output = _laz.subprocess.run(version_command, capture_output=True, text=True)
-                uv_version = version_output.stdout.split()[1]
-                with open(f"{uv_path}.version", 'w') as ver_file:
-                    ver_file.write(uv_version)
+        uv_path = download_uv(paths=paths)
 
     return uv_path
 

tests/test_get_uv.py

@@ -26,17 +26,40 @@
 import unittest.mock as mock
 from pathlib import Path
 
+import pytest
+
 import ducktools.env.scripts.get_uv as get_uv
 from ducktools.env.platform_paths import ManagedPaths
 
 UV_PYTHON_LIST_OUTPUT = Path(__file__).parent / "data" / "uv_python_versions_list.txt"
 
 
+@pytest.fixture(scope="function")
+def block_local_uv():
+    with mock.patch("shutil.which") as which_mock:
+        which_mock.return_value = None
+        yield
+
+
 class TestRetrieveUV:
     paths = ManagedPaths("ducktools_testing")
 
+    def test_local_uv(self):
+        fake_uv_path = "/home/uname/.cargo/bin/uv"
+        with (
+            mock.patch("shutil.which") as which_mock,
+            mock.patch("subprocess.run") as run_mock,
+        ):
+            which_mock.return_value = fake_uv_path
+
+            uv_cmd_mock = mock.MagicMock()
+            uv_cmd_mock.stdout = "uv 0.6.5"
+            run_mock.return_value = uv_cmd_mock
+
+            assert get_uv.get_local_uv() == fake_uv_path
+            assert get_uv.retrieve_uv(self.paths, reinstall=False) == fake_uv_path
 
-    def test_uv_install(self):
+    def test_uv_install(self, block_local_uv):
         with (
             mock.patch("os.path.exists") as exists_mock,
             mock.patch("os.remove") as remove_mock,
@@ -52,7 +75,7 @@ def test_uv_install(self):
             open_mock.return_value.__enter__.return_value = writer_mock
 
             uv_cmd_mock = mock.MagicMock()
-            uv_cmd_mock.stdout = "uv 0.4.15 (0d81bfbc6 2024-09-21)"
+            uv_cmd_mock.stdout = "uv 0.6.5"
             run_mock.return_value = uv_cmd_mock
 
             build_path = "build/path"
@@ -94,14 +117,14 @@ def test_uv_install(self):
 
             # One open call and write to store the UV version
             open_mock.assert_called_with(f"{self.paths.uv_executable}.version", "w")
-            writer_mock.write.assert_called_with("0.4.15")
+            writer_mock.write.assert_called_with("0.6.5")
 
             # Remove should not have been called
             remove_mock.assert_not_called()
 
             assert uv_path == self.paths.uv_executable
 
-    def test_uv_reinstall(self):
+    def test_uv_reinstall(self, block_local_uv):
         with (
             mock.patch("os.path.exists") as exists_mock,
             mock.patch("os.remove") as remove_mock,
@@ -117,7 +140,7 @@ def test_uv_reinstall(self):
             open_mock.return_value.__enter__.return_value = writer_mock
 
             uv_cmd_mock = mock.MagicMock()
-            uv_cmd_mock.stdout = "uv 0.4.15 (0d81bfbc6 2024-09-21)"
+            uv_cmd_mock.stdout = "uv 0.6.5"
             run_mock.return_value = uv_cmd_mock
 
             build_path = "build/path"
@@ -159,7 +182,7 @@ def test_uv_reinstall(self):
 
             # One open call and write to store the UV version
             open_mock.assert_called_with(f"{self.paths.uv_executable}.version", "w")
-            writer_mock.write.assert_called_with("0.4.15")
+            writer_mock.write.assert_called_with("0.6.5")
 
             # Remove should have been called twice
             remove_mock.assert_has_calls(
@@ -171,7 +194,7 @@ def test_uv_reinstall(self):
 
             assert uv_path == self.paths.uv_executable
 
-    def test_uv_install_failure(self):
+    def test_uv_install_failure(self, block_local_uv):
         with (
             mock.patch("os.path.exists") as exists_mock,
             mock.patch("os.remove") as remove_mock,
@@ -218,14 +241,14 @@ def test_uv_install_failure(self):
             open_mock.assert_not_called()
             remove_mock.assert_not_called()
 
-    def test_uv_exists_keep(self):
+    def test_uv_exists_keep(self, block_local_uv):
         with (
             mock.patch("os.path.exists") as exists_mock,
             mock.patch("os.remove") as remove_mock,
             mock.patch("subprocess.run") as run_mock,
             mock.patch.object(ManagedPaths, "get_uv_version") as uv_ver_mock
         ):
-            uv_ver_mock.return_value = "0.4.25"
+            uv_ver_mock.return_value = "0.6.5"
             exists_mock.return_value = True
             uv_path = get_uv.retrieve_uv(paths=self.paths, reinstall=False)