Refactor ConfigDiffBase to use class methods for variable handling and update custom_field query parameters

Author: miaow2

netbox_config_diff/compliance/base.py

@@ -1,4 +1,5 @@
 import asyncio
+import inspect
 import re
 import traceback
 from typing import Iterable, Iterator
@@ -9,7 +10,7 @@
 from dcim.models import Device, DeviceRole, Site
 from django.db.models import Q
 from extras.models import CustomField
-from extras.scripts import MultiObjectVar, ObjectVar, TextVar
+from extras.scripts import MultiObjectVar, ObjectVar, ScriptVariable, TextVar
 from jinja2.exceptions import TemplateError
 from netutils.config.compliance import diff_network_config
 from utilities.exceptions import AbortScript
@@ -68,13 +69,35 @@ class ConfigDiffBase(SecretsMixin):
         "Reference the object as <code>{{ object }}</code>.",
     )
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.custom_field.query_params["object_type_id"] = self._get_device_object_type_id()
-
-    def _get_device_object_type_id(self) -> list[int]:
+    @classmethod
+    def _get_device_object_type_id(cls) -> list[int]:
         return list(ObjectType.objects.filter(app_label="dcim", model="device").values_list("id", flat=True))
 
+    @classmethod
+    def _get_vars(cls):
+        vars = {}
+        device_id = cls._get_device_object_type_id()
+
+        # Iterate all base classes looking for ScriptVariables
+        for base_class in inspect.getmro(cls):
+            # When object is reached there's no reason to continue
+            if base_class is object:
+                break
+
+            for name, attr in base_class.__dict__.items():
+                if name not in vars and issubclass(attr.__class__, ScriptVariable):
+                    if name == "custom_field":
+                        attr.field_attrs["query_params"]["object_type_id"] = device_id
+                    vars[name] = attr
+
+        # Order variables according to field_order
+        if not cls.field_order:
+            return vars
+        ordered_vars = {field: vars.pop(field) for field in cls.field_order if field in vars}
+        ordered_vars.update(vars)
+
+        return ordered_vars
+
     def run_script(self, data: dict) -> None:
         devices = self.validate_data(data)
         devices = list(self.get_devices_with_rendered_configs(devices))