Merge pull request #25 from tbabej/deserialized-data-dict

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

diff --git a/tasklib/task.py b/tasklib/task.py
index d5913af9adda62e66f05bb7931410c94a0000f37..f61fb056591c3afb22486ad62a30f78c586c8918 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -93,7 +93,7 @@ class SerializingObject(object):
         return ','.join(tags) if tags else ''
 
     def deserialize_tags(self, tags):
         return ','.join(tags) if tags else ''
 
     def deserialize_tags(self, tags):

-        if isinstance(tags, basestring):
+        if isinstance(tags, six.string_types):

             return tags.split(',') if tags else []
         return tags or []
 
             return tags.split(',') if tags else []
         return tags or []
 


@@ -117,6 +117,19 @@ class TaskResource(SerializingObject):
         # are not propagated.
         self._original_data = copy.deepcopy(self._data)
 
         # 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
     def __getitem__(self, key):
         # This is a workaround to make TaskResource non-iterable
         # over simple index-based iteration


@@ -126,7 +139,10 @@ class TaskResource(SerializingObject):
         except ValueError:
             pass
 
         except ValueError:
             pass
 

-        return self._data.get(key) or self._deserialize(key, None)
+        if key not in self._data:
+            self._data[key] = self._deserialize(key, None)
+
+        return self._data.get(key)

 
     def __setitem__(self, key, value):
         if key in self.read_only_fields:
 
     def __setitem__(self, key, value):
         if key in self.read_only_fields:


@@ -156,6 +172,11 @@ class TaskAnnotation(TaskResource):
     def __unicode__(self):
         return self['description']
 
     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__
 
 
     __repr__ = __unicode__
 
 


@@ -224,7 +245,15 @@ class Task(TaskResource):
     def _modified_fields(self):
         writable_fields = set(self._data.keys()) - set(self.read_only_fields)
         for key in writable_fields:
     def _modified_fields(self):
         writable_fields = set(self._data.keys()) - set(self.read_only_fields)
         for key in writable_fields:

-            if self._data.get(key) != self._original_data.get(key):
+            new_value = self._data.get(key)
+            old_value = self._original_data.get(key)
+
+            # Make sure not to mark data removal as modified field if the
+            # field originally had some empty value
+            if key in self._data and not new_value and not old_value:
+                continue
+
+            if new_value != old_value:

                 yield key
 
     @property
                 yield key
 
     @property


@@ -292,7 +321,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
             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")
 
         if self.deleted:
             raise Task.DeletedTask("Task was already deleted")


@@ -300,7 +329,7 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'delete'])
 
         # Refresh the status again, so that we have updated info stored
         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):
 
 
     def done(self):


@@ -308,7 +337,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
             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")
 
         if self.completed:
             raise Task.CompletedTask("Cannot complete a completed task")


@@ -318,7 +347,7 @@ class Task(TaskResource):
         self.warrior.execute_command([self['uuid'], 'done'])
 
         # Refresh the status again, so that we have updated info stored
         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:
 
     def save(self):
         if self.saved and not self._is_modified:


@@ -349,7 +378,7 @@ class Task(TaskResource):
 
         args = [self['uuid'], 'annotate', annotation]
         self.warrior.execute_command(args)
 
         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:
 
     def remove_annotation(self, annotation):
         if not self.saved:


@@ -359,7 +388,7 @@ class Task(TaskResource):
             annotation = annotation['description']
         args = [self['uuid'], 'denotate', annotation]
         self.warrior.execute_command(args)
             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 = []
 
     def _get_modified_fields_as_args(self):
         args = []


@@ -368,7 +397,10 @@ class Task(TaskResource):
             # Add the output of format_field method to args list (defaults to
             # field:value)
             serialized_value = self._serialize(field, self._data[field]) or ''
             # Add the output of format_field method to args list (defaults to
             # field:value)
             serialized_value = self._serialize(field, self._data[field]) or ''

-            format_default = lambda: "{0}:'{1}'".format(field, serialized_value)
+            format_default = lambda: "{0}:{1}".format(
+                field,
+                "'{0}'".format(serialized_value) if serialized_value else ''
+            )

             format_func = getattr(self, 'format_{0}'.format(field),
                                   format_default)
             args.append(format_func())
             format_func = getattr(self, 'format_{0}'.format(field),
                                   format_default)
             args.append(format_func())


@@ -386,7 +418,7 @@ class Task(TaskResource):
 
         return args
 
 
         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")
         # 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")


@@ -396,7 +428,12 @@ class Task(TaskResource):
         # with using UUID only.
         args = [self['uuid'] or self['id'], 'export']
         new_data = json.loads(self.warrior.execute_command(args)[0])
         # 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)

 
 
 class TaskFilter(SerializingObject):
 
 
 class TaskFilter(SerializingObject):