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 pytz
   8 import six
   9 import sys
  10 import subprocess
  11 import tzlocal
  12
  13 DATE_FORMAT = '%Y%m%dT%H%M%SZ'
  14 DATE_FORMAT_CALC = '%Y-%m-%dT%H:%M:%S'
  15 REPR_OUTPUT_SIZE = 10
  16 PENDING = 'pending'
  17 COMPLETED = 'completed'
  18
  19 VERSION_2_1_0 = six.u('2.1.0')
  20 VERSION_2_2_0 = six.u('2.2.0')
  21 VERSION_2_3_0 = six.u('2.3.0')
  22 VERSION_2_4_0 = six.u('2.4.0')
  23 VERSION_2_4_1 = six.u('2.4.1')
  24 VERSION_2_4_2 = six.u('2.4.2')
  25 VERSION_2_4_3 = six.u('2.4.3')
  26
  27 logger = logging.getLogger(__name__)
  28 local_zone = tzlocal.get_localzone()
  29
  30
  31 class TaskWarriorException(Exception):
  32     pass
  33
  34
  35 class ReadOnlyDictView(object):
  36     """
  37     Provides simplified read-only view upon dict object.
  38     """
  39
  40     def __init__(self, viewed_dict):
  41         self.viewed_dict = viewed_dict
  42
  43     def __getitem__(self, key):
  44         return copy.deepcopy(self.viewed_dict.__getitem__(key))
  45
  46     def __contains__(self, k):
  47         return self.viewed_dict.__contains__(k)
  48
  49     def __iter__(self):
  50         for value in self.viewed_dict:
  51             yield copy.deepcopy(value)
  52
  53     def __len__(self):
  54         return len(self.viewed_dict)
  55
  56     def get(self, key, default=None):
  57         return copy.deepcopy(self.viewed_dict.get(key, default))
  58
  59     def items(self):
  60         return [copy.deepcopy(v) for v in self.viewed_dict.items()]
  61
  62     def values(self):
  63         return [copy.deepcopy(v) for v in self.viewed_dict.values()]
  64
  65
  66 class SerializingObject(object):
  67     """
  68     Common ancestor for TaskResource & TaskFilter, since they both
  69     need to serialize arguments.
  70
  71     Serializing method should hold the following contract:
  72       - any empty value (meaning removal of the attribute)
  73         is deserialized into a empty string
  74       - None denotes a empty value for any attribute
  75
  76     Deserializing method should hold the following contract:
  77       - None denotes a empty value for any attribute (however,
  78         this is here as a safeguard, TaskWarrior currently does
  79         not export empty-valued attributes) if the attribute
  80         is not iterable (e.g. list or set), in which case
  81         a empty iterable should be used.
  82
  83     Normalizing methods should hold the following contract:
  84       - They are used to validate and normalize the user input.
  85         Any attribute value that comes from the user (during Task
  86         initialization, assignign values to Task attributes, or
  87         filtering by user-provided values of attributes) is first
  88         validated and normalized using the normalize_{key} method.
  89       - If validation or normalization fails, normalizer is expected
  90         to raise ValueError.
  91     """
  92
  93     def __init__(self, warrior):
  94         self.warrior = warrior
  95
  96     def _deserialize(self, key, value):
  97         hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
  98                                lambda x: x if x != '' else None)
  99         return hydrate_func(value)
 100
 101     def _serialize(self, key, value):
 102         dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
 103                                  lambda x: x if x is not None else '')
 104         return dehydrate_func(value)
 105
 106     def _normalize(self, key, value):
 107         """
 108         Use normalize_<key> methods to normalize user input. Any user
 109         input will be normalized at the moment it is used as filter,
 110         or entered as a value of Task attribute.
 111         """
 112
 113         # None value should not be converted by normalizer
 114         if value is None:
 115             return None
 116
 117         normalize_func = getattr(self, 'normalize_{0}'.format(key),
 118                                  lambda x: x)
 119
 120         return normalize_func(value)
 121
 122     def timestamp_serializer(self, date):
 123         if not date:
 124             return ''
 125
 126         # Any serialized timestamp should be localized, we need to
 127         # convert to UTC before converting to string (DATE_FORMAT uses UTC)
 128         date = date.astimezone(pytz.utc)
 129
 130         return date.strftime(DATE_FORMAT)
 131
 132     def timestamp_deserializer(self, date_str):
 133         if not date_str:
 134             return None
 135
 136         # Return timestamp localized in the local zone
 137         naive_timestamp = datetime.datetime.strptime(date_str, DATE_FORMAT)
 138         localized_timestamp = pytz.utc.localize(naive_timestamp)
 139         return localized_timestamp.astimezone(local_zone)
 140
 141     def serialize_entry(self, value):
 142         return self.timestamp_serializer(value)
 143
 144     def deserialize_entry(self, value):
 145         return self.timestamp_deserializer(value)
 146
 147     def normalize_entry(self, value):
 148         return self.datetime_normalizer(value)
 149
 150     def serialize_modified(self, value):
 151         return self.timestamp_serializer(value)
 152
 153     def deserialize_modified(self, value):
 154         return self.timestamp_deserializer(value)
 155
 156     def normalize_modified(self, value):
 157         return self.datetime_normalizer(value)
 158
 159     def serialize_start(self, value):
 160         return self.timestamp_serializer(value)
 161
 162     def deserialize_start(self, value):
 163         return self.timestamp_deserializer(value)
 164
 165     def normalize_start(self, value):
 166         return self.datetime_normalizer(value)
 167
 168     def serialize_end(self, value):
 169         return self.timestamp_serializer(value)
 170
 171     def deserialize_end(self, value):
 172         return self.timestamp_deserializer(value)
 173
 174     def normalize_end(self, value):
 175         return self.datetime_normalizer(value)
 176
 177     def serialize_due(self, value):
 178         return self.timestamp_serializer(value)
 179
 180     def deserialize_due(self, value):
 181         return self.timestamp_deserializer(value)
 182
 183     def normalize_due(self, value):
 184         return self.datetime_normalizer(value)
 185
 186     def serialize_scheduled(self, value):
 187         return self.timestamp_serializer(value)
 188
 189     def deserialize_scheduled(self, value):
 190         return self.timestamp_deserializer(value)
 191
 192     def normalize_scheduled(self, value):
 193         return self.datetime_normalizer(value)
 194
 195     def serialize_until(self, value):
 196         return self.timestamp_serializer(value)
 197
 198     def deserialize_until(self, value):
 199         return self.timestamp_deserializer(value)
 200
 201     def normalize_until(self, value):
 202         return self.datetime_normalizer(value)
 203
 204     def serialize_wait(self, value):
 205         return self.timestamp_serializer(value)
 206
 207     def deserialize_wait(self, value):
 208         return self.timestamp_deserializer(value)
 209
 210     def normalize_wait(self, value):
 211         return self.datetime_normalizer(value)
 212
 213     def serialize_annotations(self, value):
 214         value = value if value is not None else []
 215
 216         # This may seem weird, but it's correct, we want to export
 217         # a list of dicts as serialized value
 218         serialized_annotations = [json.loads(annotation.export_data())
 219                                   for annotation in value]
 220         return serialized_annotations if serialized_annotations else ''
 221
 222     def deserialize_annotations(self, data):
 223         return [TaskAnnotation(self, d) for d in data] if data else []
 224
 225     def serialize_tags(self, tags):
 226         return ','.join(tags) if tags else ''
 227
 228     def deserialize_tags(self, tags):
 229         if isinstance(tags, six.string_types):
 230             return tags.split(',') if tags else []
 231         return tags or []
 232
 233     def serialize_depends(self, value):
 234         # Return the list of uuids
 235         value = value if value is not None else set()
 236         return ','.join(task['uuid'] for task in value)
 237
 238     def deserialize_depends(self, raw_uuids):
 239         raw_uuids = raw_uuids or ''  # Convert None to empty string
 240         uuids = raw_uuids.split(',')
 241         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 242
 243     def datetime_normalizer(self, value):
 244         """
 245         Normalizes date/datetime value (considered to come from user input)
 246         to localized datetime value. Following conversions happen:
 247
 248         naive date -> localized datetime with the same date, and time=midnight
 249         naive datetime -> localized datetime with the same value
 250         localized datetime -> localized datetime (no conversion)
 251         """
 252
 253         if (isinstance(value, datetime.date)
 254             and not isinstance(value, datetime.datetime)):
 255             # Convert to local midnight
 256             value_full = datetime.datetime.combine(value, datetime.time.min)
 257             localized = local_zone.localize(value_full)
 258         elif isinstance(value, datetime.datetime):
 259             if value.tzinfo is None:
 260                 # Convert to localized datetime object
 261                 localized = local_zone.localize(value)
 262             else:
 263                 # If the value is already localized, there is no need to change
 264                 # time zone at this point. Also None is a valid value too.
 265                 localized = value
 266         elif (isinstance(value, six.string_types)
 267                 and self.warrior.version > VERSION_2_4_0):
 268             # For strings, use 'task calc' to evaluate the string to datetime
 269             # available since TW 2.4.0
 270             args = value.split()
 271             result = self.warrior.execute_command(['calc'] + args)
 272             naive = datetime.datetime.strptime(result[0], DATE_FORMAT_CALC)
 273             localized = local_zone.localize(naive)
 274         else:
 275             raise ValueError("Provided value could not be converted to "
 276                              "datetime, its type is not supported: {}"
 277                              .format(type(value)))
 278
 279         return localized
 280
 281     def normalize_uuid(self, value):
 282         # Enforce sane UUID
 283         if not isinstance(value, six.string_types) or value == '':
 284             raise ValueError("UUID must be a valid non-empty string, "
 285                              "not: {}".format(value))
 286
 287         return value
 288
 289
 290 class TaskResource(SerializingObject):
 291     read_only_fields = []
 292
 293     def _load_data(self, data):
 294         self._data = dict((key, self._deserialize(key, value))
 295                           for key, value in data.items())
 296         # We need to use a copy for original data, so that changes
 297         # are not propagated.
 298         self._original_data = copy.deepcopy(self._data)
 299
 300     def _update_data(self, data, update_original=False):
 301         """
 302         Low level update of the internal _data dict. Data which are coming as
 303         updates should already be serialized. If update_original is True, the
 304         original_data dict is updated as well.
 305         """
 306         self._data.update(dict((key, self._deserialize(key, value))
 307                                for key, value in data.items()))
 308
 309         if update_original:
 310             self._original_data = copy.deepcopy(self._data)
 311
 312
 313     def __getitem__(self, key):
 314         # This is a workaround to make TaskResource non-iterable
 315         # over simple index-based iteration
 316         try:
 317             int(key)
 318             raise StopIteration
 319         except ValueError:
 320             pass
 321
 322         if key not in self._data:
 323             self._data[key] = self._deserialize(key, None)
 324
 325         return self._data.get(key)
 326
 327     def __setitem__(self, key, value):
 328         if key in self.read_only_fields:
 329             raise RuntimeError('Field \'%s\' is read-only' % key)
 330
 331         # Normalize the user input before saving it
 332         value = self._normalize(key, value)
 333         self._data[key] = value
 334
 335     def __str__(self):
 336         s = six.text_type(self.__unicode__())
 337         if not six.PY3:
 338             s = s.encode('utf-8')
 339         return s
 340
 341     def __repr__(self):
 342         return str(self)
 343
 344     def export_data(self):
 345         """
 346         Exports current data contained in the Task as JSON
 347         """
 348
 349         # We need to remove spaces for TW-1504, use custom separators
 350         data_tuples = ((key, self._serialize(key, value))
 351                        for key, value in six.iteritems(self._data))
 352
 353         # Empty string denotes empty serialized value, we do not want
 354         # to pass that to TaskWarrior.
 355         data_tuples = filter(lambda t: t[1] is not '', data_tuples)
 356         data = dict(data_tuples)
 357         return json.dumps(data, separators=(',',':'))
 358
 359     @property
 360     def _modified_fields(self):
 361         writable_fields = set(self._data.keys()) - set(self.read_only_fields)
 362         for key in writable_fields:
 363             new_value = self._data.get(key)
 364             old_value = self._original_data.get(key)
 365
 366             # Make sure not to mark data removal as modified field if the
 367             # field originally had some empty value
 368             if key in self._data and not new_value and not old_value:
 369                 continue
 370
 371             if new_value != old_value:
 372                 yield key
 373
 374     @property
 375     def modified(self):
 376         return bool(list(self._modified_fields))
 377
 378
 379 class TaskAnnotation(TaskResource):
 380     read_only_fields = ['entry', 'description']
 381
 382     def __init__(self, task, data={}):
 383         self.task = task
 384         self._load_data(data)
 385         super(TaskAnnotation, self).__init__(task.warrior)
 386
 387     def remove(self):
 388         self.task.remove_annotation(self)
 389
 390     def __unicode__(self):
 391         return self['description']
 392
 393     def __eq__(self, other):
 394         # consider 2 annotations equal if they belong to the same task, and
 395         # their data dics are the same
 396         return self.task == other.task and self._data == other._data
 397
 398     __repr__ = __unicode__
 399
 400
 401 class Task(TaskResource):
 402     read_only_fields = ['id', 'entry', 'urgency', 'uuid', 'modified']
 403
 404     class DoesNotExist(Exception):
 405         pass
 406
 407     class CompletedTask(Exception):
 408         """
 409         Raised when the operation cannot be performed on the completed task.
 410         """
 411         pass
 412
 413     class DeletedTask(Exception):
 414         """
 415         Raised when the operation cannot be performed on the deleted task.
 416         """
 417         pass
 418
 419     class NotSaved(Exception):
 420         """
 421         Raised when the operation cannot be performed on the task, because
 422         it has not been saved to TaskWarrior yet.
 423         """
 424         pass
 425
 426     @classmethod
 427     def from_input(cls, input_file=sys.stdin, modify=None, warrior=None):
 428         """
 429         Creates a Task object, directly from the stdin, by reading one line.
 430         If modify=True, two lines are used, first line interpreted as the
 431         original state of the Task object, and second line as its new,
 432         modified value. This is consistent with the TaskWarrior's hook
 433         system.
 434
 435         Object created by this method should not be saved, deleted
 436         or refreshed, as t could create a infinite loop. For this
 437         reason, TaskWarrior instance is set to None.
 438
 439         Input_file argument can be used to specify the input file,
 440         but defaults to sys.stdin.
 441         """
 442
 443         # Detect the hook type if not given directly
 444         name = os.path.basename(sys.argv[0])
 445         modify = name.startswith('on-modify') if modify is None else modify
 446
 447         # Create the TaskWarrior instance if none passed
 448         if warrior is None:
 449             hook_parent_dir = os.path.dirname(os.path.dirname(sys.argv[0]))
 450             warrior = TaskWarrior(data_location=hook_parent_dir)
 451
 452         # TaskWarrior instance is set to None
 453         task = cls(warrior)
 454
 455         # Load the data from the input
 456         task._load_data(json.loads(input_file.readline().strip()))
 457
 458         # If this is a on-modify event, we are provided with additional
 459         # line of input, which provides updated data
 460         if modify:
 461             task._update_data(json.loads(input_file.readline().strip()))
 462
 463         return task
 464
 465     def __init__(self, warrior, **kwargs):
 466         super(Task, self).__init__(warrior)
 467
 468         # Check that user is not able to set read-only value in __init__
 469         for key in kwargs.keys():
 470             if key in self.read_only_fields:
 471                 raise RuntimeError('Field \'%s\' is read-only' % key)
 472
 473         # We serialize the data in kwargs so that users of the library
 474         # do not have to pass different data formats via __setitem__ and
 475         # __init__ methods, that would be confusing
 476
 477         # Rather unfortunate syntax due to python2.6 comaptiblity
 478         self._data = dict((key, self._normalize(key, value))
 479                           for (key, value) in six.iteritems(kwargs))
 480         self._original_data = copy.deepcopy(self._data)
 481
 482         # Provide read only access to the original data
 483         self.original = ReadOnlyDictView(self._original_data)
 484
 485     def __unicode__(self):
 486         return self['description']
 487
 488     def __eq__(self, other):
 489         if self['uuid'] and other['uuid']:
 490             # For saved Tasks, just define equality by equality of uuids
 491             return self['uuid'] == other['uuid']
 492         else:
 493             # If the tasks are not saved, compare the actual instances
 494             return id(self) == id(other)
 495
 496
 497     def __hash__(self):
 498         if self['uuid']:
 499             # For saved Tasks, just define equality by equality of uuids
 500             return self['uuid'].__hash__()
 501         else:
 502             # If the tasks are not saved, return hash of instance id
 503             return id(self).__hash__()
 504
 505     @property
 506     def completed(self):
 507         return self['status'] == six.text_type('completed')
 508
 509     @property
 510     def deleted(self):
 511         return self['status'] == six.text_type('deleted')
 512
 513     @property
 514     def waiting(self):
 515         return self['status'] == six.text_type('waiting')
 516
 517     @property
 518     def pending(self):
 519         return self['status'] == six.text_type('pending')
 520
 521     @property
 522     def saved(self):
 523         return self['uuid'] is not None or self['id'] is not None
 524
 525     def serialize_depends(self, cur_dependencies):
 526         # Check that all the tasks are saved
 527         for task in (cur_dependencies or set()):
 528             if not task.saved:
 529                 raise Task.NotSaved('Task \'%s\' needs to be saved before '
 530                                     'it can be set as dependency.' % task)
 531
 532         return super(Task, self).serialize_depends(cur_dependencies)
 533
 534     def format_depends(self):
 535         # We need to generate added and removed dependencies list,
 536         # since Taskwarrior does not accept redefining dependencies.
 537
 538         # This cannot be part of serialize_depends, since we need
 539         # to keep a list of all depedencies in the _data dictionary,
 540         # not just currently added/removed ones
 541
 542         old_dependencies = self._original_data.get('depends', set())
 543
 544         added = self['depends'] - old_dependencies
 545         removed = old_dependencies - self['depends']
 546
 547         # Removed dependencies need to be prefixed with '-'
 548         return 'depends:' + ','.join(
 549                 [t['uuid'] for t in added] +
 550                 ['-' + t['uuid'] for t in removed]
 551             )
 552
 553     def format_description(self):
 554         # Task version older than 2.4.0 ignores first word of the
 555         # task description if description: prefix is used
 556         if self.warrior.version < VERSION_2_4_0:
 557             return self._data['description']
 558         else:
 559             return "description:'{0}'".format(self._data['description'] or '')
 560
 561     def delete(self):
 562         if not self.saved:
 563             raise Task.NotSaved("Task needs to be saved before it can be deleted")
 564
 565         # Refresh the status, and raise exception if the task is deleted
 566         self.refresh(only_fields=['status'])
 567
 568         if self.deleted:
 569             raise Task.DeletedTask("Task was already deleted")
 570
 571         self.warrior.execute_command([self['uuid'], 'delete'])
 572
 573         # Refresh the status again, so that we have updated info stored
 574         self.refresh(only_fields=['status', 'start', 'end'])
 575
 576     def start(self):
 577         if not self.saved:
 578             raise Task.NotSaved("Task needs to be saved before it can be started")
 579
 580         # Refresh, and raise exception if task is already completed/deleted
 581         self.refresh(only_fields=['status'])
 582
 583         if self.completed:
 584             raise Task.CompletedTask("Cannot start a completed task")
 585         elif self.deleted:
 586             raise Task.DeletedTask("Deleted task cannot be started")
 587
 588         self.warrior.execute_command([self['uuid'], 'start'])
 589
 590         # Refresh the status again, so that we have updated info stored
 591         self.refresh(only_fields=['status', 'start'])
 592
 593     def done(self):
 594         if not self.saved:
 595             raise Task.NotSaved("Task needs to be saved before it can be completed")
 596
 597         # Refresh, and raise exception if task is already completed/deleted
 598         self.refresh(only_fields=['status'])
 599
 600         if self.completed:
 601             raise Task.CompletedTask("Cannot complete a completed task")
 602         elif self.deleted:
 603             raise Task.DeletedTask("Deleted task cannot be completed")
 604
 605         self.warrior.execute_command([self['uuid'], 'done'])
 606
 607         # Refresh the status again, so that we have updated info stored
 608         self.refresh(only_fields=['status', 'start', 'end'])
 609
 610     def save(self):
 611         if self.saved and not self.modified:
 612             return
 613
 614         args = [self['uuid'], 'modify'] if self.saved else ['add']
 615         args.extend(self._get_modified_fields_as_args())
 616         output = self.warrior.execute_command(args)
 617
 618         # Parse out the new ID, if the task is being added for the first time
 619         if not self.saved:
 620             id_lines = [l for l in output if l.startswith('Created task ')]
 621
 622             # Complain loudly if it seems that more tasks were created
 623             # Should not happen
 624             if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3:
 625                 raise TaskWarriorException("Unexpected output when creating "
 626                                            "task: %s" % '\n'.join(id_lines))
 627
 628             # Circumvent the ID storage, since ID is considered read-only
 629             self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
 630
 631         # Refreshing is very important here, as not only modification time
 632         # is updated, but arbitrary attribute may have changed due hooks
 633         # altering the data before saving
 634         self.refresh()
 635
 636     def add_annotation(self, annotation):
 637         if not self.saved:
 638             raise Task.NotSaved("Task needs to be saved to add annotation")
 639
 640         args = [self['uuid'], 'annotate', annotation]
 641         self.warrior.execute_command(args)
 642         self.refresh(only_fields=['annotations'])
 643
 644     def remove_annotation(self, annotation):
 645         if not self.saved:
 646             raise Task.NotSaved("Task needs to be saved to remove annotation")
 647
 648         if isinstance(annotation, TaskAnnotation):
 649             annotation = annotation['description']
 650         args = [self['uuid'], 'denotate', annotation]
 651         self.warrior.execute_command(args)
 652         self.refresh(only_fields=['annotations'])
 653
 654     def _get_modified_fields_as_args(self):
 655         args = []
 656
 657         def add_field(field):
 658             # Add the output of format_field method to args list (defaults to
 659             # field:value)
 660             serialized_value = self._serialize(field, self._data[field])
 661
 662             # Empty values should not be enclosed in quotation marks, see
 663             # TW-1510
 664             if serialized_value is '':
 665                 escaped_serialized_value = ''
 666             else:
 667                 escaped_serialized_value = "'{0}'".format(serialized_value)
 668
 669             format_default = lambda: "{0}:{1}".format(field,
 670                                                       escaped_serialized_value)
 671
 672             format_func = getattr(self, 'format_{0}'.format(field),
 673                                   format_default)
 674
 675             args.append(format_func())
 676
 677         # If we're modifying saved task, simply pass on all modified fields
 678         if self.saved:
 679             for field in self._modified_fields:
 680                 add_field(field)
 681         # For new tasks, pass all fields that make sense
 682         else:
 683             for field in self._data.keys():
 684                 if field in self.read_only_fields:
 685                     continue
 686                 add_field(field)
 687
 688         return args
 689
 690     def refresh(self, only_fields=[]):
 691         # Raise error when trying to refresh a task that has not been saved
 692         if not self.saved:
 693             raise Task.NotSaved("Task needs to be saved to be refreshed")
 694
 695         # We need to use ID as backup for uuid here for the refreshes
 696         # of newly saved tasks. Any other place in the code is fine
 697         # with using UUID only.
 698         args = [self['uuid'] or self['id'], 'export']
 699         new_data = json.loads(self.warrior.execute_command(args)[0])
 700         if only_fields:
 701             to_update = dict(
 702                 [(k, new_data.get(k)) for k in only_fields])
 703             self._update_data(to_update, update_original=True)
 704         else:
 705             self._load_data(new_data)
 706
 707 class TaskFilter(SerializingObject):
 708     """
 709     A set of parameters to filter the task list with.
 710     """
 711
 712     def __init__(self, warrior, filter_params=[]):
 713         self.filter_params = filter_params
 714         super(TaskFilter, self).__init__(warrior)
 715
 716     def add_filter(self, filter_str):
 717         self.filter_params.append(filter_str)
 718
 719     def add_filter_param(self, key, value):
 720         key = key.replace('__', '.')
 721
 722         # Replace the value with empty string, since that is the
 723         # convention in TW for empty values
 724         attribute_key = key.split('.')[0]
 725
 726         # Since this is user input, we need to normalize before we serialize
 727         value = self._normalize(attribute_key, value)
 728         value = self._serialize(attribute_key, value)
 729
 730         # If we are filtering by uuid:, do not use uuid keyword
 731         # due to TW-1452 bug
 732         if key == 'uuid':
 733             self.filter_params.insert(0, value)
 734         else:
 735             # Surround value with aphostrophes unless it's a empty string
 736             value = "'%s'" % value if value else ''
 737
 738             # We enforce equality match by using 'is' (or 'none') modifier
 739             # Without using this syntax, filter fails due to TW-1479
 740             modifier = '.is' if value else '.none'
 741             key = key + modifier if '.' not in key else key
 742
 743             self.filter_params.append("{0}:{1}".format(key, value))
 744
 745     def get_filter_params(self):
 746         return [f for f in self.filter_params if f]
 747
 748     def clone(self):
 749         c = self.__class__(self.warrior)
 750         c.filter_params = list(self.filter_params)
 751         return c
 752
 753
 754 class TaskQuerySet(object):
 755     """
 756     Represents a lazy lookup for a task objects.
 757     """
 758
 759     def __init__(self, warrior=None, filter_obj=None):
 760         self.warrior = warrior
 761         self._result_cache = None
 762         self.filter_obj = filter_obj or TaskFilter(warrior)
 763
 764     def __deepcopy__(self, memo):
 765         """
 766         Deep copy of a QuerySet doesn't populate the cache
 767         """
 768         obj = self.__class__()
 769         for k, v in self.__dict__.items():
 770             if k in ('_iter', '_result_cache'):
 771                 obj.__dict__[k] = None
 772             else:
 773                 obj.__dict__[k] = copy.deepcopy(v, memo)
 774         return obj
 775
 776     def __repr__(self):
 777         data = list(self[:REPR_OUTPUT_SIZE + 1])
 778         if len(data) > REPR_OUTPUT_SIZE:
 779             data[-1] = "...(remaining elements truncated)..."
 780         return repr(data)
 781
 782     def __len__(self):
 783         if self._result_cache is None:
 784             self._result_cache = list(self)
 785         return len(self._result_cache)
 786
 787     def __iter__(self):
 788         if self._result_cache is None:
 789             self._result_cache = self._execute()
 790         return iter(self._result_cache)
 791
 792     def __getitem__(self, k):
 793         if self._result_cache is None:
 794             self._result_cache = list(self)
 795         return self._result_cache.__getitem__(k)
 796
 797     def __bool__(self):
 798         if self._result_cache is not None:
 799             return bool(self._result_cache)
 800         try:
 801             next(iter(self))
 802         except StopIteration:
 803             return False
 804         return True
 805
 806     def __nonzero__(self):
 807         return type(self).__bool__(self)
 808
 809     def _clone(self, klass=None, **kwargs):
 810         if klass is None:
 811             klass = self.__class__
 812         filter_obj = self.filter_obj.clone()
 813         c = klass(warrior=self.warrior, filter_obj=filter_obj)
 814         c.__dict__.update(kwargs)
 815         return c
 816
 817     def _execute(self):
 818         """
 819         Fetch the tasks which match the current filters.
 820         """
 821         return self.warrior.filter_tasks(self.filter_obj)
 822
 823     def all(self):
 824         """
 825         Returns a new TaskQuerySet that is a copy of the current one.
 826         """
 827         return self._clone()
 828
 829     def pending(self):
 830         return self.filter(status=PENDING)
 831
 832     def completed(self):
 833         return self.filter(status=COMPLETED)
 834
 835     def filter(self, *args, **kwargs):
 836         """
 837         Returns a new TaskQuerySet with the given filters added.
 838         """
 839         clone = self._clone()
 840         for f in args:
 841             clone.filter_obj.add_filter(f)
 842         for key, value in kwargs.items():
 843             clone.filter_obj.add_filter_param(key, value)
 844         return clone
 845
 846     def get(self, **kwargs):
 847         """
 848         Performs the query and returns a single object matching the given
 849         keyword arguments.
 850         """
 851         clone = self.filter(**kwargs)
 852         num = len(clone)
 853         if num == 1:
 854             return clone._result_cache[0]
 855         if not num:
 856             raise Task.DoesNotExist(
 857                 'Task matching query does not exist. '
 858                 'Lookup parameters were {0}'.format(kwargs))
 859         raise ValueError(
 860             'get() returned more than one Task -- it returned {0}! '
 861             'Lookup parameters were {1}'.format(num, kwargs))
 862
 863
 864 class TaskWarrior(object):
 865     def __init__(self, data_location='~/.task', create=True, taskrc_location='~/.taskrc'):
 866         data_location = os.path.expanduser(data_location)
 867         self.taskrc_location = os.path.expanduser(taskrc_location)
 868
 869         # If taskrc does not exist, pass / to use defaults and avoid creating
 870         # dummy .taskrc file by TaskWarrior
 871         if not os.path.exists(self.taskrc_location):
 872             self.taskrc_location = '/'
 873
 874         if create and not os.path.exists(data_location):
 875             os.makedirs(data_location)
 876
 877         self.version = self._get_version()
 878         self.config = {
 879             'data.location': data_location,
 880             'confirmation': 'no',
 881             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
 882             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks
 883             # 2.4.3 onwards supports 0 as infite bulk, otherwise set just
 884             # arbitrary big number which is likely to be large enough
 885             'bulk': 0 if self.version > VERSION_2_4_3 else 100000,
 886         }
 887         self.tasks = TaskQuerySet(self)
 888
 889     def _get_command_args(self, args, config_override={}):
 890         command_args = ['task', 'rc:{0}'.format(self.taskrc_location)]
 891         config = self.config.copy()
 892         config.update(config_override)
 893         for item in config.items():
 894             command_args.append('rc.{0}={1}'.format(*item))
 895         command_args.extend(map(str, args))
 896         return command_args
 897
 898     def _get_version(self):
 899         p = subprocess.Popen(
 900                 ['task', '--version'],
 901                 stdout=subprocess.PIPE,
 902                 stderr=subprocess.PIPE)
 903         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
 904         return stdout.strip('\n')
 905
 906     def execute_command(self, args, config_override={}, allow_failure=True):
 907         command_args = self._get_command_args(
 908             args, config_override=config_override)
 909         logger.debug(' '.join(command_args))
 910         p = subprocess.Popen(command_args, stdout=subprocess.PIPE,
 911                              stderr=subprocess.PIPE)
 912         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
 913         if p.returncode and allow_failure:
 914             if stderr.strip():
 915                 error_msg = stderr.strip()
 916             else:
 917                 error_msg = stdout.strip()
 918             raise TaskWarriorException(error_msg)
 919         return stdout.rstrip().split('\n')
 920
 921     def enforce_recurrence(self):
 922         # Run arbitrary report command which will trigger generation
 923         # of recurrent tasks.
 924
 925         # Only necessary for TW up to 2.4.1, fixed in 2.4.2.
 926         if self.version < VERSION_2_4_2:
 927             self.execute_command(['next'], allow_failure=False)
 928
 929     def filter_tasks(self, filter_obj):
 930         self.enforce_recurrence()
 931         args = ['export', '--'] + filter_obj.get_filter_params()
 932         tasks = []
 933         for line in self.execute_command(args):
 934             if line:
 935                 data = line.strip(',')
 936                 try:
 937                     filtered_task = Task(self)
 938                     filtered_task._load_data(json.loads(data))
 939                     tasks.append(filtered_task)
 940                 except ValueError:
 941                     raise TaskWarriorException('Invalid JSON: %s' % data)
 942         return tasks
 943
 944     def merge_with(self, path, push=False):
 945         path = path.rstrip('/') + '/'
 946         self.execute_command(['merge', path], config_override={
 947             'merge.autopush': 'yes' if push else 'no',
 948         })
 949
 950     def undo(self):
 951         self.execute_command(['undo'])