X-Git-Url: https://git.madduck.net/etc/taskwarrior.git/blobdiff_plain/fda5cf272018a0596c3ea97c9d4658cf0b5fa048..45feb577b06dd85e0827de3e6d98a40b996ab020:/tasklib/backends.py diff --git a/tasklib/backends.py b/tasklib/backends.py index 38b88b1..825db82 100644 --- a/tasklib/backends.py +++ b/tasklib/backends.py @@ -1,25 +1,26 @@ import abc +import datetime import json +import logging import os import re +import six import subprocess -from tasklib.task import TaskFilter +from .task import Task, TaskQuerySet +from .filters import TaskWarriorFilter +from .serializing import local_zone -VERSION_2_1_0 = six.u('2.1.0') -VERSION_2_2_0 = six.u('2.2.0') -VERSION_2_3_0 = six.u('2.3.0') -VERSION_2_4_0 = six.u('2.4.0') -VERSION_2_4_1 = six.u('2.4.1') -VERSION_2_4_2 = six.u('2.4.2') -VERSION_2_4_3 = six.u('2.4.3') -VERSION_2_4_4 = six.u('2.4.4') -VERSION_2_4_5 = six.u('2.4.5') +DATE_FORMAT_CALC = '%Y-%m-%dT%H:%M:%S' +logger = logging.getLogger(__name__) class Backend(object): - filter_class = TaskFilter + @abc.abstractproperty + def filter_class(self): + """Returns the TaskFilter class used by this backend""" + pass @abc.abstractmethod def filter_tasks(self, filter_obj): @@ -67,12 +68,30 @@ class Backend(object): """Syncs the backend database with the taskd server""" pass + def convert_datetime_string(self, value): + """ + Converts TW syntax datetime string to a localized datetime + object. This method is not mandatory. + """ + raise NotImplemented + class TaskWarriorException(Exception): pass class TaskWarrior(object): + + VERSION_2_1_0 = six.u('2.1.0') + VERSION_2_2_0 = six.u('2.2.0') + VERSION_2_3_0 = six.u('2.3.0') + VERSION_2_4_0 = six.u('2.4.0') + VERSION_2_4_1 = six.u('2.4.1') + VERSION_2_4_2 = six.u('2.4.2') + VERSION_2_4_3 = six.u('2.4.3') + VERSION_2_4_4 = six.u('2.4.4') + VERSION_2_4_5 = six.u('2.4.5') + def __init__(self, data_location=None, create=True, taskrc_location='~/.taskrc'): self.taskrc_location = os.path.expanduser(taskrc_location) @@ -92,7 +111,7 @@ class TaskWarrior(object): # 2.4.3 onwards supports 0 as infite bulk, otherwise set just # arbitrary big number which is likely to be large enough - 'bulk': 0 if self.version >= VERSION_2_4_3 else 100000, + 'bulk': 0 if self.version >= self.VERSION_2_4_3 else 100000, } # Set data.location override if passed via kwarg @@ -136,13 +155,13 @@ class TaskWarrior(object): else: escaped_serialized_value = six.u("'{0}'").format(serialized_value) - format_default = lambda: six.u("{0}:{1}").format(field, + format_default = lambda task: six.u("{0}:{1}").format(field, escaped_serialized_value) - format_func = getattr(task, 'format_{0}'.format(field), + format_func = getattr(self, 'format_{0}'.format(field), format_default) - args.append(format_func()) + args.append(format_func(task)) # If we're modifying saved task, simply pass on all modified fields if task.saved: @@ -157,6 +176,54 @@ class TaskWarrior(object): return args + def format_depends(self, task): + # We need to generate added and removed dependencies list, + # since Taskwarrior does not accept redefining dependencies. + + # This cannot be part of serialize_depends, since we need + # to keep a list of all depedencies in the _data dictionary, + # not just currently added/removed ones + + old_dependencies = task._original_data.get('depends', set()) + + added = task['depends'] - old_dependencies + removed = old_dependencies - task['depends'] + + # Removed dependencies need to be prefixed with '-' + return 'depends:' + ','.join( + [t['uuid'] for t in added] + + ['-' + t['uuid'] for t in removed] + ) + + def format_description(self, task): + # Task version older than 2.4.0 ignores first word of the + # task description if description: prefix is used + if self.version < self.VERSION_2_4_0: + return task._data['description'] + else: + return six.u("description:'{0}'").format(task._data['description'] or '') + + def convert_datetime_string(self, value): + + if self.version >= self.VERSION_2_4_0: + # For strings, use 'task calc' to evaluate the string to datetime + # available since TW 2.4.0 + args = value.split() + result = self.execute_command(['calc'] + args) + naive = datetime.datetime.strptime(result[0], DATE_FORMAT_CALC) + localized = local_zone.localize(naive) + else: + raise ValueError("Provided value could not be converted to " + "datetime, its type is not supported: {}" + .format(type(value))) + + return localized + + @property + def filter_class(self): + return TaskWarriorFilter + + # Public interface def get_config(self): raw_output = self.execute_command( @@ -202,7 +269,7 @@ class TaskWarrior(object): # of recurrent tasks. # Only necessary for TW up to 2.4.1, fixed in 2.4.2. - if self.version < VERSION_2_4_2: + if self.version < self.VERSION_2_4_2: self.execute_command(['next'], allow_failure=False) def merge_with(self, path, push=False): @@ -273,7 +340,7 @@ class TaskWarrior(object): def complete_task(self, task): # Older versions of TW do not stop active task at completion - if self.version < VERSION_2_4_0 and task.active: + if self.version < self.VERSION_2_4_0 and task.active: task.stop() self.execute_command([task['uuid'], 'done']) @@ -299,7 +366,7 @@ class TaskWarrior(object): # For older TW versions attempt to uniquely locate the task # using the data we have if it has been just saved. # This can happen when adding a completed task on older TW versions. - if (not valid(output) and self.version < VERSION_2_4_5 + if (not valid(output) and self.version < self.VERSION_2_4_5 and after_save): # Make a copy, removing ID and UUID. It's most likely invalid