drf-query-method 0.1.0__tar.gz → 0.2.0__tar.gz

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/.github/workflows/ci.yml

@@ -96,7 +96,7 @@ jobs:
             drf_req="djangorestframework~=$DRF.0"
           fi
           uv venv --python "$PYTHON"
-          uv pip install -e . "$django_req" "$drf_req" django-filter coverage pytest pytest-django
+          uv pip install -e . "$django_req" "$drf_req" django-filter djangorestframework-datatables coverage pytest pytest-django
 
       - name: Run tests with coverage
         run: .venv/bin/coverage run -m pytest

drf_query_method-0.2.0/CHANGELOG/0.2.0.md

@@ -0,0 +1,10 @@
+# drf-query-method 0.2.0
+
+## Added
+
+- `patch()` makes [django-rest-framework-datatables](https://github.com/izimobil/django-rest-framework-datatables) read
+  `QUERY` request bodies, so server-side DataTables can send their parameters as a `QUERY` body.
+
+## Changed
+
+- `filter_params()` caches its result on the request.

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: drf-query-method
-Version: 0.1.0
+Version: 0.2.0
 Summary: HTTP QUERY method (RFC 10008) support for Django REST framework.
 Project-URL: bugs, https://github.com/BenA-SA/drf-query-method/issues
 Project-URL: changelog, https://github.com/BenA-SA/drf-query-method/releases
@@ -73,8 +73,8 @@ class NoteViewSet(ModelViewSet):
         return self.list(request, *args, **kwargs)
 ```
 
-Routers then send `QUERY /notes/` to `query()`, and `SearchFilter`, `OrderingFilter` and django-filter's
-`DjangoFilterBackend` read their parameters from the request body. If you'd rather not patch DRF, import drop-in
+Routers then send `QUERY /notes/` to `query()`, and `SearchFilter`, `OrderingFilter`, django-filter's
+`DjangoFilterBackend` and django-rest-framework-datatables read their parameters from the request body. If you'd rather not patch DRF, import drop-in
 classes with the same names from `drf_query_method` instead. See the [documentation](https://BenA-SA.github.io/drf-query-method/usage/)
 for both approaches, and for sending `QUERY` requests from JavaScript and other clients.
 
@@ -85,7 +85,7 @@ The package is in early development and not yet released.
 * Python 3.10+
 * Django 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1. Django 6.2 adds `QUERY` natively; on earlier versions this package adds it.
 * Django REST framework 3.16+
-* django-filter, optionally
+* django-filter and django-rest-framework-datatables, optionally
 
 ## Installation
 

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/README.md

@@ -35,8 +35,8 @@ class NoteViewSet(ModelViewSet):
         return self.list(request, *args, **kwargs)
 ```
 
-Routers then send `QUERY /notes/` to `query()`, and `SearchFilter`, `OrderingFilter` and django-filter's
-`DjangoFilterBackend` read their parameters from the request body. If you'd rather not patch DRF, import drop-in
+Routers then send `QUERY /notes/` to `query()`, and `SearchFilter`, `OrderingFilter`, django-filter's
+`DjangoFilterBackend` and django-rest-framework-datatables read their parameters from the request body. If you'd rather not patch DRF, import drop-in
 classes with the same names from `drf_query_method` instead. See the [documentation](https://BenA-SA.github.io/drf-query-method/usage/)
 for both approaches, and for sending `QUERY` requests from JavaScript and other clients.
 
@@ -47,7 +47,7 @@ The package is in early development and not yet released.
 * Python 3.10+
 * Django 4.2, 5.0, 5.1, 5.2, 6.0 and 6.1. Django 6.2 adds `QUERY` natively; on earlier versions this package adds it.
 * Django REST framework 3.16+
-* django-filter, optionally
+* django-filter and django-rest-framework-datatables, optionally
 
 ## Installation
 

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/docs/usage.md

@@ -57,6 +57,8 @@ were merged:
 * DRF's deprecated OpenAPI generator leaves `QUERY` out, as OpenAPI 3.0 has no query operation.
 * If [django-filter](https://github.com/carltongibson/django-filter) is installed, `DjangoFilterBackend` reads the
   request body too.
+* If [django-rest-framework-datatables](https://github.com/izimobil/django-rest-framework-datatables) is installed, its
+  filter backends, pagination and renderer read the request body too. See [DataTables](#datatables) below.
 
 `patch()` is safe to call more than once, and leaves DRF alone once DRF supports `QUERY` itself.
 
@@ -73,6 +75,8 @@ Every class has the same name as DRF's (or django-filter's), so you change the i
 | `rest_framework.test.APIRequestFactory`, `APIClient`, `APITestCase` and friends | `drf_query_method.test` |
 | `django_filters.rest_framework.DjangoFilterBackend` | `drf_query_method.django_filters` |
 
+django-rest-framework-datatables is supported through `patch()` only.
+
 Use the router and viewset classes together: the viewsets stop a `query()` method answering `QUERY` on detail routes.
 
 On Django versions before 6.2, also call `drf_query_method.add_query_method()` at startup (`patch()` does this for you).
@@ -137,8 +141,23 @@ A few things to check before relying on `QUERY` in production:
   application through everything in front of it.
 * **Caching.** `QUERY` responses are cacheable in principle, but caches generally don't key on request bodies, and
   Django's `cache_page` ignores `QUERY` from 6.2. Don't expect responses to be cached.
-* **django-rest-framework-datatables** reads its parameters with its own helper, which looks at the request body only
-  for `POST`. It doesn't read `QUERY` bodies yet.
+## DataTables
+
+With `patch()` and [django-rest-framework-datatables](https://github.com/izimobil/django-rest-framework-datatables),
+a server-side DataTable can send its parameters as a `QUERY` body instead of a long query string. Keep `format=datatables`
+in the URL, and set the Ajax type:
+
+```javascript
+new DataTable("#notes", {
+  serverSide: true,
+  ajax: {url: "/api/notes/?format=datatables", type: "QUERY"},
+  columns: [{data: "title"}, {data: "created"}],
+});
+```
+
+jQuery sends DataTables' parameters as a form-encoded body for any method other than `GET` and `HEAD`, which is the
+form django-rest-framework-datatables expects. The view needs a `query()` handler, as above. Its `?keep=` parameter is
+still read from the URL.
 
 ## Django versions before 6.2
 

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "drf-query-method"
-version = "0.1.0"
+version = "0.2.0"
 description = "HTTP QUERY method (RFC 10008) support for Django REST framework."
 readme = "README.md"
 authors = [
@@ -54,6 +54,7 @@ lint = [
 test = [
     "coverage",
     "django-filter",
+    "djangorestframework-datatables",
     "pytest",
     "pytest-django",
 ]
@@ -81,7 +82,7 @@ homepage = "https://github.com/BenA-SA/drf-query-method"
 
 [[tool.ty.overrides]]
 # These tests use attributes that patch() adds to DRF at runtime.
-include = ["tests/test_patching.py"]
+include = ["tests/test_patching.py", "tests/test_datatables.py"]
 rules = { unresolved-attribute = "ignore" }
 
 [tool.ruff]

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/src/drf_query_method/params.py

@@ -6,6 +6,8 @@ from django.http import QueryDict
 from django.utils.datastructures import MultiValueDict
 from rest_framework.exceptions import ParseError
 
+_CACHE_ATTRIBUTE = "_drf_query_method_filter_params"
+
 
 def merge_filter_params(request) -> QueryDict:
     """Return ``request.query_params`` with a QUERY request's body merged over it.
@@ -17,11 +19,16 @@ def merge_filter_params(request) -> QueryDict:
     values, as repeated query-string parameters do.
 
     Raises ``ParseError`` (400) when the body is not an object of parameters,
-    such as a JSON array.
+    such as a JSON array. The result is cached on the request, as packages
+    such as django-rest-framework-datatables read many parameters each.
     """
     if request.method != "QUERY":
         return request.query_params
 
+    cached = request.__dict__.get(_CACHE_ATTRIBUTE)
+    if cached is not None:
+        return cached
+
     body = request.data
     if not isinstance(body, Mapping):
         raise ParseError(f"QUERY request body must be an object of parameters, not {type(body).__name__}.")
@@ -32,6 +39,7 @@ def merge_filter_params(request) -> QueryDict:
     params = request.query_params.copy()
     for key, values in body.lists():
         params.setlist(key, values)
+    request.__dict__[_CACHE_ATTRIBUTE] = params
     return params
 
 

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/src/drf_query_method/patching.py

@@ -2,8 +2,9 @@
 
 :func:`patch` makes DRF behave as if encode/django-rest-framework#10091 were
 merged, so existing views, routers and settings pick up ``QUERY`` without
-changing imports. Call it once at startup, for example from an
-``AppConfig.ready()``. It does nothing to DRF once DRF supports ``QUERY``
+changing imports. When django-filter or django-rest-framework-datatables
+is installed, they read QUERY request bodies too. Call it once at startup,
+for example from an ``AppConfig.ready()``. It does nothing to DRF once DRF supports ``QUERY``
 itself.
 """
 
@@ -78,8 +79,28 @@ def _patch_django_filter() -> None:
     )
 
 
+def _patch_drf_datatables() -> None:
+    """Make django-rest-framework-datatables read QUERY request bodies.
+
+    Its modules import ``get_param`` by name, so each binding is replaced.
+    """
+    from rest_framework_datatables import filters, pagination, renderers, utils
+
+    from drf_query_method.params import filter_params
+
+    original = utils.get_param
+
+    def get_param(request, param, default=None):
+        if request.method == "QUERY":
+            return filter_params(request).get(param, default)
+        return original(request, param, default)
+
+    for module in (utils, filters, pagination, renderers):
+        _set(module, "get_param", get_param)
+
+
 def patch() -> None:
-    """Add QUERY support to Django, DRF and django-filter in place.
+    """Add QUERY support to Django, DRF, django-filter and django-rest-framework-datatables in place.
 
     Safe to call more than once. On Django versions before 6.2 this also
     calls :func:`~drf_query_method.add_query_method`, which :func:`unpatch`
@@ -95,6 +116,8 @@ def patch() -> None:
         _patch_drf()
     if importlib.util.find_spec("django_filters") is not None:
         _patch_django_filter()
+    if importlib.util.find_spec("rest_framework_datatables") is not None:
+        _patch_drf_datatables()
 
 
 def unpatch() -> None:

drf_query_method-0.2.0/tests/test_datatables.py

@@ -0,0 +1,94 @@
+from urllib.parse import urlencode
+
+import django_filters
+import pytest
+from django.contrib.auth.models import User
+from rest_framework import generics
+from rest_framework.renderers import JSONRenderer
+from rest_framework.test import APIRequestFactory
+from rest_framework_datatables import filters, pagination, renderers
+from rest_framework_datatables.django_filters.backends import DatatablesFilterBackend
+from rest_framework_datatables.django_filters.filters import GlobalFilter
+from rest_framework_datatables.django_filters.filterset import DatatablesFilterSet
+
+from tests.views import UserSerializer
+
+DATATABLES_PARAMS = {
+    "draw": "3",
+    "start": "1",
+    "length": "1",
+    "columns[0][data]": "username",
+    "columns[0][name]": "username",
+    "columns[0][searchable]": "true",
+    "columns[0][orderable]": "true",
+    "columns[0][search][value]": "",
+    "columns[0][search][regex]": "false",
+    "order[0][column]": "0",
+    "order[0][dir]": "desc",
+    "search[value]": "o",
+    "search[regex]": "false",
+}
+
+
+class GlobalCharFilter(GlobalFilter, django_filters.CharFilter):
+    pass
+
+
+class UserGlobalFilterSet(DatatablesFilterSet):
+    username = GlobalCharFilter(lookup_expr="icontains")
+
+    class Meta:
+        model = User
+        fields = ["username"]
+
+
+def build_view(filter_backend):
+    class View(generics.ListAPIView):
+        queryset = User.objects.order_by("pk")
+        serializer_class = UserSerializer
+        permission_classes = []
+        filterset_class = UserGlobalFilterSet
+        renderer_classes = [JSONRenderer, renderers.DatatablesRenderer]
+        filter_backends = [filter_backend]
+        pagination_class = pagination.DatatablesPageNumberPagination
+
+        def query(self, request, *args, **kwargs):
+            return self.list(request, *args, **kwargs)
+
+    return View.as_view()
+
+
+@pytest.fixture
+def users(db):
+    for username in ["alice", "bob", "carol"]:
+        User.objects.create(username=username)
+
+
+@pytest.mark.parametrize("filter_backend", [filters.DatatablesFilterBackend, DatatablesFilterBackend])
+def test_datatables_reads_query_body(patched, users, filter_backend):
+    request = APIRequestFactory().query(
+        "/?format=datatables", urlencode(DATATABLES_PARAMS), content_type="application/x-www-form-urlencoded"
+    )
+    response = build_view(filter_backend)(request)
+    response.render()
+    assert response.data["draw"] == 3
+    assert response.data["recordsTotal"] == 3
+    assert response.data["recordsFiltered"] == 2
+    assert [user["username"] for user in response.data["data"]] == ["bob"]
+
+
+def test_datatables_get_is_unchanged(patched, users):
+    request = APIRequestFactory().get("/", {**DATATABLES_PARAMS, "format": "datatables"})
+    response = build_view(filters.DatatablesFilterBackend)(request)
+    assert [user["username"] for user in response.data["data"]] == ["bob"]
+
+
+def test_merged_filter_params_are_cached_per_request():
+    from rest_framework.parsers import JSONParser
+    from rest_framework.request import Request
+
+    from drf_query_method.params import merge_filter_params
+    from drf_query_method.test import APIRequestFactory as QueryRequestFactory
+
+    request = Request(QueryRequestFactory().query("/", {"a": "1"}, format="json"), parsers=[JSONParser()])
+    assert merge_filter_params(request) is merge_filter_params(request)

{drf_query_method-0.1.0 → drf_query_method-0.2.0}/uv.lock

@@ -408,9 +408,21 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/c4/dd/de5f4543765bec94e036a5e9593a42f8fa7efec8de78eb56b9ca834385f3/djangorestframework-3.18.3-py3-none-any.whl", hash = "sha256:8544bb674846731b1e3c9b309236ee1dc412905a0aa725be2ec193ca950a7d12", size = 903986, upload-time = "2026-10-06T21:33:49.917Z" },
 ]
 
+[[package]]
+name = "djangorestframework-datatables"
+version = "0.7.2"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "djangorestframework" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c7/a0/7481fee713387fd5c632b05c1d95c32f5b2ea6e1e8f15c9cf1894e1895a8/djangorestframework_datatables-0.7.2.tar.gz", hash = "sha256:d7953968088ceb14968621a0c0a83d2f39ec1cda24b5ebe1240f3c9619bc7129", size = 19647, upload-time = "2024-06-14T17:11:41.742Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/f3/25/17cd01982c7299cbca9e20247e73c83bfa53a0ed9e8b7735c915c1bb6675/djangorestframework_datatables-0.7.2-py2.py3-none-any.whl", hash = "sha256:fd5747b1e3d0bfb84713a975394dd4d879b57ee8bc66cc0f97566fa67f4406f4", size = 15303, upload-time = "2024-06-14T17:11:39.658Z" },
+]
+
 [[package]]
 name = "drf-query-method"
-version = "0.1.0"
+version = "0.2.0"
 source = { editable = "." }
 dependencies = [
     { name = "django", version = "5.2.18", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.12'" },
@@ -430,6 +442,7 @@ dev = [
     { name = "coverage", version = "7.17.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },
     { name = "django-filter", version = "26.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" },
     { name = "django-filter", version = "26.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },
+    { name = "djangorestframework-datatables" },
     { name = "pytest" },
     { name = "pytest-django" },
     { name = "ruff" },
@@ -449,6 +462,7 @@ test = [
     { name = "coverage", version = "7.17.0", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },
     { name = "django-filter", version = "26.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.11'" },
     { name = "django-filter", version = "26.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.11'" },
+    { name = "djangorestframework-datatables" },
     { name = "pytest" },
     { name = "pytest-django" },
 ]
@@ -468,6 +482,7 @@ provides-extras = ["django-filter"]
 dev = [
     { name = "coverage" },
     { name = "django-filter" },
+    { name = "djangorestframework-datatables" },
     { name = "pytest" },
     { name = "pytest-django" },
     { name = "ruff" },
@@ -481,6 +496,7 @@ lint = [{ name = "ruff" }]
 test = [
     { name = "coverage" },
     { name = "django-filter" },
+    { name = "djangorestframework-datatables" },
     { name = "pytest" },
     { name = "pytest-django" },
 ]