From 9b0a910d7eb9314ab8fea127b377ff5fb2a2d621 Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Mon, 7 Oct 2019 10:35:17 +0100 Subject: [PATCH] Update typing and documentation on renderers. --- volatility/framework/interfaces/renderers.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/volatility/framework/interfaces/renderers.py b/volatility/framework/interfaces/renderers.py index b66100b98..38b39d66e 100644 --- a/volatility/framework/interfaces/renderers.py +++ b/volatility/framework/interfaces/renderers.py @@ -194,7 +194,7 @@ class TreeGrid(object, metaclass = ABCMeta): @abstractmethod def visit(self, - node: TreeNode, + node: Optional[TreeNode], function: VisitorSignature, initial_accumulator: _Type, sort_key: ColumnSortKey = None) -> None: @@ -207,6 +207,8 @@ class TreeGrid(object, metaclass = ABCMeta): be set based on a sort_key function which should accept a node's values and return something that can be sorted to receive the desired order (similar to the sort/sorted key). + If node is None, then the root node is used. + Args: node: The initial node to be visited function: The visitor to apply to the nodes under the initial node