filters: Define TaskFilter base class

[etc/taskwarrior.git] / tasklib / filters.py

diff --git a/tasklib/filters.py b/tasklib/filters.py
index 1899d1d568831f3f4ae5edefb71cd73467e1b60c..7b44e9858b93bb46bb14c1308aaed07ba1935497 100644 (file)
--- a/tasklib/filters.py
+++ b/tasklib/filters.py
@@ -1,7 +1,35 @@
+import abc
 from tasklib.serializing import SerializingObject
 
 
-class TaskFilter(SerializingObject):
+class TaskFilter(object):
+    """
+    Abstract base class that defines interface of a TaskFilter.
+    """
+
+    @abc.abstractmethod
+    def add_filter(self, arg):
+        """
+        Processes an non-keyword filter.
+        """
+        pass
+
+    @abc.abstractmethod
+    def add_filter_param(self, key, value):
+        """
+        Processes a keyword filter.
+        """
+        pass
+
+    @abc.abstractmethod
+    def clone(self):
+        """
+        Returns a new deep copy of itself.
+        """
+        pass
+
+
+class TaskWarriorFilter(TaskFilter, SerializingObject):
     """
     A set of parameters to filter the task list with.
     """