X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/faa9531194cd3657ce1e2f40e6e8067ac546958c..58f3ecf4ed9351d3226b3ac0152ec56313f79431:/tasklib/task.py?ds=sidebyside diff --git a/tasklib/task.py b/tasklib/task.py index 3a58e50..f61fb05 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -24,15 +24,98 @@ class TaskWarriorException(Exception): pass -class TaskResource(object): +class SerializingObject(object): + """ + Common ancestor for TaskResource & TaskFilter, since they both + need to serialize arguments. + """ + + def _deserialize(self, key, value): + hydrate_func = getattr(self, 'deserialize_{0}'.format(key), + lambda x: x if x != '' else None) + return hydrate_func(value) + + def _serialize(self, key, value): + dehydrate_func = getattr(self, 'serialize_{0}'.format(key), + lambda x: x if x is not None else '') + return dehydrate_func(value) + + def timestamp_serializer(self, date): + if not date: + return None + return date.strftime(DATE_FORMAT) + + def timestamp_deserializer(self, date_str): + if not date_str: + return None + return datetime.datetime.strptime(date_str, DATE_FORMAT) + + def serialize_entry(self, value): + return self.timestamp_serializer(value) + + def deserialize_entry(self, value): + return self.timestamp_deserializer(value) + + def serialize_modified(self, value): + return self.timestamp_serializer(value) + + def deserialize_modified(self, value): + return self.timestamp_deserializer(value) + + def serialize_due(self, value): + return self.timestamp_serializer(value) + + def deserialize_due(self, value): + return self.timestamp_deserializer(value) + + def serialize_scheduled(self, value): + return self.timestamp_serializer(value) + + def deserialize_scheduled(self, value): + return self.timestamp_deserializer(value) + + def serialize_until(self, value): + return self.timestamp_serializer(value) + + def deserialize_until(self, value): + return self.timestamp_deserializer(value) + + def serialize_wait(self, value): + return self.timestamp_serializer(value) + + def deserialize_wait(self, value): + return self.timestamp_deserializer(value) + + def deserialize_annotations(self, data): + return [TaskAnnotation(self, d) for d in data] if data else [] + + def serialize_tags(self, tags): + return ','.join(tags) if tags else '' + + def deserialize_tags(self, tags): + if isinstance(tags, six.string_types): + return tags.split(',') if tags else [] + return tags or [] + + def serialize_depends(self, cur_dependencies): + # Return the list of uuids + return ','.join(task['uuid'] for task in cur_dependencies) + + def deserialize_depends(self, raw_uuids): + raw_uuids = raw_uuids or '' # Convert None to empty string + uuids = raw_uuids.split(',') + return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid) + + +class TaskResource(SerializingObject): read_only_fields = [] def _load_data(self, data): - self._data = data + self._data = dict((key, self._deserialize(key, value)) + for key, value in data.items()) # We need to use a copy for original data, so that changes - # are not propagated. Shallow copy is alright, since data dict uses only - # primitive data types - self._original_data = data.copy() + # are not propagated. + self._original_data = copy.deepcopy(self._data) def _update_data(self, data, update_original=False): """ @@ -40,11 +123,12 @@ class TaskResource(object): updates should already be serialized. If update_original is True, the original_data dict is updated as well. """ - - self._data.update(data) + self._data.update(dict((key, self._deserialize(key, value)) + for key, value in data.items())) if update_original: - self._original_data.update(data) + self._original_data = copy.deepcopy(self._data) + def __getitem__(self, key): # This is a workaround to make TaskResource non-iterable @@ -55,22 +139,15 @@ class TaskResource(object): except ValueError: pass - return self._deserialize(key, self._data.get(key)) + 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: raise RuntimeError('Field \'%s\' is read-only' % key) - self._data[key] = self._serialize(key, value) - - def _deserialize(self, key, value): - hydrate_func = getattr(self, 'deserialize_{0}'.format(key), - lambda x: x) - return hydrate_func(value) - - def _serialize(self, key, value): - dehydrate_func = getattr(self, 'serialize_{0}'.format(key), - lambda x: x) - return dehydrate_func(value) + self._data[key] = value def __str__(self): s = six.text_type(self.__unicode__()) @@ -89,18 +166,17 @@ class TaskAnnotation(TaskResource): self.task = task self._load_data(data) - def deserialize_entry(self, data): - return datetime.datetime.strptime(data, DATE_FORMAT) if data else None - - def serialize_entry(self, date): - return date.strftime(DATE_FORMAT) if date else '' - def remove(self): self.task.remove_annotation(self) 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__ @@ -169,9 +245,21 @@ class Task(TaskResource): 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 + def _is_modified(self): + return bool(list(self._modified_fields)) + @property def completed(self): return self['status'] == six.text_type('completed') @@ -192,16 +280,6 @@ class Task(TaskResource): def saved(self): return self['uuid'] is not None or self['id'] is not None - def serialize_due(self, date): - if not date: - return None - return date.strftime(DATE_FORMAT) - - def deserialize_due(self, date_str): - if not date_str: - return None - return datetime.datetime.strptime(date_str, DATE_FORMAT) - def serialize_depends(self, cur_dependencies): # Check that all the tasks are saved for task in cur_dependencies: @@ -209,13 +287,7 @@ class Task(TaskResource): raise Task.NotSaved('Task \'%s\' needs to be saved before ' 'it can be set as dependency.' % task) - # Return the list of uuids - return ','.join(task['uuid'] for task in cur_dependencies) - - def deserialize_depends(self, raw_uuids): - raw_uuids = raw_uuids or '' # Convert None to empty string - uuids = raw_uuids.split(',') - return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid) + return super(Task, self).serialize_depends(cur_dependencies) def format_depends(self): # We need to generate added and removed dependencies list, @@ -225,8 +297,7 @@ class Task(TaskResource): # to keep a list of all depedencies in the _data dictionary, # not just currently added/removed ones - old_dependencies_raw = self._original_data.get('depends','') - old_dependencies = self.deserialize_depends(old_dependencies_raw) + old_dependencies = self._original_data.get('depends', set()) added = self['depends'] - old_dependencies removed = old_dependencies - self['depends'] @@ -237,17 +308,6 @@ class Task(TaskResource): ['-' + t['uuid'] for t in removed] ) - def deserialize_annotations(self, data): - return [TaskAnnotation(self, d) for d in data] if data else [] - - def deserialize_tags(self, tags): - if isinstance(tags, basestring): - return tags.split(',') if tags else [] - return tags - - 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 @@ -290,6 +350,9 @@ class Task(TaskResource): self.refresh(only_fields=['status']) def save(self): + if self.saved and not self._is_modified: + return + args = [self['uuid'], 'modify'] if self.saved else ['add'] args.extend(self._get_modified_fields_as_args()) output = self.warrior.execute_command(args) @@ -319,7 +382,7 @@ class Task(TaskResource): def remove_annotation(self, annotation): if not self.saved: - raise Task.NotSaved("Task needs to be saved to add annotation") + raise Task.NotSaved("Task needs to be saved to remove annotation") if isinstance(annotation, TaskAnnotation): annotation = annotation['description'] @@ -333,9 +396,13 @@ class Task(TaskResource): def add_field(field): # 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 '') + serialized_value = self._serialize(field, self._data[field]) or '' + format_default = lambda: "{0}:{1}".format( + field, + "'{0}'".format(serialized_value) if serialized_value else '' + ) format_func = getattr(self, 'format_{0}'.format(field), - lambda: format_default(field)) + format_default) args.append(format_func()) # If we're modifying saved task, simply pass on all modified fields @@ -369,7 +436,7 @@ class Task(TaskResource): self._load_data(new_data) -class TaskFilter(object): +class TaskFilter(SerializingObject): """ A set of parameters to filter the task list with. """ @@ -385,14 +452,23 @@ class TaskFilter(object): # Replace the value with empty string, since that is the # convention in TW for empty values - value = value if value is not None else '' + attribute_key = key.split('.')[0] + value = self._serialize(attribute_key, value) # If we are filtering by uuid:, do not use uuid keyword # due to TW-1452 bug if key == 'uuid': self.filter_params.insert(0, value) else: - self.filter_params.append('{0}:{1}'.format(key, value)) + # Surround value with aphostrophes unless it's a empty string + value = "'%s'" % value if value else '' + + # We enforce equality match by using 'is' (or 'none') modifier + # Without using this syntax, filter fails due to TW-1479 + modifier = '.is' if value else '.none' + key = key + modifier if '.' not in key else key + + self.filter_params.append("{0}:{1}".format(key, value)) def get_filter_params(self): return [f for f in self.filter_params if f] @@ -521,6 +597,7 @@ class TaskWarrior(object): self.config = { 'data.location': os.path.expanduser(data_location), 'confirmation': 'no', + 'dependency.confirmation': 'no', # See TW-1483 or taskrc man page } self.tasks = TaskQuerySet(self) self.version = self._get_version()