Added more documentation, enabled futures consistently across modules…

…, and fixed some formatting errors

byte/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import absolute_import, division, print_function
+
 from pkgutil import extend_path
 
 __path__ = extend_path(__path__, __name__)

byte/base.py

@@ -1,9 +1,14 @@
+"""Base models module."""
+
+from __future__ import absolute_import, division, print_function
+
+
 class BaseExpression(object):
     """Base class for expressions."""
 
     def execute(self, item):
         """Execute expression.
-        
+
         :param item: Item
         :type item: byte.model.Model
         """
@@ -15,18 +20,18 @@ class BaseProperty(object):
 
     def get(self, obj):
         """Get property value from object.
-        
+
         :param obj: Item
         :type obj: byte.model.Model
         """
         raise NotImplementedError
 
     def set(self, obj, value):
         """Set property value on object.
-        
+
         :param obj: Item
         :type obj: byte.model.Model
-        
+
         :param value: Value
         :type value: any
         """

byte/collection.py

@@ -2,6 +2,8 @@
 
 """Contains the collection structure for the storage of keyed items."""
 
+from __future__ import absolute_import, division, print_function
+
 from byte.core.plugin.manager import PluginManager
 from byte.executors.core.base import Executor
 from byte.model import Model
@@ -24,7 +26,7 @@ class CollectionLoadError(CollectionError):
 
 
 class CollectionModelError(CollectionError):
-    """"Collection model violation."""
+    """Collection model violation."""
 
 
 class CollectionParseError(CollectionError):
@@ -47,10 +49,10 @@ def __init__(self, model_or_uri=None, uri=None, model=None, executor=None, plugi
 
         :param model: Collection data model
         :type model: class
-        
+
         :param executor: Collection executor
         :type executor: byte.executors.core.base.Executor or type
-        
+
         :param plugins: List of plugins to enable for the collection (if :code:`None` is provided
                         all plugins will be enabled)
         :type plugins: list

byte/compilers/__init__.py

@@ -1,3 +1,5 @@
+from __future__ import absolute_import, division, print_function
+
 from pkgutil import extend_path
 
 __path__ = extend_path(__path__, __name__)

byte/compilers/core/__init__.py

@@ -0,0 +1,3 @@
+"""Core compilers package."""
+
+from __future__ import absolute_import, division, print_function

byte/compilers/core/base.py

@@ -1,3 +1,7 @@
+"""Base compiler module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.core.helpers.resolve import resolve_tuples
 from byte.core.helpers.validate import is_list_of
 from byte.core.plugin.base import Plugin

byte/compilers/core/models.py

@@ -1,3 +1,8 @@
+"""Compiler models module."""
+
+from __future__ import absolute_import, division, print_function
+
+
 class Operation(object):
     pass
 

byte/compilers/operation.py

@@ -1,3 +1,5 @@
+"""Operation compiler module."""
+
 from __future__ import absolute_import, division, print_function
 
 from byte.compilers.core.base import CompilerPlugin

byte/core/__init__.py

@@ -0,0 +1,3 @@
+"""Core package."""
+
+from __future__ import absolute_import, division, print_function

byte/core/helpers/__init__.py

@@ -0,0 +1,3 @@
+"""Byte helpers package."""
+
+from __future__ import absolute_import, division, print_function

byte/core/helpers/resolve.py

@@ -1,4 +1,14 @@
+"""Resolve helper functions module."""
+
+from __future__ import absolute_import, division, print_function
+
+
 def resolve_list(value):
+    """Resolve list (convert provided value if not list).
+
+    :param value: Value
+    :type value: any
+    """
     if value is None:
         return []
 
@@ -9,6 +19,14 @@ def resolve_list(value):
 
 
 def resolve_tuple(value, default=None):
+    """Resolve tuple (convert provided value if not tuple).
+
+    :param value: Value
+    :type value: any
+
+    :param default: Default tuple function
+    :type default: function
+    """
     if value is None:
         return tuple()
 
@@ -23,6 +41,14 @@ def resolve_tuple(value, default=None):
 
 
 def resolve_tuples(items, default=None):
+    """Resolve list of tuples (convert provided value if not list of tuples).
+
+    :param items: Value
+    :type items: any
+
+    :param default: Default tuple function
+    :type default: function
+    """
     if items is None:
         return []
 

byte/core/helpers/validate.py

@@ -1,4 +1,17 @@
+"""Validation helper functions module."""
+
+from __future__ import absolute_import, division, print_function
+
+
 def is_list_of(items, value_type):
+    """Validate list :code:`items` match :code:`value_type`.
+
+    :param items: Items
+    :type items: list
+
+    :param value_type: Value type
+    :type value_type: class
+    """
     if not isinstance(items, list):
         return False
 
@@ -14,6 +27,14 @@ def match():
 
 
 def is_tuple_of(items, value_type):
+    """Validate tuple :code:`items` match :code:`value_type`.
+
+    :param items: Items
+    :type items: tuple
+
+    :param value_type: Value type
+    :type value_type: class
+    """
     if not isinstance(items, tuple):
         return False
 

byte/core/models/__init__.py

@@ -1,4 +1,24 @@
-from byte.core.models.reader import Reader
+"""Core models package."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.core.models.task.base import Task, ReadTask, SelectTask, WriteTask
 from byte.core.models.task.simple import SimpleTask, SimpleReadTask, SimpleSelectTask, SimpleWriteTask
 from byte.core.models.task.stream import StreamTask, StreamReadTask, StreamSelectTask, StreamWriteTask
+
+__all__ = (
+    'Task',
+    'ReadTask',
+    'SelectTask',
+    'WriteTask',
+
+    'SimpleTask',
+    'SimpleReadTask',
+    'SimpleSelectTask',
+    'SimpleWriteTask',
+
+    'StreamTask',
+    'StreamReadTask',
+    'StreamSelectTask',
+    'StreamWriteTask'
+)

byte/core/models/task/__init__.py

@@ -0,0 +1,3 @@
+"""Task model package."""
+
+from __future__ import absolute_import, division, print_function

byte/core/models/task/base.py

@@ -1,3 +1,7 @@
+"""Task base module."""
+
+from __future__ import absolute_import, division, print_function
+
 __all__ = (
     'Task',
     'ReadTask',
@@ -9,7 +13,7 @@ class Task(object):
     class State(object):
         created = 0
         started = 1
-        closed  = 2
+        closed  = 2  # noqa
 
     def __init__(self, executor):
         self.executor = executor
@@ -35,18 +39,23 @@ def state(self):
         raise NotImplementedError
 
     def open(self):
+        """Open task."""
         raise NotImplementedError
 
     def execute(self):
+        """Execute task."""
         raise NotImplementedError
 
     def close(self):
+        """Close task."""
         raise NotImplementedError
 
     def __enter__(self):
+        """Enter task context (execute task)."""
         return self
 
     def __exit__(self, exc_type, exc_val, exc_tb):
+        """Exit task context (close task)."""
         self.close()
 
 

byte/core/models/task/simple.py

@@ -1,3 +1,7 @@
+"""Simple task module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.compilers.core.models import InsertOperation
 from byte.core.models.task.base import Task, ReadTask, SelectTask, WriteTask
 

byte/core/models/task/stream.py

@@ -1,3 +1,7 @@
+"""Stream task module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.core.models.task.base import Task
 from byte.core.models.task.simple import SimpleTask, SimpleReadTask, SimpleSelectTask, SimpleWriteTask
 

byte/core/plugin/__init__.py

@@ -0,0 +1,3 @@
+"""Plugin package."""
+
+from __future__ import absolute_import, division, print_function

byte/core/plugin/base.py

@@ -1,3 +1,8 @@
+"""Plugin base module."""
+
+from __future__ import absolute_import, division, print_function
+
+
 class Plugin(object):
     class Meta(object):
         kind = None
@@ -11,6 +16,6 @@ def validate(cls, plugin):
             return True
 
     class Priority(object):
-        Low     =  1000
-        Medium  =     0
-        High    = -1000
+        Low     =  1000  # noqa
+        Medium  =     0  # noqa
+        High    = -1000  # noqa

byte/core/plugin/manager.py

@@ -1,8 +1,12 @@
-from byte.core.plugin.base import Plugin
+"""Plugin manager module."""
+
+from __future__ import absolute_import, division, print_function
+
+from byte import __path__ as byte_path
 from byte.compilers.core.base import CompilerPlugin
+from byte.core.plugin.base import Plugin
 from byte.executors.core.base import ExecutorPlugin
 from byte.formats.core.base import CollectionFormatPlugin, DocumentFormatPlugin
-import byte
 
 import imp
 import inspect
@@ -48,7 +52,7 @@ def __init__(self, modules=None):
     def discover(self, packages=('compilers', 'executors', 'formats')):
         scanned_paths = set()
 
-        for search_path in byte.__path__:
+        for search_path in byte_path:
             search_path = os.path.normcase(os.path.normpath(
                 os.path.realpath(search_path)
             ))

byte/executors/__init__.py

@@ -1,3 +1,7 @@
+"""Executors package."""
+
+from __future__ import absolute_import, division, print_function
+
 from pkgutil import extend_path
 
 __path__ = extend_path(__path__, __name__)

byte/executors/core/__init__.py

@@ -0,0 +1,3 @@
+"""Executors core package."""
+
+from __future__ import absolute_import, division, print_function

byte/executors/core/base/__init__.py

@@ -1,3 +1,18 @@
+"""Executor base package."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.executors.core.base.executor import Executor, ExecutorPlugin
 from byte.executors.core.base.format import FormatExecutor, FormatExecutorPlugin
 from byte.executors.core.base.simple import SimpleExecutor, SimpleExecutorPlugin
+
+__all__ = (
+    'Executor',
+    'ExecutorPlugin',
+
+    'FormatExecutor',
+    'FormatExecutorPlugin',
+
+    'SimpleExecutor',
+    'SimpleExecutorPlugin'
+)

byte/executors/core/base/executor.py

@@ -1,3 +1,7 @@
+"""Executor base module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.core.helpers.resolve import resolve_tuples
 from byte.core.helpers.validate import is_list_of
 from byte.core.plugin.base import Plugin

byte/executors/core/base/format.py

@@ -1,3 +1,7 @@
+"""Format base module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.executors.core.base.simple import SimpleExecutor, SimpleExecutorPlugin
 
 

byte/executors/core/base/simple.py

@@ -1,3 +1,7 @@
+"""Simple executor base module."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.executors.core.base.executor import Executor, ExecutorPlugin
 
 

byte/executors/core/models/__init__.py

@@ -1 +1,9 @@
+"""Executor models package."""
+
+from __future__ import absolute_import, division, print_function
+
 from byte.executors.core.models.revision import Revision
+
+__all__ = (
+    'Revision',
+)