move legacy Plugin base class from core to config

Signed-off-by: David Wallace <david.wallace@tu-darmstadt.de>

Author: MyPyDavid

rdmo/config/helpers.py

@@ -3,6 +3,8 @@
 from dataclasses import dataclass, field
 from typing import Any
 
+from django.utils.module_loading import import_string
+
 
 @dataclass(frozen=True)
 class DeclaredPlugin:
@@ -17,7 +19,6 @@ class DeclaredPlugin:
 
     def get_plugin_instance(self):
         try:
-            from django.utils.module_loading import import_string
             return import_string(self.python_path)(self.uri_path, self.title, self.python_path)
         except Exception:
             return None

rdmo/config/plugin_types.py

@@ -2,8 +2,6 @@
 
 from django.utils.module_loading import import_string
 
-from rdmo.core.plugins import Plugin as LegacyPluginBase
-
 
 def get_plugin_type_mapping():
     # imports at run-time only
@@ -35,6 +33,7 @@ def detect_plugin_type(python_path) -> str:
         else:
             return "has_plugin_type_but_empty"
 
+    from rdmo.config.plugins import PluginBase as LegacyPluginBase
     if not issubclass(cls, LegacyPluginBase):
         return "not_an_rdmo_plugin"
 

rdmo/config/plugins.py

@@ -4,6 +4,11 @@
 
 from rdmo.config.helpers import DeclaredPlugin
 from rdmo.config.models import Plugin
+from rdmo.core.utils import import_class
+
+
+class PluginBase:
+    pass
 
 
 def get_plugins_from_db(project=None, plugin_type: str | None=None, user=None) -> list[DeclaredPlugin]:
@@ -29,7 +34,7 @@ def get_plugins_from_db(project=None, plugin_type: str | None=None, user=None) -
             continue
 
         if instance.python_path not in settings.PLUGINS:
-            continue
+            continue  # plugins are filtered by settings as well
 
         if instance.plugin_type != plugin_type:
             continue
@@ -44,3 +49,15 @@ def get_plugins_from_db(project=None, plugin_type: str | None=None, user=None) -
             source=f"Plugin(id={instance.id})",
         ))
     return results
+
+
+def get_plugin(plugin_settings, plugin_key):
+    try:
+        key, label, class_name = next(
+            (key, label, class_name)
+            for key, label, class_name in getattr(settings, plugin_settings)
+            if key == plugin_key
+        )
+        return import_class(class_name)(key, label, class_name)
+    except StopIteration:
+        return None

rdmo/core/plugins.py

@@ -1,7 +1,7 @@
-from rdmo.core.plugins import Plugin
+from rdmo.config.plugins import PluginBase
 
 
-class Provider(Plugin):
+class Provider(PluginBase):
 
     plugin_type = 'optionset_provider'
 

rdmo/options/providers.py

@@ -3,8 +3,8 @@
 from django.conf import settings
 from django.http import HttpResponse
 
+from rdmo.config.plugins import PluginBase
 from rdmo.core.exports import prettify_xml
-from rdmo.core.plugins import Plugin
 from rdmo.core.utils import render_to_csv, render_to_json
 from rdmo.views.templatetags import view_tags
 from rdmo.views.utils import ProjectWrapper
@@ -14,7 +14,7 @@
 from .serializers.export import SnapshotSerializer as SnapshotExportSerializer
 
 
-class Export(Plugin):
+class Export(PluginBase):
 
     plugin_type = 'project_export'
 

rdmo/projects/exports.py

@@ -8,8 +8,8 @@
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
+from rdmo.config.plugins import get_plugin
 from rdmo.core.constants import VALUE_TYPE_FILE
-from rdmo.core.plugins import get_plugin
 from rdmo.core.utils import markdown2html
 
 from .constants import ROLE_CHOICES

rdmo/projects/forms.py

@@ -11,8 +11,8 @@
 
 import requests
 
+from rdmo.config.plugins import PluginBase
 from rdmo.core.imports import handle_fetched_file
-from rdmo.core.plugins import Plugin
 from rdmo.core.xml import get_ns_map, get_uri, read_xml_file
 from rdmo.domain.models import Attribute
 from rdmo.options.models import Option
@@ -25,7 +25,7 @@
 log = logging.getLogger(__name__)
 
 
-class Import(Plugin):
+class Import(PluginBase):
 
     plugin_type = 'project_import'
     accept = None

rdmo/projects/imports.py

@@ -5,7 +5,7 @@
 from django.core.management.base import BaseCommand, CommandError
 from django.db.models import Prefetch
 
-from rdmo.core.plugins import get_plugin
+from rdmo.config.plugins import get_plugin
 from rdmo.core.utils import render_to_format
 from rdmo.projects.models import Project
 from rdmo.projects.utils import get_value_path

rdmo/projects/management/commands/export_projects.py

@@ -39,8 +39,10 @@ def provider(self):
             .for_context(plugin_type="issue_provider", project=self.project)
             .filter(uri_path__contains=self.provider_key)
         )
-        provider = plugins.first().initialize_class() if plugins else None
-        return provider
+        if plugins.exists():
+            return plugins.first().initialize_class()
+        else:
+            return None
 
     def get_option_value(self, key):
         try: