X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/f04af3994208c8889f51c680860dd47351a45f4d..48d272800ebe0432e120ec95c357932a23a2cf21:/tasklib/task.py?ds=inline diff --git a/tasklib/task.py b/tasklib/task.py index 1bd3ce7..d5913af 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -24,27 +24,98 @@ class TaskWarriorException(Exception): pass -class TaskResource(object): - read_only_fields = [] +class SerializingObject(object): + """ + Common ancestor for TaskResource & TaskFilter, since they both + need to serialize arguments. + """ - def _load_data(self, data): - self._data = data - # 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() + 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 _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. - """ + 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) - self._data.update(data) + def deserialize_scheduled(self, value): + return self.timestamp_deserializer(value) - if update_original: - self._original_data.update(data) + 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 = 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): # This is a workaround to make TaskResource non-iterable @@ -55,22 +126,12 @@ class TaskResource(object): except ValueError: pass - return self._deserialize(key, self._data.get(key)) + return self._data.get(key) or self._deserialize(key, None) 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,12 +150,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) @@ -132,6 +187,11 @@ class Task(TaskResource): def __init__(self, warrior, **kwargs): 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 @@ -167,6 +227,10 @@ class Task(TaskResource): 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): return self['status'] == six.text_type('completed') @@ -187,16 +251,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: @@ -204,13 +258,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, @@ -220,45 +268,39 @@ 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'] # Removed dependencies need to be prefixed with '-' - return ','.join( + return 'depends:' + ','.join( [t['uuid'] for t in added] + ['-' + 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 + 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): @@ -266,7 +308,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") @@ -276,9 +318,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) @@ -304,31 +349,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]) - 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) + 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: @@ -343,7 +386,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") @@ -353,15 +396,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._update_data(to_update, update_original=True) - else: - self._load_data(new_data) + self._load_data(new_data) -class TaskFilter(object): +class TaskFilter(SerializingObject): """ A set of parameters to filter the task list with. """ @@ -377,14 +415,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] @@ -512,6 +559,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() @@ -569,6 +618,4 @@ class TaskWarrior(object): }) def undo(self): - self.execute_command(['undo'], config_override={ - 'confirmation': 'no', - }) + self.execute_command(['undo'])