X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/0a55d5e7c3a56be520fc0806b970a59d50ae3c2f..9811f65b56e9bdb15722179e59c722de6713ffa2:/tasklib/task.py?ds=sidebyside diff --git a/tasklib/task.py b/tasklib/task.py index c3f8f3e..491a374 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -1,13 +1,16 @@ +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' REPR_OUTPUT_SIZE = 10 PENDING = 'pending' +COMPLETED = 'completed' logger = logging.getLogger(__name__) @@ -16,19 +19,11 @@ class TaskWarriorException(Exception): pass -class Task(object): +class TaskResource(object): + read_only_fields = [] - class DoesNotExist(Exception): - pass - - def __init__(self, warrior, data={}): - self.warrior = warrior + def _load_data(self, data): self._data = data - print 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 +31,59 @@ 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'] + + class DoesNotExist(Exception): + pass + + def __init__(self, warrior, data={}): + self.warrior = warrior + self._load_data(data) + self._modified_fields = set() + + def __unicode__(self): + return self['description'] + def serialize_due(self, date): return date.strftime(DATE_FORMAT) @@ -49,18 +92,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): @@ -76,7 +109,7 @@ class Task(object): }) def done(self): - self.warrior.execute_comamnd([self['id'], 'done']) + self.warrior.execute_command([self['id'], 'done']) def save(self): args = [self['id'], 'modify'] if self['id'] else ['add'] @@ -84,13 +117,33 @@ class Task(object): self.warrior.execute_command(args) self._modified_fields.clear() + def add_annotation(self, annotation): + args = [self['id'], 'annotate', annotation] + self.warrior.execute_command(args) + self.refresh(only_fields=['annotations']) + + def remove_annotation(self, annotation): + if isinstance(annotation, TaskAnnotation): + annotation = annotation['description'] + args = [self['id'], '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])) return args - __repr__ = __unicode__ + def refresh(self, only_fields=[]): + args = [self['uuid'], '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,6 +159,10 @@ 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): @@ -195,6 +252,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. @@ -227,7 +287,7 @@ class TaskQuerySet(object): class TaskWarrior(object): def __init__(self, data_location='~/.task', create=True): data_location = os.path.expanduser(data_location) - if not os.path.exists(data_location): + if create and not os.path.exists(data_location): os.makedirs(data_location) self.config = { 'data.location': os.path.expanduser(data_location), @@ -249,9 +309,12 @@ class TaskWarrior(object): logger.debug(' '.join(command_args)) p = subprocess.Popen(command_args, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - stdout, stderr = p.communicate() + stdout, stderr = [x.decode('utf-8') for x in p.communicate()] if p.returncode: - error_msg = stderr.strip().splitlines()[-1] + if stderr.strip(): + error_msg = stderr.strip().splitlines()[-1] + else: + error_msg = stdout.strip() raise TaskWarriorException(error_msg) return stdout.strip().split('\n') @@ -260,7 +323,11 @@ class TaskWarrior(object): tasks = [] 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 merge_with(self, path, push=False):