Restore real imports for compatibility with mypy.

Fix #940.
python-websockets · May 13, 2021 · b99c4fe · lig · May 14, 2021 · b99c4fe
1 parent e44e085
commit b99c4fe
Show file tree

Hide file tree

Showing 8 changed files with 35 additions and 27 deletions.
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -1,7 +1,7 @@
 Client
 ======
 
-.. automodule:: websockets.legacy.client
+.. automodule:: websockets.client
 
     Opening a connection
     --------------------

diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -46,5 +46,10 @@ both in the client API and server API.
    utilities
 
 All public APIs can be imported from the :mod:`websockets` package, unless
-noted otherwise. Anything that isn't listed in this API documentation is a
-private API, with no guarantees of behavior or backwards-compatibility.
+noted otherwise. This convenience feature is incompatible with static code
+analysis tools such as mypy_, though.
+
+.. _mypy: https://github.com/python/mypy
+
+Anything that isn't listed in this API documentation is a private API. There's
+no guarantees of behavior or backwards-compatibility for private APIs.
diff --git a/docs/api/server.rst b/docs/api/server.rst
@@ -1,7 +1,7 @@
 Server
 ======
 
-.. automodule:: websockets.legacy.server
+.. automodule:: websockets.server
 
     Starting a server
     -----------------
@@ -90,7 +90,7 @@ Server
 Basic authentication
 --------------------
 
-.. automodule:: websockets.legacy.auth
+.. automodule:: websockets.auth
 
     .. autofunction:: basic_auth_protocol_factory
 

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -37,6 +37,8 @@ They may change at any time.
 
 * Restored compatibility of ``python -m websockets`` with Python < 3.9.
 
+* Restored compatibility with mypy.
+
 9.0.1
 .....
 
@@ -73,6 +75,20 @@ They may change at any time.
       but that never happened. Keeping these APIs public makes it more
       difficult to improve websockets for no actual benefit.
 
+.. note::
+
+    **Version 9.0 may require changes if you use static code analysis tools.**
+
+    Convenience imports from the ``websockets`` module are performed lazily.
+    While this is supported by Python, static code analysis tools such as mypy
+    are unable to understand the behavior.
+
+    If you depend on such tools, use the real import path, which can be found
+    in the API documentation::
+
+        from websockets.client import connect
+        from websockets.server import serve
+
 * Added compatibility with Python 3.9.
 
 * Added support for IRIs in addition to URIs.

diff --git a/docs/extensions.rst b/docs/extensions.rst
@@ -14,9 +14,8 @@ specification, WebSocket Per-Message Deflate, specified in :rfc:`7692`.
 Per-Message Deflate
 -------------------
 
-:func:`~websockets.legacy.client.connect` and
-:func:`~websockets.legacy.server.serve` enable the Per-Message Deflate
-extension by default.
+:func:`~websockets.client.connect` and :func:`~websockets.server.serve` enable
+the Per-Message Deflate extension by default.
 
 If you want to disable it, set ``compression=None``::
 

diff --git a/src/websockets/auth.py b/src/websockets/auth.py
@@ -0,0 +1,2 @@
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.auth import *  # noqa
diff --git a/src/websockets/client.py b/src/websockets/client.py
@@ -24,7 +24,6 @@
 )
 from .http import USER_AGENT, build_host
 from .http11 import Request, Response
-from .imports import lazy_import
 from .typing import (
     ConnectionOption,
     ExtensionHeader,
@@ -36,14 +35,9 @@
 from .utils import accept_key, generate_key
 
 
-lazy_import(
-    globals(),
-    aliases={
-        "connect": ".legacy.client",
-        "unix_connect": ".legacy.client",
-        "WebSocketClientProtocol": ".legacy.client",
-    },
-)
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.client import *  # isort:skip  # noqa
+
 
 __all__ = ["ClientConnection"]
 

diff --git a/src/websockets/server.py b/src/websockets/server.py
@@ -26,7 +26,6 @@
 )
 from .http import USER_AGENT
 from .http11 import Request, Response
-from .imports import lazy_import
 from .typing import (
     ConnectionOption,
     ExtensionHeader,
@@ -37,15 +36,8 @@
 from .utils import accept_key
 
 
-lazy_import(
-    globals(),
-    aliases={
-        "serve": ".legacy.server",
-        "unix_serve": ".legacy.server",
-        "WebSocketServerProtocol": ".legacy.server",
-        "WebSocketServer": ".legacy.server",
-    },
-)
+# See #940 for why lazy_import isn't used here for backwards compatibility.
+from .legacy.server import *  # isort:skip  # noqa
 
 
 __all__ = ["ServerConnection"]