Merge pull request #27 from AlexanderWillner/main

added api.search - addressing https://github.com/thingsapi/things.py/…

Author: AlexanderWillner

.coveragerc

@@ -0,0 +1,14 @@
+[report]
+
+exclude_lines =
+    if __name__ == .__main__.:
+
+[run]
+    relative_files = True
+
+omit =
+    setup.py
+    */__init__.py
+    src/*_app.py
+    tests/*
+    *site-packages*

Makefile

@@ -34,7 +34,7 @@ test: ## Test the code
 
 .PHONY: doc
 doc: ## Document the code
-	@$(PYDOC) $(SRC_CORE).things
+	@$(PYDOC) $(SRC_CORE).api
 
 .PHONY: clean
 clean: ## Cleanup
@@ -87,7 +87,7 @@ feedback: ## Give feedback
 
 upload: clean ## Upload the code
 	@$(PYTHON) setup.py sdist bdist_wheel
-	@$(PYTHON) -m twine upload --repository-url https://upload.pypi.org/legacy/ dist/things*
+	@$(PYTHON) -m twine upload dist/things.py*
 
 copy-db:
 	@cp ~/Library/Group\ Containers/JLMPQHK86H.com.culturedcode.ThingsMac/Things\ Database.thingsdatabase/main.sqlite* tests/

setup.py

@@ -33,7 +33,7 @@ def package_files(directory):
     app=APP,
     author=AUTHOR,
     author_email=AUTHOR_MAIL,
-    name="things",
+    name="things.py",
     description=DESCRIPTON,
     long_description=LONG_DESRIPTION,
     long_description_content_type="text/markdown",

tests/main.sqlite-shm

@@ -14,6 +14,13 @@
 class ThingsCase(unittest.TestCase):
     """Class documentation goes here."""
 
+    def test_search(self):
+        """Test search."""
+        tasks = things.search('wrong_query', **FILEPATH)
+        self.assertEqual(0, len(tasks))
+        tasks = things.search('To-Do % Heading', **FILEPATH)
+        self.assertEqual(1, len(tasks))
+
     def test_inbox(self):
         """Test inbox."""
         tasks = things.inbox(**FILEPATH)

tests/main.sqlite-wal

@@ -11,6 +11,7 @@
     link,
     logbook,
     projects,
+    search,
     show,
     someday,
     tags,

tests/test_things.py

@@ -7,6 +7,7 @@
 import os
 from shlex import quote
 import sys
+from typing import List, Dict
 
 from .database import Database
 
@@ -16,7 +17,7 @@
 # --------------------------------------------------
 
 
-def tasks(uuid=None, include_items=False, **kwargs):
+def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
     """
     Read tasks into dicts.
 
@@ -314,6 +315,27 @@ def tags(title=None, include_items=False, **kwargs):
 # Utility API functions derived from above
 # --------------------------------------------------
 
+def search(query: str, **kwargs) -> List[Dict]:
+    """
+    Search the database. This takes mainly notes and titles into account.
+
+    Parameters
+    ----------
+    query : str
+        The string with optional placeholders (%) to search for.
+
+    Returns
+    -------
+    list of dict
+        Representing Things items.
+
+    Examples
+    --------
+    >>> things.search('substring % within notes and titles')
+    ...
+    """
+    return tasks(querystr=query, **kwargs)
+
 
 def get(uuid, default=None, **kwargs):
     """

things/__init__.py

@@ -123,6 +123,7 @@ def get_tasks(
         due_date=None,
         index="index",
         count_only=False,
+        querystr=None
     ):
         """Get tasks. See `api.tasks` for details on parameters."""
 
@@ -162,6 +163,7 @@ def get_tasks(
                     AND TASK.{self.IS_NOT_RECURRING}
                     AND (PROJECT.title IS NULL OR PROJECT.{self.IS_NOT_TRASHED})
                     AND (HEADPROJ.title IS NULL OR HEADPROJ.{self.IS_NOT_TRASHED})
+                    {make_search(querystr)}
                     {make_filter('TASK.uuid', uuid)}
                     {make_filter("TASK.area", area)}
                     {make_filter("TASK.project", project)}
@@ -397,6 +399,7 @@ def get_count(self, sql):
         sql = f"""SELECT COUNT(uuid) FROM ({sql})"""
         return self.execute_query(sql, row_factory=list_factory)[0]
 
+    # noqa todo: add type hinting for resutl (List[Tuple[str, Any]]?)
     def execute_query(self, sql, parameters=(), row_factory=None):
         """Run the actual query"""
         if self.debug is True:
@@ -664,6 +667,30 @@ def make_filter(column, value):
     }.get(value, default)
 
 
+def make_search(value: str) -> str:
+    query = ""
+    # noqa todo 'TMChecklistItem.title'
+    sources = ['TASK.title', 'TASK.notes', 'AREA.title']
+    for source in sources:
+        subsearch = make_sub_search(source, value)
+        if subsearch:
+            query = query + subsearch + ' OR '
+    if query.endswith(' OR '):
+        query = query[:-4]
+    if query != "":
+        query = 'AND (' + query + ')'
+    return query
+
+
+def make_sub_search(column, value):
+    default = f'{column} LIKE "%{value}%"'
+    return {
+        None: "",
+        False: f"{column} IS NULL",
+        True: f"{column} IS NOT NULL",
+    }.get(value, default)
+
+
 def validate(parameter, argument, valid_arguments):
     """
     For a given parameter, check if its argument type is valid.