Tests: Cover setting read only attributes

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

diff --git a/tasklib/task.py b/tasklib/task.py
index d9b2678e084b89fb3e7a75867b0fa0f07bbf02e7..3a58e50895c0ad0d739930a44c1487e813b24e15 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -30,9 +30,22 @@ class TaskResource(object):
     def _load_data(self, data):
         self._data = data
         # We need to use a copy for original data, so that changes
     def _load_data(self, data):
         self._data = data
         # We need to use a copy for original data, so that changes

-        # are not propagated
+        # are not propagated. Shallow copy is alright, since data dict uses only
+        # primitive data types

         self._original_data = data.copy()
 
         self._original_data = data.copy()
 

+    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(data)
+
+        if update_original:
+            self._original_data.update(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


@@ -116,9 +129,14 @@ class Task(TaskResource):
         """
         pass
 
         """
         pass
 

-    def __init__(self, warrior, data={}, **kwargs):
+    def __init__(self, warrior, **kwargs):

         self.warrior = warrior
 
         self.warrior = warrior
 

+        # Check that user is not able to set read-only value in __init__
+        for key in kwargs.keys():
+            if key in self.read_only_fields:
+                raise RuntimeError('Field \'%s\' is read-only' % key)
+

         # We serialize the data in kwargs so that users of the library
         # do not have to pass different data formats via __setitem__ and
         # __init__ methods, that would be confusing
         # We serialize the data in kwargs so that users of the library
         # do not have to pass different data formats via __setitem__ and
         # __init__ methods, that would be confusing


@@ -127,11 +145,6 @@ class Task(TaskResource):
         self._load_data(dict((key, self._serialize(key, value))
                         for (key, value) in six.iteritems(kwargs)))
 
         self._load_data(dict((key, self._serialize(key, value))
                         for (key, value) in six.iteritems(kwargs)))
 

-        # We keep data for backwards compatibility
-        # TODO: Should we keep this using unserialized access to _data dict?
-        self._data.update(data)
-        self._original_data.update(data)
-

     def __unicode__(self):
         return self['description']
 
     def __unicode__(self):
         return self['description']
 


@@ -219,7 +232,7 @@ class Task(TaskResource):
         removed = old_dependencies - self['depends']
 
         # Removed dependencies need to be prefixed with '-'
         removed = old_dependencies - self['depends']
 
         # Removed dependencies need to be prefixed with '-'

-        return ','.join(
+        return 'depends:' + ','.join(

                 [t['uuid'] for t in added] +
                 ['-' + t['uuid'] for t in removed]
             )
                 [t['uuid'] for t in added] +
                 ['-' + t['uuid'] for t in removed]
             )


@@ -235,6 +248,14 @@ class Task(TaskResource):
     def serialize_tags(self, tags):
         return ','.join(tags) if tags else ''
 
     def serialize_tags(self, tags):
         return ','.join(tags) if tags else ''
 

+    def format_description(self):
+        # Task version older than 2.4.0 ignores first word of the
+        # task description if description: prefix is used
+        if self.warrior.version < VERSION_2_4_0:
+            return self._data['description']
+        else:
+            return "description:'{0}'".format(self._data['description'] or '')
+

     def delete(self):
         if not self.saved:
             raise Task.NotSaved("Task needs to be saved before it can be deleted")
     def delete(self):
         if not self.saved:
             raise Task.NotSaved("Task needs to be saved before it can be deleted")


@@ -245,9 +266,7 @@ class Task(TaskResource):
         if self.deleted:
             raise Task.DeletedTask("Task was already deleted")
 
         if self.deleted:
             raise Task.DeletedTask("Task was already deleted")
 

-        self.warrior.execute_command([self['uuid'], 'delete'], config_override={
-            'confirmation': 'no',
-        })
+        self.warrior.execute_command([self['uuid'], 'delete'])

 
         # Refresh the status again, so that we have updated info stored
         self.refresh(only_fields=['status'])
 
         # Refresh the status again, so that we have updated info stored
         self.refresh(only_fields=['status'])


@@ -312,15 +331,12 @@ class Task(TaskResource):
         args = []
 
         def add_field(field):
         args = []
 
         def add_field(field):

-            # Task version older than 2.4.0 ignores first word of the
-            # task description if description: prefix is used
-            if self.warrior.version < VERSION_2_4_0 and field == 'description':
-                args.append(self._data[field])
-            elif field == 'depends':
-                args.append('{0}:{1}'.format(field, self.format_depends()))
-            else:
-                # Use empty string to substitute for None value
-                args.append('{0}:{1}'.format(field, self._data[field] or ''))
+            # Add the output of format_field method to args list (defaults to
+            # field:value)
+            format_default = lambda k: "{0}:'{1}'".format(k, self._data[k] or '')
+            format_func = getattr(self, 'format_{0}'.format(field),
+                                  lambda: format_default(field))
+            args.append(format_func())

 
         # If we're modifying saved task, simply pass on all modified fields
         if self.saved:
 
         # If we're modifying saved task, simply pass on all modified fields
         if self.saved:


@@ -348,14 +364,9 @@ class Task(TaskResource):
         if only_fields:
             to_update = dict(
                 [(k, new_data.get(k)) for k in only_fields])
         if only_fields:
             to_update = dict(
                 [(k, new_data.get(k)) for k in only_fields])

-            self._data.update(to_update)
-            self._original_data.update(to_update)
+            self._update_data(to_update, update_original=True)

         else:
         else:

-            self._data = new_data
-            # We need to create a clone for original_data though
-            # Shallow copy is alright, since data dict uses only
-            # primitive data types
-            self._original_data = new_data.copy()
+            self._load_data(new_data)

 
 
 class TaskFilter(object):
 
 
 class TaskFilter(object):


@@ -509,6 +520,7 @@ class TaskWarrior(object):
             os.makedirs(data_location)
         self.config = {
             'data.location': os.path.expanduser(data_location),
             os.makedirs(data_location)
         self.config = {
             'data.location': os.path.expanduser(data_location),

+            'confirmation': 'no',

         }
         self.tasks = TaskQuerySet(self)
         self.version = self._get_version()
         }
         self.tasks = TaskQuerySet(self)
         self.version = self._get_version()


@@ -552,7 +564,9 @@ class TaskWarrior(object):
             if line:
                 data = line.strip(',')
                 try:
             if line:
                 data = line.strip(',')
                 try:

-                    tasks.append(Task(self, json.loads(data)))
+                    filtered_task = Task(self)
+                    filtered_task._load_data(json.loads(data))
+                    tasks.append(filtered_task)

                 except ValueError:
                     raise TaskWarriorException('Invalid JSON: %s' % data)
         return tasks
                 except ValueError:
                     raise TaskWarriorException('Invalid JSON: %s' % data)
         return tasks


@@ -564,6 +578,4 @@ class TaskWarrior(object):
         })
 
     def undo(self):
         })
 
     def undo(self):

-        self.execute_command(['undo'], config_override={
-            'confirmation': 'no',
-        })
+        self.execute_command(['undo'])