Merge pull request #33 from mikez/main

Consistency update: Rename `due` to `deadline`, rename `checklist item` to `checklist-item`.

Author: AlexanderWillner

tests/test_things.py

@@ -16,9 +16,9 @@ class ThingsCase(unittest.TestCase):
 
     def test_search(self):
         """Test search."""
-        tasks = things.search('wrong_query', **FILEPATH)
+        tasks = things.search("wrong_query", **FILEPATH)
         self.assertEqual(0, len(tasks))
-        tasks = things.search('To-Do % Heading', **FILEPATH)
+        tasks = things.search("To-Do % Heading", **FILEPATH)
         self.assertEqual(1, len(tasks))
 
     def test_inbox(self):
@@ -31,9 +31,9 @@ def test_upcoming(self):
         tasks = things.upcoming(**FILEPATH)
         self.assertEqual(2, len(tasks))
 
-    def test_due(self):
-        """Test due."""
-        tasks = things.due(**FILEPATH)
+    def test_deadlines(self):
+        """Test deadlines."""
+        tasks = things.deadlines(**FILEPATH)
         self.assertEqual(1, len(tasks))
 
     def test_today(self):

things/__init__.py

@@ -5,7 +5,7 @@
     areas,
     canceled,
     completed,
-    due,
+    deadlines,
     get,
     inbox,
     link,

things/api.py

@@ -85,9 +85,9 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
         If the argument is `True`, only include tasks _with_ a start date.
         If the argument is `None` (default), then include all tasks.
 
-    due_date : bool or None, optional
-        If the argument is `False`, only include tasks _without_ a due date.
-        If the argument is `True`, only include tasks _with_ a due date.
+    deadline : bool or None, optional
+        If the argument is `False`, only include tasks _without_ a deadline.
+        If the argument is `True`, only include tasks _with_ a deadline.
         If the argument is `None` (default), then include all tasks.
 
     search_query : str, optional
@@ -427,8 +427,8 @@ def today(**kwargs):
 
 def upcoming(**kwargs):
     """
-    Note: unscheduled tasks with a due date are not included here.
-    See the `due` function instead.
+    Note: unscheduled tasks with a deadline are not included here.
+    See the `deadline` function instead.
     """
     return tasks(start_date=True, start="Someday", **kwargs)
 
@@ -466,9 +466,9 @@ def completed(**kwargs):
     return tasks(status="completed", **kwargs)
 
 
-def due(**kwargs):
-    result = tasks(due_date=True, **kwargs)
-    result.sort(key=lambda task: task["due_date"])
+def deadlines(**kwargs):
+    result = tasks(deadline=True, **kwargs)
+    result.sort(key=lambda task: task["deadline"])
     return result
 
 

things/database.py

@@ -1,7 +1,11 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
 
-"""Simple read-only API for Things."""
+"""Simple read-only API for Things.
+
+We attempt to follow the names used in the Things app, URL Scheme,
+and SQL database whenever possible.
+"""
 
 from __future__ import print_function
 
@@ -67,15 +71,15 @@ class Database:
     TABLE_META = "Meta"
     DATE_CREATE = "creationDate"
     DATE_MOD = "userModificationDate"
-    DATE_DUE = "dueDate"
+    DATE_DEADLINE = "dueDate"
     DATE_START = "startDate"
     DATE_STOP = "stopDate"
     IS_INBOX = START_TO_FILTER["Inbox"]
     IS_ANYTIME = START_TO_FILTER["Anytime"]
     IS_SOMEDAY = START_TO_FILTER["Someday"]
     IS_SCHEDULED = f"{DATE_START} IS NOT NULL"
     IS_NOT_SCHEDULED = f"{DATE_START} IS NULL"
-    IS_DUE = f"{DATE_DUE} IS NOT NULL"
+    IS_DEADLINE = f"{DATE_DEADLINE} IS NOT NULL"
     IS_RECURRING = "recurrenceRule IS NOT NULL"
     IS_NOT_RECURRING = "recurrenceRule IS NULL"
     IS_TODO = TYPE_TO_FILTER["to-do"]
@@ -120,7 +124,7 @@ def get_tasks(
         heading=None,
         tag=None,
         start_date=None,
-        due_date=None,
+        deadline=None,
         index="index",
         count_only=False,
         search_query=None,
@@ -168,7 +172,7 @@ def get_tasks(
                     {make_filter("TASK.project", project)}
                     {make_filter("TASK.actionGroup", heading)}
                     {make_filter("TASK.startDate", start_date)}
-                    {make_filter("TASK.dueDate", due_date)}
+                    {make_filter(f"TASK.{self.DATE_DEADLINE}", deadline)}
                     {make_filter("TAG.title", tag)}
                     {make_search_filter(search_query)}
                     ORDER BY TASK."{index}"
@@ -221,8 +225,8 @@ def make_task_sql_query(self, where_predicate):
                     WHEN CHECKLIST_ITEM.uuid IS NOT NULL THEN 1
                 END AS checklist,
                 date(TASK.startDate, "unixepoch") AS start_date,
-                date(TASK.dueDate, "unixepoch") AS due_date,
-                date(TASK.stopDate, "unixepoch") AS stop_date,
+                date(TASK.{self.DATE_DEADLINE}, "unixepoch") AS deadline,
+                date(TASK.stopDate, "unixepoch") AS "stop_date",
                 datetime(TASK.{self.DATE_CREATE}, "unixepoch", "localtime") AS created,
                 datetime(TASK.{self.DATE_MOD}, "unixepoch", "localtime") AS modified
             FROM
@@ -302,7 +306,7 @@ def get_checklist_items(self, task_uuid=None):
                         WHEN CHECKLIST_ITEM.{self.IS_CANCELED} THEN 'canceled'
                     END AS status,
                     date(CHECKLIST_ITEM.stopDate, "unixepoch") AS stop_date,
-                    'checklist item' as type,
+                    'checklist-item' as type,
                     CHECKLIST_ITEM.uuid,
                     datetime(
                         CHECKLIST_ITEM.{self.DATE_MOD}, "unixepoch", "localtime"