From 2954d7433fc3299fbc73f553d2f914fcadabfac9 Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Fri, 11 Aug 2017 19:29:37 +0100 Subject: [PATCH] Improve documentation and ordering. --- volatility/framework/interfaces/symbols.py | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/volatility/framework/interfaces/symbols.py b/volatility/framework/interfaces/symbols.py index f5036ad89..4645ae94c 100644 --- a/volatility/framework/interfaces/symbols.py +++ b/volatility/framework/interfaces/symbols.py @@ -105,10 +105,15 @@ class BaseSymbolTableInterface(validity.ValidityRoutines): @property def symbols(self): - """Returns an iterator of the Symbols""" + """Returns an iterator of the Symbol names""" raise NotImplementedError("Abstract property symbols not implemented by subclass.") - # ## Required Symbol type functions + # ## Required Type functions + + @property + def types(self): + """Returns an iterator of the Symbol type names""" + raise NotImplementedError("Abstract property types not implemented by subclass.") def get_type(self, name): """Resolves a symbol name into an object template @@ -117,10 +122,12 @@ class BaseSymbolTableInterface(validity.ValidityRoutines): """ raise NotImplementedError("Abstract method get_type not implemented by subclass.") + # ## Required Symbol enumeration functions + @property - def types(self): - """Returns an iterator of the Symbol types""" - raise NotImplementedError("Abstract property types not implemented by subclass.") + def enumerations(self): + """Returns an iterator of the Enumeration names""" + raise NotImplementedError("Abstract property enumerations not implemented by subclass.") # ## Native Type Handler @@ -181,11 +188,6 @@ class BaseSymbolTableInterface(validity.ValidityRoutines): if closest_symbol.address == offset: yield closest_symbol.name - @property - def enumerations(self): - """Returns an iterator of the Enumeration names""" - raise NotImplementedError("Abstract property enumerations not implemented by subclass.") - class SymbolTableInterface(BaseSymbolTableInterface, configuration.ConfigurableInterface): """Handles a table of symbols"""