Add HttpResponse.text (#2622)

* Add HttpResponse.text

* Remove corresponding allowlist entries

* Since HttpResponse.text uses @cached_property, add it in allowlist.txt

It was previously in allowlist_todo_django52.txt because
it is a Django 5.2 addition, and was not implemented in django-stubs
yet.

It is now in allowlist.txt because it uses @cached_property,
which stubtest currently doesn't handle
(details: #1771)

Author: cuu508

django-stubs/http/response.pyi

@@ -6,6 +6,7 @@ from json import JSONEncoder
 from typing import Any, Literal, TypeVar, overload, type_check_only
 
 from django.utils.datastructures import CaseInsensitiveMapping, _PropertyDescriptor
+from django.utils.functional import cached_property
 
 class BadHeaderError(ValueError): ...
 
@@ -102,6 +103,8 @@ class HttpResponse(HttpResponseBase, Iterable[bytes]):
     __bytes__ = serialize
     def __iter__(self) -> Iterator[bytes]: ...
     def getvalue(self) -> bytes: ...
+    @cached_property
+    def text(self) -> str: ...
 
 class StreamingHttpResponse(HttpResponseBase, Iterable[bytes], AsyncIterable[bytes]):
     is_async: bool

django-stubs/test/client.pyi

@@ -18,6 +18,7 @@ from django.http.response import HttpResponseBase
 from django.template.base import Template
 from django.test.utils import ContextList
 from django.urls import ResolverMatch
+from django.utils.functional import cached_property
 
 BOUNDARY: str
 MULTIPART_CONTENT: str
@@ -227,6 +228,8 @@ class _MonkeyPatchedWSGIResponse(_WSGIResponse):
     content: bytes
     resolver_match: ResolverMatch
     redirect_chain: list[tuple[str, int]]
+    @cached_property
+    def text(self) -> str: ...
 
 @type_check_only
 class _MonkeyPatchedASGIResponse(_ASGIResponse):

scripts/stubtest/allowlist.txt

@@ -395,8 +395,10 @@ django.forms.renderers.Jinja2.backend
 django.forms.renderers.Jinja2DivFormRenderer.__init__
 django.http.HttpRequest.accepted_types
 django.http.HttpRequest.headers
+django.http.HttpResponse.text
 django.http.request.HttpRequest.accepted_types
 django.http.request.HttpRequest.headers
+django.http.response.HttpResponse.text
 django.middleware.csrf.CsrfViewMiddleware.allowed_origin_subdomains
 django.middleware.csrf.CsrfViewMiddleware.allowed_origins_exact
 django.middleware.csrf.CsrfViewMiddleware.csrf_trusted_origins_hosts

scripts/stubtest/allowlist_todo_django52.txt

@@ -186,7 +186,6 @@ django.forms.renderers.BaseRenderer.bound_field_class
 django.forms.utils.ErrorList.__init__
 django.http.HttpRequest.accepted_type
 django.http.HttpRequest.get_preferred_type
-django.http.HttpResponse.text
 django.http.HttpResponsePermanentRedirect.status_code_preserve_request
 django.http.HttpResponseRedirect.status_code_preserve_request
 django.http.QueryDict.pop
@@ -197,7 +196,6 @@ django.http.request.MediaType.quality
 django.http.request.MediaType.specificity
 django.http.request.QueryDict.pop
 django.http.request.parse_accept_header
-django.http.response.HttpResponse.text
 django.http.response.HttpResponsePermanentRedirect.status_code_preserve_request
 django.http.response.HttpResponseRedirect.status_code_preserve_request
 django.http.response.HttpResponseRedirectBase.__init__

tests/typecheck/http/test_response.yml

@@ -0,0 +1,4 @@
+- case: response_object_has_text_of_type_str
+  main: |
+      from django.http.response import HttpResponse
+      reveal_type(HttpResponse().text)  # N: Revealed type is "builtins.str"

tests/typecheck/test/test_client.yml

@@ -1,5 +1,5 @@
--   case: client_methods
-    main: |
+- case: client_methods
+  main: |
       from django.test.client import Client
       client = Client()
       response = client.get('foo')
@@ -11,9 +11,10 @@
       reveal_type(response.context_data)  # N: Revealed type is "Union[django.test.utils.ContextList, builtins.dict[builtins.str, Any]]"
       reveal_type(response.content)  # N: Revealed type is "builtins.bytes"
       reveal_type(response.redirect_chain)  # N: Revealed type is "builtins.list[Tuple[builtins.str, builtins.int]]"
+      reveal_type(response.text)  # N: Revealed type is "builtins.str"
       response.json()
--   case: async_client_methods
-    main: |
+- case: async_client_methods
+  main: |
       from django.test.client import AsyncClient
       async def main() -> None:
         client = AsyncClient()
@@ -27,8 +28,8 @@
         reveal_type(response.content)  # N: Revealed type is "builtins.bytes"
         reveal_type(response.redirect_chain)  # N: Revealed type is "builtins.list[Tuple[builtins.str, builtins.int]]"
         response.json()
--   case: request_factories
-    main: |
+- case: request_factories
+  main: |
       from django.test.client import RequestFactory, AsyncRequestFactory
       factory = RequestFactory()
       request = factory.get('foo')