➕ Add Python 3.10 support (ethereum#2175)

* ➕ Add Python 3.10 support to CI

* Dropped support for all parities

* Change docker image to use 3.10

* Update pytest-asyncio plugin

* Mark async fixture as such, clean up pytest DeprecationWarnings

Signed-off-by: Harmouch101 <[email protected]>

Co-authored-by: Felipe Selmo <[email protected]>
Co-authored-by: kclowes <[email protected]>
Signed-off-by: Harmouch101 <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -421,10 +421,75 @@ jobs:
         environment:
           TOXENV: py39-wheel-cli
 
+  #
+  # Python 3.10
+  #
+  py310-core:
+    <<: *common
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-core
+
+  py310-ens:
+    <<: *common
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-ens
+
+  py310-ethpm:
+    <<: *ethpm_steps
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-ethpm
+      # Please don't use this key for any shenanigans
+      WEB3_INFURA_PROJECT_ID: 7707850c2fb7465ebe6f150d67182e22
+
+  py310-integration-goethereum-ipc:
+    <<: *geth_steps
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-integration-goethereum-ipc
+      GETH_VERSION: v1.10.11
+
+  py310-integration-goethereum-http:
+    <<: *geth_steps
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-integration-goethereum-http
+      GETH_VERSION: v1.10.11
+
+  py310-integration-goethereum-ws:
+    <<: *geth_steps
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-integration-goethereum-ws
+      GETH_VERSION: v1.10.11
+
+  py310-integration-ethtester-pyevm:
+    <<: *common
+    docker:
+      - image: circleci/python:3.10
+    environment:
+      TOXENV: py310-integration-ethtester
+      ETHEREUM_TESTER_CHAIN_BACKEND: eth_tester.backends.PyEVMBackend
+
+  py310-wheel-cli:
+    <<: *common
+    docker:
+      - image: circleci/python:3.10
+        environment:
+          TOXENV: py310-wheel-cli
+
   benchmark:
     <<: *geth_steps
     docker:
-      - image: circleci/python:3.9
+      - image: circleci/python:3.10
     environment:
       TOXENV: benchmark
       GETH_VERSION: v1.10.13
@@ -437,6 +502,7 @@ workflows:
       - py37-core
       - py38-core
       - py39-core
+      - py310-core
       - lint
       - docs
       - benchmark
@@ -462,3 +528,10 @@ workflows:
       - py39-integration-goethereum-ws
       - py39-integration-ethtester-pyevm
       - py39-wheel-cli
+      - py310-ens
+      - py310-ethpm
+      - py310-integration-goethereum-ipc
+      - py310-integration-goethereum-http
+      - py310-integration-goethereum-ws
+      - py310-integration-ethtester-pyevm
+      - py310-wheel-cli

newsfragments/2175.feature.rst

@@ -0,0 +1 @@
+Add support for Python 3.10

newsfragments/2344.feature.rst

@@ -0,0 +1 @@
+Adds a depreaction warning for the optional ``loop`` parameter of ``web3.providers.websocket``.

pytest.ini

@@ -2,6 +2,7 @@
 addopts= -v --showlocals --durations 10
 python_paths= .
 xfail_strict=true
+asyncio_mode=strict
 
 [pytest-watch]
 runner= pytest --failed-first --maxfail=1 --no-success-flaky-report

setup.py

@@ -26,7 +26,7 @@
         "contextlib2>=0.5.4",
         "py-geth>=3.6.0,<4",
         "py-solc>=0.4.0",
-        "pytest>=4.4.0,<5.0.0",
+        "pytest>=6.2.5,<7",
         "sphinx>=3.0,<4",
         "sphinx_rtd_theme>=0.1.9",
         "toposort>=1.4",
@@ -38,8 +38,8 @@
         "bumpversion",
         "flaky>=3.7.0,<4",
         "hypothesis>=3.31.2,<6",
-        "pytest>=4.4.0,<5.0.0",
-        "pytest-asyncio>=0.10.0,<0.11",
+        "pytest>=6.2.5,<7",
+        "pytest-asyncio>=0.18.1,<0.19",
         "pytest-mock>=1.10,<2",
         "pytest-pythonpath>=0.3",
         "pytest-watch>=4.2,<5",
@@ -92,7 +92,7 @@
         "typing-extensions>=3.7.4.1,<5;python_version<'3.8'",
         "websockets>=10.0.0,<11",
     ],
-    python_requires='>=3.7,<3.10',
+    python_requires='>=3.7,<3.11',
     extras_require=extras_require,
     py_modules=['web3', 'ens', 'ethpm'],
     entry_points={"pytest11": ["pytest_ethereum = web3.tools.pytest_ethereum.plugins"]},
@@ -110,5 +110,6 @@
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
     ],
 )

tests/core/providers/test_websocket_provider.py

@@ -15,6 +15,7 @@
     ValidationError,
 )
 from web3.providers.websocket import (
+    PersistentWebSocket,
     WebsocketProvider,
 )
 
@@ -28,7 +29,7 @@
     )
 
 
-@pytest.yield_fixture
+@pytest.fixture
 def start_websocket_server(open_port):
     event_loop = asyncio.new_event_loop()
 
@@ -39,7 +40,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 = websockets.serve(empty_server, "127.0.0.1", open_port)
         event_loop.run_until_complete(server)
         event_loop.run_forever()
 
@@ -51,11 +52,11 @@ async def empty_server(websocket, path):
         event_loop.call_soon_threadsafe(event_loop.stop)
 
 
-@pytest.fixture()
+@pytest.fixture
 def w3(open_port, start_websocket_server):
     # need new event loop as the one used by server is already running
     event_loop = asyncio.new_event_loop()
-    endpoint_uri = 'ws://127.0.0.1:{}'.format(open_port)
+    endpoint_uri = "ws://127.0.0.1:{}".format(open_port)
     event_loop.run_until_complete(wait_for_ws(endpoint_uri))
     provider = WebsocketProvider(endpoint_uri, websocket_timeout=0.01)
     return Web3(provider)
@@ -67,7 +68,28 @@ def test_websocket_provider_timeout(w3):
 
 
 def test_restricted_websocket_kwargs():
-    invalid_kwargs = {'uri': 'ws://127.0.0.1:8546'}
-    re_exc_message = r'.*found: {0}*'.format(set(invalid_kwargs.keys()))
+    invalid_kwargs = {"uri": "ws://127.0.0.1:8546"}
+    re_exc_message = r".*found: {0}*".format(set(invalid_kwargs.keys()))
     with pytest.raises(ValidationError, match=re_exc_message):
         WebsocketProvider(websocket_kwargs=invalid_kwargs)
+
+
+def test_event_loop_argument_deprecated():
+    event_loop = asyncio.new_event_loop()
+    endpoint_uri = "ws://127.0.0.1:8546"
+    websocket_kwargs = {}
+    match = (
+        "The loop parameter is deprecated and was removed from websocket "
+        "provider as of web3 v5. Consider instantiating this class without passing this argument instead."
+    )
+    with pytest.warns(
+        expected_warning=DeprecationWarning,
+        match=match,
+    ):
+        WebsocketProvider(endpoint_uri, websocket_timeout=0.01, loop=event_loop)
+    with pytest.warns(
+        expected_warning=DeprecationWarning,
+        match=match,
+    ):
+        PersistentWebSocket(endpoint_uri, websocket_kwargs, loop=event_loop)
+    event_loop.close()

tests/integration/conftest.py

@@ -37,7 +37,7 @@ def revert_contract_factory(web3):
     return contract_factory
 
 
-@pytest.yield_fixture(scope="module")
+@pytest.fixture(scope="module")
 def event_loop(request):
     loop = asyncio.get_event_loop_policy().new_event_loop()
     yield loop

tests/integration/go_ethereum/conftest.py

@@ -181,7 +181,7 @@ def unlockable_account_dual_type(unlockable_account, address_conversion_func):
     return address_conversion_func(unlockable_account)
 
 
-@pytest.yield_fixture
+@pytest.fixture
 def unlocked_account_dual_type(web3, unlockable_account_dual_type, unlockable_account_pw):
     web3.geth.personal.unlock_account(unlockable_account_dual_type, unlockable_account_pw)
     yield unlockable_account_dual_type

tests/integration/go_ethereum/test_goethereum_http.py

@@ -1,5 +1,7 @@
 import pytest
 
+import pytest_asyncio
+
 from tests.utils import (
     get_open_port,
 )
@@ -94,7 +96,7 @@ def web3(geth_process, endpoint_uri):
     return _web3
 
 
-@pytest.fixture(scope="module")
+@pytest_asyncio.fixture(scope="module")
 async def async_w3(geth_process, endpoint_uri):
     await wait_for_aiohttp(endpoint_uri)
     _web3 = Web3(

tests/utils.py

@@ -1,21 +1,23 @@
 import asyncio
 import socket
 import time
+import warnings
 
 import websockets
 
 
 def get_open_port():
     sock = socket.socket()
-    sock.bind(('127.0.0.1', 0))
+    sock.bind(("127.0.0.1", 0))
     port = sock.getsockname()[1]
     sock.close()
     return str(port)
 
 
 async def wait_for_ws(endpoint_uri, timeout=10):
     start = time.time()
-    while time.time() < start + timeout:
+    stop = start + timeout
+    while time.time() < stop:
         try:
             async with websockets.connect(uri=endpoint_uri):
                 pass