X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/57c5057d9885ce0020fca03b83d1c75f6143fdc3..4896cf0df68b68e931e621b7cb160fd566ae182d:/tasklib/task.py?ds=inline diff --git a/tasklib/task.py b/tasklib/task.py index 85ba042..36f3c3b 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -1,48 +1,120 @@ +from __future__ import print_function import copy import datetime import json +import logging import os +import six import subprocess -import tempfile -import uuid - DATE_FORMAT = '%Y%m%dT%H%M%SZ' - REPR_OUTPUT_SIZE = 10 - PENDING = 'pending' +COMPLETED = 'completed' + +logger = logging.getLogger(__name__) class TaskWarriorException(Exception): pass -class Task(object): +class TaskResource(object): + read_only_fields = [] + + def _load_data(self, data): + self._data = data + + def __getitem__(self, key): + hydrate_func = getattr(self, 'deserialize_{0}'.format(key), + lambda x: x) + 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 + def __init__(self, warrior, data={}): self.warrior = warrior - self._data = data + self._load_data(data) + self._modified_fields = set() - def __getitem__(self, key): - return self._get_field(key) + def __unicode__(self): + return self['description'] - def __setitem__(self, key, val): - self._data[key] = val + @property + def completed(self): + return self['status'] == six.text_type('completed') - def __unicode__(self): - return self._data.get('description') + @property + def deleted(self): + return self['status'] == six.text_type('deleted') - def _get_field(self, key): - hydrate_func = getattr(self, 'deserialize_{0}'.format(key), lambda x:x) - return hydrate_func(self._data.get(key)) + @property + def waiting(self): + return self['status'] == six.text_type('waiting') - def _set_field(self, key, value): - dehydrate_func = getattr(self, 'serialize_{0}'.format(key), lambda x:x) - self._data[key] = dehydrate_func(value) + @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) @@ -52,23 +124,113 @@ class Task(object): return None return datetime.datetime.strptime(date_str, DATE_FORMAT) - def regenerate_uuid(self): - self['uuid'] = str(uuid.uuid4()) + 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 delete(self): - self.warrior.delete_task(self['uuid']) + # Refresh the status, and raise exception if the task is deleted + self.refresh(only_fields=['status']) - def done(self): - self.warrior.complete_task(self['uuid']) + if self.deleted: + raise self.DeletedTask("Task was already deleted") - def save(self, delete_first=True): - if self['uuid'] and delete_first: - self.delete() - if not self['uuid'] or delete_first: - self.regenerate_uuid() - self.warrior.import_tasks([self._data]) + 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']) - __repr__ = __unicode__ + + def done(self): + # Refresh, and raise exception if task is already completed/deleted + self.refresh(only_fields=['status']) + + if self.completed: + raise self.CompletedTask("Cannot complete a completed task") + elif self.deleted: + raise self.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['uuid'], 'modify'] if self.saved else ['add'] + args.extend(self._get_modified_fields_as_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): + args = [self['uuid'], 'annotate', annotation] + self.warrior.execute_command(args) + # TODO: This will not work with the tasks that are not yet saved + self.refresh(only_fields=['annotations']) + + def remove_annotation(self, annotation): + if isinstance(annotation, TaskAnnotation): + annotation = annotation['description'] + args = [self['uuid'], 'denotate', annotation] + self.warrior.execute_command(args) + # TODO: This will not work with the tasks that are not yet saved + self.refresh(only_fields=['annotations']) + + def _get_modified_fields_as_args(self): + args = [] + + # If we're modifying saved task, simply pass on all modified fields + if self.saved: + for field in self._modified_fields: + args.append('{0}:{1}'.format(field, self._data[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 + args.append('{0}:{1}'.format(field, self._data[field])) + + return args + + def refresh(self, only_fields=[]): + # Do not refresh for tasks that are not yet saved in the TW + if not self.saved: + return + + # 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): @@ -84,10 +246,14 @@ class TaskFilter(object): def add_filter_param(self, key, value): key = key.replace('__', '.') + + # Replace the value with empty string, since that is the + # convention in TW for empty values + value = value if value is not None else '' self.filter_params.append('{0}:{1}'.format(key, value)) def get_filter_params(self): - return ['({})'.format(f) for f in self.filter_params if f] + return [f for f in self.filter_params if f] def clone(self): c = self.__class__() @@ -110,8 +276,8 @@ class TaskQuerySet(object): Deep copy of a QuerySet doesn't populate the cache """ obj = self.__class__() - for k,v in self.__dict__.items(): - if k in ('_iter','_result_cache'): + for k, v in self.__dict__.items(): + if k in ('_iter', '_result_cache'): obj.__dict__[k] = None else: obj.__dict__[k] = copy.deepcopy(v, memo) @@ -162,7 +328,7 @@ class TaskQuerySet(object): """ Fetch the tasks which match the current filters. """ - return self.warrior._execute_filter(self.filter_obj) + return self.warrior.filter_tasks(self.filter_obj) def all(self): """ @@ -173,6 +339,9 @@ class TaskQuerySet(object): def pending(self): return self.filter(status=PENDING) + def completed(self): + return self.filter(status=COMPLETED) + def filter(self, *args, **kwargs): """ Returns a new TaskQuerySet with the given filters added. @@ -203,58 +372,58 @@ class TaskQuerySet(object): class TaskWarrior(object): - DEFAULT_FILTERS = { - 'status': 'pending', - } - def __init__(self, data_location='~/.task', create=True): - if not os.path.exists(data_location): + data_location = os.path.expanduser(data_location) + if create and not os.path.exists(data_location): os.makedirs(data_location) self.config = { 'data.location': os.path.expanduser(data_location), } self.tasks = TaskQuerySet(self) - def _get_command_args(self, args): + def _get_command_args(self, args, config_override={}): command_args = ['task', 'rc:/'] - for item in self.config.items(): + config = self.config.copy() + config.update(config_override) + for item in config.items(): command_args.append('rc.{0}={1}'.format(*item)) - command_args.extend(args) + command_args.extend(map(str, args)) return command_args - def _execute_command(self, args): - p = subprocess.Popen(self._get_command_args(args), - stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = p.communicate() + 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('utf-8') for x in p.communicate()] if p.returncode: - raise TaskWarriorException(stderr.strip()) + if stderr.strip(): + error_msg = stderr.strip().splitlines()[-1] + else: + error_msg = stdout.strip() + raise TaskWarriorException(error_msg) return stdout.strip().split('\n') - def _execute_filter(self, filter_obj): - args = filter_obj.get_filter_params() + ['export'] + def filter_tasks(self, filter_obj): + args = ['export', '--'] + filter_obj.get_filter_params() tasks = [] - for line in self._execute_command(args): + for line in self.execute_command(args): if line: - tasks.append(Task(self, json.loads(line.strip(',')))) + data = line.strip(',') + try: + tasks.append(Task(self, json.loads(data))) + except ValueError: + raise TaskWarriorException('Invalid JSON: %s' % data) return tasks - def add_task(self, description, project=None): - args = ['add', description] - if project is not None: - args.append('project:{0}'.format(project)) - self._execute_command(args) - - def delete_task(self, task_id): - args = [task_id, 'rc.confirmation:no', 'delete'] - self._execute_command(args) - - def complete_task(self, task_id): - args = [task_id, 'done'] - self._execute_command(args) - - def import_tasks(self, tasks): - fd, path = tempfile.mkstemp() - with open(path, 'w') as f: - f.write(json.dumps(tasks)) - args = ['import', path] - self._execute_command(args) + def merge_with(self, path, push=False): + path = path.rstrip('/') + '/' + self.execute_command(['merge', path], config_override={ + 'merge.autopush': 'yes' if push else 'no', + }) + + def undo(self): + self.execute_command(['undo'], config_override={ + 'confirmation': 'no', + })