Merge pull request #1821 from eve-mem/deprecation_warning_for_PluginRequirement

Add a deprecation warning for PluginRequirement

Author: ikelos

volatility3/framework/__init__.py

@@ -13,7 +13,7 @@
 import traceback
 from typing import Any, Dict, Generator, List, Optional, Tuple, Type, TypeVar
 
-from volatility3.framework import constants, interfaces
+from volatility3.framework import constants, interfaces, versionutils
 
 if (
     sys.version_info.major != constants.REQUIRED_PYTHON_VERSION[0]
@@ -48,19 +48,13 @@ def interface_version() -> Tuple[int, int, int]:
 
 def require_interface_version(*args) -> None:
     """Checks the required version of a plugin."""
-    if len(args):
-        if args[0] != interface_version()[0]:
-            raise RuntimeError(
-                f"Framework interface version {interface_version()[0]} is incompatible with required version {args[0]}"
+    if not versionutils.matches_required(args, interface_version()):
+        raise RuntimeError(
+            "Framework interface version {} is incompatible with required version {}".format(
+                ".".join(str(x) for x in interface_version()[0:2]),
+                ".".join(str(x) for x in args[0:2]),
             )
-        if len(args) > 1:
-            if args[1] > interface_version()[1]:
-                raise RuntimeError(
-                    "Framework interface version {} is an older revision than the required version {}".format(
-                        ".".join(str(x) for x in interface_version()[0:2]),
-                        ".".join(str(x) for x in args[0:2]),
-                    )
-                )
+        )
 
 
 class NonInheritable:

volatility3/framework/configuration/requirements.py

@@ -14,7 +14,7 @@
 from typing import Any, ClassVar, Dict, List, Optional, Set, Tuple, Type
 from urllib import parse, request
 
-from volatility3.framework import constants, interfaces
+from volatility3.framework import constants, interfaces, deprecation, versionutils
 
 vollog = logging.getLogger(__name__)
 
@@ -551,7 +551,7 @@ def unsatisfied(
     ) -> Dict[str, interfaces.configuration.RequirementInterface]:
         # Mypy doesn't appreciate our classproperty implementation, self._plugin.version has no type
         config_path = interfaces.configuration.path_join(config_path, self.name)
-        if not self.matches_required(self._version, self._component.version):
+        if not versionutils.matches_required(self._version, self._component.version):
             return {config_path: self}
 
         recurse = True
@@ -593,13 +593,14 @@ def unsatisfied(
     def matches_required(
         cls, required: Tuple[int, ...], version: Tuple[int, int, int]
     ) -> bool:
-        if len(required) > 0 and version[0] != required[0]:
-            return False
-        if len(required) > 1 and version[1] < required[1]:
-            return False
-        return True
+        return versionutils.matches_required(required, version)
 
 
+@deprecation.renamed_class(
+    deprecated_class_name="PluginRequirement",
+    removal_date="2026-06-01",
+    message="PluginRequirement is to be deprecated. Use VersionRequirement instead.",
+)
 class PluginRequirement(VersionRequirement):
     def __init__(
         self,

volatility3/framework/deprecation.py

@@ -10,8 +10,7 @@
 
 from typing import Callable, Tuple
 
-from volatility3.framework import interfaces, exceptions
-from volatility3.framework.configuration import requirements
+from volatility3.framework import interfaces, exceptions, versionutils
 
 
 def method_being_removed(message: str, removal_date: str):
@@ -70,7 +69,7 @@ def wrapper(*args, **kwargs):
                     interfaces.configuration.VersionableInterface,
                 ):
                     # SemVer check
-                    if not requirements.VersionRequirement.matches_required(
+                    if not versionutils.matches_required(
                         replacement_version, replacement_base_class.version
                     ):
                         raise exceptions.VersionMismatchException(

volatility3/framework/versionutils.py

@@ -0,0 +1,23 @@
+# This file is Copyright 2025 Volatility Foundation and licensed under the Volatility Software License 1.0
+# which is available at https://www.volatilityfoundation.org/license/vsl-v1.0
+#
+
+from typing import Tuple
+
+
+def matches_required(required: Tuple[int, ...], version: Tuple[int, int, int]) -> bool:
+    """
+    Checks if a version tuple satisfies the required version major and minor constraints.
+
+    Parameters:
+        required (Tuple[int, ...]): A tuple containing required major and optionally minor version numbers.
+        version (Tuple[int, int, int]): A tuple containing the full version (major, minor, patch).
+
+    Returns:
+        bool: True if the version matches the required constraints, False otherwise.
+    """
+    if len(required) > 0 and version[0] != required[0]:
+        return False
+    if len(required) > 1 and version[1] < required[1]:
+        return False
+    return True