Task: Add support for creating Task objects in hook scripts

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

diff --git a/tasklib/task.py b/tasklib/task.py
index 9d6d47f4a8bcf6c0951514d9c0a78f6056182ed7..c34a104afa08871f4a9d3b852300f2dd7250b5fd 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -5,6 +5,7 @@ import json
 import logging
 import os
 import six
+import sys
 import subprocess
 
 DATE_FORMAT = '%Y%m%dT%H%M%SZ'
@@ -117,6 +118,19 @@ class TaskResource(SerializingObject):
         # are not propagated.
         self._original_data = copy.deepcopy(self._data)
 
+    def _update_data(self, data, update_original=False):
+        """
+        Low level update of the internal _data dict. Data which are coming as
+        updates should already be serialized. If update_original is True, the
+        original_data dict is updated as well.
+        """
+        self._data.update(dict((key, self._deserialize(key, value))
+                               for key, value in data.items()))
+
+        if update_original:
+            self._original_data = copy.deepcopy(self._data)
+
+
     def __getitem__(self, key):
         # This is a workaround to make TaskResource non-iterable
         # over simple index-based iteration
@@ -159,6 +173,11 @@ class TaskAnnotation(TaskResource):
     def __unicode__(self):
         return self['description']
 
+    def __eq__(self, other):
+        # consider 2 annotations equal if they belong to the same task, and
+        # their data dics are the same
+        return self.task == other.task and self._data == other._data
+
     __repr__ = __unicode__
 
 
@@ -187,6 +206,33 @@ class Task(TaskResource):
         """
         pass
 
+    @classmethod
+    def from_input(cls, modify=False):
+        """
+        Creates a Task object, directly from the stdin, by reading one line.
+        If modify=True, two lines are used, first line interpreted as the
+        original state of the Task object, and second line as its new,
+        modified value. This is consistent with the TaskWarrior's hook
+        system.
+
+        Object created by this method should not be saved, deleted
+        or refreshed, as t could create a infinite loop. For this
+        reason, TaskWarrior instance is set to None.
+        """
+
+        # TaskWarrior instance is set to None
+        task = cls(None)
+
+        # Load the data from the input
+        task._load_data(json.loads(sys.stdin.readline().strip()))
+
+        # If this is a on-modify event, we are provided with additional
+        # line of input, which provides updated data
+        if modify:
+            task._update_data(json.loads(sys.stdin.readline().strip()))
+
+        return task
+
     def __init__(self, warrior, **kwargs):
         self.warrior = warrior
 
@@ -295,7 +341,7 @@ class Task(TaskResource):
             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()
+        self.refresh(only_fields=['status'])
 
         if self.deleted:
             raise Task.DeletedTask("Task was already deleted")
@@ -303,7 +349,7 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'delete'])
 
         # Refresh the status again, so that we have updated info stored
-        self.refresh()
+        self.refresh(only_fields=['status'])
 
 
     def done(self):
@@ -311,7 +357,7 @@ class Task(TaskResource):
             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()
+        self.refresh(only_fields=['status'])
 
         if self.completed:
             raise Task.CompletedTask("Cannot complete a completed task")
@@ -321,7 +367,7 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored
-        self.refresh()
+        self.refresh(only_fields=['status'])
 
     def save(self):
         if self.saved and not self._is_modified:
@@ -352,7 +398,7 @@ class Task(TaskResource):
 
         args = [self['uuid'], 'annotate', annotation]
         self.warrior.execute_command(args)
-        self.refresh()
+        self.refresh(only_fields=['annotations'])
 
     def remove_annotation(self, annotation):
         if not self.saved:
@@ -362,7 +408,7 @@ class Task(TaskResource):
             annotation = annotation['description']
         args = [self['uuid'], 'denotate', annotation]
         self.warrior.execute_command(args)
-        self.refresh()
+        self.refresh(only_fields=['annotations'])
 
     def _get_modified_fields_as_args(self):
         args = []
@@ -392,7 +438,7 @@ class Task(TaskResource):
 
         return args
 
-    def refresh(self):
+    def refresh(self, only_fields=[]):
         # Raise error when trying to refresh a task that has not been saved
         if not self.saved:
             raise Task.NotSaved("Task needs to be saved to be refreshed")
@@ -402,8 +448,19 @@ class Task(TaskResource):
         # with using UUID only.
         args = [self['uuid'] or self['id'], 'export']
         new_data = json.loads(self.warrior.execute_command(args)[0])
-        self._load_data(new_data)
+        if only_fields:
+            to_update = dict(
+                [(k, new_data.get(k)) for k in only_fields])
+            self._update_data(to_update, update_original=True)
+        else:
+            self._load_data(new_data)
+
+    def export_data(self):
+        """
+        Exports current data contained in the Task as JSON
+        """
 
+        return json.dumps(self._data)
 
 class TaskFilter(SerializingObject):
     """