X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/3c47c1b8537fcd2557ee86374b8e234b521eee8f..55f248ccc3e7c132258f396583ba96effa3ff4a0:/tasklib/task.py?ds=sidebyside diff --git a/tasklib/task.py b/tasklib/task.py index f2b020d..bb3fa53 100644 --- a/tasklib/task.py +++ b/tasklib/task.py @@ -12,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__) @@ -88,9 +93,20 @@ class Task(TaskResource): """ pass - def __init__(self, warrior, data={}): + 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 - self._load_data(data) + + # We keep data for backwards compatibility + kwargs.update(data) + + self._load_data(kwargs) self._modified_fields = set() def __unicode__(self): @@ -112,6 +128,10 @@ class Task(TaskResource): 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) @@ -132,11 +152,14 @@ class Task(TaskResource): return ','.join(tags) if tags else '' 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']) if self.deleted: - raise self.DeletedTask("Task was already deleted") + raise Task.DeletedTask("Task was already deleted") self.warrior.execute_command([self['uuid'], 'delete'], config_override={ 'confirmation': 'no', @@ -147,13 +170,16 @@ class Task(TaskResource): def done(self): + 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 self.CompletedTask("Cannot complete a completed task") + raise Task.CompletedTask("Cannot complete a completed task") elif self.deleted: - raise self.DeletedTask("Deleted task cannot be completed") + raise Task.DeletedTask("Deleted task cannot be completed") self.warrior.execute_command([self['uuid'], 'done']) @@ -161,17 +187,38 @@ class Task(TaskResource): self.refresh(only_fields=['status']) def save(self): - args = [self['uuid'], 'modify'] if self['uuid'] 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] @@ -180,12 +227,37 @@ class Task(TaskResource): 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 def refresh(self, only_fields=[]): - args = [self['uuid'], 'export'] + # 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( @@ -212,7 +284,13 @@ 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 '' - self.filter_params.append('{0}:{1}'.format(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)) def get_filter_params(self): return [f for f in self.filter_params if f] @@ -342,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:/'] @@ -352,6 +431,14 @@ 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)