feat: adds None as possible chainable target (#20)

* Adds ability to paginate using the pages API (#19)

* feat: adds ability to paginate using the pages API which was originally hidden to the user

* chore: adds testcase for new paginator

* feat: adds None as possible chainable target

Author: becelot

hostingde/model/filter.py

@@ -157,7 +157,7 @@ def contains(self, value: str) -> 'FilterCondition':
         self.relation = FilterConditionRelation.EQUAL
         return self
 
-    def __and__(self, other: FilterElement) -> 'FilterChain':
+    def __and__(self, other: Optional[FilterElement]) -> 'FilterChain':
         """
         Dynamically construct a 'and' filter chain object using binary operations.
         :param other: The other filter element to chain to this element.
@@ -172,10 +172,12 @@ def __and__(self, other: FilterElement) -> 'FilterChain':
                 return FilterChain(FilterChainConnective.AND).add_filter(self).add_filter(other)
             else:
                 raise FilterCompilationException('Unknown filter element connective operation')
+        elif other is None:
+            return self
         else:
             raise FilterCompilationException('Unknown filter element type')
 
-    def __or__(self, other: FilterElement) -> 'FilterChain':
+    def __or__(self, other: Optional[FilterElement]) -> 'FilterChain':
         """
         Dynamically construct a 'or' filter chain object using binary operations.
         :param other: The other filter element to chain to this element.
@@ -190,6 +192,8 @@ def __or__(self, other: FilterElement) -> 'FilterChain':
                 return FilterChain(FilterChainConnective.OR).add_filter(self).add_filter(other)
             else:
                 raise FilterCompilationException('Unknown filter element connective operation')
+        elif other is None:
+            return self
         else:
             raise FilterCompilationException('Unknown filter element type')
 
@@ -242,7 +246,7 @@ def add_filter(self, filter_element: FilterElement, front: bool = False) -> 'Fil
 
         return self
 
-    def __and__(self, other: FilterElement) -> 'FilterChain':
+    def __and__(self, other: Optional[FilterElement]) -> 'FilterChain':
         """
         Dynamically construct a 'and' filter chain object using binary operations.
         :param other: The other filter element to chain to this element.
@@ -269,10 +273,12 @@ def __and__(self, other: FilterElement) -> 'FilterChain':
                 return FilterChain(FilterChainConnective.AND).add_filter(self).add_filter(other)
             else:
                 raise FilterCompilationException('Unknown filter element connective operation')
+        elif other is None:
+            return self
         else:
             raise FilterCompilationException('Unknown filter element type')
 
-    def __or__(self, other: FilterElement) -> 'FilterChain':
+    def __or__(self, other: Optional[FilterElement]) -> 'FilterChain':
         """
         Dynamically construct a 'and' filter chain object using binary operations.
         :param other: The other filter element to chain to this element.
@@ -299,5 +305,7 @@ def __or__(self, other: FilterElement) -> 'FilterChain':
                 return FilterChain(FilterChainConnective.OR).add_filter(self).add_filter(other)
             else:
                 raise FilterCompilationException('Unknown filter element connective operation')
+        elif other is None:
+            return self
         else:
             raise FilterCompilationException('Unknown filter element type')

tests/unit/model/test_filter.py

@@ -66,6 +66,20 @@ def test_condition_needs_value(self):
 
 
 class TestSimpleFilterChain:
+
+    def test_filter_bitand_none(self):
+        f1 = FilterCondition('field').eq('value')
+        f2 = None
+
+        chain = f1 & f2
+
+        filter_object = chain.to_filter_object()
+
+        assert filter_object is not None
+        assert filter_object.get('field') == 'field'
+        assert filter_object.get('value') == 'value'
+        assert filter_object.get('relation') == 'equal'
+
     def test_filter_bitand_chain(self):
         f1 = FilterCondition('field').eq('value')
         f2 = FilterCondition('field2').ne('value')
@@ -78,6 +92,19 @@ def test_filter_bitand_chain(self):
         assert filter_object.get('subFilterConnective') == 'and'
         assert len(filter_object.get('subFilter', [])) == 2
 
+    def test_filter_bitor_none(self):
+        f1 = FilterCondition('field').eq('value')
+        f2 = None
+
+        chain = f1 | f2
+
+        filter_object = chain.to_filter_object()
+
+        assert filter_object is not None
+        assert filter_object.get('field') == 'field'
+        assert filter_object.get('value') == 'value'
+        assert filter_object.get('relation') == 'equal'
+
     def test_filter_bitor_chain(self):
         f1 = FilterCondition('field').eq('value')
         f2 = FilterCondition('field2').ne('value')
@@ -96,6 +123,26 @@ def test_empty_chain_should_throw(self):
 
 
 class TestFilterIntoChainInsertion:
+    def test_none_into_and_chain(self):
+        c1 = FilterCondition('field2').eq('radnom') & FilterCondition('field3').eq('something')
+
+        chain = c1 & None
+
+        filter_object = chain.to_filter_object()
+        assert filter_object is not None
+        assert filter_object.get('subFilterConnective') == 'and'
+        assert len(filter_object.get('subFilter', [])) == 2
+
+    def test_none_into_or_chain(self):
+        c1 = FilterCondition('field2').eq('radnom') | FilterCondition('field3').eq('something')
+
+        chain = c1 | None
+
+        filter_object = chain.to_filter_object()
+        assert filter_object is not None
+        assert filter_object.get('subFilterConnective') == 'or'
+        assert len(filter_object.get('subFilter', [])) == 2
+
     def test_filter_ele_and_into_and(self):
         f1 = FilterCondition('field').eq('value')
         c1 = FilterCondition('field2').eq('radnom') & FilterCondition('field3').eq('something')