]> git.madduck.net Git - etc/taskwarrior.git/blob - tasklib/task.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

6de828f92cd458702690516de6548c3a1635c8ff
[etc/taskwarrior.git] / 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, input_file=sys.stdin, modify=None):
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         Input_file argument can be used to specify the input file,
223         but defaults to sys.stdin.
224         """
225
226         # TaskWarrior instance is set to None
227         task = cls(None)
228
229         # Detect the hook type if not given directly
230         name = os.path.basename(sys.argv[0])
231         modify = name.startswith('on-modify') if modify is None else modify
232
233         # Load the data from the input
234         task._load_data(json.loads(input_file.readline().strip()))
235
236         # If this is a on-modify event, we are provided with additional
237         # line of input, which provides updated data
238         if modify:
239             task._update_data(json.loads(input_file.readline().strip()))
240
241         return task
242
243     def __init__(self, warrior, **kwargs):
244         self.warrior = warrior
245
246         # Check that user is not able to set read-only value in __init__
247         for key in kwargs.keys():
248             if key in self.read_only_fields:
249                 raise RuntimeError('Field \'%s\' is read-only' % key)
250
251         # We serialize the data in kwargs so that users of the library
252         # do not have to pass different data formats via __setitem__ and
253         # __init__ methods, that would be confusing
254
255         # Rather unfortunate syntax due to python2.6 comaptiblity
256         self._load_data(dict((key, self._serialize(key, value))
257                         for (key, value) in six.iteritems(kwargs)))
258
259     def __unicode__(self):
260         return self['description']
261
262     def __eq__(self, other):
263         if self['uuid'] and other['uuid']:
264             # For saved Tasks, just define equality by equality of uuids
265             return self['uuid'] == other['uuid']
266         else:
267             # If the tasks are not saved, compare the actual instances
268             return id(self) == id(other)
269
270
271     def __hash__(self):
272         if self['uuid']:
273             # For saved Tasks, just define equality by equality of uuids
274             return self['uuid'].__hash__()
275         else:
276             # If the tasks are not saved, return hash of instance id
277             return id(self).__hash__()
278
279     @property
280     def _modified_fields(self):
281         writable_fields = set(self._data.keys()) - set(self.read_only_fields)
282         for key in writable_fields:
283             new_value = self._data.get(key)
284             old_value = self._original_data.get(key)
285
286             # Make sure not to mark data removal as modified field if the
287             # field originally had some empty value
288             if key in self._data and not new_value and not old_value:
289                 continue
290
291             if new_value != old_value:
292                 yield key
293
294     @property
295     def modified(self):
296         return bool(list(self._modified_fields))
297
298     @property
299     def completed(self):
300         return self['status'] == six.text_type('completed')
301
302     @property
303     def deleted(self):
304         return self['status'] == six.text_type('deleted')
305
306     @property
307     def waiting(self):
308         return self['status'] == six.text_type('waiting')
309
310     @property
311     def pending(self):
312         return self['status'] == six.text_type('pending')
313
314     @property
315     def saved(self):
316         return self['uuid'] is not None or self['id'] is not None
317
318     def serialize_depends(self, cur_dependencies):
319         # Check that all the tasks are saved
320         for task in cur_dependencies:
321             if not task.saved:
322                 raise Task.NotSaved('Task \'%s\' needs to be saved before '
323                                     'it can be set as dependency.' % task)
324
325         return super(Task, self).serialize_depends(cur_dependencies)
326
327     def format_depends(self):
328         # We need to generate added and removed dependencies list,
329         # since Taskwarrior does not accept redefining dependencies.
330
331         # This cannot be part of serialize_depends, since we need
332         # to keep a list of all depedencies in the _data dictionary,
333         # not just currently added/removed ones
334
335         old_dependencies = self._original_data.get('depends', set())
336
337         added = self['depends'] - old_dependencies
338         removed = old_dependencies - self['depends']
339
340         # Removed dependencies need to be prefixed with '-'
341         return 'depends:' + ','.join(
342                 [t['uuid'] for t in added] +
343                 ['-' + t['uuid'] for t in removed]
344             )
345
346     def format_description(self):
347         # Task version older than 2.4.0 ignores first word of the
348         # task description if description: prefix is used
349         if self.warrior.version < VERSION_2_4_0:
350             return self._data['description']
351         else:
352             return "description:'{0}'".format(self._data['description'] or '')
353
354     def delete(self):
355         if not self.saved:
356             raise Task.NotSaved("Task needs to be saved before it can be deleted")
357
358         # Refresh the status, and raise exception if the task is deleted
359         self.refresh(only_fields=['status'])
360
361         if self.deleted:
362             raise Task.DeletedTask("Task was already deleted")
363
364         self.warrior.execute_command([self['uuid'], 'delete'])
365
366         # Refresh the status again, so that we have updated info stored
367         self.refresh(only_fields=['status'])
368
369
370     def done(self):
371         if not self.saved:
372             raise Task.NotSaved("Task needs to be saved before it can be completed")
373
374         # Refresh, and raise exception if task is already completed/deleted
375         self.refresh(only_fields=['status'])
376
377         if self.completed:
378             raise Task.CompletedTask("Cannot complete a completed task")
379         elif self.deleted:
380             raise Task.DeletedTask("Deleted task cannot be completed")
381
382         self.warrior.execute_command([self['uuid'], 'done'])
383
384         # Refresh the status again, so that we have updated info stored
385         self.refresh(only_fields=['status'])
386
387     def save(self):
388         if self.saved and not self.modified:
389             return
390
391         args = [self['uuid'], 'modify'] if self.saved else ['add']
392         args.extend(self._get_modified_fields_as_args())
393         output = self.warrior.execute_command(args)
394
395         # Parse out the new ID, if the task is being added for the first time
396         if not self.saved:
397             id_lines = [l for l in output if l.startswith('Created task ')]
398
399             # Complain loudly if it seems that more tasks were created
400             # Should not happen
401             if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3:
402                 raise TaskWarriorException("Unexpected output when creating "
403                                            "task: %s" % '\n'.join(id_lines))
404
405             # Circumvent the ID storage, since ID is considered read-only
406             self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
407
408         # Refreshing is very important here, as not only modification time
409         # is updated, but arbitrary attribute may have changed due hooks
410         # altering the data before saving
411         self.refresh()
412
413     def add_annotation(self, annotation):
414         if not self.saved:
415             raise Task.NotSaved("Task needs to be saved to add annotation")
416
417         args = [self['uuid'], 'annotate', annotation]
418         self.warrior.execute_command(args)
419         self.refresh(only_fields=['annotations'])
420
421     def remove_annotation(self, annotation):
422         if not self.saved:
423             raise Task.NotSaved("Task needs to be saved to remove annotation")
424
425         if isinstance(annotation, TaskAnnotation):
426             annotation = annotation['description']
427         args = [self['uuid'], 'denotate', annotation]
428         self.warrior.execute_command(args)
429         self.refresh(only_fields=['annotations'])
430
431     def _get_modified_fields_as_args(self):
432         args = []
433
434         def add_field(field):
435             # Add the output of format_field method to args list (defaults to
436             # field:value)
437             serialized_value = self._serialize(field, self._data[field]) or ''
438             format_default = lambda: "{0}:{1}".format(
439                 field,
440                 "'{0}'".format(serialized_value) if serialized_value else ''
441             )
442             format_func = getattr(self, 'format_{0}'.format(field),
443                                   format_default)
444             args.append(format_func())
445
446         # If we're modifying saved task, simply pass on all modified fields
447         if self.saved:
448             for field in self._modified_fields:
449                 add_field(field)
450         # For new tasks, pass all fields that make sense
451         else:
452             for field in self._data.keys():
453                 if field in self.read_only_fields:
454                     continue
455                 add_field(field)
456
457         return args
458
459     def refresh(self, only_fields=[]):
460         # Raise error when trying to refresh a task that has not been saved
461         if not self.saved:
462             raise Task.NotSaved("Task needs to be saved to be refreshed")
463
464         # We need to use ID as backup for uuid here for the refreshes
465         # of newly saved tasks. Any other place in the code is fine
466         # with using UUID only.
467         args = [self['uuid'] or self['id'], 'export']
468         new_data = json.loads(self.warrior.execute_command(args)[0])
469         if only_fields:
470             to_update = dict(
471                 [(k, new_data.get(k)) for k in only_fields])
472             self._update_data(to_update, update_original=True)
473         else:
474             self._load_data(new_data)
475
476     def export_data(self):
477         """
478         Exports current data contained in the Task as JSON
479         """
480
481         # We need to remove spaces for TW-1504, use custom separators
482         data_tuples = ((key, self._serialize(key, value))
483                        for key, value in six.iteritems(self._data))
484
485         # Empty string denotes empty serialized value, we do not want
486         # to pass that to TaskWarrior.
487         data_tuples = filter(lambda t: t[1] is not '', data_tuples)
488         data = dict(data_tuples)
489         return json.dumps(data, separators=(',',':'))
490
491 class TaskFilter(SerializingObject):
492     """
493     A set of parameters to filter the task list with.
494     """
495
496     def __init__(self, filter_params=[]):
497         self.filter_params = filter_params
498
499     def add_filter(self, filter_str):
500         self.filter_params.append(filter_str)
501
502     def add_filter_param(self, key, value):
503         key = key.replace('__', '.')
504
505         # Replace the value with empty string, since that is the
506         # convention in TW for empty values
507         attribute_key = key.split('.')[0]
508         value = self._serialize(attribute_key, value)
509
510         # If we are filtering by uuid:, do not use uuid keyword
511         # due to TW-1452 bug
512         if key == 'uuid':
513             self.filter_params.insert(0, value)
514         else:
515             # Surround value with aphostrophes unless it's a empty string
516             value = "'%s'" % value if value else ''
517
518             # We enforce equality match by using 'is' (or 'none') modifier
519             # Without using this syntax, filter fails due to TW-1479
520             modifier = '.is' if value else '.none'
521             key = key + modifier if '.' not in key else key
522
523             self.filter_params.append("{0}:{1}".format(key, value))
524
525     def get_filter_params(self):
526         return [f for f in self.filter_params if f]
527
528     def clone(self):
529         c = self.__class__()
530         c.filter_params = list(self.filter_params)
531         return c
532
533
534 class TaskQuerySet(object):
535     """
536     Represents a lazy lookup for a task objects.
537     """
538
539     def __init__(self, warrior=None, filter_obj=None):
540         self.warrior = warrior
541         self._result_cache = None
542         self.filter_obj = filter_obj or TaskFilter()
543
544     def __deepcopy__(self, memo):
545         """
546         Deep copy of a QuerySet doesn't populate the cache
547         """
548         obj = self.__class__()
549         for k, v in self.__dict__.items():
550             if k in ('_iter', '_result_cache'):
551                 obj.__dict__[k] = None
552             else:
553                 obj.__dict__[k] = copy.deepcopy(v, memo)
554         return obj
555
556     def __repr__(self):
557         data = list(self[:REPR_OUTPUT_SIZE + 1])
558         if len(data) > REPR_OUTPUT_SIZE:
559             data[-1] = "...(remaining elements truncated)..."
560         return repr(data)
561
562     def __len__(self):
563         if self._result_cache is None:
564             self._result_cache = list(self)
565         return len(self._result_cache)
566
567     def __iter__(self):
568         if self._result_cache is None:
569             self._result_cache = self._execute()
570         return iter(self._result_cache)
571
572     def __getitem__(self, k):
573         if self._result_cache is None:
574             self._result_cache = list(self)
575         return self._result_cache.__getitem__(k)
576
577     def __bool__(self):
578         if self._result_cache is not None:
579             return bool(self._result_cache)
580         try:
581             next(iter(self))
582         except StopIteration:
583             return False
584         return True
585
586     def __nonzero__(self):
587         return type(self).__bool__(self)
588
589     def _clone(self, klass=None, **kwargs):
590         if klass is None:
591             klass = self.__class__
592         filter_obj = self.filter_obj.clone()
593         c = klass(warrior=self.warrior, filter_obj=filter_obj)
594         c.__dict__.update(kwargs)
595         return c
596
597     def _execute(self):
598         """
599         Fetch the tasks which match the current filters.
600         """
601         return self.warrior.filter_tasks(self.filter_obj)
602
603     def all(self):
604         """
605         Returns a new TaskQuerySet that is a copy of the current one.
606         """
607         return self._clone()
608
609     def pending(self):
610         return self.filter(status=PENDING)
611
612     def completed(self):
613         return self.filter(status=COMPLETED)
614
615     def filter(self, *args, **kwargs):
616         """
617         Returns a new TaskQuerySet with the given filters added.
618         """
619         clone = self._clone()
620         for f in args:
621             clone.filter_obj.add_filter(f)
622         for key, value in kwargs.items():
623             clone.filter_obj.add_filter_param(key, value)
624         return clone
625
626     def get(self, **kwargs):
627         """
628         Performs the query and returns a single object matching the given
629         keyword arguments.
630         """
631         clone = self.filter(**kwargs)
632         num = len(clone)
633         if num == 1:
634             return clone._result_cache[0]
635         if not num:
636             raise Task.DoesNotExist(
637                 'Task matching query does not exist. '
638                 'Lookup parameters were {0}'.format(kwargs))
639         raise ValueError(
640             'get() returned more than one Task -- it returned {0}! '
641             'Lookup parameters were {1}'.format(num, kwargs))
642
643
644 class TaskWarrior(object):
645     def __init__(self, data_location='~/.task', create=True):
646         data_location = os.path.expanduser(data_location)
647         if create and not os.path.exists(data_location):
648             os.makedirs(data_location)
649         self.config = {
650             'data.location': os.path.expanduser(data_location),
651             'confirmation': 'no',
652             'dependency.confirmation': 'no', # See TW-1483 or taskrc man page
653         }
654         self.tasks = TaskQuerySet(self)
655         self.version = self._get_version()
656
657     def _get_command_args(self, args, config_override={}):
658         command_args = ['task', 'rc:/']
659         config = self.config.copy()
660         config.update(config_override)
661         for item in config.items():
662             command_args.append('rc.{0}={1}'.format(*item))
663         command_args.extend(map(str, args))
664         return command_args
665
666     def _get_version(self):
667         p = subprocess.Popen(
668                 ['task', '--version'],
669                 stdout=subprocess.PIPE,
670                 stderr=subprocess.PIPE)
671         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
672         return stdout.strip('\n')
673
674     def execute_command(self, args, config_override={}):
675         command_args = self._get_command_args(
676             args, config_override=config_override)
677         logger.debug(' '.join(command_args))
678         p = subprocess.Popen(command_args, stdout=subprocess.PIPE,
679                              stderr=subprocess.PIPE)
680         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
681         if p.returncode:
682             if stderr.strip():
683                 error_msg = stderr.strip().splitlines()[-1]
684             else:
685                 error_msg = stdout.strip()
686             raise TaskWarriorException(error_msg)
687         return stdout.strip().split('\n')
688
689     def filter_tasks(self, filter_obj):
690         args = ['export', '--'] + filter_obj.get_filter_params()
691         tasks = []
692         for line in self.execute_command(args):
693             if line:
694                 data = line.strip(',')
695                 try:
696                     filtered_task = Task(self)
697                     filtered_task._load_data(json.loads(data))
698                     tasks.append(filtered_task)
699                 except ValueError:
700                     raise TaskWarriorException('Invalid JSON: %s' % data)
701         return tasks
702
703     def merge_with(self, path, push=False):
704         path = path.rstrip('/') + '/'
705         self.execute_command(['merge', path], config_override={
706             'merge.autopush': 'yes' if push else 'no',
707         })
708
709     def undo(self):
710         self.execute_command(['undo'])