X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/351a4268660a1d24d7893b2e3ce8daa8f131f966..534403b480471617e4cf509bc085a55eadce1e49:/tasklib/task.py diff --git a/tasklib/task.py b/tasklib/task.py index 336c050..a739d25 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -24,24 +24,117 @@ 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, basestring): + 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. + self._original_data = copy.deepcopy(self._data) def __getitem__(self, key): - hydrate_func = getattr(self, 'deserialize_{0}'.format(key), - lambda x: x) - return hydrate_func(self._data.get(key)) + # This is a workaround to make TaskResource non-iterable + # over simple index-based iteration + try: + int(key) + raise StopIteration + except ValueError: + pass + + 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) - dehydrate_func = getattr(self, 'serialize_{0}'.format(key), - lambda x: x) - self._data[key] = dehydrate_func(value) - self._modified_fields.add(key) + self._data[key] = value def __str__(self): s = six.text_type(self.__unicode__()) @@ -60,12 +153,6 @@ 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) @@ -76,7 +163,7 @@ class TaskAnnotation(TaskResource): class Task(TaskResource): - read_only_fields = ['id', 'entry', 'urgency', 'uuid'] + read_only_fields = ['id', 'entry', 'urgency', 'uuid', 'modified'] class DoesNotExist(Exception): pass @@ -100,23 +187,52 @@ class Task(TaskResource): """ pass - def __init__(self, warrior, data={}, **kwargs): + def __init__(self, warrior, **kwargs): self.warrior = warrior - # We keep data for backwards compatibility - kwargs.update(data) + # 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) - self._load_data(kwargs) - self._modified_fields = set() + # 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 + + # Rather unfortunate syntax due to python2.6 comaptiblity + self._load_data(dict((key, self._serialize(key, value)) + for (key, value) in six.iteritems(kwargs))) def __unicode__(self): return self['description'] def __eq__(self, other): - return self['uuid'] == other['uuid'] + if self['uuid'] and other['uuid']: + # For saved Tasks, just define equality by equality of uuids + return self['uuid'] == other['uuid'] + else: + # If the tasks are not saved, compare the actual instances + return id(self) == id(other) + def __hash__(self): - return self['uuid'].__hash__() + if self['uuid']: + # For saved Tasks, just define equality by equality of uuids + return self['uuid'].__hash__() + else: + # If the tasks are not saved, return hash of instance id + return id(self).__hash__() + + @property + 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): + yield key + + @property + def _is_modified(self): + return bool(list(self._modified_fields)) @property def completed(self): @@ -138,41 +254,56 @@ class Task(TaskResource): def saved(self): return self['uuid'] is not None or self['id'] is not None - def serialize_due(self, date): - return date.strftime(DATE_FORMAT) + def serialize_depends(self, cur_dependencies): + # Check that all the tasks are saved + for task in cur_dependencies: + if not task.saved: + raise Task.NotSaved('Task \'%s\' needs to be saved before ' + 'it can be set as dependency.' % task) - def deserialize_due(self, date_str): - if not date_str: - return None - return datetime.datetime.strptime(date_str, DATE_FORMAT) + return super(Task, self).serialize_depends(cur_dependencies) - def deserialize_annotations(self, data): - return [TaskAnnotation(self, d) for d in data] if data else [] + def format_depends(self): + # We need to generate added and removed dependencies list, + # since Taskwarrior does not accept redefining dependencies. - def deserialize_tags(self, tags): - if isinstance(tags, basestring): - return tags.split(',') if tags else [] - return tags + # This cannot be part of serialize_depends, since we need + # to keep a list of all depedencies in the _data dictionary, + # not just currently added/removed ones - def serialize_tags(self, tags): - return ','.join(tags) if tags else '' + old_dependencies = self._original_data.get('depends', set()) + + added = self['depends'] - old_dependencies + removed = old_dependencies - self['depends'] + + # Removed dependencies need to be prefixed with '-' + return 'depends:' + ','.join( + [t['uuid'] for t in added] + + ['-' + t['uuid'] for t in removed] + ) + + 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") # Refresh the status, and raise exception if the task is deleted - self.refresh(only_fields=['status']) + self.refresh() 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']) + self.refresh() def done(self): @@ -180,7 +311,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(only_fields=['status']) + self.refresh() if self.completed: raise Task.CompletedTask("Cannot complete a completed task") @@ -190,9 +321,12 @@ class Task(TaskResource): self.warrior.execute_command([self['uuid'], 'done']) # Refresh the status again, so that we have updated info stored - self.refresh(only_fields=['status']) + self.refresh() 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) @@ -210,7 +344,6 @@ class Task(TaskResource): # Circumvent the ID storage, since ID is considered read-only self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.')) - self._modified_fields.clear() self.refresh() def add_annotation(self, annotation): @@ -219,28 +352,29 @@ class Task(TaskResource): args = [self['uuid'], 'annotate', annotation] self.warrior.execute_command(args) - self.refresh(only_fields=['annotations']) + self.refresh() 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'] args = [self['uuid'], 'denotate', annotation] self.warrior.execute_command(args) - self.refresh(only_fields=['annotations']) + self.refresh() def _get_modified_fields_as_args(self): 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]) - else: - args.append('{0}:{1}'.format(field, self._data[field])) + # 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_func = getattr(self, 'format_{0}'.format(field), + format_default) + args.append(format_func()) # If we're modifying saved task, simply pass on all modified fields if self.saved: @@ -255,7 +389,7 @@ class Task(TaskResource): return args - def refresh(self, only_fields=[]): + def refresh(self): # 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") @@ -265,15 +399,10 @@ class Task(TaskResource): # with using UUID only. args = [self['uuid'] or self['id'], 'export'] new_data = json.loads(self.warrior.execute_command(args)[0]) - if only_fields: - to_update = dict( - [(k, new_data.get(k)) for k in only_fields]) - self._data.update(to_update) - else: - self._data = new_data + self._load_data(new_data) -class TaskFilter(object): +class TaskFilter(SerializingObject): """ A set of parameters to filter the task list with. """ @@ -289,14 +418,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] @@ -424,6 +562,8 @@ class TaskWarrior(object): os.makedirs(data_location) 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() @@ -467,7 +607,9 @@ class TaskWarrior(object): 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 @@ -479,6 +621,4 @@ class TaskWarrior(object): }) def undo(self): - self.execute_command(['undo'], config_override={ - 'confirmation': 'no', - }) + self.execute_command(['undo'])