Added a range filter type. Thanks to davisp & lukesneeringer for the suggestion!

Note that integer ranges are broken on the current Whoosh (1.1.1). However, date & character ranges seem to work fine.

Author: toastdriven

docs/searchqueryset_api.rst

@@ -579,6 +579,7 @@ The following lookup types are supported:
 * lte
 * in
 * startswith
+* range
 
 These options are similar in function to the way Django's lookup types work.
 The actual behavior of these lookups is backend-specific.
@@ -603,6 +604,7 @@ Example::
     # Other usages look like:
     SearchQuerySet().filter(pub_date__gte=datetime.date(2008, 1, 1), pub_date__lt=datetime.date(2009, 1, 1))
     SearchQuerySet().filter(author__in=['daniel', 'john', 'jane'])
+    SearchQuerySet().filter(view_count__range=[3, 5])
 
 
 ``EmptySearchQuerySet``

haystack/backends/solr_backend.py

@@ -401,15 +401,19 @@ def build_query_fragment(self, field, filter_type, value):
                 'startswith': "%s:%s*",
             }
 
-            if filter_type != 'in':
-                result = filter_types[filter_type] % (index_fieldname, value)
-            else:
+            if filter_type == 'in':
                 in_options = []
 
                 for possible_value in value:
                     in_options.append('%s:"%s"' % (index_fieldname, self.backend.conn._from_python(possible_value)))
 
                 result = "(%s)" % " OR ".join(in_options)
+            elif filter_type == 'range':
+                start = self.backend.conn._from_python(value[0])
+                end = self.backend.conn._from_python(value[1])
+                return "%s:[%s TO %s]" % (index_fieldname, start, end)
+            else:
+                result = filter_types[filter_type] % (index_fieldname, value)
 
         return result
 

haystack/backends/whoosh_backend.py

@@ -596,7 +596,7 @@ def build_query_fragment(self, field, filter_type, value):
         if hasattr(value, 'strftime'):
             is_datetime = True
 
-        if filter_type != 'in':
+        if not filter_type in ('in', 'range'):
             # 'in' is a bit of a special case, as we don't want to
             # convert a valid list/tuple to string. Defer handling it
             # until later...
@@ -622,12 +622,7 @@ def build_query_fragment(self, field, filter_type, value):
                 'startswith': "%s:%s*",
             }
 
-            if filter_type != 'in':
-                if is_datetime is True:
-                    value = self._convert_datetime(value)
-                
-                result = filter_types[filter_type] % (index_fieldname, value)
-            else:
+            if filter_type == 'in':
                 in_options = []
 
                 for possible_value in value:
@@ -644,5 +639,21 @@ def build_query_fragment(self, field, filter_type, value):
                     in_options.append('%s:"%s"' % (index_fieldname, pv))
 
                 result = "(%s)" % " OR ".join(in_options)
+            elif filter_type == 'range':
+                start = self.backend._from_python(value[0])
+                end = self.backend._from_python(value[1])
+                
+                if hasattr(value[0], 'strftime'):
+                    start = self._convert_datetime(start)
+                
+                if hasattr(value[1], 'strftime'):
+                    end = self._convert_datetime(end)
+                
+                return "%s:[%s TO %s]" % (index_fieldname, start, end)
+            else:
+                if is_datetime is True:
+                    value = self._convert_datetime(value)
+                
+                result = filter_types[filter_type] % (index_fieldname, value)
 
         return result

haystack/constants.py

@@ -4,7 +4,7 @@
 DEFAULT_OPERATOR = getattr(settings, 'HAYSTACK_DEFAULT_OPERATOR', 'AND')
 
 # Valid expression extensions.
-VALID_FILTERS = set(['exact', 'gt', 'gte', 'lt', 'lte', 'in', 'startswith'])
+VALID_FILTERS = set(['exact', 'gt', 'gte', 'lt', 'lte', 'in', 'startswith', 'range'])
 FILTER_SEPARATOR = '__'
 
 # The maximum number of items to display in a SearchQuerySet.__repr__

tests/core/tests/query.py

@@ -31,6 +31,7 @@ def test_split_expression(self):
         self.assertEqual(sq.split_expression('foo__gte'), ('foo', 'gte'))
         self.assertEqual(sq.split_expression('foo__in'), ('foo', 'in'))
         self.assertEqual(sq.split_expression('foo__startswith'), ('foo', 'startswith'))
+        self.assertEqual(sq.split_expression('foo__range'), ('foo', 'range'))
 
         # Unrecognized filter. Fall back to exact.
         self.assertEqual(sq.split_expression('foo__moof'), ('foo', 'exact'))

tests/solr_tests/tests/solr_query.py

@@ -63,7 +63,8 @@ def test_build_query_multiple_filter_types(self):
         self.sq.add_filter(SQ(created__lt='2009-02-12 12:13:00'))
         self.sq.add_filter(SQ(title__gte='B'))
         self.sq.add_filter(SQ(id__in=[1, 2, 3]))
-        self.assertEqual(self.sq.build_query(), u'(why AND pub_date:[* TO "2009-02-10 01:59:00"] AND author:{daniel TO *} AND created:{* TO "2009-02-12 12:13:00"} AND title:[B TO *] AND (id:"1" OR id:"2" OR id:"3"))')
+        self.sq.add_filter(SQ(rating__range=[3, 5]))
+        self.assertEqual(self.sq.build_query(), u'(why AND pub_date:[* TO "2009-02-10 01:59:00"] AND author:{daniel TO *} AND created:{* TO "2009-02-12 12:13:00"} AND title:[B TO *] AND (id:"1" OR id:"2" OR id:"3") AND rating:[3 TO 5])')
 
     def test_build_query_in_filter_multiple_words(self):
         self.sq.add_filter(SQ(content='why'))

tests/whoosh_tests/tests/whoosh_query.py

@@ -72,7 +72,8 @@ def test_build_query_multiple_filter_types(self):
         self.sq.add_filter(SQ(created__lt=datetime.datetime(2009, 2, 12, 12, 13)))
         self.sq.add_filter(SQ(title__gte='B'))
         self.sq.add_filter(SQ(id__in=[1, 2, 3]))
-        self.assertEqual(self.sq.build_query(), u'(why AND pub_date:[TO 20090210T015900] AND author:{daniel TO} AND created:{TO 20090212T121300} AND title:[B TO] AND (id:"1" OR id:"2" OR id:"3"))')
+        self.sq.add_filter(SQ(rating__range=[3, 5]))
+        self.assertEqual(self.sq.build_query(), u'(why AND pub_date:[TO 20090210T015900] AND author:{daniel TO} AND created:{TO 20090212T121300} AND title:[B TO] AND (id:"1" OR id:"2" OR id:"3") AND rating:[3 TO 5])')
 
     def test_build_query_in_filter_multiple_words(self):
         self.sq.add_filter(SQ(content='why'))