Merge pull request #1707 from volatilityfoundation/1471-registry-plugins-spread-across-directories-needs-standardization

1471 registry plugins spread across directories needs standardization

Author: ikelos

volatility3/framework/deprecation.py

@@ -88,3 +88,52 @@ def wrapper(*args, **kwargs):
         return wrapper
 
     return decorator
+
+
+def renamed_class(deprecated_class_name: str, message: str, removal_date: str):
+    """A decorator for marking classes as being renamed and removed in the future.
+       Callers to this function should explicitly update to use the other plugins instead.
+
+    Args:
+        deprecated_class_name: The name of the class being deprecated
+        message: A message added to the standard deprecation warning. Should include the replacement API paths
+        removal_date: A YYYY-MM-DD formatted date of when the function will be removed from the framework
+    """
+
+    def decorator(replacement_func):
+        @functools.wraps(replacement_func)
+        def wrapper(*args, **kwargs):
+            warnings.warn(
+                f"This plugin ({deprecated_class_name}) has been renamed and will be removed in the first release after {removal_date}. {message}",
+                FutureWarning,
+            )
+            return replacement_func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+
+
+class PluginRenameClass:
+    """Class to move all classmethod invocations (for when a plugin has been moved)"""
+
+    def __init_subclass__(cls, replacement_class, removal_date, **kwargs):
+        deprecated_class_name = f"{cls.__module__}.{cls.__qualname__}"
+        super().__init_subclass__(**kwargs)
+        for attr, value in replacement_class.__dict__.items():
+            if isinstance(value, classmethod) and attr != "get_requirements":
+                setattr(
+                    cls,
+                    attr,
+                    classmethod(
+                        renamed_class(
+                            deprecated_class_name=deprecated_class_name,
+                            removal_date=removal_date,
+                            message=f"Please ensure all method calls to this plugin are replaced with calls to {replacement_class.__module__}.{replacement_class.__qualname__}",
+                        )(value.__func__)
+                    ),
+                )
+            else:
+                if not attr.startswith("__"):
+                    setattr(cls, attr, value)
+        return super(PluginRenameClass).__init_subclass__(**kwargs)