Task: Allow setting attributes via keyword arguments

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

diff --git a/tasklib/task.py b/tasklib/task.py
index 1202437db2f172672a9102144ec89a50fb9791d5..170fc77e545bf076a5d1d6d6ed6977178fc2fe34 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -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,6 +147,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'])
 
@@ -151,6 +165,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'])
 
@@ -186,29 +203,43 @@ class Task(TaskResource):
         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)
-        # 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 self.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):
         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=[]):
-        # 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 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