Use StarletteDeprecationWarning instead of DeprecationWarning (#3119)

Author: Kludex

pyproject.toml

@@ -112,8 +112,8 @@ xfail_strict = true
 filterwarnings = [
     # Turn warnings that aren't filtered into exceptions
     "error",
-    "ignore: run_until_first_complete is deprecated and will be removed in a future version.:DeprecationWarning",
-    "ignore: starlette.middleware.wsgi is deprecated and will be removed in a future release.*:DeprecationWarning",
+    "ignore: run_until_first_complete is deprecated and will be removed in a future version.:starlette.exceptions.StarletteDeprecationWarning",
+    "ignore: starlette.middleware.wsgi is deprecated and will be removed in a future release.*:starlette.exceptions.StarletteDeprecationWarning",
     "ignore: Async generator 'starlette.requests.Request.stream' was garbage collected before it had been exhausted.*:ResourceWarning",
     "ignore: Use 'content=<...>' to upload raw bytes/text content.:DeprecationWarning",
     "ignore: Using `httpx` with `starlette.testclient` is deprecated.*:starlette.exceptions.StarletteDeprecationWarning",

starlette/concurrency.py

@@ -7,14 +7,16 @@
 
 import anyio.to_thread
 
+from starlette.exceptions import StarletteDeprecationWarning
+
 P = ParamSpec("P")
 T = TypeVar("T")
 
 
 async def run_until_first_complete(*args: tuple[Callable, dict]) -> None:  # type: ignore[type-arg]
     warnings.warn(
         "run_until_first_complete is deprecated and will be removed in a future version.",
-        DeprecationWarning,
+        StarletteDeprecationWarning,
     )
 
     async with anyio.create_task_group() as task_group:

starlette/middleware/wsgi.py

@@ -11,12 +11,13 @@
 from anyio.abc import ObjectReceiveStream, ObjectSendStream
 
 from starlette._utils import create_collapsing_task_group
+from starlette.exceptions import StarletteDeprecationWarning
 from starlette.types import Receive, Scope, Send
 
 warnings.warn(
     "starlette.middleware.wsgi is deprecated and will be removed in a future release. "
     "Please refer to https://github.com/abersheeran/a2wsgi as a replacement.",
-    DeprecationWarning,
+    StarletteDeprecationWarning,
     stacklevel=2,
 )
 

starlette/routing.py

@@ -18,7 +18,7 @@
 from starlette.concurrency import run_in_threadpool
 from starlette.convertors import CONVERTOR_TYPES, Convertor
 from starlette.datastructures import URL, Headers, URLPath
-from starlette.exceptions import HTTPException
+from starlette.exceptions import HTTPException, StarletteDeprecationWarning
 from starlette.middleware import Middleware
 from starlette.requests import Request
 from starlette.responses import PlainTextResponse, RedirectResponse, Response
@@ -586,13 +586,13 @@ def __init__(
             warnings.warn(
                 "async generator function lifespans are deprecated, "
                 "use an @contextlib.asynccontextmanager function instead",
-                DeprecationWarning,
+                StarletteDeprecationWarning,
             )
             self.lifespan_context = asynccontextmanager(lifespan)
         elif inspect.isgeneratorfunction(lifespan):
             warnings.warn(
                 "generator function lifespans are deprecated, use an @contextlib.asynccontextmanager function instead",
-                DeprecationWarning,
+                StarletteDeprecationWarning,
             )
             self.lifespan_context = _wrap_gen_lifespan_context(lifespan)
         else:

starlette/status.py

@@ -10,6 +10,8 @@
 
 import warnings
 
+from starlette.exceptions import StarletteDeprecationWarning
+
 __all__ = [
     "HTTP_100_CONTINUE",
     "HTTP_101_SWITCHING_PROTOCOLS",
@@ -197,7 +199,7 @@ def __getattr__(name: str) -> int:
     if deprecated:
         warnings.warn(
             f"'{name}' is deprecated. Use '{deprecation_changes[name]}' instead.",
-            category=DeprecationWarning,
+            category=StarletteDeprecationWarning,
             stacklevel=3,
         )
         return deprecated

starlette/testclient.py

@@ -447,7 +447,7 @@ def request(  # type: ignore[override]
             warnings.warn(
                 "You should not use the 'timeout' argument with the TestClient. "
                 "See https://github.com/Kludex/starlette/issues/1108 for more information.",
-                DeprecationWarning,
+                StarletteDeprecationWarning,
                 stacklevel=2,
             )
         url = self._merge_url(url)

tests/test_applications.py

@@ -413,7 +413,7 @@ async def lifespan(app: ASGIApp) -> AsyncGenerator[None, None]:
     r"ignore"
     r":(async )?generator function lifespans are deprecated, use an "
     r"@contextlib\.asynccontextmanager function instead"
-    r":DeprecationWarning"
+    r":starlette.exceptions.StarletteDeprecationWarning"
     r":starlette.routing"
 )
 

tests/test_status.py

@@ -2,6 +2,8 @@
 
 import pytest
 
+from starlette.exceptions import StarletteDeprecationWarning
+
 
 @pytest.mark.parametrize(
     "constant,msg",
@@ -17,7 +19,7 @@
     ),
 )
 def test_deprecated_types(constant: str, msg: str) -> None:
-    with pytest.warns(DeprecationWarning) as record:
+    with pytest.warns(StarletteDeprecationWarning) as record:
         getattr(importlib.import_module("starlette.status"), constant)
         assert len(record) == 1
         assert msg in str(record.list[0])

tests/test_testclient.py

@@ -14,6 +14,7 @@
 import trio.lowlevel
 
 from starlette.applications import Starlette
+from starlette.exceptions import StarletteDeprecationWarning
 from starlette.middleware import Middleware
 from starlette.requests import Request
 from starlette.responses import JSONResponse, RedirectResponse, Response
@@ -425,6 +426,8 @@ async def app(scope: Scope, receive: Receive, send: Send) -> None:
 
 
 def test_timeout_deprecation() -> None:
-    with pytest.deprecated_call(match="You should not use the 'timeout' argument with the TestClient."):
+    with pytest.warns(
+        StarletteDeprecationWarning, match="You should not use the 'timeout' argument with the TestClient."
+    ):
         client = TestClient(mock_service)
         client.get("/", timeout=1)