Merge pull request #188 from GaetanF/master

Basic Implementation of Regexp Field Lookup

Author: barseghyanartur

src/django_elasticsearch_dsl_drf/constants.py

@@ -27,6 +27,7 @@
     'LOOKUP_FILTER_GEO_POLYGON',
     'LOOKUP_FILTER_PREFIX',
     'LOOKUP_FILTER_RANGE',
+    'LOOKUP_FILTER_REGEXP',
     'LOOKUP_FILTER_TERM',
     'LOOKUP_FILTER_TERMS',
     'LOOKUP_FILTER_WILDCARD',
@@ -433,7 +434,7 @@
     LOOKUP_FILTER_EXISTS,
     LOOKUP_FILTER_PREFIX,
     LOOKUP_FILTER_WILDCARD,
-    # LOOKUP_FILTER_REGEXP,
+    LOOKUP_FILTER_REGEXP,
     # LOOKUP_FILTER_FUZZY,
     # LOOKUP_FILTER_TYPE,
 
@@ -474,6 +475,7 @@
     LOOKUP_FILTER_TERMS,
     LOOKUP_FILTER_PREFIX,
     LOOKUP_FILTER_WILDCARD,
+    LOOKUP_FILTER_REGEXP,
     LOOKUP_QUERY_CONTAINS,
     LOOKUP_QUERY_IN,
     LOOKUP_QUERY_STARTSWITH,

src/django_elasticsearch_dsl_drf/filter_backends/filtering/common.py

@@ -17,6 +17,7 @@
     ALL_LOOKUP_FILTERS_AND_QUERIES,
     LOOKUP_FILTER_PREFIX,
     LOOKUP_FILTER_RANGE,
+    LOOKUP_FILTER_REGEXP,
     LOOKUP_FILTER_TERMS,
     LOOKUP_FILTER_EXISTS,
     LOOKUP_FILTER_WILDCARD,
@@ -293,6 +294,35 @@ def apply_filter_range(cls, queryset, options, value):
             kwargs={options['field']: cls.get_range_params(value)}
         )
 
+    @classmethod
+    def apply_filter_regexp(cls, queryset, options, value):
+        """Apply `reexp` filter.
+
+         Syntax:
+
+            /endpoint/?field_name__regexp={regexp}
+
+        Example:
+
+            http://localhost:8000/api/users/?age__regexp=1[6-9]
+            http://localhost:8000/api/users/?age__regexp=2.*
+
+        :param queryset: Original queryset.
+        :param options: Filter options.
+        :param value: value to filter on.
+        :type queryset: elasticsearch_dsl.search.Search
+        :type options: dict
+        :type value: str
+        :return: Modified queryset.
+        :rtype: elasticsearch_dsl.search.Search
+        """
+        return cls.apply_filter(
+            queryset=queryset,
+            options=options,
+            args=['regexp'],
+            kwargs={options['field']: value}
+        )
+
     @classmethod
     def apply_query_exists(cls, queryset, options, value):
         """Apply `exists` filter.
@@ -789,6 +819,12 @@ def filter_queryset(self, request, queryset, view):
                                                        options,
                                                        value)
 
+                # `regexp` filter lookup
+                elif options['lookup'] == LOOKUP_FILTER_REGEXP:
+                    queryset = self.apply_filter_regexp(queryset,
+                                                       options,
+                                                       value)
+
                 # `exists` filter lookup
                 elif options['lookup'] == LOOKUP_FILTER_EXISTS:
                     queryset = self.apply_query_exists(queryset,

src/django_elasticsearch_dsl_drf/tests/test_filtering_common.py

@@ -193,6 +193,19 @@ def test_field_filter_range(self):
             self.published_count
         )
 
+    def test_field_filter_regexp(self):
+        """Field filter regexp.
+
+        Example:
+
+            http://localhost:8000/api/users/?title__regexp=De.{8}Ins.*
+        """
+        return self._field_filter_value(
+            'title__regexp',
+            '{}.{{8}}{}.*'.format(self.prefix[0:2], self.prefix[10:13]),
+            self.prefix_count
+        )
+
     def test_field_filter_range_with_boost(self):
         """Field filter range.