]> git.madduck.net Git - etc/taskwarrior.git/blobdiff - tasklib/backends.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:

travis: Taskwarrior 2.5.1 is not yet released
[etc/taskwarrior.git] / tasklib / backends.py
index edf9ac3eeca32526b95ae3dc8e837dc87fd9c830..6e7d91815180d0f357bc3759ff867c6da7056615 100644 (file)
@@ -1,26 +1,20 @@
 import abc
+import copy
 import datetime
 import json
+import logging
 import os
 import re
 import six
 import subprocess
 
-from .task import Task, TaskQuerySet
+from .task import Task, TaskQuerySet, ReadOnlyDictView
 from .filters import TaskWarriorFilter
 from .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')
-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')
+logger = logging.getLogger(__name__)
 
 
 class Backend(object):
@@ -81,14 +75,25 @@ class Backend(object):
         Converts TW syntax datetime string to a localized datetime
         object. This method is not mandatory.
         """
-        raise NotImplemented
+        raise NotImplementedError
 
 
 class TaskWarriorException(Exception):
     pass
 
 
-class TaskWarrior(object):
+class TaskWarrior(Backend):
+
+    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)
 
@@ -97,8 +102,9 @@ class TaskWarrior(object):
         if not os.path.exists(self.taskrc_location):
             self.taskrc_location = '/'
 
+        self._config = None
         self.version = self._get_version()
-        self.config = {
+        self.overrides = {
             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks
@@ -108,7 +114,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
@@ -116,24 +122,24 @@ class TaskWarrior(object):
             data_location = os.path.expanduser(data_location)
             if create and not os.path.exists(data_location):
                 os.makedirs(data_location)
-            self.config['data.location'] = data_location
+            self.overrides['data.location'] = data_location
 
         self.tasks = TaskQuerySet(self)
 
     def _get_command_args(self, args, config_override=None):
         command_args = ['task', 'rc:{0}'.format(self.taskrc_location)]
-        config = self.config.copy()
-        config.update(config_override or dict())
-        for item in config.items():
+        overrides = self.overrides.copy()
+        overrides.update(config_override or dict())
+        for item in overrides.items():
             command_args.append('rc.{0}={1}'.format(*item))
         command_args.extend(map(six.text_type, args))
         return command_args
 
     def _get_version(self):
         p = subprocess.Popen(
-                ['task', '--version'],
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE)
+            ['task', '--version'],
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE)
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
@@ -150,10 +156,11 @@ class TaskWarrior(object):
             if serialized_value is '':
                 escaped_serialized_value = ''
             else:
-                escaped_serialized_value = six.u("'{0}'").format(serialized_value)
+                escaped_serialized_value = six.u("'{0}'").format(
+                    serialized_value)
 
-            format_default = lambda: six.u("{0}:{1}").format(field,
-                                                      escaped_serialized_value)
+            format_default = lambda task: six.u("{0}:{1}").format(
+                field, escaped_serialized_value)
 
             format_func = getattr(self, 'format_{0}'.format(field),
                                   format_default)
@@ -183,26 +190,26 @@ class TaskWarrior(object):
 
         old_dependencies = task._original_data.get('depends', set())
 
-        added = self['depends'] - old_dependencies
-        removed = old_dependencies - self['depends']
+        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]
-            )
+            [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:
+        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 >= VERSION_2_4_0:
+        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()
@@ -214,17 +221,25 @@ class TaskWarrior(object):
                              "datetime, its type is not supported: {}"
                              .format(type(value)))
 
+        return localized
+
     @property
     def filter_class(self):
         return TaskWarriorFilter
 
     # Public interface
 
-    def get_config(self):
+    @property
+    def config(self):
+        # First, check if memoized information is available
+        if self._config:
+            return self._config
+
+        # If not, fetch the config using the 'show' command
         raw_output = self.execute_command(
-                ['show'],
-                config_override={'verbose': 'nothing'}
-            )
+            ['show'],
+            config_override={'verbose': 'nothing'}
+        )
 
         config = dict()
         config_regex = re.compile(r'^(?P<key>[^\s]+)\s+(?P<value>[^\s].+$)')
@@ -234,7 +249,10 @@ class TaskWarrior(object):
             if match:
                 config[match.group('key')] = match.group('value').strip()
 
-        return config
+        # Memoize the config dict
+        self._config = ReadOnlyDictView(config)
+
+        return self._config
 
     def execute_command(self, args, config_override=None, allow_failure=True,
                         return_all=False):
@@ -264,7 +282,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):
@@ -280,7 +298,7 @@ class TaskWarrior(object):
 
     def filter_tasks(self, filter_obj):
         self.enforce_recurrence()
-        args = ['export', '--'] + filter_obj.get_filter_params()
+        args = ['export'] + filter_obj.get_filter_params()
         tasks = []
         for line in self.execute_command(args):
             if line:
@@ -305,8 +323,10 @@ class TaskWarrior(object):
             id_lines = [l for l in output if l.startswith('Created task ')]
 
             # Complain loudly if it seems that more tasks were created
-            # Should not happen
-            if len(id_lines) != 1 or len(id_lines[0].split(' ')) != 3:
+            # Should not happen.
+            # Expected output: Created task 1.
+            #                  Created task 1 (recurrence template).
+            if len(id_lines) != 1 or len(id_lines[0].split(' ')) not in (3, 5):
                 raise TaskWarriorException("Unexpected output when creating "
                                            "task: %s" % '\n'.join(id_lines))
 
@@ -335,7 +355,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'])
@@ -361,7 +381,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
@@ -374,15 +394,15 @@ class TaskWarrior(object):
             for key, value in data.items():
                 taskfilter.add_filter_param(key, value)
 
-            output = self.execute_command(['export', '--'] +
-                taskfilter.get_filter_params())
+            output = self.execute_command(['export'] +
+                                          taskfilter.get_filter_params())
 
         # If more than 1 task has been matched still, raise an exception
         if not valid(output):
             raise TaskWarriorException(
                 "Unique identifiers {0} with description: {1} matches "
                 "multiple tasks: {2}".format(
-                task['uuid'] or task['id'], task['description'], output)
+                    task['uuid'] or task['id'], task['description'], output)
             )
 
         return json.loads(output[0])