]> 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:

LazyUUIDTaskSet: Make the lazy iteration behaviour as defualt
[etc/taskwarrior.git] / tasklib / backends.py
index dfef0a873328653ac15051b5039065432254a4fb..b15e8bd97afac69339d6cdeb64bce43d953616bc 100644 (file)
@@ -1,4 +1,5 @@
 import abc
 import abc
+import copy
 import datetime
 import json
 import logging
 import datetime
 import json
 import logging
@@ -7,7 +8,7 @@ import re
 import six
 import subprocess
 
 import six
 import subprocess
 
-from .task import Task, TaskQuerySet
+from .task import Task, TaskQuerySet, ReadOnlyDictView
 from .filters import TaskWarriorFilter
 from .serializing import local_zone
 
 from .filters import TaskWarriorFilter
 from .serializing import local_zone
 
@@ -15,6 +16,7 @@ DATE_FORMAT_CALC = '%Y-%m-%dT%H:%M:%S'
 
 logger = logging.getLogger(__name__)
 
 
 logger = logging.getLogger(__name__)
 
+
 class Backend(object):
 
     @abc.abstractproperty
 class Backend(object):
 
     @abc.abstractproperty
@@ -80,7 +82,7 @@ class TaskWarriorException(Exception):
     pass
 
 
     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_1_0 = six.u('2.1.0')
     VERSION_2_2_0 = six.u('2.2.0')
@@ -100,8 +102,9 @@ class TaskWarrior(object):
         if not os.path.exists(self.taskrc_location):
             self.taskrc_location = '/'
 
         if not os.path.exists(self.taskrc_location):
             self.taskrc_location = '/'
 
+        self._config = None
         self.version = self._get_version()
         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
             'confirmation': 'no',
             'dependency.confirmation': 'no',  # See TW-1483 or taskrc man page
             'recurrence.confirmation': 'no',  # Necessary for modifying R tasks
@@ -119,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)
             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)]
 
         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(
             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')
 
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
@@ -153,10 +156,11 @@ class TaskWarrior(object):
             if serialized_value is '':
                 escaped_serialized_value = ''
             else:
             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 task: 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)
 
             format_func = getattr(self, 'format_{0}'.format(field),
                                   format_default)
@@ -191,9 +195,9 @@ class TaskWarrior(object):
 
         # Removed dependencies need to be prefixed with '-'
         return 'depends:' + ','.join(
 
         # 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
 
     def format_description(self, task):
         # Task version older than 2.4.0 ignores first word of the
@@ -217,17 +221,25 @@ class TaskWarrior(object):
                              "datetime, its type is not supported: {}"
                              .format(type(value)))
 
                              "datetime, its type is not supported: {}"
                              .format(type(value)))
 
+        return localized
+
     @property
     def filter_class(self):
         return TaskWarriorFilter
 
     # Public interface
 
     @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(
         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].+$)')
 
         config = dict()
         config_regex = re.compile(r'^(?P<key>[^\s]+)\s+(?P<value>[^\s].+$)')
@@ -237,7 +249,10 @@ class TaskWarrior(object):
             if match:
                 config[match.group('key')] = match.group('value').strip()
 
             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):
 
     def execute_command(self, args, config_override=None, allow_failure=True,
                         return_all=False):
@@ -283,7 +298,7 @@ class TaskWarrior(object):
 
     def filter_tasks(self, filter_obj):
         self.enforce_recurrence()
 
     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:
         tasks = []
         for line in self.execute_command(args):
             if line:
@@ -377,15 +392,15 @@ class TaskWarrior(object):
             for key, value in data.items():
                 taskfilter.add_filter_param(key, value)
 
             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(
 
         # 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])
             )
 
         return json.loads(output[0])