From 8719a6181ee6e81282822598e7f14d2d5c9b4c3c Mon Sep 17 00:00:00 2001 From: Mariusz Felisiak Date: Fri, 28 Jun 2024 13:39:55 +0200 Subject: [PATCH] Refs #22712 -- Corrected deprecation of "all" argument in django.contrib.staticfiles.finders.find(). Features deprecated in Django 5.2 should be removed in Django 6.1. --- django/contrib/staticfiles/finders.py | 26 ++++++++++++------------- docs/internals/deprecation.txt | 3 +++ tests/staticfiles_tests/test_finders.py | 14 ++++++------- 3 files changed, 23 insertions(+), 20 deletions(-) diff --git a/django/contrib/staticfiles/finders.py b/django/contrib/staticfiles/finders.py index aca98b2b49..8051650daf 100644 --- a/django/contrib/staticfiles/finders.py +++ b/django/contrib/staticfiles/finders.py @@ -9,7 +9,7 @@ from django.core.checks import Error, Warning from django.core.exceptions import ImproperlyConfigured from django.core.files.storage import FileSystemStorage, Storage, default_storage from django.utils._os import safe_join -from django.utils.deprecation import RemovedInDjango60Warning +from django.utils.deprecation import RemovedInDjango61Warning from django.utils.functional import LazyObject, empty from django.utils.module_loading import import_string @@ -17,7 +17,7 @@ from django.utils.module_loading import import_string searched_locations = [] -# RemovedInDjango60Warning: When the deprecation ends, remove completely. +# RemovedInDjango61Warning: When the deprecation ends, remove completely. def _check_deprecated_find_param(class_name="", find_all=False, **kwargs): method_name = "find" if not class_name else f"{class_name}.find" if "all" in kwargs: @@ -26,7 +26,7 @@ def _check_deprecated_find_param(class_name="", find_all=False, **kwargs): "Passing the `all` argument to find() is deprecated. Use `find_all` " "instead." ) - warnings.warn(msg, RemovedInDjango60Warning, stacklevel=2) + warnings.warn(msg, RemovedInDjango61Warning, stacklevel=2) # If both `find_all` and `all` were given, raise TypeError. if find_all is not False: @@ -54,13 +54,13 @@ class BaseFinder: "configured correctly." ) - # RemovedInDjango60Warning: When the deprecation ends, remove completely. + # RemovedInDjango61Warning: When the deprecation ends, remove completely. def _check_deprecated_find_param(self, **kwargs): return _check_deprecated_find_param( class_name=self.__class__.__qualname__, **kwargs ) - # RemovedInDjango60Warning: When the deprecation ends, replace with: + # RemovedInDjango61Warning: When the deprecation ends, replace with: # def find(self, path, find_all=False): def find(self, path, find_all=False, **kwargs): """ @@ -149,13 +149,13 @@ class FileSystemFinder(BaseFinder): ) return errors - # RemovedInDjango60Warning: When the deprecation ends, replace with: + # RemovedInDjango61Warning: When the deprecation ends, replace with: # def find(self, path, find_all=False): def find(self, path, find_all=False, **kwargs): """ Look for files in the extra locations as defined in STATICFILES_DIRS. """ - # RemovedInDjango60Warning. + # RemovedInDjango61Warning. if kwargs: find_all = self._check_deprecated_find_param(find_all=find_all, **kwargs) matches = [] @@ -232,13 +232,13 @@ class AppDirectoriesFinder(BaseFinder): for path in utils.get_files(storage, ignore_patterns): yield path, storage - # RemovedInDjango60Warning: When the deprecation ends, replace with: + # RemovedInDjango61Warning: When the deprecation ends, replace with: # def find(self, path, find_all=False): def find(self, path, find_all=False, **kwargs): """ Look for files in the app directories. """ - # RemovedInDjango60Warning. + # RemovedInDjango61Warning. if kwargs: find_all = self._check_deprecated_find_param(find_all=find_all, **kwargs) matches = [] @@ -287,13 +287,13 @@ class BaseStorageFinder(BaseFinder): self.storage = self.storage() super().__init__(*args, **kwargs) - # RemovedInDjango60Warning: When the deprecation ends, replace with: + # RemovedInDjango61Warning: When the deprecation ends, replace with: # def find(self, path, find_all=False): def find(self, path, find_all=False, **kwargs): """ Look for files in the default file storage, if it's local. """ - # RemovedInDjango60Warning. + # RemovedInDjango61Warning. if kwargs: find_all = self._check_deprecated_find_param(find_all=find_all, **kwargs) try: @@ -336,7 +336,7 @@ class DefaultStorageFinder(BaseStorageFinder): ) -# RemovedInDjango60Warning: When the deprecation ends, replace with: +# RemovedInDjango61Warning: When the deprecation ends, replace with: # def find(path, find_all=False): def find(path, find_all=False, **kwargs): """ @@ -345,7 +345,7 @@ def find(path, find_all=False, **kwargs): If ``find_all`` is ``False`` (default), return the first matching absolute path (or ``None`` if no match). Otherwise return a list. """ - # RemovedInDjango60Warning. + # RemovedInDjango61Warning. if kwargs: find_all = _check_deprecated_find_param(find_all=find_all, **kwargs) searched_locations[:] = [] diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 4b14b404fc..85ad0d400f 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -15,6 +15,9 @@ about each item can often be found in the release notes of two versions prior. See the :ref:`Django 5.2 release notes ` for more details on these changes. +* The ``all`` keyword argument of ``django.contrib.staticfiles.finders.find()`` + will be removed. + .. _deprecation-removed-in-6.0: 6.0 diff --git a/tests/staticfiles_tests/test_finders.py b/tests/staticfiles_tests/test_finders.py index 28870e6fbe..ddae508c5c 100644 --- a/tests/staticfiles_tests/test_finders.py +++ b/tests/staticfiles_tests/test_finders.py @@ -4,7 +4,7 @@ from django.conf import settings from django.contrib.staticfiles import finders, storage from django.core.exceptions import ImproperlyConfigured from django.test import SimpleTestCase, override_settings -from django.utils.deprecation import RemovedInDjango60Warning +from django.utils.deprecation import RemovedInDjango61Warning from .cases import StaticFilesTestCase from .settings import TEST_ROOT @@ -37,7 +37,7 @@ class TestFinders: def test_find_all_deprecated_param(self): src, dst = self.find_all - with self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG): + with self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG): found = self.finder.find(src, all=True) found = [os.path.normcase(f) for f in found] dst = [os.path.normcase(d) for d in dst] @@ -50,7 +50,7 @@ class TestFinders: "argument 'find_all'" ) with ( - self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG), + self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG), self.assertRaisesMessage(TypeError, msg), ): self.finder.find(src, find_all=True, all=True) @@ -62,7 +62,7 @@ class TestFinders: "argument 'wrong'" ) with ( - self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG), + self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG), self.assertRaisesMessage(TypeError, msg), ): self.finder.find(src, all=True, wrong=1) @@ -165,7 +165,7 @@ class TestMiscFinder(SimpleTestCase): ) def test_searched_locations_deprecated_all(self): - with self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG): + with self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG): finders.find("spam", all=True) self.assertEqual( finders.searched_locations, @@ -175,7 +175,7 @@ class TestMiscFinder(SimpleTestCase): def test_searched_locations_conflicting_params(self): msg = "find() got multiple values for argument 'find_all'" with ( - self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG), + self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG), self.assertRaisesMessage(TypeError, msg), ): finders.find("spam", find_all=True, all=True) @@ -183,7 +183,7 @@ class TestMiscFinder(SimpleTestCase): def test_searched_locations_unexpected_params(self): msg = "find() got an unexpected keyword argument 'wrong'" with ( - self.assertWarnsMessage(RemovedInDjango60Warning, DEPRECATION_MSG), + self.assertWarnsMessage(RemovedInDjango61Warning, DEPRECATION_MSG), self.assertRaisesMessage(TypeError, msg), ): finders.find("spam", all=True, wrong=1)