things-py 0.0.9.dev0__tar.gz → 0.0.11__tar.gz

things.py-0.0.11/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

{things.py-0.0.9.dev0 → things.py-0.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: things.py
-Version: 0.0.9.dev0
+Version: 0.0.11
 Summary: A simple Python 3 library to read your Things app data.
 Home-page: https://github.com/thingsapi/things.py
 Author: Alexander Willner, Michael B.

{things.py-0.0.9.dev0 → things.py-0.0.11}/setup.cfg

@@ -13,6 +13,10 @@ ignore = E501,E203,W503
 [pylama]
 ignore = E501,E203,W503
 
+[isort]
+lines_after_imports = 2
+force_sort_within_sections = True
+
 [egg_info]
 tag_build = 
 tag_date = 0

{things.py-0.0.9.dev0 → things.py-0.0.11}/setup.py

@@ -1,7 +1,8 @@
 """A simple Python 3 library to read your Things app data."""
 
 import os
-from setuptools import setup, find_packages  # type: ignore
+
+from setuptools import find_packages, setup  # type: ignore
 
 
 def package_files(directory):

{things.py-0.0.9.dev0 → things.py-0.0.11}/tests/test_things.py

@@ -3,6 +3,8 @@
 
 """Module documentation goes here."""
 
+import contextlib
+import io
 import os
 import unittest
 
@@ -48,14 +50,49 @@ class ThingsCase(unittest.TestCase):
         """Test search."""
         tasks = things.search("wrong_query")
         self.assertEqual(0, len(tasks))
-        tasks = things.search("To-Do % Heading")
-        self.assertEqual(1, len(tasks))
+
+        # test some special characters
+        tasks = things.search("'")
+        self.assertEqual(0, len(tasks))
+
+        tasks = things.search('"')
+        self.assertEqual(0, len(tasks))
+
+        with self.assertRaises(ValueError):
+            things.search("To-Do\0Heading")
+
+        todos = things.search("To-Do % Heading", status=None)
+        # Assert finds
+        #   "To-Do in Heading",
+        #   "Completed To-Do in Heading",
+        #   "Canceled To-Do in Heading"
+        self.assertEqual(3, len(todos))
 
     def test_inbox(self):
         """Test inbox."""
         tasks = things.inbox()
         self.assertEqual(2, len(tasks))
 
+    def test_trashed(self):
+        """Test getting trashed tasks."""
+        tasks = things.trash()
+        self.assertEqual(5, len(tasks))
+        todos = things.todos(trashed=True)
+        self.assertEqual(2, len(todos))
+        projects = things.projects(trashed=True)
+        self.assertEqual(1, len(projects))
+        projects = things.projects(trashed=None)
+        self.assertEqual(4, len(projects))
+        projects = things.trash(type="project")
+        self.assertEqual(1, len(projects))
+        projects = things.trash(type="project", include_items=True)
+        # TOOD: doesn't inlucde items
+        # self.assertEqual(1, len(projects[0]["items"]))
+        # tasks = list(
+        #     filter(lambda _: "in Deleted Project" in _["title"], projects[0]["items"])
+        # )
+        # self.assertEqual(1, len(tasks))
+
     def test_upcoming(self):
         """Test upcoming."""
         tasks = things.upcoming()
@@ -69,7 +106,7 @@ class ThingsCase(unittest.TestCase):
     def test_today(self):
         """Test today."""
         tasks = things.today()
-        self.assertEqual(2, len(tasks))
+        self.assertEqual(3, len(tasks))
 
     def test_checklist(self):
         """Test checklist."""
@@ -81,7 +118,7 @@ class ThingsCase(unittest.TestCase):
     def test_anytime(self):
         """Test anytime."""
         tasks = things.anytime()
-        self.assertEqual(11, len(tasks))
+        self.assertEqual(12, len(tasks))
         self.assertTrue(any(task.get("area_title") == "Area 1" for task in tasks))
 
     def test_logbook(self):
@@ -123,6 +160,8 @@ class ThingsCase(unittest.TestCase):
         self.assertEqual(10, len(todos))
         todos = things.todos(include_items=True)
         self.assertEqual(12, len(todos))
+        tasks = things.tasks(include_items=True)
+        self.assertEqual(16, len(tasks))
         with self.assertRaises(ValueError):
             things.todos(status="wrong_value")
         todo = things.todos("A2oPvtt4dXoypeoLc8uYzY")
@@ -132,18 +171,36 @@ class ThingsCase(unittest.TestCase):
         """Test all tags."""
         tags = things.tags()
         self.assertEqual(5, len(tags))
-        tasks = things.tasks(tag="Errand")
-        self.assertEqual(1, len(tasks))
+        tags = things.tags(include_items=True)
+        self.assertEqual(5, len(tags))
+        tags = things.tasks(tag="Errand")
+        self.assertEqual(1, len(tags))
+        tag = things.tags(title="Errand")
+        self.assertEqual("Errand", tag["title"])
+
+    def test_get_link(self):
+        link = things.link("uuid")
+        self.assertEqual("things:///show?id=uuid", link)
 
     def test_projects(self):
         """Test all projects."""
         projects = things.projects()
-        self.assertEqual(2, len(projects))
+        self.assertEqual(3, len(projects))
+        projects = things.projects(include_items=True)
+        self.assertEqual(2, len(projects[0]["items"]))
 
     def test_areas(self):
         """Test all test_areas."""
         areas = things.areas()
         self.assertEqual(3, len(areas))
+        areas = things.areas(include_items=True)
+        self.assertEqual(3, len(areas))
+        count = things.areas(count_only=True)
+        self.assertEqual(3, count)
+        with self.assertRaises(ValueError):
+            things.areas("wrong-uuid")
+        area = things.areas("Y3JC4XeyGWxzDocQL4aobo")
+        self.assertEqual("Area 3", area["title"])
 
     def test_database_version(self):
         """Test database version."""
@@ -152,11 +209,11 @@ class ThingsCase(unittest.TestCase):
 
     def test_last(self):
         """Test last parameter"""
-        last_tasks = things.last("1d")
+        last_tasks = things.last("0d")
         self.assertEqual(len(last_tasks), 0)
 
         last_tasks = things.last("10000w")
-        self.assertEqual(len(last_tasks), 15)
+        self.assertEqual(len(last_tasks), 16)
 
         last_tasks = things.last("100y", status="completed")
         self.assertEqual(len(last_tasks), 10)
@@ -164,6 +221,9 @@ class ThingsCase(unittest.TestCase):
         with self.assertRaises(ValueError):
             things.last(None)
 
+        with self.assertRaises(ValueError):
+            things.last([])
+
         with self.assertRaises(ValueError):
             things.last("XYZ")
 
@@ -177,6 +237,29 @@ class ThingsCase(unittest.TestCase):
         """Test tasks"""
         count = things.tasks(status="completed", last="100y", count_only=True)
         self.assertEqual(count, 10)
+        # special characters
+        tasks = things.tasks(area='"')
+        self.assertEqual(len(tasks), 0)
+
+        tasks = things.tasks(area="'")
+        self.assertEqual(len(tasks), 0)
+
+        with self.assertRaises(ValueError):
+            things.tasks(area="\0")
+
+    def test_database(self):
+        """Test some database details"""
+        output = io.StringIO()
+        with contextlib.redirect_stdout(output):
+            db = things.api.pop_database({})
+            db.debug = True
+            db.get_tags()
+        self.assertTrue("H96sVJwE7VJveAnv7itmux" in output.getvalue())
+        with contextlib.redirect_stdout(output):
+            things.areas(print_sql=True)
+        self.assertTrue("ORDER BY" in output.getvalue())
+        with self.assertRaises(SystemExit):  # noqa TODO: should actually NOT crash
+            db.execute_query('"')
 
 
 if __name__ == "__main__":

{things.py-0.0.9.dev0 → things.py-0.0.11}/things/__init__.py

@@ -4,7 +4,7 @@ __author__ = ["Alexander Willner", "Michael Belfrage"]
 __copyright__ = "2021 Alexander Willner & Michael Belfrage"
 __credits__ = ["Alexander Willner", "Michael Belfrage"]
 __license__ = "Apache License 2.0"
-__version__ = "0.0.9.dev"
+__version__ = "0.0.11"
 __maintainer__ = ["Alexander Willner", "Michael Belfrage"]
 __email__ = "alex@willner.ws"
 __status__ = "Development"
@@ -30,6 +30,7 @@ from things.api import (  # noqa
     today,
     todos,
     token,
+    trash,
     upcoming,
 )
 from things.database import Database  # noqa

{things.py-0.0.9.dev0 → things.py-0.0.11}/things/api.py

@@ -12,7 +12,7 @@ data structures. Whenever that happens, we define the new term here.
 import os
 from shlex import quote
 import sys
-from typing import Dict, List
+from typing import Dict, List, Union
 
 from things.database import Database
 
@@ -98,14 +98,18 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
         - `deadline == True`, only include tasks _with_ a deadline.
         - `deadline == None` (default), then include all tasks.
 
-    last : str, optional
-        Limit returned tasks to tasks created in the last X days or weeks.
+    trashed : bool or None, optional
+        - `trashed == True`, only include trashed tasks.
+        - `trashed == False`, (default), only include non-trashed tasks.
+        - `trashed == None`, include both kind of tasks.
 
-        Takes as input an offset string of format 'X[d/w]' where X is a
-        non-negative  integer that is followed by 'd' or 'w' which stand
-        for 'days' and 'weeks', respectively.
+    last : str, optional
+        Limit returned tasks to tasks created within the last X days,
+        weeks, or years. For example: '3d', '5w', or '1y'.
 
-        For example: '3d' or '5w'.
+        Takes as input an offset string of the format 'X[d/w/y]' where X
+        is a non-negative  integer that is followed by 'd', 'w', or 'y'
+        which stand for 'days', 'weeks', and 'years', respectively.
 
     search_query : str, optional
         The string value is passed to the SQL LIKE operator. It can thus
@@ -121,6 +125,11 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
     count_only : bool, default False
         Only output length of result. This is done by a SQL COUNT query.
 
+    print_sql : bool, default False
+        Print every SQL query performed. Some may contain '?' and ':'
+        characters, which correspond to SQLite parameter tokens.
+        See https://www.sqlite.org/lang_expr.html#varparam
+
     filepath : str, optional
         Any valid path of a SQLite database file generated by the Things app.
         If the environment variable `THINGSDB` is set, then use that path.
@@ -178,7 +187,7 @@ def tasks(uuid=None, include_items=False, **kwargs):  # noqa: C901
         # include items
         if task["type"] == "to-do":
             if task.get("checklist"):
-                task["checklist"] = database.get_checklist_items(task_uuid=task["uuid"])
+                task["checklist"] = database.get_checklist_items(task["uuid"])
         elif task["type"] == "project":
             project = task
             project["items"] = items = tasks(
@@ -340,6 +349,27 @@ def tags(title=None, include_items=False, **kwargs):
     return result
 
 
+def checklist_items(todo_uuid, **kwargs):
+    """
+    Read checklist items of to-dos into dicts.
+
+    Note: checklists are contained in the return value of
+    `things.todos(todo_uuid)` and `things.tasks(todo_uuid)`.
+
+    Parameters
+    ----------
+    todo_uuid : str, optional
+        A valid to-do uuid.
+
+    Returns
+    -------
+    list of dict
+        Checklist items.
+    """
+    database = pop_database(kwargs)
+    return database.get_checklist_items(todo_uuid=todo_uuid)
+
+
 # --------------------------------------------------
 # Utility API functions derived from above
 # --------------------------------------------------
@@ -419,26 +449,6 @@ def projects(uuid=None, **kwargs):
     return tasks(uuid=uuid, type="project", **kwargs)
 
 
-def checklist_items(uuid, **kwargs):
-    """
-    Read checklist items of a to-do into dicts.
-
-    Note: this checklist is also contained in the return value of
-    `things.todos(uuid)` and `things.tasks(uuid)`.
-
-    Parameters
-    ----------
-    uuid : str
-        A valid to-do uuid.
-
-    Returns
-    -------
-    list of dict
-        Checklist items of the to-do. If none, then return empty list.
-    """
-    return tasks(uuid=uuid, **kwargs).get("checklist", [])  # type: ignore
-
-
 # Filter by collections in the Things app sidebar.
 
 
@@ -463,7 +473,7 @@ def today(**kwargs):
     See `things.api.tasks` for details on the optional parameters.
     """
     database = pop_database(kwargs)
-    if not database.was_modified_today():
+    if not database.was_modified_today():  # pragma: no cover
         print(
             "[NOTE] The results reflect the state of the Things app "
             "when it was last run. If the results seem out of date, "
@@ -521,6 +531,15 @@ def logbook(**kwargs):
     return result
 
 
+def trash(**kwargs):
+    """
+    Read Trash tasks into dicts.
+
+    See `things.api.tasks` for details on the optional parameters.
+    """
+    return tasks(trashed=True, status=kwargs.pop("status", None), **kwargs)
+
+
 # Filter by various task properties
 
 
@@ -602,7 +621,7 @@ def last(offset, **kwargs):
 # Interact with Things app
 
 
-def token(**kwargs) -> str:
+def token(**kwargs) -> Union[str, None]:
     """
     Read the Things URL scheme authentication token.
 
@@ -636,8 +655,8 @@ def show(uuid):
     >>> tag = things.tags('Home')
     >>> things.show(tag['uuid'])
     """
-    uri = link(uuid)
-    os.system(f"open {quote(uri)}")
+    uri = link(uuid)  # pragma: no cover
+    os.system(f"open {quote(uri)}")  # pragma: no cover
 
 
 # Helper functions
@@ -645,7 +664,10 @@ def show(uuid):
 
 def pop_database(kwargs):
     """instantiate non-default database from `kwargs` if provided"""
-    filepath, database = kwargs.pop("filepath", None), kwargs.pop("database", None)
+    filepath = kwargs.pop("filepath", None)
+    database = kwargs.pop("database", None)
+    print_sql = kwargs.pop("print_sql", False)
+
     if not database:
-        database = Database(filepath=filepath)
+        database = Database(filepath=filepath, print_sql=print_sql)
     return database