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:

Add support for custom `task` location or command
authorRob Golding-Day <rob@golding-day.com>
Mon, 6 May 2019 14:56:35 +0000 (10:56 -0400)
committerRob Golding-Day <rob@golding-day.com>
Mon, 6 May 2019 18:45:58 +0000 (14:45 -0400)
Thanks @xarthurx for proposing WSL support in #62. This commit adds
support in a different way, by allowing the "task" command to be
customised (to `wsl task`, for example).

tasklib/backends.py
tasklib/tests.py

index 9110e125bb3ae38c4f3a9a71f7e6ff6f355d4df9..a5dd280e5cb08e2802af48180a3f2ba22ca38641 100644 (file)
@@ -95,7 +95,7 @@ class TaskWarrior(Backend):
     VERSION_2_4_5 = six.u('2.4.5')
 
     def __init__(self, data_location=None, create=True,
-                 taskrc_location='~/.taskrc'):
+                 taskrc_location='~/.taskrc', task_command='task'):
         self.taskrc_location = os.path.expanduser(taskrc_location)
 
         # If taskrc does not exist, pass / to use defaults and avoid creating
@@ -103,6 +103,8 @@ class TaskWarrior(Backend):
         if not os.path.exists(self.taskrc_location):
             self.taskrc_location = '/'
 
+        self.task_command = task_command
+
         self._config = None
         self.version = self._get_version()
         self.overrides = {
@@ -127,8 +129,11 @@ class TaskWarrior(Backend):
 
         self.tasks = TaskQuerySet(self)
 
+    def _get_task_command(self):
+        return self.task_command.split()
+
     def _get_command_args(self, args, config_override=None):
-        command_args = ['task', 'rc:{0}'.format(self.taskrc_location)]
+        command_args = self._get_task_command() + ['rc:{0}'.format(self.taskrc_location)]
         overrides = self.overrides.copy()
         overrides.update(config_override or dict())
         for item in overrides.items():
@@ -141,7 +146,7 @@ class TaskWarrior(Backend):
 
     def _get_version(self):
         p = subprocess.Popen(
-            ['task', '--version'],
+            self._get_task_command() + ['--version'],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE)
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
@@ -222,7 +227,7 @@ class TaskWarrior(Backend):
     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
+            # For strings, use 'calc' to evaluate the string to datetime
             # available since TW 2.4.0
             args = value.split()
             result = self.execute_command(['calc'] + args)
index d53fc31e2f425b14df29a044a84e989ab2bca51b..6cba1fc6279a52410c5a5ec78f8764be08a8cf88 100644 (file)
@@ -47,14 +47,31 @@ def total_seconds_2_6(x):
 
 class TasklibTest(unittest.TestCase):
 
+    def get_taskwarrior(self, **kwargs):
+        tw_kwargs = dict(
+            data_location=self.tmp,
+            taskrc_location='/',
+        )
+        tw_kwargs.update(kwargs)
+        return TaskWarrior(**tw_kwargs)
+
     def setUp(self):
         self.tmp = tempfile.mkdtemp(dir='.')
-        self.tw = TaskWarrior(data_location=self.tmp, taskrc_location='/')
+        self.tw = self.get_taskwarrior()
 
     def tearDown(self):
         shutil.rmtree(self.tmp)
 
 
+class TaskWarriorTest(TasklibTest):
+
+    def test_custom_command(self):
+        # ensure that a custom command which contains multiple parts
+        # is properly split up
+        tw = self.get_taskwarrior(task_command='wsl task')
+        self.assertEqual(tw._get_task_command(), ['wsl', 'task'])
+
+
 class TaskFilterTest(TasklibTest):
 
     def test_all_empty(self):