Annotate return type of reverse_lazy() (#2766)

Update `urls.base.pyi` with an annotated `_StrPromise`
return type for `reverse_lazy()`

Fixes ##2765

Author: pgcd

django-stubs/urls/base.pyi

@@ -4,26 +4,36 @@ from typing import Any, Literal, TypeAlias
 from django.http.request import QueryDict
 from django.http.response import HttpResponseBase
 from django.urls.resolvers import ResolverMatch
+from django.utils.functional import _StrPromise
 
 # https://github.com/python/typeshed/blob/87f599dc8312ac67b941b5f2b47274534a1a2d3a/stdlib/urllib/parse.pyi#L136-L138
 _QueryType: TypeAlias = (
     Mapping[Any, Any] | Mapping[Any, Sequence[Any]] | Sequence[tuple[Any, Any]] | Sequence[tuple[Any, Sequence[Any]]]
 )
 
 def resolve(path: str, urlconf: str | None = ...) -> ResolverMatch: ...
+
+# NOTE: make sure `reverse` and `reverse_lazy` objects are in sync:
 def reverse(
     viewname: Callable[..., HttpResponseBase] | str | None,
-    urlconf: str | None = ...,
-    args: Sequence[Any] | None = ...,
-    kwargs: dict[str, Any] | None = ...,
-    current_app: str | None = ...,
+    urlconf: str | None = None,
+    args: Sequence[Any] | None = None,
+    kwargs: dict[str, Any] | None = None,
+    current_app: str | None = None,
     *,
-    query: QueryDict | _QueryType | None = ...,
-    fragment: str | None = ...,
+    query: QueryDict | _QueryType | None = None,
+    fragment: str | None = None,
 ) -> str: ...
-
-reverse_lazy: Any
-
+def reverse_lazy(
+    viewname: Callable[..., HttpResponseBase] | str | None,
+    urlconf: str | None = None,
+    args: Sequence[Any] | None = None,
+    kwargs: dict[str, Any] | None = None,
+    current_app: str | None = None,
+    *,
+    query: QueryDict | _QueryType | None = None,
+    fragment: str | None = None,
+) -> _StrPromise: ...
 def clear_url_caches() -> None: ...
 def set_script_prefix(prefix: str) -> None: ...
 def get_script_prefix() -> str: ...