create exceptions module

--HG--
extra : convert_revision : eduardo%40eduardo-laptop-20100427152644-5ksuie1mstcgjz5q

TODO.txt

@@ -1,7 +1,6 @@
 0.8
 ------
 
-. task cleanup property
 . deprecate setup objects
 
 . support for depedency scanner (#218303)

doit/__init__.py

@@ -24,55 +24,3 @@
 """
 
 __version__ = (0,8,'dev')
-
-
-import sys
-import traceback
-
-
-class CatchedException(object):
-    """This used to save info from catched exceptions
-    The traceback from the original exception is saved
-    """
-    def __init__(self, msg, exception=None):
-        self.message = msg
-        self.traceback = ''
-
-        if exception is not None:
-            self.traceback = traceback.format_exception(
-                exception.__class__, exception, sys.exc_info()[2])
-
-        #FIXME support exception parameter to be a CatchedException
-
-    def get_msg(self):
-        return "%s\n%s" % (self.message, "".join(self.traceback))
-
-    def get_name(self):
-        return self.__class__.__name__
-
-    def __repr__(self):
-        return "(<%s> %s)" % (self.get_name(), self.message)
-
-    def __str__(self):
-        return "%s\n%s" % (self.get_name(), self.get_msg())
-
-
-# TODO rename this? should be ActionFailed?
-class TaskFailed(CatchedException):
-    """Task execution was not successful."""
-    pass
-
-
-class TaskError(CatchedException):
-    """Error while trying to execute task."""
-    pass
-
-
-class SetupError(CatchedException):
-    """Error while trying to execute setup object"""
-    pass
-
-
-class DependencyError(CatchedException):
-    """Error while trying to check if task is up-to-date"""
-    pass

doit/action.py

@@ -3,7 +3,7 @@
 import inspect
 from threading import Thread
 
-from doit import TaskFailed, TaskError
+from doit.exceptions import TaskFailed, TaskError
 
 # Exceptions
 class InvalidTask(Exception):

doit/exceptions.py

@@ -0,0 +1,53 @@
+import sys
+import traceback
+
+
+class CatchedException(object):
+    """This used to save info from catched exceptions
+    The traceback from the original exception is saved
+    """
+    def __init__(self, msg, exception=None):
+        self.message = msg
+        self.traceback = ''
+
+        if isinstance(exception, CatchedException):
+            self.traceback = exception.traceback
+        elif exception is not None:
+            self.traceback = traceback.format_exception(
+                exception.__class__, exception, sys.exc_info()[2])
+
+
+    def get_msg(self):
+        """return full exception description (includes traceback)"""
+        return "%s\n%s" % (self.message, "".join(self.traceback))
+
+    def get_name(self):
+        return self.__class__.__name__
+
+    def __repr__(self):
+        return "(<%s> %s)" % (self.get_name(), self.message)
+
+    def __str__(self):
+        return "%s\n%s" % (self.get_name(), self.get_msg())
+
+
+class TaskFailed(CatchedException):
+    """Task execution was not successful."""
+    pass
+
+
+class TaskError(CatchedException):
+    """Error while trying to execute task."""
+    pass
+
+
+class SetupError(CatchedException):
+    """Error while trying to execute setup object"""
+    pass
+
+
+class DependencyError(CatchedException):
+    """Error while trying to check if task is up-to-date"""
+    pass
+
+

doit/runner.py

@@ -2,7 +2,8 @@
 
 import sys
 
-from doit import CatchedException, TaskFailed, SetupError, DependencyError
+from doit.exceptions import CatchedException
+from doit.exceptions import TaskFailed, SetupError, DependencyError
 from doit.dependency import Dependency
 
 
@@ -190,7 +191,7 @@ def teardown(self):
             catched = task.execute_teardown(sys.stdout, sys.stderr,
                                             self.verbosity)
             if catched:
-                error = SetupError("ERROR on setup_obj cleanup", catched)
+                error = SetupError("ERROR on teardown action", catched)
                 self.reporter.cleanup_error(error)
 
 

doit/task.py

@@ -1,10 +1,11 @@
 import types
 import os
 
-from doit import CatchedException
 from doit import cmdparse
+from doit.exceptions import CatchedException
 from doit.action import create_action, InvalidTask
 
+
 class Task(object):
     """Task
 

tests/test_action.py

@@ -4,7 +4,7 @@
 import py.test
 
 from doit import action
-from doit import TaskError, TaskFailed
+from doit.exceptions import TaskError, TaskFailed
 
 #path to test folder
 TEST_PATH = os.path.dirname(__file__)

tests/test_exceptions.py

@@ -0,0 +1,47 @@
+from doit import exceptions
+
+
+class TestCatchedException(object):
+    def test_name(self):
+        class XYZ(exceptions.CatchedException):
+            pass
+        my_excp = XYZ("hello")
+        assert 'XYZ' == my_excp.get_name()
+        assert 'XYZ' in str(my_excp)
+        assert 'XYZ' in repr(my_excp)
+
+    def test_msg_notraceback(self):
+        my_excp = exceptions.CatchedException('got you')
+        msg = my_excp.get_msg()
+        assert 'got you' in msg
+
+    def test_exception(self):
+        try:
+            raise IndexError('too big')
+        except Exception, e:
+            my_excp = exceptions.CatchedException('got this', e)
+        msg = my_excp.get_msg()
+        assert 'got this' in msg
+        assert 'too big' in msg
+        assert 'IndexError' in msg
+
+    def test_catched(self):
+        try:
+            raise IndexError('too big')
+        except Exception, e:
+            my_excp = exceptions.CatchedException('got this', e)
+        my_excp2 = exceptions.CatchedException('handle that', my_excp)
+        msg = my_excp2.get_msg()
+        assert 'handle that' in msg
+        assert 'got this' not in msg # could be there too...
+        assert 'too big' in msg
+        assert 'IndexError' in msg
+
+
+class TestAllCatched(object):
+    def test(self):
+        assert issubclass(exceptions.TaskFailed, exceptions.CatchedException)
+        assert issubclass(exceptions.TaskError, exceptions.CatchedException)
+        assert issubclass(exceptions.SetupError, exceptions.CatchedException)
+        assert issubclass(exceptions.DependencyError,
+                          exceptions.CatchedException)

tests/test_reporter.py

@@ -3,7 +3,7 @@
 
 from doit import reporter
 from doit.task import Task
-from doit import CatchedException
+from doit.exceptions import CatchedException
 from doit.dependency import json #FIXME move json import to __init__.py
 
 

tests/test_task.py

@@ -4,8 +4,8 @@
 
 import py.test
 
-from doit import TaskError
-from doit import CatchedException
+from doit.exceptions import TaskError
+from doit.exceptions import CatchedException
 from doit import action
 from doit import task