Add additional docstrings and refactor/rearrange the entire codebase.

volatility/framework/__init__.py

@@ -1,3 +1,5 @@
+"""Volatility 3 framework"""
+
 # ##
 #
 # Libtool version scheme

volatility/framework/constants.py

@@ -1,4 +1,7 @@
-__author__ = 'mike'
+"""Volatility 3 Constants
+
+Stores all the constant values that are generally fixed throughout volatiltiy
+This includes default scanning block sizes, etc."""
 
 import os.path
 

volatility/framework/exceptions.py

@@ -4,17 +4,22 @@ Created on 1 Dec 2012
 @author: mike
 """
 
+
 class VolatilityException(Exception):
     """Class to allow filtering of all VolatilityExceptions"""
 
+
 class SymbolError(VolatilityException):
     """Thrown when a symbol lookup has failed"""
 
+
 class InvalidAddressException(VolatilityException):
     """Thrown when an address is not valid in the space it was requested"""
 
+
 class SymbolSpaceError(VolatilityException):
     """Thrown when an error occurs dealing with Symbols and Symbolspaces"""
 
+
 class LayerException(VolatilityException):
     """Thrown when an error occurs dealing with memory and layers"""

volatility/framework/interfaces/renderers.py

@@ -1,15 +1,17 @@
 from abc import abstractmethod, ABCMeta
+
 from volatility.framework import validity
 
+
 __author__ = 'mike'
 
-class Renderer(validity.ValidityRoutines):
 
+class Renderer(validity.ValidityRoutines):
     __metaclass__ = ABCMeta
 
     def __init__(self, options):
         """Accepts an options object to configure the renderers"""
-        #FIXME: Once the config option objects are in place, put the type_check in place
+        # FIXME: Once the config option objects are in place, put the type_check in place
 
     @abstractmethod
     def get_render_options(self):

volatility/framework/interfaces/symbols.py

@@ -52,7 +52,7 @@ class SymbolTableInterface(validity.ValidityRoutines):
         """Returns None or a symbol_space for handling space specific native types"""
         return self._native_structures
 
-    ### Functions for overriding classes
+    # ## Functions for overriding classes
 
     def set_structure_class(self, name, clazz):
         """Overrides the object class for a specific structure symbol
@@ -74,7 +74,7 @@ class SymbolTableInterface(validity.ValidityRoutines):
 #
 # def __len__(self):
 # """Returns the number of items in the symbol list"""
-#        return len(self.structures)
+# return len(self.structures)
 #
 #    def __getitem__(self, key):
 #        """Resolves a symbol name into an object template

volatility/framework/renderers/__init__.py

@@ -1,7 +1,8 @@
+"""Renderers
+
+Renderers display the unified output format in some manner (be it text or file or graphical output"""
+
 import collections
-
-__author__ = 'mike'
-
 import re
 
 from volatility.framework import validity
@@ -38,6 +39,7 @@ class TreeRow(validity.ValidityRoutines):
 
     @property
     def values(self):
+        """The individual cell values of the row"""
         return self._values
 
     @property