X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/0ea1b0d359dc80d2bef66971b523a26515e90fee..b54a08fa5d4f436dd212abba509504c02bae28a2:/tasklib/task.py diff --git a/tasklib/task.py b/tasklib/task.py index f7afbf2..6392b9e 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -24,7 +24,90 @@ 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 + + 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): @@ -62,16 +145,6 @@ class TaskResource(object): 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) - def __str__(self): s = six.text_type(self.__unicode__()) if not six.PY3: @@ -89,12 +162,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 +199,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 @@ -187,16 +259,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 +266,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, @@ -232,17 +288,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 @@ -314,7 +359,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'] @@ -364,7 +409,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. """ @@ -380,14 +425,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] @@ -516,6 +570,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()