Remove contrib.staticfiles finders from allowlist 52. Fix tests and stubs. (typeddjango#2684)

Author: skv0zsneg

django-stubs/contrib/staticfiles/finders.pyi

@@ -9,9 +9,9 @@ searched_locations: Any
 class BaseFinder:
     def check(self, **kwargs: Any) -> list[CheckMessage]: ...
     @overload
-    def find(self, path: str, all: Literal[False] = False) -> str | None: ...
+    def find(self, path: str, find_all: Literal[False] = False) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[True]) -> list[str]: ...
+    def find(self, path: str, find_all: Literal[True]) -> list[str]: ...
     def list(self, ignore_patterns: Iterable[str] | None) -> Iterable[Any]: ...
 
 class FileSystemFinder(BaseFinder):
@@ -20,9 +20,9 @@ class FileSystemFinder(BaseFinder):
     def __init__(self, app_names: Sequence[str] | None = None, *args: Any, **kwargs: Any) -> None: ...
     def find_location(self, root: str, path: str, prefix: str | None = None) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[False] = False) -> str | None: ...
+    def find(self, path: str, find_all: Literal[False] = False) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[True]) -> list[str]: ...
+    def find(self, path: str, find_all: Literal[True]) -> list[str]: ...
     def list(self, ignore_patterns: Iterable[str] | None) -> Iterable[Any]: ...
 
 class AppDirectoriesFinder(BaseFinder):
@@ -33,27 +33,27 @@ class AppDirectoriesFinder(BaseFinder):
     def __init__(self, app_names: Iterable[str] | None = None, *args: Any, **kwargs: Any) -> None: ...
     def find_in_app(self, app: str, path: str) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[False] = False) -> str | None: ...
+    def find(self, path: str, find_all: Literal[False] = False) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[True]) -> list[str]: ...
+    def find(self, path: str, find_all: Literal[True]) -> list[str]: ...
     def list(self, ignore_patterns: Iterable[str] | None) -> Iterable[Any]: ...
 
 class BaseStorageFinder(BaseFinder):
     storage: Storage
     def __init__(self, storage: Storage | None = None, *args: Any, **kwargs: Any) -> None: ...
     @overload
-    def find(self, path: str, all: Literal[False] = False) -> str | None: ...
+    def find(self, path: str, find_all: Literal[False] = False) -> str | None: ...
     @overload
-    def find(self, path: str, all: Literal[True]) -> list[str]: ...
+    def find(self, path: str, find_all: Literal[True]) -> list[str]: ...
     def list(self, ignore_patterns: Iterable[str] | None) -> Iterable[Any]: ...
 
 class DefaultStorageFinder(BaseStorageFinder):
     storage: Storage
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
 
 @overload
-def find(path: str, all: Literal[False] = False) -> str | None: ...
+def find(path: str, find_all: Literal[False] = False) -> str | None: ...
 @overload
-def find(path: str, all: Literal[True]) -> list[str]: ...
+def find(path: str, find_all: Literal[True]) -> list[str]: ...
 def get_finders() -> Iterator[BaseFinder]: ...
 def get_finder(import_path: str) -> BaseFinder: ...

scripts/stubtest/allowlist_todo_django52.txt

@@ -38,11 +38,6 @@ django.contrib.gis.management.commands.ogrinspect
 django.contrib.postgres.aggregates.mixins.OrderableAggMixin.__init__
 django.contrib.postgres.indexes.BTreeIndex.__init__
 django.contrib.sessions.backends.base.SessionBase.pop
-django.contrib.staticfiles.finders.AppDirectoriesFinder.find
-django.contrib.staticfiles.finders.BaseFinder.find
-django.contrib.staticfiles.finders.BaseStorageFinder.find
-django.contrib.staticfiles.finders.FileSystemFinder.find
-django.contrib.staticfiles.finders.find
 django.core.checks.Tags.commands
 django.core.checks.commands
 django.core.checks.registry.Tags.commands

tests/typecheck/contrib/staticfiles/test_finders.yml

@@ -15,14 +15,14 @@
     main: |
       from django.contrib.staticfiles import finders
 
-      reveal_type(finders.find("filepath", all=True))  # N: Revealed type is "builtins.list[builtins.str]"
+      reveal_type(finders.find("filepath", find_all=True))  # N: Revealed type is "builtins.list[builtins.str]"
 
       for finder in finders.get_finders():
-          reveal_type(finder.find("filepath", all=True))  # N: Revealed type is "builtins.list[builtins.str]"
+          reveal_type(finder.find("filepath", find_all=True))  # N: Revealed type is "builtins.list[builtins.str]"
 
-      reveal_type(finders.FileSystemFinder().find("filepath", all=True)) # N: Revealed type is "builtins.list[builtins.str]"
-      reveal_type(finders.AppDirectoriesFinder().find("filepath", all=True)) # N: Revealed type is "builtins.list[builtins.str]"
-      reveal_type(finders.DefaultStorageFinder().find("filepath", all=True)) # N: Revealed type is "builtins.list[builtins.str]"
+      reveal_type(finders.FileSystemFinder().find("filepath", find_all=True)) # N: Revealed type is "builtins.list[builtins.str]"
+      reveal_type(finders.AppDirectoriesFinder().find("filepath", find_all=True)) # N: Revealed type is "builtins.list[builtins.str]"
+      reveal_type(finders.DefaultStorageFinder().find("filepath", find_all=True)) # N: Revealed type is "builtins.list[builtins.str]"
 
 -   case: test_file_system_finder  # test methods *only* on FileSystemFinder
     main: |