Add Django 5.2 support (#46)

[Django 5.2](https://docs.djangoproject.com/en/5.2/releases/5.2/)
introduced a deprecation:
> The all argument for the django.contrib.staticfiles.finders.find()
function is deprecated in favor of the find_all argument.

---------

Co-authored-by: Johannes Maron <johannes@maron.family>

Author: amureki

.github/workflows/ci.yml

@@ -51,6 +51,7 @@ jobs:
         python-version:
           - "3.9"
           - "3.10"
+          - "3.11"
           - "3.12"
         django-version:
           - "4.2"  # LTS
@@ -78,10 +79,9 @@ jobs:
         python-version:
           - "3.11"
         django-version:
-          # LTS gets tested on all OS
-          - "3.2"
-          - "4.2"
-          - "5.0"
+          # oldest LTS gets tested on all Python versions
+          - "5.1"
+          - "5.2"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

django_esm/finders.py

@@ -1,5 +1,6 @@
 import functools
 import json
+import warnings
 
 from django.conf import settings
 from django.contrib.staticfiles.finders import BaseFinder
@@ -29,9 +30,31 @@ def _check_package_json(self):
             ]
         return []
 
-    def find(self, path, all=False):
+    def _check_deprecated_find_param(self, find_all, **kwargs):
+        # @todo: remove this after Django 5.2 support is dropped
+        try:
+            find_all = kwargs["all"]
+        except KeyError:
+            pass
+        else:
+            try:
+                from django.utils.deprecation import RemovedInDjango61Warning
+            except ImportError:
+                pass
+            else:
+                warnings.warn(
+                    "The 'all' argument of the find() method is deprecated in favor of "
+                    "the 'find_all' argument.",
+                    category=RemovedInDjango61Warning,
+                    stacklevel=2,
+                )
+        return find_all
+
+    def find(self, path, find_all=False, **kwargs):
+        find_all = self._check_deprecated_find_param(find_all, **kwargs)
+
         if path in self.all:
-            return [path] if all else path
+            return [path] if find_all else path
         return []  # this method has a strange return type
 
     def list(self, ignore_patterns):

pyproject.toml

@@ -28,12 +28,12 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Framework :: Django",
-  "Framework :: Django :: 3.2",
   "Framework :: Django :: 4.2",
-  "Framework :: Django :: 5.0",
+  "Framework :: Django :: 5.1",
+  "Framework :: Django :: 5.2",
 ]
 requires-python = ">=3.9"
-dependencies = ["django>=3.2.0"]
+dependencies = ["django>=4.2.0"]
 
 [project.optional-dependencies]
 test = [

tests/test_finders.py

@@ -1,3 +1,7 @@
+import warnings
+
+import django.utils.deprecation
+import pytest
 from django.contrib.staticfiles.finders import get_finder
 from django.core.checks import Error
 
@@ -17,9 +21,22 @@ def test_find(self):
             self.finder.find("testapp/static/js/components/index.js")
             == "testapp/static/js/components/index.js"
         )
-        assert self.finder.find("lit-html/lit-html.js", all=True) == []
+        assert self.finder.find("lit-html/lit-html.js", find_all=True) == []
         assert self.finder.find("foo/bar.js") == []
 
+    @pytest.mark.skipif(
+        not hasattr(django.utils.deprecation, "RemovedInDjango61Warning"),
+        reason="Django < 5.2",
+    )
+    def test_find_with_deprecated_param(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            result = self.finder.find("testapp/static/js/index.js", all=True)
+            assert len(w) == 1
+            assert w[0].category == django.utils.deprecation.RemovedInDjango61Warning
+            assert "deprecated in favor of" in str(w[0].message)
+            assert result == ["testapp/static/js/index.js"]
+
     def test_list(self):
         all_files = self.finder.list([])
         assert ("testapp/static/js/index.js", storages.root_storage) in all_files