tasklib/task.py

   1 from __future__ import print_function
   2 import copy
   3 import datetime
   4 import json
   5 import logging
   6 import os
   7 import six
   8 import sys
   9 import subprocess
  10
  11 DATE_FORMAT = '%Y%m%dT%H%M%SZ'
  12 REPR_OUTPUT_SIZE = 10
  13 PENDING = 'pending'
  14 COMPLETED = 'completed'
  15
  16 VERSION_2_1_0 = six.u('2.1.0')
  17 VERSION_2_2_0 = six.u('2.2.0')
  18 VERSION_2_3_0 = six.u('2.3.0')
  19 VERSION_2_4_0 = six.u('2.4.0')
  20
  21 logger = logging.getLogger(__name__)
  22
  23
  24 class TaskWarriorException(Exception):
  25     pass
  26
  27
  28 class SerializingObject(object):
  29     """
  30     Common ancestor for TaskResource & TaskFilter, since they both
  31     need to serialize arguments.
  32     """
  33
  34     def _deserialize(self, key, value):
  35         hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
  36                                lambda x: x if x != '' else None)
  37         return hydrate_func(value)
  38
  39     def _serialize(self, key, value):
  40         dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
  41                                  lambda x: x if x is not None else '')
  42         return dehydrate_func(value)
  43
  44     def timestamp_serializer(self, date):
  45         if not date:
  46             return None
  47         return date.strftime(DATE_FORMAT)
  48
  49     def timestamp_deserializer(self, date_str):
  50         if not date_str:
  51             return None
  52         return datetime.datetime.strptime(date_str, DATE_FORMAT)
  53
  54     def serialize_entry(self, value):
  55         return self.timestamp_serializer(value)
  56
  57     def deserialize_entry(self, value):
  58         return self.timestamp_deserializer(value)
  59
  60     def serialize_modified(self, value):
  61         return self.timestamp_serializer(value)
  62
  63     def deserialize_modified(self, value):
  64         return self.timestamp_deserializer(value)
  65
  66     def serialize_due(self, value):
  67         return self.timestamp_serializer(value)
  68
  69     def deserialize_due(self, value):
  70         return self.timestamp_deserializer(value)
  71
  72     def serialize_scheduled(self, value):
  73         return self.timestamp_serializer(value)
  74
  75     def deserialize_scheduled(self, value):
  76         return self.timestamp_deserializer(value)
  77
  78     def serialize_until(self, value):
  79         return self.timestamp_serializer(value)
  80
  81     def deserialize_until(self, value):
  82         return self.timestamp_deserializer(value)
  83
  84     def serialize_wait(self, value):
  85         return self.timestamp_serializer(value)
  86
  87     def deserialize_wait(self, value):
  88         return self.timestamp_deserializer(value)
  89
  90     def deserialize_annotations(self, data):
  91         return [TaskAnnotation(self, d) for d in data] if data else []
  92
  93     def serialize_tags(self, tags):
  94         return ','.join(tags) if tags else ''
  95
  96     def deserialize_tags(self, tags):
  97         if isinstance(tags, six.string_types):
  98             return tags.split(',') if tags else []
  99         return tags or []
 100
 101     def serialize_depends(self, cur_dependencies):
 102         # Return the list of uuids
 103         return ','.join(task['uuid'] for task in cur_dependencies)
 104
 105     def deserialize_depends(self, raw_uuids):
 106         raw_uuids = raw_uuids or ''  # Convert None to empty string
 107         uuids = raw_uuids.split(',')
 108         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 109
 110
 111 class TaskResource(SerializingObject):
 112     read_only_fields = []
 113
 114     def _load_data(self, data):
 115         self._data = dict((key, self._deserialize(key, value))
 116                           for key, value in data.items())
 117         # We need to use a copy for original data, so that changes
 118         # are not propagated.
 119         self._original_data = copy.deepcopy(self._data)
 120
 121     def _update_data(self, data, update_original=False):
 122         """
 123         Low level update of the internal _data dict. Data which are coming as
 124         updates should already be serialized. If update_original is True, the
 125         original_data dict is updated as well.
 126         """
 127         self._data.update(dict((key, self._deserialize(key, value))
 128                                for key, value in data.items()))
 129
 130         if update_original:
 131             self._original_data = copy.deepcopy(self._data)
 132
 133
 134     def __getitem__(self, key):
 135         # This is a workaround to make TaskResource non-iterable
 136         # over simple index-based iteration
 137         try:
 138             int(key)
 139             raise StopIteration
 140         except ValueError:
 141             pass
 142
 143         if key not in self._data:
 144             self._data[key] = self._deserialize(key, None)
 145
 146         return self._data.get(key)
 147
 148     def __setitem__(self, key, value):
 149         if key in self.read_only_fields:
 150             raise RuntimeError('Field \'%s\' is read-only' % key)
 151         self._data[key] = value
 152
 153     def __str__(self):
 154         s = six.text_type(self.__unicode__())
 155         if not six.PY3:
 156             s = s.encode('utf-8')
 157         return s
 158
 159     def __repr__(self):
 160         return str(self)
 161
 162
 163 class TaskAnnotation(TaskResource):
 164     read_only_fields = ['entry', 'description']
 165
 166     def __init__(self, task, data={}):
 167         self.task = task
 168         self._load_data(data)
 169
 170     def remove(self):
 171         self.task.remove_annotation(self)
 172
 173     def __unicode__(self):
 174         return self['description']
 175
 176     def __eq__(self, other):
 177         # consider 2 annotations equal if they belong to the same task, and
 178         # their data dics are the same
 179         return self.task == other.task and self._data == other._data
 180
 181     __repr__ = __unicode__
 182
 183
 184 class Task(TaskResource):
 185     read_only_fields = ['id', 'entry', 'urgency', 'uuid', 'modified']
 186
 187     class DoesNotExist(Exception):
 188         pass
 189
 190     class CompletedTask(Exception):
 191         """
 192         Raised when the operation cannot be performed on the completed task.
 193         """
 194         pass
 195
 196     class DeletedTask(Exception):
 197         """
 198         Raised when the operation cannot be performed on the deleted task.
 199         """
 200         pass
 201
 202     class NotSaved(Exception):
 203         """
 204         Raised when the operation cannot be performed on the task, because
 205         it has not been saved to TaskWarrior yet.
 206         """
 207         pass
 208
 209     @classmethod
 210     def from_input(cls, modify=False):
 211         """
 212         Creates a Task object, directly from the stdin, by reading one line.
 213         If modify=True, two lines are used, first line interpreted as the
 214         original state of the Task object, and second line as its new,
 215         modified value. This is consistent with the TaskWarrior's hook
 216         system.
 217
 218         Object created by this method should not be saved, deleted
 219         or refreshed, as t could create a infinite loop. For this
 220         reason, TaskWarrior instance is set to None.
 221         """
 222
 223         # TaskWarrior instance is set to None
 224         task = cls(None)
 225
 226         # Load the data from the input
 227         task._load_data(json.loads(sys.stdin.readline().strip()))
 228
 229         # If this is a on-modify event, we are provided with additional
 230         # line of input, which provides updated data
 231         if modify:
 232             task._update_data(json.loads(sys.stdin.readline().strip()))
 233
 234         return task
 235
 236     def __init__(self, warrior, **kwargs):
 237         self.warrior = warrior
 238
 239         # Check that user is not able to set read-only value in __init__
 240         for key in kwargs.keys():
 241             if key in self.read_only_fields:
 242                 raise RuntimeError('Field \'%s\' is read-only' % key)
 243
 244         # We serialize the data in kwargs so that users of the library
 245         # do not have to pass different data formats via __setitem__ and
 246         # __init__ methods, that would be confusing
 247
 248         # Rather unfortunate syntax due to python2.6 comaptiblity
 249         self._load_data(dict((key, self._serialize(key, value))
 250                         for (key, value) in six.iteritems(kwargs)))
 251
 252     def __unicode__(self):
 253         return self['description']
 254
 255     def __eq__(self, other):
 256         if self['uuid'] and other['uuid']:
 257             # For saved Tasks, just define equality by equality of uuids
 258             return self['uuid'] == other['uuid']
 259         else:
 260             # If the tasks are not saved, compare the actual instances
 261             return id(self) == id(other)
 262
 263
 264     def __hash__(self):
 265         if self['uuid']:
 266             # For saved Tasks, just define equality by equality of uuids
 267             return self['uuid'].__hash__()
 268         else:
 269             # If the tasks are not saved, return hash of instance id
 270             return id(self).__hash__()
 271
 272     @property
 273     def _modified_fields(self):
 274         writable_fields = set(self._data.keys()) - set(self.read_only_fields)
 275         for key in writable_fields:
 276             if self._data.get(key) != self._original_data.get(key):
 277                 yield key
 278
 279     @property
 280     def _is_modified(self):
 281         return bool(list(self._modified_fields))
 282
 283     @property
 284     def completed(self):
 285         return self['status'] == six.text_type('completed')
 286
 287     @property
 288     def deleted(self):
 289         return self['status'] == six.text_type('deleted')
 290
 291     @property
 292     def waiting(self):
 293         return self['status'] == six.text_type('waiting')
 294
 295     @property
 296     def pending(self):
 297         return self['status'] == six.text_type('pending')
 298
 299     @property
 300     def saved(self):
 301         return self['uuid'] is not None or self['id'] is not None
 302
 303     def serialize_depends(self, cur_dependencies):
 304         # Check that all the tasks are saved
 305         for task in cur_dependencies:
 306             if not task.saved:
 307                 raise Task.NotSaved('Task \'%s\' needs to be saved before '
 308                                     'it can be set as dependency.' % task)
 309
 310         return super(Task, self).serialize_depends(cur_dependencies)
 311
 312     def format_depends(self):
 313         # We need to generate added and removed dependencies list,
 314         # since Taskwarrior does not accept redefining dependencies.
 315
 316         # This cannot be part of serialize_depends, since we need
 317         # to keep a list of all depedencies in the _data dictionary,
 318         # not just currently added/removed ones
 319
 320         old_dependencies = self._original_data.get('depends', set())
 321
 322         added = self['depends'] - old_dependencies
 323         removed = old_dependencies - self['depends']
 324
 325         # Removed dependencies need to be prefixed with '-'
 326         return 'depends:' + ','.join(
 327                 [t['uuid'] for t in added] +
 328                 ['-' + t['uuid'] for t in removed]
 329             )
 330
 331     def format_description(self):
 332         # Task version older than 2.4.0 ignores first word of the
 333         # task description if description: prefix is used
 334         if self.warrior.version < VERSION_2_4_0:
 335             return self._data['description']
 336         else:
 337             return "description:'{0}'".format(self._data['description'] or '')
 338
 339     def delete(self):
 340         if not self.saved:
 341             raise Task.NotSaved("Task needs to be saved before it can be deleted")
 342
 343         # Refresh the status, and raise exception if the task is deleted
 344         self.refresh(only_fields=['status'])
 345
 346         if self.deleted:
 347             raise Task.DeletedTask("Task was already deleted")
 348
 349         self.warrior.execute_command([self['uuid'], 'delete'])
 350
 351         # Refresh the status again, so that we have updated info stored
 352         self.refresh(only_fields=['status'])
 353
 354
 355     def done(self):
 356         if not self.saved:
 357             raise Task.NotSaved("Task needs to be saved before it can be completed")
 358
 359         # Refresh, and raise exception if task is already completed/deleted
 360         self.refresh(only_fields=['status'])
 361
 362         if self.completed:
 363             raise Task.CompletedTask("Cannot complete a completed task")
 364         elif self.deleted:
 365             raise Task.DeletedTask("Deleted task cannot be completed")
 366
 367         self.warrior.execute_command([self['uuid'], 'done'])
 368
 369         # Refresh the status again, so that we have updated info stored
 370         self.refresh(only_fields=['status'])
 371
 372     def save(self):
 373         if self.saved and not self._is_modified:
 374             return
 375
 376         args = [self['uuid'], 'modify'] if self.saved else ['add']
 377         args.extend(self._get_modified_fields_as_args())
 378         output = self.warrior.execute_command(args)
 379
 380         # Parse out the new ID, if the task is being added for the first time
 381         if not self.saved:
 382             id_lines = [l for l in output if l.startswith('Created task ')]
 383
 384             # Complain loudly if it seems that more tasks were created
 385             # Should not happen
 386             if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3:
 387                 raise TaskWarriorException("Unexpected output when creating "
 388                                            "task: %s" % '\n'.join(id_lines))
 389
 390             # Circumvent the ID storage, since ID is considered read-only
 391             self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
 392
 393         self.refresh()
 394
 395     def add_annotation(self, annotation):
 396         if not self.saved:
 397             raise Task.NotSaved("Task needs to be saved to add annotation")
 398
 399         args = [self['uuid'], 'annotate', annotation]
 400         self.warrior.execute_command(args)
 401         self.refresh(only_fields=['annotations'])
 402
 403     def remove_annotation(self, annotation):
 404         if not self.saved:
 405             raise Task.NotSaved("Task needs to be saved to remove annotation")
 406
 407         if isinstance(annotation, TaskAnnotation):
 408             annotation = annotation['description']
 409         args = [self['uuid'], 'denotate', annotation]
 410         self.warrior.execute_command(args)
 411         self.refresh(only_fields=['annotations'])
 412
 413     def _get_modified_fields_as_args(self):
 414         args = []
 415
 416         def add_field(field):
 417             # Add the output of format_field method to args list (defaults to
 418             # field:value)
 419             serialized_value = self._serialize(field, self._data[field]) or ''
 420             format_default = lambda: "{0}:{1}".format(
 421                 field,
 422                 "'{0}'".format(serialized_value) if serialized_value else ''
 423             )
 424             format_func = getattr(self, 'format_{0}'.format(field),
 425                                   format_default)
 426             args.append(format_func())
 427
 428         # If we're modifying saved task, simply pass on all modified fields
 429         if self.saved:
 430             for field in self._modified_fields:
 431                 add_field(field)
 432         # For new tasks, pass all fields that make sense
 433         else:
 434             for field in self._data.keys():
 435                 if field in self.read_only_fields:
 436                     continue
 437                 add_field(field)
 438
 439         return args
 440
 441     def refresh(self, only_fields=[]):
 442         # Raise error when trying to refresh a task that has not been saved
 443         if not self.saved:
 444             raise Task.NotSaved("Task needs to be saved to be refreshed")
 445
 446         # We need to use ID as backup for uuid here for the refreshes
 447         # of newly saved tasks. Any other place in the code is fine
 448         # with using UUID only.
 449         args = [self['uuid'] or self['id'], 'export']
 450         new_data = json.loads(self.warrior.execute_command(args)[0])
 451         if only_fields:
 452             to_update = dict(
 453                 [(k, new_data.get(k)) for k in only_fields])
 454             self._update_data(to_update, update_original=True)
 455         else:
 456             self._load_data(new_data)
 457
 458     def export_data(self):
 459         """
 460         Exports current data contained in the Task as JSON
 461         """
 462
 463         return json.dumps(self._data)
 464
 465 class TaskFilter(SerializingObject):
 466     """
 467     A set of parameters to filter the task list with.
 468     """
 469
 470     def __init__(self, filter_params=[]):
 471         self.filter_params = filter_params
 472
 473     def add_filter(self, filter_str):
 474         self.filter_params.append(filter_str)
 475
 476     def add_filter_param(self, key, value):
 477         key = key.replace('__', '.')
 478
 479         # Replace the value with empty string, since that is the
 480         # convention in TW for empty values
 481         attribute_key = key.split('.')[0]
 482         value = self._serialize(attribute_key, value)
 483
 484         # If we are filtering by uuid:, do not use uuid keyword
 485         # due to TW-1452 bug
 486         if key == 'uuid':
 487             self.filter_params.insert(0, value)
 488         else:
 489             # Surround value with aphostrophes unless it's a empty string
 490             value = "'%s'" % value if value else ''
 491
 492             # We enforce equality match by using 'is' (or 'none') modifier
 493             # Without using this syntax, filter fails due to TW-1479
 494             modifier = '.is' if value else '.none'
 495             key = key + modifier if '.' not in key else key
 496
 497             self.filter_params.append("{0}:{1}".format(key, value))
 498
 499     def get_filter_params(self):
 500         return [f for f in self.filter_params if f]
 501
 502     def clone(self):
 503         c = self.__class__()
 504         c.filter_params = list(self.filter_params)
 505         return c
 506
 507
 508 class TaskQuerySet(object):
 509     """
 510     Represents a lazy lookup for a task objects.
 511     """
 512
 513     def __init__(self, warrior=None, filter_obj=None):
 514         self.warrior = warrior
 515         self._result_cache = None
 516         self.filter_obj = filter_obj or TaskFilter()
 517
 518     def __deepcopy__(self, memo):
 519         """
 520         Deep copy of a QuerySet doesn't populate the cache
 521         """
 522         obj = self.__class__()
 523         for k, v in self.__dict__.items():
 524             if k in ('_iter', '_result_cache'):
 525                 obj.__dict__[k] = None
 526             else:
 527                 obj.__dict__[k] = copy.deepcopy(v, memo)
 528         return obj
 529
 530     def __repr__(self):
 531         data = list(self[:REPR_OUTPUT_SIZE + 1])
 532         if len(data) > REPR_OUTPUT_SIZE:
 533             data[-1] = "...(remaining elements truncated)..."
 534         return repr(data)
 535
 536     def __len__(self):
 537         if self._result_cache is None:
 538             self._result_cache = list(self)
 539         return len(self._result_cache)
 540
 541     def __iter__(self):
 542         if self._result_cache is None:
 543             self._result_cache = self._execute()
 544         return iter(self._result_cache)
 545
 546     def __getitem__(self, k):
 547         if self._result_cache is None:
 548             self._result_cache = list(self)
 549         return self._result_cache.__getitem__(k)
 550
 551     def __bool__(self):
 552         if self._result_cache is not None:
 553             return bool(self._result_cache)
 554         try:
 555             next(iter(self))
 556         except StopIteration:
 557             return False
 558         return True
 559
 560     def __nonzero__(self):
 561         return type(self).__bool__(self)
 562
 563     def _clone(self, klass=None, **kwargs):
 564         if klass is None:
 565             klass = self.__class__
 566         filter_obj = self.filter_obj.clone()
 567         c = klass(warrior=self.warrior, filter_obj=filter_obj)
 568         c.__dict__.update(kwargs)
 569         return c
 570
 571     def _execute(self):
 572         """
 573         Fetch the tasks which match the current filters.
 574         """
 575         return self.warrior.filter_tasks(self.filter_obj)
 576
 577     def all(self):
 578         """
 579         Returns a new TaskQuerySet that is a copy of the current one.
 580         """
 581         return self._clone()
 582
 583     def pending(self):
 584         return self.filter(status=PENDING)
 585
 586     def completed(self):
 587         return self.filter(status=COMPLETED)
 588
 589     def filter(self, *args, **kwargs):
 590         """
 591         Returns a new TaskQuerySet with the given filters added.
 592         """
 593         clone = self._clone()
 594         for f in args:
 595             clone.filter_obj.add_filter(f)
 596         for key, value in kwargs.items():
 597             clone.filter_obj.add_filter_param(key, value)
 598         return clone
 599
 600     def get(self, **kwargs):
 601         """
 602         Performs the query and returns a single object matching the given
 603         keyword arguments.
 604         """
 605         clone = self.filter(**kwargs)
 606         num = len(clone)
 607         if num == 1:
 608             return clone._result_cache[0]
 609         if not num:
 610             raise Task.DoesNotExist(
 611                 'Task matching query does not exist. '
 612                 'Lookup parameters were {0}'.format(kwargs))
 613         raise ValueError(
 614             'get() returned more than one Task -- it returned {0}! '
 615             'Lookup parameters were {1}'.format(num, kwargs))
 616
 617
 618 class TaskWarrior(object):
 619     def __init__(self, data_location='~/.task', create=True):
 620         data_location = os.path.expanduser(data_location)
 621         if create and not os.path.exists(data_location):
 622             os.makedirs(data_location)
 623         self.config = {
 624             'data.location': os.path.expanduser(data_location),
 625             'confirmation': 'no',
 626             'dependency.confirmation': 'no', # See TW-1483 or taskrc man page
 627         }
 628         self.tasks = TaskQuerySet(self)
 629         self.version = self._get_version()
 630
 631     def _get_command_args(self, args, config_override={}):
 632         command_args = ['task', 'rc:/']
 633         config = self.config.copy()
 634         config.update(config_override)
 635         for item in config.items():
 636             command_args.append('rc.{0}={1}'.format(*item))
 637         command_args.extend(map(str, args))
 638         return command_args
 639
 640     def _get_version(self):
 641         p = subprocess.Popen(
 642                 ['task', '--version'],
 643                 stdout=subprocess.PIPE,
 644                 stderr=subprocess.PIPE)
 645         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
 646         return stdout.strip('\n')
 647
 648     def execute_command(self, args, config_override={}):
 649         command_args = self._get_command_args(
 650             args, config_override=config_override)
 651         logger.debug(' '.join(command_args))
 652         p = subprocess.Popen(command_args, stdout=subprocess.PIPE,
 653                              stderr=subprocess.PIPE)
 654         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
 655         if p.returncode:
 656             if stderr.strip():
 657                 error_msg = stderr.strip().splitlines()[-1]
 658             else:
 659                 error_msg = stdout.strip()
 660             raise TaskWarriorException(error_msg)
 661         return stdout.strip().split('\n')
 662
 663     def filter_tasks(self, filter_obj):
 664         args = ['export', '--'] + filter_obj.get_filter_params()
 665         tasks = []
 666         for line in self.execute_command(args):
 667             if line:
 668                 data = line.strip(',')
 669                 try:
 670                     filtered_task = Task(self)
 671                     filtered_task._load_data(json.loads(data))
 672                     tasks.append(filtered_task)
 673                 except ValueError:
 674                     raise TaskWarriorException('Invalid JSON: %s' % data)
 675         return tasks
 676
 677     def merge_with(self, path, push=False):
 678         path = path.rstrip('/') + '/'
 679         self.execute_command(['merge', path], config_override={
 680             'merge.autopush': 'yes' if push else 'no',
 681         })
 682
 683     def undo(self):
 684         self.execute_command(['undo'])