X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/0217f08c8bd255be1a64803bb359e66cf1e9fb59..55f248ccc3e7c132258f396583ba96effa3ff4a0:/tasklib/task.py diff --git a/tasklib/task.py b/tasklib/task.py index 9246e1f..bb3fa53 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -1,8 +1,10 @@ +from __future__ import print_function import copy import datetime import json import logging import os +import six import subprocess DATE_FORMAT = '%Y%m%dT%H%M%SZ' @@ -10,6 +12,11 @@ REPR_OUTPUT_SIZE = 10 PENDING = 'pending' COMPLETED = 'completed' +VERSION_2_1_0 = six.u('2.1.0') +VERSION_2_2_0 = six.u('2.2.0') +VERSION_2_3_0 = six.u('2.3.0') +VERSION_2_4_0 = six.u('2.4.0') + logger = logging.getLogger(__name__) @@ -17,18 +24,11 @@ class TaskWarriorException(Exception): pass -class Task(object): - - class DoesNotExist(Exception): - pass +class TaskResource(object): + read_only_fields = [] - def __init__(self, warrior, data={}): - self.warrior = warrior + def _load_data(self, data): self._data = data - self._modified_fields = set() - - def __unicode__(self): - return self['description'] def __getitem__(self, key): hydrate_func = getattr(self, 'deserialize_{0}'.format(key), @@ -36,11 +36,102 @@ class Task(object): return hydrate_func(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) + def __str__(self): + s = six.text_type(self.__unicode__()) + if not six.PY3: + s = s.encode('utf-8') + return s + + def __repr__(self): + return str(self) + + +class TaskAnnotation(TaskResource): + read_only_fields = ['entry', 'description'] + + def __init__(self, task, data={}): + 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'] + + __repr__ = __unicode__ + + +class Task(TaskResource): + read_only_fields = ['id', 'entry', 'urgency', 'uuid'] + + class DoesNotExist(Exception): + pass + + class CompletedTask(Exception): + """ + Raised when the operation cannot be performed on the completed task. + """ + pass + + class DeletedTask(Exception): + """ + Raised when the operation cannot be performed on the deleted task. + """ + pass + + class NotSaved(Exception): + """ + Raised when the operation cannot be performed on the task, because + it has not been saved to TaskWarrior yet. + """ + pass + + def __init__(self, warrior, data={}, **kwargs): + self.warrior = warrior + + # We keep data for backwards compatibility + kwargs.update(data) + + self._load_data(kwargs) + self._modified_fields = set() + + def __unicode__(self): + return self['description'] + + @property + def completed(self): + return self['status'] == six.text_type('completed') + + @property + def deleted(self): + return self['status'] == six.text_type('deleted') + + @property + def waiting(self): + return self['status'] == six.text_type('waiting') + + @property + def pending(self): + return self['status'] == six.text_type('pending') + + @property + 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) @@ -49,18 +140,8 @@ class Task(object): return None return datetime.datetime.strptime(date_str, DATE_FORMAT) - def serialize_annotations(self, annotations): - ann_list = list(annotations) - for ann in ann_list: - ann['entry'] = ann['entry'].strftime(DATE_FORMAT) - return ann_list - - def deserialize_annotations(self, annotations): - ann_list = list(annotations) - for ann in ann_list: - ann['entry'] = datetime.datetime.strptime( - ann['entry'], DATE_FORMAT) - return ann_list + 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): @@ -71,26 +152,119 @@ class Task(object): return ','.join(tags) if tags else '' def delete(self): - self.warrior.execute_command([self['id'], 'delete'], config_override={ + 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']) + + if self.deleted: + raise Task.DeletedTask("Task was already deleted") + + self.warrior.execute_command([self['uuid'], 'delete'], config_override={ 'confirmation': 'no', }) + # Refresh the status again, so that we have updated info stored + self.refresh(only_fields=['status']) + + def done(self): - self.warrior.execute_command([self['id'], 'done']) + if not self.saved: + 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']) + + if self.completed: + raise Task.CompletedTask("Cannot complete a completed task") + elif self.deleted: + raise Task.DeletedTask("Deleted task cannot be completed") + + self.warrior.execute_command([self['uuid'], 'done']) + + # Refresh the status again, so that we have updated info stored + self.refresh(only_fields=['status']) def save(self): - args = [self['id'], 'modify'] if self['id'] else ['add'] + args = [self['uuid'], 'modify'] if self.saved else ['add'] args.extend(self._get_modified_fields_as_args()) - self.warrior.execute_command(args) + output = self.warrior.execute_command(args) + + # Parse out the new ID, if the task is being added for the first time + if not self.saved: + id_lines = [l for l in output if l.startswith('Created task ')] + + # Complain loudly if it seems that more tasks were created + # Should not happen + if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3: + raise TaskWarriorException("Unexpected output when creating " + "task: %s" % '\n'.join(id_lines)) + + # 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): + if not self.saved: + raise Task.NotSaved("Task needs to be saved to add annotation") + + args = [self['uuid'], 'annotate', annotation] + self.warrior.execute_command(args) + self.refresh(only_fields=['annotations']) + + def remove_annotation(self, annotation): + if not self.saved: + raise Task.NotSaved("Task needs to be saved to add annotation") + + if isinstance(annotation, TaskAnnotation): + annotation = annotation['description'] + args = [self['uuid'], 'denotate', annotation] + self.warrior.execute_command(args) + self.refresh(only_fields=['annotations']) def _get_modified_fields_as_args(self): args = [] - for field in self._modified_fields: - args.append('{}:{}'.format(field, self._data[field])) + + 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])) + + # If we're modifying saved task, simply pass on all modified fields + if self.saved: + for field in self._modified_fields: + add_field(field) + # For new tasks, pass all fields that make sense + else: + for field in self._data.keys(): + if field in self.read_only_fields: + continue + add_field(field) + return args - __repr__ = __unicode__ + def refresh(self, only_fields=[]): + # 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") + + # We need to use ID as backup for uuid here for the refreshes + # of newly saved tasks. Any other place in the code is fine + # 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 class TaskFilter(object): @@ -106,7 +280,17 @@ class TaskFilter(object): def add_filter_param(self, key, value): key = key.replace('__', '.') - self.filter_params.append('{0}:{1}'.format(key, value)) + + # Replace the value with empty string, since that is the + # convention in TW for empty values + value = value if value is not None else '' + + # 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)) def get_filter_params(self): return [f for f in self.filter_params if f] @@ -236,6 +420,7 @@ class TaskWarrior(object): 'data.location': os.path.expanduser(data_location), } self.tasks = TaskQuerySet(self) + self.version = self._get_version() def _get_command_args(self, args, config_override={}): command_args = ['task', 'rc:/'] @@ -246,13 +431,21 @@ class TaskWarrior(object): command_args.extend(map(str, args)) return command_args + def _get_version(self): + p = subprocess.Popen( + ['task', '--version'], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE) + stdout, stderr = [x.decode('utf-8') for x in p.communicate()] + return stdout.strip('\n') + def execute_command(self, args, config_override={}): command_args = self._get_command_args( args, config_override=config_override) logger.debug(' '.join(command_args)) p = subprocess.Popen(command_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = [x.decode() for x in p.communicate()] + stdout, stderr = [x.decode('utf-8') for x in p.communicate()] if p.returncode: if stderr.strip(): error_msg = stderr.strip().splitlines()[-1]