Improving Code Quality of the Project

.gitignore

@@ -5,4 +5,5 @@ __pycache__/
 /cache/
 /data/
 *.pt
-*.vtk
+*.vtk
+.DS_Store

dfibert/__init__.py

@@ -1,7 +1,11 @@
+"""The deepFibreTrackin (dfibert) module offers modules and classes to help with
+development and evaluation of different machine learning approaches for fibre tracking
+of diffusion weighted MRI data.
+"""
 from . import cache
 from . import config
 from . import data
 from . import dataset
 from . import envs
 from . import tracker
-from . import util
+from . import util

dfibert/cache/__init__.py → dfibert/cache.py

@@ -15,7 +15,6 @@
 from dipy.io.streamline import save_vtk_streamlines, load_vtk_streamlines
 
 from dfibert.config import Config
-from .exceptions import KeyNotCachedError
 
 class Cache():
     """
@@ -134,11 +133,12 @@ def get(self, key):
 
         Raises
         ------
-        KeyNotCachedError
+        LookupError
             This exception is thrown if no object is assigned to given key.
         """
         if not self.in_cache(key):
-            raise KeyNotCachedError(key)
+            raise LookupError("""The key {} isn't cached (anymore).
+                                Check if key is cached with in_cache(key).""".format(key))
         self.objects[key]["last_accessed"] = int(time.time()*1000.0)
 
         filename = self.objects[key]["filename"]
@@ -195,8 +195,7 @@ def clear(self):
         """
         Clears the whole cache.
         """
-        keys = [key for key in self.objects]
-        for key in keys:
+        for key in self.objects:
             self.remove(key)
 
     def save_configuration(self):