Move imports and constants to respective modules

[etc/taskwarrior.git] / tasklib / backends.py

diff --git a/tasklib/backends.py b/tasklib/backends.py
index a1d858f54e24285aecb0b154700f5e62e9112841..fe24fd205d521c64214418afd7bb0c64b30b07df 100644 (file)
--- a/tasklib/backends.py
+++ b/tasklib/backends.py
@@ -4,7 +4,10 @@ import os
 import re
 import subprocess
 
-from tasklib.task import TaskFilter
+from tasklib.filters import TaskWarriorFilter
+from tasklib.serializing import local_zone
+
+DATE_FORMAT_CALC = '%Y-%m-%dT%H:%M:%S'
 
 VERSION_2_1_0 = six.u('2.1.0')
 VERSION_2_2_0 = six.u('2.2.0')
@@ -19,7 +22,7 @@ VERSION_2_4_5 = six.u('2.4.5')
 
 class Backend(object):
 
-    filter_class = TaskFilter
+    filter_class = TaskWarriorFilter
 
     @abc.abstractmethod
     def filter_tasks(self, filter_obj):
@@ -67,6 +70,13 @@ 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
@@ -121,6 +131,85 @@ class TaskWarrior(object):
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
+    def _get_modified_task_fields_as_args(self, task):
+        args = []
+
+        def add_field(field):
+            # Add the output of format_field method to args list (defaults to
+            # field:value)
+            serialized_value = task._serialize(field, task._data[field])
+
+            # Empty values should not be enclosed in quotation marks, see
+            # TW-1510
+            if serialized_value is '':
+                escaped_serialized_value = ''
+            else:
+                escaped_serialized_value = six.u("'{0}'").format(serialized_value)
+
+            format_default = lambda: six.u("{0}:{1}").format(field,
+                                                      escaped_serialized_value)
+
+            format_func = getattr(self, 'format_{0}'.format(field),
+                                  format_default)
+
+            args.append(format_func(task))
+
+        # If we're modifying saved task, simply pass on all modified fields
+        if task.saved:
+            for field in task._modified_fields:
+                add_field(field)
+        # For new tasks, pass all fields that make sense
+        else:
+            for field in task._data.keys():
+                if field in task.read_only_fields:
+                    continue
+                add_field(field)
+
+        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 = self['depends'] - old_dependencies
+        removed = old_dependencies - self['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 < 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 >= 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)))
+
+    # Public interface
+
     def get_config(self):
         raw_output = self.execute_command(
                 ['show'],
@@ -198,7 +287,7 @@ class TaskWarrior(object):
         """Save a task into TaskWarrior database using add/modify call"""
 
         args = [task['uuid'], 'modify'] if task.saved else ['add']
-        args.extend(task._get_modified_fields_as_args())
+        args.extend(self._get_modified_task_fields_as_args(task))
         output = self.execute_command(args)
 
         # Parse out the new ID, if the task is being added for the first time
@@ -241,6 +330,14 @@ class TaskWarrior(object):
 
         self.execute_command([task['uuid'], 'done'])
 
+    def annotate_task(self, task, annotation):
+        args = [task['uuid'], 'annotate', annotation]
+        self.execute_command(args)
+
+    def denotate_task(self, task, annotation):
+        args = [task['uuid'], 'denotate', annotation]
+        self.execute_command(args)
+
     def refresh_task(self, task, after_save=False):
         # We need to use ID as backup for uuid here for the refreshes
         # of newly saved tasks. Any other place in the code is fine