]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - tasklib/task.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

tests: Add basic Task tests
[etc/taskwarrior.git] / tasklib / task.py
index 36f3c3b13054e4bdab5870ec8e663c89535c5489..86e98ec40b7a8e34ecea8080b090ad3b0a894dd2 100644 (file)
@@ -88,9 +88,20 @@ class Task(TaskResource):
         """
         pass
 
-    def __init__(self, warrior, data={}):
+    class NotSaved(Exception):
+        """
+        Raised when the operation cannot be performed on the task, because
+        it has not been saved to TaskWarrior yet.
+        """
+        pass
+
+    def __init__(self, warrior, data={}, **kwargs):
         self.warrior = warrior
-        self._load_data(data)
+
+        # We keep data for backwards compatibility
+        kwargs.update(data)
+
+        self._load_data(kwargs)
         self._modified_fields = set()
 
     def __unicode__(self):
@@ -136,11 +147,14 @@ class Task(TaskResource):
         return ','.join(tags) if tags else ''
 
     def delete(self):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved before it can be deleted")
+
         # Refresh the status, and raise exception if the task is deleted
         self.refresh(only_fields=['status'])
 
         if self.deleted:
-            raise self.DeletedTask("Task was already deleted")
+            raise Task.DeletedTask("Task was already deleted")
 
         self.warrior.execute_command([self['uuid'], 'delete'], config_override={
             'confirmation': 'no',
@@ -151,13 +165,16 @@ class Task(TaskResource):
 
 
     def done(self):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved before it can be completed")
+
         # Refresh, and raise exception if task is already completed/deleted
         self.refresh(only_fields=['status'])
 
         if self.completed:
-            raise self.CompletedTask("Cannot complete a completed task")
+            raise Task.CompletedTask("Cannot complete a completed task")
         elif self.deleted:
-            raise self.DeletedTask("Deleted task cannot be completed")
+            raise Task.DeletedTask("Deleted task cannot be completed")
 
         self.warrior.execute_command([self['uuid'], 'done'])
 
@@ -186,17 +203,21 @@ class Task(TaskResource):
         self.refresh()
 
     def add_annotation(self, annotation):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved to add annotation")
+
         args = [self['uuid'], 'annotate', annotation]
         self.warrior.execute_command(args)
-        # TODO: This will not work with the tasks that are not yet saved
         self.refresh(only_fields=['annotations'])
 
     def remove_annotation(self, annotation):
+        if not self.saved:
+            raise Task.NotSaved("Task needs to be saved to add annotation")
+
         if isinstance(annotation, TaskAnnotation):
             annotation = annotation['description']
         args = [self['uuid'], 'denotate', annotation]
         self.warrior.execute_command(args)
-        # TODO: This will not work with the tasks that are not yet saved
         self.refresh(only_fields=['annotations'])
 
     def _get_modified_fields_as_args(self):
@@ -216,9 +237,9 @@ class Task(TaskResource):
         return args
 
     def refresh(self, only_fields=[]):
-        # Do not refresh for tasks that are not yet saved in the TW
+        # Raise error when trying to refresh a task that has not been saved
         if not self.saved:
-            return
+            raise Task.NotSaved("Task needs to be saved to be refreshed")
 
         # We need to use ID as backup for uuid here for the refreshes
         # of newly saved tasks. Any other place in the code is fine