Merge pull request #62 from miki725/coreapi

added CoreAPIURLFilterBackend

HISTORY.rst

@@ -3,6 +3,15 @@
 History
 -------
 
+0.3.6 (2018-07-23)
+~~~~~~~~~~~~~~~~~~
+
+* Added support for ``extra_kwargs`` in ``ModelFilterSet.Meta``.
+* Added ``CoreAPIURLFilterBackend`` which enables documented filters in swagger docs.
+* Added ``iin`` lookup in plain and sqlalchemy backends.
+* Fixing inconsistency between plain and Django ``week_day`` lookup.
+  Now both are consistent with ``1``-Monday and ``7``-Sunday.
+
 0.3.5 (2018-02-27)
 ~~~~~~~~~~~~~~~~~~
 

docs/api/url_filter.backends.base.rst

@@ -1,5 +1,5 @@
-url_filter.backends.base module
-===============================
+url\_filter.backends.base module
+================================
 
 .. automodule:: url_filter.backends.base
     :members:

docs/api/url_filter.backends.django.rst

@@ -1,5 +1,5 @@
-url_filter.backends.django module
-=================================
+url\_filter.backends.django module
+==================================
 
 .. automodule:: url_filter.backends.django
     :members:

docs/api/url_filter.backends.plain.rst

@@ -1,5 +1,5 @@
-url_filter.backends.plain module
-================================
+url\_filter.backends.plain module
+=================================
 
 .. automodule:: url_filter.backends.plain
     :members:

docs/api/url_filter.backends.rst

@@ -1,5 +1,5 @@
-url_filter.backends package
-===========================
+url\_filter.backends package
+============================
 
 .. automodule:: url_filter.backends
     :members:

docs/api/url_filter.backends.sqlalchemy.rst

@@ -1,5 +1,5 @@
-url_filter.backends.sqlalchemy module
-=====================================
+url\_filter.backends.sqlalchemy module
+======================================
 
 .. automodule:: url_filter.backends.sqlalchemy
     :members:

docs/api/url_filter.exceptions.rst

@@ -1,5 +1,5 @@
-url_filter.exceptions module
-============================
+url\_filter.exceptions module
+=============================
 
 .. automodule:: url_filter.exceptions
     :members:

docs/api/url_filter.fields.rst

@@ -1,5 +1,5 @@
-url_filter.fields module
-========================
+url\_filter.fields module
+=========================
 
 .. automodule:: url_filter.fields
     :members:

docs/api/url_filter.filters.rst

@@ -1,5 +1,5 @@
-url_filter.filters module
-=========================
+url\_filter.filters module
+==========================
 
 .. automodule:: url_filter.filters
     :members:

docs/api/url_filter.filtersets.base.rst

@@ -1,5 +1,5 @@
-url_filter.filtersets.base module
-=================================
+url\_filter.filtersets.base module
+==================================
 
 .. automodule:: url_filter.filtersets.base
     :members:

docs/api/url_filter.filtersets.django.rst

@@ -1,5 +1,5 @@
-url_filter.filtersets.django module
-===================================
+url\_filter.filtersets.django module
+====================================
 
 .. automodule:: url_filter.filtersets.django
     :members:

docs/api/url_filter.filtersets.plain.rst

@@ -1,5 +1,5 @@
-url_filter.filtersets.plain module
-==================================
+url\_filter.filtersets.plain module
+===================================
 
 .. automodule:: url_filter.filtersets.plain
     :members:

docs/api/url_filter.filtersets.rst

@@ -1,5 +1,5 @@
-url_filter.filtersets package
-=============================
+url\_filter.filtersets package
+==============================
 
 .. automodule:: url_filter.filtersets
     :members:

docs/api/url_filter.filtersets.sqlalchemy.rst

@@ -1,5 +1,5 @@
-url_filter.filtersets.sqlalchemy module
-=======================================
+url\_filter.filtersets.sqlalchemy module
+========================================
 
 .. automodule:: url_filter.filtersets.sqlalchemy
     :members:

docs/api/url_filter.integrations.drf.rst

@@ -1,5 +1,5 @@
-url_filter.integrations.drf module
-==================================
+url\_filter.integrations.drf module
+===================================
 
 .. automodule:: url_filter.integrations.drf
     :members:

docs/api/url_filter.integrations.drf_coreapi.rst

@@ -0,0 +1,7 @@
+url\_filter.integrations.drf\_coreapi module
+============================================
+
+.. automodule:: url_filter.integrations.drf_coreapi
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/api/url_filter.integrations.rst

@@ -1,5 +1,5 @@
-url_filter.integrations package
-===============================
+url\_filter.integrations package
+================================
 
 .. automodule:: url_filter.integrations
     :members:
@@ -12,4 +12,5 @@ Submodules
 .. toctree::
 
    url_filter.integrations.drf
+   url_filter.integrations.drf_coreapi
 

docs/api/url_filter.rst

@@ -1,5 +1,5 @@
-url_filter package
-==================
+url\_filter package
+===================
 
 .. automodule:: url_filter
     :members:

docs/api/url_filter.utils.rst

@@ -1,5 +1,5 @@
-url_filter.utils module
-=======================
+url\_filter.utils module
+========================
 
 .. automodule:: url_filter.utils
     :members:

docs/api/url_filter.validators.rst

@@ -1,5 +1,5 @@
-url_filter.validators module
-============================
+url\_filter.validators module
+=============================
 
 .. automodule:: url_filter.validators
     :members:

requirements-dev.txt

@@ -1,10 +1,13 @@
 -r requirements.txt
+coreapi
 coverage
 django-extensions
 djangorestframework
 flake8
 importanize
 mock
+pdbpp
+ptpython
 pytest
 pytest-cov
 pytest-django

tests/backends/test_plain.py

@@ -150,6 +150,12 @@ def test_filter_in(self):
             [DATA[1]]
         )
 
+    def test_filter_iin(self):
+        self._test_filter(
+            FilterSpec(['restaurant', 'waiters', 'name'], 'iin', ['john', 'steve'], False),
+            [DATA[1]]
+        )
+
     def test_filter_in_simple_list(self):
         self._test_filter(
             FilterSpec(['nicknames'], 'in', ['ace', 'dogs'], False),
@@ -246,7 +252,7 @@ def test_filter_year(self):
 
     def test_filter_week_day(self):
         self._test_filter(
-            FilterSpec(['created'], 'week_day', 1, False),
+            FilterSpec(['created'], 'week_day', 2, False),  # Monday
             [DATA[1]]
         )
 

tests/backends/test_sqlalchemy.py

@@ -159,6 +159,12 @@ def test_build_clause_in(self, alchemy_db):
             Waiter.name.in_(['Django', 'rocks'])
         )
 
+    def test_build_clause_iin(self, alchemy_db):
+        self._test_build_clause(
+            alchemy_db, 'name', 'iin', ['Django', 'rocks'],
+            func.lower(Waiter.name).in_(['django', 'rocks'])
+        )
+
     def test_build_clause_isnull(self, alchemy_db):
         self._test_build_clause(
             alchemy_db, 'name', 'isnull', True,

tests/filtersets/test_django.py

@@ -28,6 +28,9 @@ class Meta(object):
                 model = Place
                 allow_related = False
                 allow_related_reverse = False
+                extra_kwargs = {
+                    'id': {'no_lookup': True},
+                }
 
         filters = PlaceFilterSet().get_filters()
 
@@ -37,6 +40,7 @@ class Meta(object):
 
         assert isinstance(filters['id'], Filter)
         assert isinstance(filters['id'].form_field, forms.IntegerField)
+        assert filters['id'].no_lookup is True
         assert isinstance(filters['name'], Filter)
         assert isinstance(filters['name'].form_field, forms.CharField)
         assert isinstance(filters['address'], Filter)
@@ -127,6 +131,11 @@ def test_get_filters_with_both_reverse_and_direct_relations(self):
         class RestaurantFilterSet(ModelFilterSet):
             class Meta(object):
                 model = Restaurant
+                extra_kwargs = {
+                    'place': {
+                        'id': {'no_lookup': True},
+                    },
+                }
 
         filters = RestaurantFilterSet().get_filters()
 
@@ -140,6 +149,8 @@ class Meta(object):
             'id', 'name',
         }
 
+        assert filters['place'].filters['id'].no_lookup is True
+
         assert isinstance(filters['serves_hot_dogs'], Filter)
         assert isinstance(filters['serves_hot_dogs'].form_field, forms.BooleanField)
         assert isinstance(filters['serves_pizza'], Filter)

tests/filtersets/test_plain.py

@@ -36,6 +36,9 @@ class Meta(object):
                     "ignored": [{}],
                 }
                 allow_related = False
+                extra_kwargs = {
+                    'id': {'no_lookup': True},
+                }
 
         filters = PlaceFilterSet().get_filters()
 
@@ -45,6 +48,7 @@ class Meta(object):
 
         assert isinstance(filters['id'], Filter)
         assert isinstance(filters['id'].form_field, forms.IntegerField)
+        assert filters['id'].no_lookup is True
         assert isinstance(filters['name'], Filter)
         assert isinstance(filters['name'].form_field, forms.CharField)
         assert isinstance(filters['address'], Filter)
@@ -78,6 +82,11 @@ class Meta(object):
                     "name": "Demon Dogs",
                     "address": "944 W. Fullerton"
                 }
+                extra_kwargs = {
+                    'restaurant': {
+                        'place': {'no_lookup': True},
+                    },
+                }
 
         filters = PlaceFilterSet().get_filters()
 
@@ -91,6 +100,8 @@ class Meta(object):
             'id', 'name', 'restaurant',
         }
 
+        assert filters['restaurant'].filters['place'].no_lookup is True
+
         assert isinstance(filters['id'], Filter)
         assert isinstance(filters['id'].form_field, forms.IntegerField)
         assert isinstance(filters['address'], Filter)

tests/filtersets/test_sqlalchemy.py

@@ -29,6 +29,9 @@ class PlaceFilterSet(SQLAlchemyModelFilterSet):
             class Meta(object):
                 model = Place
                 allow_related = False
+                extra_kwargs = {
+                    'id': {'no_lookup': True},
+                }
 
         filters = PlaceFilterSet().get_filters()
 
@@ -38,6 +41,7 @@ class Meta(object):
 
         assert isinstance(filters['id'], Filter)
         assert isinstance(filters['id'].form_field, forms.IntegerField)
+        assert filters['id'].no_lookup is True
         assert isinstance(filters['name'], Filter)
         assert isinstance(filters['name'].form_field, forms.CharField)
         assert isinstance(filters['address'], Filter)
@@ -88,6 +92,11 @@ def test_get_filters_with_both_reverse_and_direct_relations(self):
         class RestaurantFilterSet(SQLAlchemyModelFilterSet):
             class Meta(object):
                 model = Restaurant
+                extra_kwargs = {
+                    'place': {
+                        'id': {'no_lookup': True},
+                    },
+                }
 
         filters = RestaurantFilterSet().get_filters()
 
@@ -101,6 +110,8 @@ class Meta(object):
             'id', 'name', 'restaurant_id'
         }
 
+        assert filters['place'].filters['id'].no_lookup is True
+
         assert isinstance(filters['serves_hot_dogs'], Filter)
         assert isinstance(filters['serves_hot_dogs'].form_field, forms.BooleanField)
         assert isinstance(filters['serves_pizza'], Filter)