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