add exact date query to enable logyesterday

.github/workflows/deploy.yml

@@ -7,6 +7,7 @@ on:
 
 jobs:
     publish:
+        if: github.repository == 'thingsapi/things.py'
         runs-on: ubuntu-latest
         environment: github-pages
         steps:

.github/workflows/github-pages.yml

@@ -21,6 +21,7 @@ jobs:
         make deps-install
     - name: Run docs
       run: |
+        pip install pytest
         pip install pdoc
         make doc
     - name: Commit files
@@ -29,6 +30,7 @@ jobs:
         git config --local user.name "github-actions[bot]"
         git commit -m "Updated docs" -a||true
     - name: Push changes
+      if: github.repository == 'thingsapi/things.py'
       uses: ad-m/github-push-action@master
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/tests.yml

@@ -27,7 +27,8 @@ jobs:
           pip install coverage pytest
           make test testdoc
       - name: "Upload coverage to Codecov"
-        uses: codecov/codecov-action@v1
+        if: github.repository == 'thingsapi/things.py'
+        uses: codecov/codecov-action@v3
         with:
           fail_ci_if_error: true
       - name: Run lint

Makefile

@@ -42,6 +42,7 @@ testdoc: ## Test the code within the documentation
 
 .PHONY: doc
 doc: install ## Document the code
+	@type pytest >/dev/null 2>&1 || (echo "Run '$(PIP) install pytest' first." >&2 ; exit 1)
 	@#$(PYDOC) $(SRC_CORE).api
 	@$(PDOC) -o $(DST_DOCS) -d numpy -n $(SRC_CORE)
 	@echo "Now open $(DST_DOCS)"
@@ -100,7 +101,8 @@ lint: code-style code-lint  ## Lint everything
 
 deps-install: ## Install the dependencies
 	@type $(PIPENV) >/dev/null 2>&1 || (echo "Run e.g. 'brew install pipenv' first." >&2 ; exit 1)
-	@$(PIPENV) install
+	@$(PIPENV) install --dev
+	npm install pyright
 
 feedback: ## Give feedback
 	@open https://github.com/thingsapi/things.py/issues
@@ -131,3 +133,6 @@ db-to-things:
 
 db-from-things:
 	@cp ~/Library/Group\ Containers/JLMPQHK86H.com.culturedcode.ThingsMac/Things\ Database.thingsdatabase/main.sqlite* tests/
+
+info:
+	pipenv --venv

Pipfile

@@ -7,5 +7,17 @@ name = "pypi"
 
 [dev-packages]
 
+black = "*"
+coverage = "*"
+flake8 = "*"
+mypy = "*"
+pycodestyle = "*"
+pydocstyle = "*"
+pylama = "*"
+pylint = "*"
+pyright = "*"
+pytest = "*"
+vulture = "*"
+
 [requires]
 python_version = "3"

tests/test_things.py

@@ -170,6 +170,8 @@ def test_logbook(self):
         self.assertEqual(0, len(tasks))
         tasks = things.logbook(stop_date="2021-03-28")
         self.assertEqual(21, len(tasks))
+        tasks = things.logbook(stop_date="2021-03-27", exact=True)
+        self.assertEqual(0, len(tasks))
 
     def test_canceled(self):
         tasks = things.canceled()

things/__init__.py

@@ -4,7 +4,7 @@
 __copyright__ = "2021 Alexander Willner & Michael Belfrage"
 __credits__ = ["Alexander Willner", "Michael Belfrage"]
 __license__ = "Apache License 2.0"
-__version__ = "0.0.14"
+__version__ = "0.0.15"
 __maintainer__ = ["Alexander Willner", "Michael Belfrage"]
 __email__ = "[email protected]"
 __status__ = "Development"

things/api.py

@@ -93,6 +93,12 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
           Note: this includes today's date.
         - `start_date == None` (default), then include all tasks.
 
+    stop_date : as start_date, signifies the date of completion
+
+    exact : bool, optional
+        - `exact == False` (default) compare date provided with >=
+        - `exact == True`, compare date with ==
+
     deadline : bool, str or None, optional
         - `deadline == False`, only include tasks _without_ a deadline.
         - `deadline == True`, only include tasks _with_ a deadline.

things/database.py

@@ -188,6 +188,7 @@ def get_tasks(  # pylint: disable=R0914
         tag=None,
         start_date=None,
         stop_date=None,
+        exact=False,
         deadline=None,
         deadline_suppressed=None,
         trashed=False,
@@ -224,10 +225,10 @@ def get_tasks(  # pylint: disable=R0914
         # TK: might consider executing SQL with parameters instead.
         # See: https://docs.python.org/3/library/sqlite3.html#sqlite3.Cursor.execute
 
-        start_filter: str = START_TO_FILTER.get(str(start), "")
-        status_filter: str = STATUS_TO_FILTER.get(str(status), "")
-        trashed_filter: str = TRASHED_TO_FILTER.get(trashed, "")
-        type_filter: str = TYPE_TO_FILTER.get(str(type), "")
+        start_filter: str = START_TO_FILTER.get(start, "") if start else ""
+        status_filter: str = STATUS_TO_FILTER.get(status, "") if status else ""
+        trashed_filter: str = get_allow_none(TRASHED_TO_FILTER, trashed, "")
+        type_filter: str = TYPE_TO_FILTER.get(type, "") if type else ""
 
         # Sometimes a task is _not_ set to trashed, but its context
         # (project or heading it is contained within) is set to trashed.
@@ -253,7 +254,7 @@ def get_tasks(  # pylint: disable=R0914
             {make_filter("TASK.deadlineSuppressionDate", deadline_suppressed)}
             {make_filter("TAG.title", tag)}
             {make_date_filter(f"TASK.{DATE_START}", start_date)}
-            {make_date_filter(f"TASK.{DATE_STOP}", stop_date)}
+            {make_date_filter(f"TASK.{DATE_STOP}", stop_date, exact)}
             {make_date_filter(f"TASK.{DATE_DEADLINE}", deadline)}
             {make_date_range_filter(f"TASK.{DATE_CREATED}", last)}
             {make_search_filter(search_query)}
@@ -474,6 +475,12 @@ def execute_query(self, sql_query, parameters=(), row_factory=None):
 
 # Helper functions
 
+def get_allow_none(dictionary, key, default):
+    """Get key with default from dict, allows none to be passed as key."""
+    if key is None:
+        return default
+    return dictionary.get(key, default)
+
 
 def make_tasks_sql_query(where_predicate=None, order_predicate=None):
     """Make SQL query for Task table."""
@@ -636,7 +643,7 @@ def make_filter(column, value):
     }.get(value, default)
 
 
-def make_date_filter(date_column: str, value) -> str:
+def make_date_filter(date_column: str, value, exact=False) -> str:
     """
     Return a SQL filter for date columns.
 
@@ -651,6 +658,9 @@ def make_date_filter(date_column: str, value) -> str:
         ISO 8601 date str is in the format "YYYY-MM-DD".
         `None` indicates any value.
 
+    exact : bool
+        matches for exact date of date_column
+
     Returns
     -------
     str
@@ -685,7 +695,7 @@ def make_date_filter(date_column: str, value) -> str:
         # Check for ISO 8601 date str
         datetime.date.fromisoformat(value)
         threshold = f"date('{value}')"
-        comparator = ">="
+        comparator = '==' if exact else '>='
     except ValueError:
         # "future" or "past"
         validate("value", value, ["future", "past"])
@@ -778,7 +788,7 @@ def make_truthy_filter(column: str, value) -> str:
     return f"AND NOT IFNULL({column}, 0)"
 
 
-def make_search_filter(query: str) -> str:
+def make_search_filter(query) -> str:
     """
     Return a SQL filter to search tasks by a string query.