Remove Signal from __all__, replace aiohttp.Signal with aiosignal.Sig…

…nal in docs (#6201)

CHANGES/6201.bugfix

@@ -0,0 +1 @@
+Remove ``Signal`` from ``__all__``, replace ``aiohttp.Signal`` with ``aiosignal.Signal`` in docs

aiohttp/__init__.py

@@ -183,8 +183,7 @@
     "AsyncResolver",
     "DefaultResolver",
     "ThreadedResolver",
-    # signals
-    "Signal",
+    # streams
     "DataQueue",
     "EMPTY_PAYLOAD",
     "EofStream",

docs/conf.py

@@ -70,6 +70,7 @@
     "python": ("http://docs.python.org/3", None),
     "multidict": ("https://multidict.readthedocs.io/en/stable/", None),
     "yarl": ("https://yarl.readthedocs.io/en/stable/", None),
+    "aiosignal": ("https://aiosignal.readthedocs.io/en/stable/", None),
     "aiohttpjinja2": ("https://aiohttp-jinja2.readthedocs.io/en/stable/", None),
     "aiohttpremotes": ("https://aiohttp-remotes.readthedocs.io/en/stable/", None),
     "aiohttpsession": ("https://aiohttp-session.readthedocs.io/en/stable/", None),

docs/utilities.rst

@@ -15,6 +15,5 @@ Miscellaneous API Shared between Client And Server.
    multipart
    multipart_reference
    streams
-   signals
    structures
    websocket_utilities

docs/web_reference.rst

@@ -1407,7 +1407,7 @@ duplicated like one using :meth:`~aiohttp.web.Application.copy`.
 
    .. attribute:: on_response_prepare
 
-      A :class:`~aiohttp.Signal` that is fired near the end
+      A :class:`~aiosignal.Signal` that is fired near the end
       of :meth:`StreamResponse.prepare` with parameters *request* and
       *response*. It can be used, for example, to add custom headers to each
       response, or to modify the default headers computed by the application,
@@ -1420,7 +1420,7 @@ duplicated like one using :meth:`~aiohttp.web.Application.copy`.
 
    .. attribute:: on_startup
 
-      A :class:`~aiohttp.Signal` that is fired on application start-up.
+      A :class:`~aiosignal.Signal` that is fired on application start-up.
 
       Subscribers may use the signal to run background tasks in the event
       loop along with the application's request handler just after the
@@ -1435,7 +1435,7 @@ duplicated like one using :meth:`~aiohttp.web.Application.copy`.
 
    .. attribute:: on_shutdown
 
-      A :class:`~aiohttp.Signal` that is fired on application shutdown.
+      A :class:`~aiosignal.Signal` that is fired on application shutdown.
 
       Subscribers may use the signal for gracefully closing long running
       connections, e.g. websockets and data streaming.
@@ -1455,7 +1455,7 @@ duplicated like one using :meth:`~aiohttp.web.Application.copy`.
 
    .. attribute:: on_cleanup
 
-      A :class:`~aiohttp.Signal` that is fired on application cleanup.
+      A :class:`~aiosignal.Signal` that is fired on application cleanup.
 
       Subscribers may use the signal for gracefully closing
       connections to database server etc.

tests/test___all__.py

@@ -0,0 +1,24 @@
+from typing import Any
+
+
+def test___all__(pytester: Any) -> None:
+    """
+    See https://github.com/aio-libs/aiohttp/issues/6197
+    """
+    pytester.makepyfile(
+        test_a="""
+            from aiohttp import *
+        """
+    )
+    result = pytester.runpytest("-vv")
+    result.assert_outcomes(passed=0, errors=0)
+
+
+def test_web___all__(pytester: Any) -> None:
+    pytester.makepyfile(
+        test_b="""
+            from aiohttp.web import *
+        """
+    )
+    result = pytester.runpytest("-vv")
+    result.assert_outcomes(passed=0, errors=0)