feat: Add logical filters (AND,OR,NOT)

Author: elchicodepython

README.md

@@ -185,6 +185,28 @@ table_rows = client.table_row_list(project, table_name, ExactDateEqFilter('colum
 table_rows = client.table_row_list(project, table_name, ExactDateOpFilter('column', '2023-06-01', op='eq'))
 ```
 
+```python
+from nocodb import filters
+
+# Basic filters...
+nick_filter = filters.EqFilter("nickname", "elchicodepython")
+country_filter = filters.EqFilter("country", "es")
+girlfriend_code = filters.EqFilter("gfcode", "404")
+current_mood_code = filters.EqFilter("moodcode", "418")
+
+# Combining filters using logical filters
+or_filter = filters.Or(nick_filter, country_filter)
+and_filter = filters.And(girlfriend_code, current_mood_code)
+
+# Negating filters with a Not filter
+not_me = filters.Not(filters.EqFilter("nickname", "elchicodepython"))
+
+# You can also combine combinations
+or_combined_filter = filters.Or(or_filter, and_filter)
+and_combined_filter = filters.And(or_filter, and_filter)
+
+```
+
 Credits to @MitPitt for asking this feature.
 
 ## Author notes

nocodb/filters/__init__.py

@@ -1,12 +1,25 @@
-from ..nocodb import WhereFilter
 from .factory import basic_filter_class_factory
+from .logical import And, Not, Or
 
-
-EqFilter = basic_filter_class_factory('eq')
+EqFilter = basic_filter_class_factory("eq")
 EqualFilter = EqFilter
-NotEqualFilter = basic_filter_class_factory('neq')
-GreaterThanFilter = basic_filter_class_factory('gt')
-GreaterOrEqualFilter = basic_filter_class_factory('ge')
-LessThanFilter = basic_filter_class_factory('lt')
-LessOrEqualFilter = basic_filter_class_factory('le')
-LikeFilter = basic_filter_class_factory('like')
+NotEqualFilter = basic_filter_class_factory("neq")
+GreaterThanFilter = basic_filter_class_factory("gt")
+GreaterOrEqualFilter = basic_filter_class_factory("ge")
+LessThanFilter = basic_filter_class_factory("lt")
+LessOrEqualFilter = basic_filter_class_factory("le")
+LikeFilter = basic_filter_class_factory("like")
+
+__all__ = [
+    "And",
+    "Not",
+    "Or",
+    "EqFilter",
+    "EqualFilter",
+    "NotEqualFilter",
+    "GreaterThanFilter",
+    "GreaterOrEqualFilter",
+    "LessThanFilter",
+    "LessOrEqualFilter",
+    "LikeFilter",
+]

nocodb/filters/filters_test.py

@@ -5,16 +5,67 @@
 from ..nocodb import WhereFilter
 
 
-@pytest.mark.parametrize('filter_class, expected_operator', [
-    (filters.EqFilter, 'eq'),
-    (filters.EqualFilter, 'eq'),
-    (filters.NotEqualFilter, 'neq'),
-    (filters.GreaterOrEqualFilter, 'ge'),
-    (filters.GreaterThanFilter, 'gt'),
-    (filters.LessThanFilter, 'lt'),
-    (filters.LessOrEqualFilter, 'le'),
-    (filters.LikeFilter, 'like')
-    ])
-def test_basic_filters_are_correctly_created(filter_class: WhereFilter, expected_operator: str):
-    test_filter = filter_class('column', 'value')
-    assert test_filter.get_where() == f'(column,{expected_operator},value)'
+@pytest.mark.parametrize(
+    "filter_class, expected_operator",
+    [
+        (filters.EqFilter, "eq"),
+        (filters.EqualFilter, "eq"),
+        (filters.NotEqualFilter, "neq"),
+        (filters.GreaterOrEqualFilter, "ge"),
+        (filters.GreaterThanFilter, "gt"),
+        (filters.LessThanFilter, "lt"),
+        (filters.LessOrEqualFilter, "le"),
+        (filters.LikeFilter, "like"),
+    ],
+)
+def test_basic_filters_are_correctly_created(
+    filter_class: WhereFilter, expected_operator: str
+):
+    test_filter = filter_class("column", "value")
+    assert test_filter.get_where() == f"(column,{expected_operator},value)"
+
+
+def test_or_filter():
+    nick_filter = filters.EqFilter("nickname", "elchicodepython")
+    country_filter = filters.EqFilter("country", "es")
+    nick_or_country_filter = filters.Or(nick_filter, country_filter)
+    assert (
+        nick_or_country_filter.get_where()
+        == "((nickname,eq,elchicodepython)~or(country,eq,es))"
+    )
+
+
+def test_and_filter():
+    nick_filter = filters.EqFilter("nickname", "elchicodepython")
+    country_filter = filters.EqFilter("country", "es")
+    nick_or_country_filter = filters.And(nick_filter, country_filter)
+    assert (
+        nick_or_country_filter.get_where()
+        == "((nickname,eq,elchicodepython)~and(country,eq,es))"
+    )
+
+
+def test_combined_filter():
+    nick_filter = filters.EqFilter("nickname", "elchicodepython")
+    country_filter = filters.EqFilter("country", "es")
+    girlfriend_code = filters.EqFilter("gfcode", "404")
+    current_mood_code = filters.EqFilter("moodcode", "418")
+    or_filter = filters.Or(nick_filter, country_filter)
+    and_filter = filters.And(girlfriend_code, current_mood_code)
+    or_combined_filter = filters.Or(or_filter, and_filter)
+    and_combined_filter = filters.And(or_filter, and_filter)
+
+    assert (
+        or_combined_filter.get_where()
+        == "(((nickname,eq,elchicodepython)~or(country,eq,es))~or((gfcode,eq,404)~and(moodcode,eq,418)))"
+    )
+    assert (
+        and_combined_filter.get_where()
+        == "(((nickname,eq,elchicodepython)~or(country,eq,es))~and((gfcode,eq,404)~and(moodcode,eq,418)))"
+    )
+
+
+def test_not_filter():
+    me = filters.EqFilter("nickname", "elchicodepython")
+    not_me = filters.Not(me)
+    assert not_me.get_where() == "~not(nickname,eq,elchicodepython)"

nocodb/filters/logical.py

@@ -0,0 +1,34 @@
+from typing import List
+from ..nocodb import WhereFilter
+
+
+class Or(WhereFilter):
+    def __init__(self, *filters: List[WhereFilter]):
+        self.__filters = filters
+
+    def get_where(self) -> str:
+        return (
+            "("
+            + "~or".join([filter.get_where() for filter in self.__filters])
+            + ")"
+        )
+
+
+class And(WhereFilter):
+    def __init__(self, *filters: List[WhereFilter]):
+        self.__filters = filters
+
+    def get_where(self) -> str:
+        return (
+            "("
+            + "~and".join([filter.get_where() for filter in self.__filters])
+            + ")"
+        )
+
+
+class Not(WhereFilter):
+    def __init__(self, filter: WhereFilter):
+        self.__filter = filter
+
+    def get_where(self) -> str:
+        return "~not" + self.__filter.get_where()