deprecate WeakNamespace

docs/index.rst

@@ -371,12 +371,9 @@ Basic Signals
 Named Signals
 +++++++++++++
 
-.. function:: signal(name, doc=None)
+.. autofunction:: signal
 
-  Return the :class:`NamedSignal` *name*, creating it if required.
-
-  Repeated calls to this function will return the same signal object.
-  Signals are created in a global :class:`Namespace`.
+.. autodata:: default_namespace
 
 .. autoclass:: NamedSignal
    :show-inheritance:
@@ -386,10 +383,6 @@ Named Signals
    :show-inheritance:
    :members: signal
 
-.. autoclass:: WeakNamespace
-   :show-inheritance:
-   :members: signal
-
 
 Changes
 =======

src/blinker/__init__.py

@@ -8,7 +8,6 @@
 from .base import Namespace
 from .base import Signal
 from .base import signal
-from .base import WeakNamespace
 
 __all__ = [
     "ANY",
@@ -17,7 +16,6 @@
     "Namespace",
     "Signal",
     "signal",
-    "WeakNamespace",
 ]
 
 
@@ -48,4 +46,15 @@ def __getattr__(name: str) -> t.Any:
         )
         return _receiver_connected
 
+    if name == "WeakNamespace":
+        from .base import _WeakNamespace
+
+        warnings.warn(
+            "'WeakNamespace' is deprecated and will be removed in Blinker 1.9."
+            " Use 'Namespace' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return _WeakNamespace
+
     raise AttributeError(name)

src/blinker/base.py

@@ -523,7 +523,7 @@ def signal(self, name: str, doc: str | None = None) -> NamedSignal:
             return result  # type: ignore[no-any-return]
 
 
-class WeakNamespace(WeakValueDictionary):  # type: ignore[type-arg]
+class _WeakNamespace(WeakValueDictionary):  # type: ignore[type-arg]
     """A weak mapping of signal names to signals.
 
     Automatically cleans up unused Signals when the last reference goes out
@@ -560,12 +560,12 @@ def signal(self, name: str, doc: str | None = None) -> NamedSignal:
 
 default_namespace = Namespace()
 """A default namespace for creating named signals. :func:`signal` creates a
-signal in this namespace.
+:class:`NamedSignal` in this namespace.
 """
 
 signal = default_namespace.signal
-"""Create a named signal in :data:`default_namespace`. Repeated calls with
-the same name will return the same signal.
+"""Create a :class:`NamedSignal` in :data:`default_namespace`. Repeated calls
+with the same name will return the same signal.
 """
 
 
@@ -580,4 +580,12 @@ def __getattr__(name: str) -> t.Any:
         )
         return _receiver_connected
 
+    if name == "WeakNamespace":
+        warnings.warn(
+            "'WeakNamespace' is deprecated and will be removed in Blinker 1.9."
+            " Use 'Namespace' instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
     raise AttributeError(name)