make addons utility work

Author: couteau

redistricting/utils/addons.py

@@ -22,13 +22,41 @@
  *                                                                         *
  ***************************************************************************/
 """
+import importlib
 import pathlib
 import subprocess
 import sys
 
 from packaging.version import parse as parse_version
+from qgis.gui import QgisInterface
+from qgis.utils import iface
 
-# from pip import main as pipmain
+iface: QgisInterface
+
+
+def install_vendor_dir():
+    vendor_dir = pathlib.Path(__file__).parent.parent / "vendor"
+    if vendor_dir.exists():
+        sys.path.insert(0, str(vendor_dir.resolve()))
+
+
+def unload_module(mod: str):
+    mod_prefix = f"{mod}."
+    for m in list(sys.modules.keys()):
+        if m == mod or m.startswith(mod_prefix):
+            del sys.modules[m]
+
+
+def reload_modules():
+    vendor_dir = pathlib.Path(__file__).parent.parent / "vendor"
+    if vendor_dir.exists():
+        for d in vendor_dir.iterdir():
+            if d.suffix == '.py' or (d.is_dir() and (d / '__init__.py').exists()):
+                mod = d.stem
+                if mod in sys.modules:
+                    unload_module(mod)
+
+                importlib.import_module(mod)
 
 
 def python_executable():
@@ -42,26 +70,40 @@ def install_addon(pkg: str, *options):
     installdir = pathlib.Path(__file__).parent.parent / "vendor"
     if not installdir.exists():
         installdir.mkdir()
+        install_vendor_dir()
+
     if (installdir / pkg).exists():
         options = (*options, "--upgrade")
-    subprocess.check_call([python_executable(), '-m', 'pip', 'install', '-t', str(installdir), *options, pkg])
-    # pipmain(['install', '-t', str(installdir), *options, pkg])
+    try:
+        subprocess.check_call([python_executable(), '-m', 'pip', 'install', '-t', str(installdir), *options, pkg])
+    except subprocess.CalledProcessError:
+        iface.messageBar().pushWarning("Warning", f"Could not install addon {pkg}")
+        return False
+
+    return True
 
 
 def install_pyogrio():
+    # pylint: disable=import-outside-toplevel
     import geopandas
     if parse_version(geopandas.__version__) < parse_version('0.12.0'):
-        install_addon('geopandas', "--no-deps")
+        install_addon('geopandas')
     import shapely
     if parse_version(shapely.__version__) < parse_version('2.0.0'):
-        install_addon('shapeley', "--no-deps")
+        install_addon('shapeley')
 
-    install_addon('pyogrio', '--no-deps')
+    install_addon('pyogrio')
+    reload_modules()
 
 
 def install_pyarrow():
-    install_addon('pyarrow', '--no-deps')
+    install_addon('pyarrow')
+    reload_modules()
 
 
 def install_gerrychain():
-    install_addon('gerrychain', '--no-deps')
+    install_addon('gerrychain==0.3.1')
+    reload_modules()
+
+
+install_vendor_dir()

tests/unittests/utils/test_addons.py

@@ -0,0 +1,52 @@
+import pathlib
+import shutil
+import sys
+
+import pytest
+
+import redistricting
+
+
+# pylint: disable=import-outside-toplevel
+class TestAddons:
+    @pytest.fixture
+    def vendor_dir(self):
+        d = pathlib.Path(redistricting.__file__).parent / "vendor"
+        yield d
+
+        if d.exists():
+            shutil.rmtree(d)
+
+    def test_install_pyogrio(self, vendor_dir):
+        from redistricting.utils import addons
+
+        assert not vendor_dir.exists()
+
+        addons.install_pyogrio()
+
+        assert (vendor_dir / 'geopandas').exists()
+        assert (vendor_dir / 'pyogrio').exists()
+        assert 'geopandas' in sys.modules
+        assert sys.modules['geopandas'].__spec__.origin == str(vendor_dir / 'geopandas' / '__init__.py')
+
+    def test_install_pyarrow(self, vendor_dir):
+        from redistricting.utils import addons
+
+        assert not vendor_dir.exists()
+
+        addons.install_pyarrow()
+
+        assert (vendor_dir / 'pyarrow').exists()
+        assert 'pyarrow' in sys.modules
+        assert sys.modules['pyarrow'].__spec__.origin == str(vendor_dir / 'pyarrow' / '__init__.py')
+
+    def test_install_gerrychain(self, vendor_dir):
+        from redistricting.utils import addons
+
+        assert not vendor_dir.exists()
+
+        addons.install_gerrychain()
+
+        assert (vendor_dir / 'gerrychain').exists()
+        assert 'gerrychain' in sys.modules
+        assert sys.modules['gerrychain'].__spec__.origin == str(vendor_dir / 'gerrychain' / '__init__.py')