add uv backend (#172)

Co-authored-by: Grzegorz Bokota <[email protected]>
Co-authored-by: Lorenzo Gaifas <[email protected]>

Author: 3 people

pyproject.toml

@@ -65,8 +65,12 @@ dev = [
   "PyQt6",
   "pre-commit",
 ]
+uv = [
+  "uv",
+]
 
 testing = [
+  "napari-plugin-manager[uv]",
   "coverage",
   "flaky",
   "pytest",

src/napari_plugin_manager/_tests/test_installer_process.py

@@ -19,6 +19,7 @@
     NapariCondaInstallerTool,
     NapariInstallerQueue,
     NapariPipInstallerTool,
+    NapariUvInstallerTool,
 )
 
 if TYPE_CHECKING:
@@ -60,18 +61,38 @@ def environment(self, env=None):
         return QProcessEnvironment.systemEnvironment()
 
 
+@pytest.fixture
+def patch_tool_executable(request):
+    mp = request.getfixturevalue('monkeypatch')
+    venv = request.getfixturevalue('tmp_virtualenv')
+    tool = request.getfixturevalue('tool')
+    mp.setattr(
+        tool,
+        'executable'
+        if tool == NapariPipInstallerTool
+        else '_python_executable',
+        lambda *a: venv.creator.exe,
+    )
+
+
+@pytest.mark.parametrize(
+    'tool', [NapariPipInstallerTool, NapariUvInstallerTool]
+)
 def test_pip_installer_tasks(
-    qtbot, tmp_virtualenv: 'Session', monkeypatch, caplog
+    qtbot,
+    tool,
+    tmp_virtualenv: 'Session',
+    monkeypatch,
+    caplog,
+    patch_tool_executable,
 ):
     caplog.set_level(logging.DEBUG, logger=bqpi.__name__)
-    installer = NapariInstallerQueue()
     monkeypatch.setattr(
-        NapariPipInstallerTool,
-        'executable',
-        lambda *a: tmp_virtualenv.creator.exe,
+        NapariInstallerQueue, 'PYPI_INSTALLER_TOOL_CLASS', tool
     )
+    installer = NapariInstallerQueue()
     monkeypatch.setattr(
-        NapariPipInstallerTool,
+        tool,
         'origins',
         ('https://pypi.org/simple',),
     )
@@ -140,13 +161,16 @@ def test_pip_installer_tasks(
         )
 
 
-def test_pip_installer_invalid_action(tmp_virtualenv: 'Session', monkeypatch):
-    installer = NapariInstallerQueue()
+@pytest.mark.parametrize(
+    'tool', [NapariPipInstallerTool, NapariUvInstallerTool]
+)
+def test_pip_installer_invalid_action(
+    tool, tmp_virtualenv: 'Session', monkeypatch, patch_tool_executable
+):
     monkeypatch.setattr(
-        NapariPipInstallerTool,
-        'executable',
-        lambda *a: tmp_virtualenv.creator.exe,
+        NapariInstallerQueue, 'PYPI_INSTALLER_TOOL_CLASS', tool
     )
+    installer = NapariInstallerQueue()
     invalid_action = 'Invalid Action'
     item = installer._build_queue_item(
         tool=InstallerTools.PYPI,
@@ -162,13 +186,16 @@ def test_pip_installer_invalid_action(tmp_virtualenv: 'Session', monkeypatch):
         installer._queue_item(item)
 
 
-def test_installer_failures(qtbot, tmp_virtualenv: 'Session', monkeypatch):
-    installer = NapariInstallerQueue()
+@pytest.mark.parametrize(
+    'tool', [NapariPipInstallerTool, NapariUvInstallerTool]
+)
+def test_installer_failures(
+    tool, qtbot, tmp_virtualenv: 'Session', monkeypatch, patch_tool_executable
+):
     monkeypatch.setattr(
-        NapariPipInstallerTool,
-        'executable',
-        lambda *a: tmp_virtualenv.creator.exe,
+        NapariInstallerQueue, 'PYPI_INSTALLER_TOOL_CLASS', tool
     )
+    installer = NapariInstallerQueue()
 
     # CHECK 1) Errors should trigger finished and allFinished too
     with qtbot.waitSignal(installer.allFinished, timeout=10_000):
@@ -206,7 +233,13 @@ def test_installer_failures(qtbot, tmp_virtualenv: 'Session', monkeypatch):
         )
 
 
-def test_cancel_incorrect_job_id(qtbot, tmp_virtualenv: 'Session'):
+@pytest.mark.parametrize(
+    'tool', [NapariPipInstallerTool, NapariUvInstallerTool]
+)
+def test_cancel_incorrect_job_id(tool, qtbot, monkeypatch):
+    monkeypatch.setattr(
+        NapariInstallerQueue, 'PYPI_INSTALLER_TOOL_CLASS', tool
+    )
     installer = NapariInstallerQueue()
     with qtbot.waitSignal(installer.allFinished, timeout=30_000):
         job_id = installer.install(
@@ -306,13 +339,15 @@ def test_conda_installer(qtbot, caplog, monkeypatch, tmp_conda_env: Path):
     assert not installer.hasJobs()
 
 
-def test_installer_error(qtbot, tmp_virtualenv: 'Session', monkeypatch):
-    installer = NapariInstallerQueue()
+@pytest.mark.parametrize(
+    'tool', [NapariPipInstallerTool, NapariUvInstallerTool]
+)
+def test_installer_error(qtbot, tool, monkeypatch):
     monkeypatch.setattr(
-        NapariPipInstallerTool,
-        'executable',
-        lambda *a: 'not-a-real-executable',
+        NapariInstallerQueue, 'PYPI_INSTALLER_TOOL_CLASS', tool
     )
+    installer = NapariInstallerQueue()
+    monkeypatch.setattr(tool, 'executable', lambda *a: 'not-a-real-executable')
     with qtbot.waitSignal(installer.allFinished, timeout=600_000):
         installer.install(
             tool=InstallerTools.PYPI,
@@ -358,11 +393,13 @@ def test_constraints_are_in_sync():
 def test_executables():
     assert NapariCondaInstallerTool.executable()
     assert NapariPipInstallerTool.executable()
+    assert NapariUvInstallerTool.executable()
 
 
 def test_available():
     assert str(NapariCondaInstallerTool.available())
     assert NapariPipInstallerTool.available()
+    assert NapariUvInstallerTool.available()
 
 
 def test_unrecognized_tool():

src/napari_plugin_manager/_tests/test_qt_plugin_dialog.py

@@ -512,7 +512,7 @@ def test_install_pypi_constructor(
     monkeypatch.setattr(
         qt_plugin_dialog.PluginListItem,
         'get_installer_source',
-        lambda self: 'PIP',
+        lambda self: 'PyPI',
     )
 
     plugin_dialog.set_prefix(str(tmp_virtualenv))

src/napari_plugin_manager/base_qt_package_installer.py

@@ -20,7 +20,7 @@
 from functools import lru_cache
 from logging import getLogger
 from pathlib import Path
-from subprocess import call
+from subprocess import run
 from tempfile import gettempdir
 from typing import TypedDict
 
@@ -122,7 +122,10 @@ class PipInstallerTool(AbstractInstallerTool):
     @classmethod
     def available(cls) -> bool:
         """Check if pip is available."""
-        return call([cls.executable(), '-m', 'pip', '--version']) == 0
+        process = run(
+            [cls.executable(), '-m', 'pip', '--version'], capture_output=True
+        )
+        return process.returncode == 0
 
     def arguments(self) -> list[str]:
         """Compose arguments for the pip command."""
@@ -149,7 +152,7 @@ def arguments(self) -> list[str]:
         else:
             raise ValueError(f"Action '{self.action}' not supported!")
 
-        if log.getEffectiveLevel() < 30:  # DEBUG and INFOlevel
+        if log.getEffectiveLevel() < 30:  # DEBUG and INFO level
             args.append('-vvv')
 
         if self.prefix is not None:
@@ -171,6 +174,79 @@ def _constraints_file(cls) -> str:
         raise NotImplementedError
 
 
+class UvInstallerTool(AbstractInstallerTool):
+    """Uv installer tool for the plugin manager.
+
+    This class is used to install and uninstall packages using uv.
+    """
+
+    @classmethod
+    def executable(cls) -> str:
+        "Path to the executable that will run the task"
+        if sys.platform == 'win32':
+            path = os.path.join(sys.prefix, 'Scripts', 'uv.exe')
+        else:
+            path = os.path.join(sys.prefix, 'bin', 'uv')
+        if os.path.isfile(path):
+            return path
+        return 'uv'
+
+    @classmethod
+    def available(cls) -> bool:
+        """Check if uv is available."""
+        try:
+            process = run([cls.executable(), '--version'], capture_output=True)
+        except FileNotFoundError:  # pragma: no cover
+            return False
+        else:
+            return process.returncode == 0
+
+    def arguments(self) -> list[str]:
+        """Compose arguments for the uv pip command."""
+        args = ['pip']
+
+        if self.action == InstallerActions.INSTALL:
+            args += ['install', '-c', self._constraints_file()]
+            for origin in self.origins:
+                args += ['--extra-index-url', origin]
+
+        elif self.action == InstallerActions.UPGRADE:
+            args += ['install', '-c', self._constraints_file()]
+            for origin in self.origins:
+                args += ['--extra-index-url', origin]
+            for pkg in self.pkgs:
+                args.append(f'--upgrade-package={pkg}')
+        elif self.action == InstallerActions.UNINSTALL:
+            args += ['uninstall']
+
+        else:
+            raise ValueError(f"Action '{self.action}' not supported!")
+
+        if log.getEffectiveLevel() < 30:  # DEBUG and INFO level
+            args.append('-vvv')
+
+        if self.prefix is not None:
+            args.extend(['--prefix', str(self.prefix)])
+        args.extend(['--python', self._python_executable()])
+
+        return [*args, *self.pkgs]
+
+    def environment(
+        self, env: QProcessEnvironment = None
+    ) -> QProcessEnvironment:
+        if env is None:
+            env = QProcessEnvironment.systemEnvironment()
+        return env
+
+    @classmethod
+    @lru_cache(maxsize=0)
+    def _constraints_file(cls) -> str:
+        raise NotImplementedError
+
+    def _python_executable(self) -> str:
+        raise NotImplementedError
+
+
 class CondaInstallerTool(AbstractInstallerTool):
     """Conda installer tool for the plugin manager.
 
@@ -199,11 +275,12 @@ def executable(cls) -> str:
     @classmethod
     def available(cls) -> bool:
         """Check if the executable is available by checking if it can output its version."""
-        executable = cls.executable()
         try:
-            return call([executable, '--version']) == 0
+            process = run([cls.executable(), '--version'], capture_output=True)
         except FileNotFoundError:  # pragma: no cover
             return False
+        else:
+            return process.returncode == 0
 
     def arguments(self) -> list[str]:
         """Compose arguments for the conda command."""

src/napari_plugin_manager/qt_package_installer.py

@@ -23,6 +23,7 @@
     CondaInstallerTool,
     InstallerQueue,
     PipInstallerTool,
+    UvInstallerTool,
 )
 
 
@@ -62,6 +63,28 @@ def _constraints_file(cls) -> str:
         return f.name
 
 
+class NapariUvInstallerTool(UvInstallerTool):
+    @staticmethod
+    def constraints() -> list[str]:
+        """
+        Version constraints to limit unwanted changes in installation.
+        """
+        return [f'napari=={_napari_version}']
+
+    @classmethod
+    @lru_cache(maxsize=0)
+    def _constraints_file(cls) -> str:
+        with NamedTemporaryFile(
+            'w', suffix='-napari-constraints.txt', delete=False
+        ) as f:
+            f.write('\n'.join(cls.constraints()))
+        atexit.register(os.unlink, f.name)
+        return f.name
+
+    def _python_executable(self) -> str:
+        return str(_get_python_exe())
+
+
 class NapariCondaInstallerTool(CondaInstallerTool):
     @staticmethod
     def constraints() -> list[str]:
@@ -80,6 +103,10 @@ def constraints() -> list[str]:
 
 
 class NapariInstallerQueue(InstallerQueue):
-    PYPI_INSTALLER_TOOL_CLASS = NapariPipInstallerTool
+    PYPI_INSTALLER_TOOL_CLASS = (
+        NapariUvInstallerTool
+        if NapariUvInstallerTool.available()
+        else NapariPipInstallerTool
+    )
     CONDA_INSTALLER_TOOL_CLASS = NapariCondaInstallerTool
     BASE_PACKAGE_NAME = 'napari'