chore(deps): bump websocksets to 15+

0xRAG · fselmo · commit 78a0a0bd2eab · 2025-03-27T10:28:16.000-06:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -221,7 +221,7 @@ workflows:
       - common:
           matrix:
             parameters:
-              python_minor_version: ["8", "9", "10", "11", "12", "13"]
+              python_minor_version: ["9", "10", "11", "12", "13"]
               tox_env: [
                 "lint",
                 "core",
@@ -234,7 +234,7 @@ workflows:
       - geth:
           matrix:
             parameters:
-              python_minor_version: ["8", "9", "10", "11", "12", "13"]
+              python_minor_version: ["9", "10", "11", "12", "13"]
               tox_env: [
                 "integration-goethereum-ipc",
                 "integration-goethereum-ipc_async",
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@
 
 web3.py allows you to interact with the Ethereum blockchain using Python, enabling you to build decentralized applications, interact with smart contracts, and much more.
 
-- Python 3.8+ support
+- Python 3.9+ support
 
 ## Installation
 
diff --git a/docs/migration.rst b/docs/migration.rst
@@ -1,6 +1,31 @@
 Migration Guide
 ===============
 
+.. _migrating_v7_to_v8:
+
+Migrating from v7 to v8
+-----------------------
+
+web3.py follows `Semantic Versioning <http://semver.org>`_, which means that
+version 8 introduced backwards-incompatible changes. If you're upgrading from
+web3.py ``v7``, you can expect to need to make some changes. Refer
+to this guide for a summary of breaking changes when updating from ``v7`` to
+``v8``. If you are more than one major version behind, you should also review
+the migration guides for the versions in between.
+
+Dependency Updates
+~~~~~~~~~~~~~~~~~~
+
+websockets
+``````````
+
+The ``websockets`` library has been updated to version 15+. This version
+drops support for Python 3.8 and below. If you are using Python 3.8 or below,
+you will need to upgrade to Python 3.9 or above to use web3.py ``v8``. Additionally,
+the minimum required version of ``websockets`` has been bumped to ``15.0.0``. If you
+are using a version of ``websockets`` below ``15.0.0``, you will need to upgrade to
+``15.0.0`` or above to use web3.py ``v8``.
+
 .. _migrating_v6_to_v7:
 
 Migrating from v6 to v7
diff --git a/newsfragments/3641.breaking.rst b/newsfragments/3641.breaking.rst
@@ -0,0 +1,6 @@
+Bump websockets to >=15.0.0,<16.0.0
+
+This is potentially a breaking change in two ways:
+1. Users directly depending on websockets 13.0 or lower will have to bump to websockets 15.0
+2. Users on Python 3.8 or lower will have to bump to Python 3.9, since websockets 14.0 dropped
+support for Python 3.8
diff --git a/setup.py b/setup.py
@@ -78,10 +78,10 @@
         "requests>=2.23.0",
         "typing-extensions>=4.0.1",
         "types-requests>=2.0.0",
-        "websockets>=10.0.0,<14.0.0",
+        "websockets>=15.0.0,<16.0.0",
         "pyunormalize>=15.0.0",
     ],
-    python_requires=">=3.8, <4",
+    python_requires=">=3.9, <4",
     extras_require=extras_require,
     py_modules=["web3", "ens"],
     license="MIT",
@@ -95,7 +95,6 @@
         "License :: OSI Approved :: MIT License",
         "Natural Language :: English",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
diff --git a/tests/core/providers/test_legacy_websocket_provider.py b/tests/core/providers/test_legacy_websocket_provider.py
@@ -7,7 +7,9 @@
     Thread,
 )
 
-import websockets
+from websockets.legacy.server import (
+    serve,
+)
 
 from tests.utils import (
     wait_for_ws,
@@ -35,7 +37,7 @@ async def empty_server(websocket, path):
             await websocket.send(data)
 
         asyncio.set_event_loop(event_loop)
-        server = websockets.serve(empty_server, "127.0.0.1", open_port)
+        server = serve(empty_server, "127.0.0.1", open_port)
         event_loop.run_until_complete(server)
         event_loop.run_forever()
 
diff --git a/tests/utils.py b/tests/utils.py
@@ -2,7 +2,9 @@
 import socket
 import time
 
-import websockets
+from websockets.legacy.client import (
+    connect,
+)
 
 from web3._utils.threads import (
     Timeout,
@@ -43,7 +45,7 @@ async def wait_for_ws(endpoint_uri, timeout=10):
     start = time.time()
     while time.time() < start + timeout:
         try:
-            async with websockets.connect(uri=endpoint_uri):
+            async with connect(uri=endpoint_uri):
                 pass
         except OSError:
             await asyncio.sleep(0.01)
diff --git a/tox.ini b/tox.ini
@@ -45,7 +45,6 @@ passenv =
 basepython =
     docs: python
     windows-wheel: python
-    py38: python3.8
     py39: python3.9
     py310: python3.10
     py311: python3.11
diff --git a/web3/providers/async_base.py b/web3/providers/async_base.py
@@ -53,7 +53,7 @@
 )
 
 if TYPE_CHECKING:
-    from websockets import (
+    from websockets.legacy.client import (
         WebSocketClientProtocol,
     )
 
diff --git a/web3/providers/legacy_websocket.py b/web3/providers/legacy_websocket.py
@@ -21,11 +21,9 @@
 from eth_typing import (
     URI,
 )
-from websockets.client import (
-    connect,
-)
 from websockets.legacy.client import (
     WebSocketClientProtocol,
+    connect,
 )
 
 from web3._utils.batching import (
diff --git a/web3/providers/persistent/request_processor.py b/web3/providers/persistent/request_processor.py
@@ -1,5 +1,4 @@
 import asyncio
-import sys
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -48,20 +47,8 @@
 
 T = TypeVar("T")
 
-# TODO: This is an ugly hack for python 3.8. Remove this after we drop support for it
-#  and use `asyncio.Queue[T]` type directly in the `TaskReliantQueue` class.
-if sys.version_info >= (3, 9):
 
-    class _TaskReliantQueue(asyncio.Queue[T], Generic[T]):
-        pass
-
-else:
-
-    class _TaskReliantQueue(asyncio.Queue, Generic[T]):  # type: ignore
-        pass
-
-
-class TaskReliantQueue(_TaskReliantQueue[T]):
+class TaskReliantQueue(asyncio.Queue[T], Generic[T]):
     """
     A queue that relies on a task to be running to process items in the queue.
     """
diff --git a/web3/providers/persistent/websocket.py b/web3/providers/persistent/websocket.py
@@ -15,16 +15,14 @@
 from toolz import (
     merge,
 )
-from websockets import (
-    WebSocketClientProtocol,
-)
-from websockets.client import (
-    connect,
-)
 from websockets.exceptions import (
     ConnectionClosedOK,
     WebSocketException,
 )
+from websockets.legacy.client import (
+    WebSocketClientProtocol,
+    connect,
+)
 
 from web3.exceptions import (
     PersistentConnectionClosedOK,

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@`
`53`	`53`	`)`
`54`	`54`
`55`	`55`	`if TYPE_CHECKING:`
`56`		`- from websockets import (`
	`56`	`+ from websockets.legacy.client import (`
`57`	`57`	`WebSocketClientProtocol,`
`58`	`58`	`)`
`59`	`59`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,9 @@`
`21`	`21`	`from eth_typing import (`
`22`	`22`	`URI,`
`23`	`23`	`)`
`24`		`-from websockets.client import (`
`25`		`- connect,`
`26`		`-)`
`27`	`24`	`from websockets.legacy.client import (`
`28`	`25`	`WebSocketClientProtocol,`
	`26`	`+ connect,`
`29`	`27`	`)`
`30`	`28`
`31`	`29`	`from web3._utils.batching import (`