Task: Add NotSaved exception

[etc/taskwarrior.git] / tasklib / task.py

diff --git a/tasklib/task.py b/tasklib/task.py
index f2b020db36f9184f0e4665ed2a9d471342355490..09535881550207dff67ed436f1a438f15b7a5949 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -88,6 +88,13 @@ class Task(TaskResource):
         """
         pass
 
+    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={}):
         self.warrior = warrior
         self._load_data(data)
@@ -112,6 +119,10 @@ class Task(TaskResource):
     def pending(self):
         return self['status'] == six.text_type('pending')
 
+    @property
+    def saved(self):
+        return self['uuid'] is not None or self['id'] is not None
+
     def serialize_due(self, date):
         return date.strftime(DATE_FORMAT)
 
@@ -132,6 +143,9 @@ class Task(TaskResource):
         return ','.join(tags) if tags else ''
 
     def delete(self):
+        if not self.saved:
+            raise self.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'])
 
@@ -147,6 +161,9 @@ class Task(TaskResource):
 
 
     def done(self):
+        if not self.saved:
+            raise self.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'])
 
@@ -161,17 +178,38 @@ class Task(TaskResource):
         self.refresh(only_fields=['status'])
 
     def save(self):
-        args = [self['uuid'], 'modify'] if self['uuid'] else ['add']
+        args = [self['uuid'], 'modify'] if self.saved else ['add']
         args.extend(self._get_modified_fields_as_args())
-        self.warrior.execute_command(args)
+        output = self.warrior.execute_command(args)
+
+        # Parse out the new ID, if the task is being added for the first time
+        if not self.saved:
+            id_lines = [l for l in output if l.startswith('Created task ')]
+
+            # Complain loudly if it seems that more tasks were created
+            # Should not happen
+            if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3:
+                raise TaskWarriorException("Unexpected output when creating "
+                                           "task: %s" % '\n'.join(id_lines))
+
+            # Circumvent the ID storage, since ID is considered read-only
+            self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
+
         self._modified_fields.clear()
+        self.refresh()
 
     def add_annotation(self, annotation):
+        if not self.saved:
+            raise self.NotSaved("Task needs to be saved to add annotation")
+
         args = [self['uuid'], 'annotate', annotation]
         self.warrior.execute_command(args)
         self.refresh(only_fields=['annotations'])
 
     def remove_annotation(self, annotation):
+        if not self.saved:
+            raise self.NotSaved("Task needs to be saved to add annotation")
+
         if isinstance(annotation, TaskAnnotation):
             annotation = annotation['description']
         args = [self['uuid'], 'denotate', annotation]
@@ -180,12 +218,29 @@ class Task(TaskResource):
 
     def _get_modified_fields_as_args(self):
         args = []
-        for field in self._modified_fields:
-            args.append('{}:{}'.format(field, self._data[field]))
+
+        # If we're modifying saved task, simply pass on all modified fields
+        if self.saved:
+            for field in self._modified_fields:
+                args.append('{0}:{1}'.format(field, self._data[field]))
+        # For new tasks, pass all fields that make sense
+        else:
+            for field in self._data.keys():
+                if field in self.read_only_fields:
+                    continue
+                args.append('{0}:{1}'.format(field, self._data[field]))
+
         return args
 
     def refresh(self, only_fields=[]):
-        args = [self['uuid'], 'export']
+        # Raise error when trying to refresh a task that has not been saved
+        if not self.saved:
+            raise self.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
+        # with using UUID only.
+        args = [self['uuid'] or self['id'], 'export']
         new_data = json.loads(self.warrior.execute_command(args)[0])
         if only_fields:
             to_update = dict(