volatility3.framework.deprecation module

class PluginRenameClass[source]

Bases: object

Class to move all classmethod invocations (for when a plugin has been moved)

deprecated_method(replacement, removal_date, replacement_version=None, additional_information='')[source]

A decorator for marking functions as deprecated.

Parameters:

  • replacement (Callable) – The replacement function overriding the deprecated API, in the form of a Callable (typically a method)

  • removal_date (str) – A YYYY-MM-DD formatted date of when the function will be removed from the framework

  • replacement_version (Tuple[int, int, int]) – The “replacement” base class version that the deprecated method expects before proxying to it. This implies that “replacement” is a method from a class that inherits from VersionableInterface.

  • additional_information (str) – Information appended at the end of the deprecation message

method_being_removed(message, removal_date)[source]
A decorator for marking functions as being removed in the future and without a replacement.

Callers to this function should explicitly list the API paths that should be used instead.

Parameters:

  • message (str) – A message added to the standard deprecation warning. Should include the replacement API paths

  • removal_date (str) – A YYYY-MM-DD formatted date of when the function will be removed from the framework

renamed_class(deprecated_class_name, message, removal_date)[source]
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.

Parameters:

  • deprecated_class_name (str) – The name of the class being deprecated

  • message (str) – A message added to the standard deprecation warning. Should include the replacement API paths

  • removal_date (str) – A YYYY-MM-DD formatted date of when the function will be removed from the framework