Added another test and some more docstrings

Author: Axel Hörteborn

a00_qpip/plugin.py

@@ -21,18 +21,18 @@
 class Plugin:
     """QGIS Plugin Implementation."""
 
-    def __init__(self, iface, test_path=None):
+    def __init__(self, iface, plugin_path=None):
         self.iface = iface
         self._defered_packages = []
         self.settings = QgsSettings()
         self.settings.beginGroup("QPIP")
 
-        if test_path is None:
+        if plugin_path is None:
             self.plugins_path = os.path.join(
                 QgsApplication.qgisSettingsDirPath(), "python", "plugins"
             )
         else:
-            self.plugins_path = test_path
+            self.plugins_path = plugin_path
         self.prefix_path = os.path.join(
             QgsApplication.qgisSettingsDirPath().replace("/", os.path.sep),
             "python",
@@ -136,6 +136,10 @@ def check_deps(self, additional_plugins=[]) -> MainDialog | bool:
         """
         This checks dependencies for installed plugins and to-be installed plugins. If
         anything is missing, shows a GUI to install them.
+
+        The function returns:
+        - MainDialog, the QDialog object (without opening it)
+        - A bool if the dialog needs to be opened or not
         """
 
         plugin_names = [*qgis.utils.active_plugins, *additional_plugins]

tests/test_finding_req.py

@@ -26,15 +26,17 @@ def plugin(qgis_iface):
 
 def test_plugin_a(plugin: Plugin):
     plugin_a = os.path.join(THIS_DIR, '..', 'test_plugins', 'plugin_a')
-    dialog, _ = plugin.check_deps([plugin_a])
+    dialog, needs_gui = plugin.check_deps([plugin_a])
     libs = dialog.reqs_to_install
     assert len(libs) == 2
     assert libs[0] == 'cowsay==4.0'
+    assert needs_gui
 
 
 def test_plugin_b(plugin: Plugin):
     plugin_b = os.path.join(THIS_DIR, '..', 'test_plugins', 'plugin_b')
-    dialog, _ = plugin.check_deps([plugin_b])
+    dialog, needs_gui = plugin.check_deps([plugin_b])
     libs = dialog.reqs_to_install
     assert len(libs) == 2
-    assert libs[0] == 'cowsay==5.0'
+    assert libs[0] == 'cowsay==5.0'
+    assert needs_gui