web3 7.12.1__py3-none-any.whl → 7.13.0__py3-none-any.whl

web3/eth/async_eth.py

@@ -720,19 +720,6 @@ class AsyncEth(BaseEth):
         mungers=[default_root_munger],
     )
 
-    _subscribe_with_args: Method[
-        Callable[
-            [
-                SubscriptionType,
-                Optional[Union[LogsSubscriptionArg, bool]],
-            ],
-            Awaitable[HexStr],
-        ]
-    ] = Method(
-        RPC.eth_subscribe,
-        mungers=[default_root_munger],
-    )
-
     async def subscribe(
         self,
         subscription_type: SubscriptionType,
@@ -745,6 +732,7 @@ class AsyncEth(BaseEth):
         handler: Optional[EthSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
         label: Optional[str] = None,
+        parallelize: Optional[bool] = None,
     ) -> HexStr:
         if not isinstance(self.w3.provider, PersistentConnectionProvider):
             raise MethodNotSupported(
@@ -757,6 +745,7 @@ class AsyncEth(BaseEth):
             handler=handler,
             handler_context=handler_context or {},
             label=label,
+            parallelize=parallelize,
         )
         return await self.w3.subscription_manager.subscribe(sub)
 

web3/exceptions.py

@@ -353,13 +353,20 @@ class PersistentConnectionClosedOK(PersistentConnectionError):
     """
 
 
-class SubscriptionProcessingFinished(Web3Exception):
+class SubscriptionProcessingFinished(PersistentConnectionError):
     """
     Raised to alert the subscription manager that the processing of subscriptions
     has finished.
     """
 
 
+class SubscriptionHandlerTaskException(TaskNotRunning):
+    """
+    Raised to alert the subscription manager that an exception occurred in the
+    subscription processing task.
+    """
+
+
 class Web3RPCError(Web3Exception):
     """
     Raised when a JSON-RPC response contains an error field.

web3/manager.py

@@ -550,13 +550,10 @@ class RequestManager:
                 else:
                     # if not an active sub, skip processing and continue
                     continue
-            except TaskNotRunning:
+            except TaskNotRunning as e:
                 await asyncio.sleep(0)
                 self._provider._handle_listener_task_exceptions()
-                self.logger.error(
-                    "Message listener background task has stopped unexpectedly. "
-                    "Stopping message stream."
-                )
+                self.logger.error("Stopping message stream: %s", e.message)
                 return
 
     async def _process_response(

web3/middleware/formatting.py

@@ -16,6 +16,7 @@ from eth_utils.toolz import (
 )
 
 from web3.exceptions import (
+    BadResponseFormat,
     Web3ValueError,
 )
 from web3.middleware.base import (
@@ -77,7 +78,12 @@ def _apply_response_formatters(
                 response, response_type, method_response_formatter(appropriate_response)
             )
 
-    if response.get("result") is not None and method in result_formatters:
+    if not isinstance(response, dict):
+        raise BadResponseFormat(
+            "Malformed response: expected a valid JSON-RPC response object, got: "
+            "`{}`".format(response)
+        )
+    elif response.get("result") is not None and method in result_formatters:
         return _format_response("result", result_formatters[method])
     elif (
         # eth_subscription responses

web3/providers/persistent/persistent.py

@@ -164,7 +164,7 @@ class PersistentConnectionProvider(AsyncJSONBaseProvider, ABC):
         if cache_key != self._send_batch_func_cache[0]:
 
             async def send_func(
-                requests: List[Tuple[RPCEndpoint, Any]]
+                requests: List[Tuple[RPCEndpoint, Any]],
             ) -> List[RPCRequest]:
                 for mw in middleware:
                     initialized = mw(async_w3)
@@ -376,11 +376,12 @@ class PersistentConnectionProvider(AsyncJSONBaseProvider, ABC):
     ) -> None:
         # Puts a `TaskNotRunning` in appropriate queues to signal the end of the
         # listener task to any listeners relying on the queues.
+        message = "Message listener task has ended."
         self._request_processor._subscription_response_queue.put_nowait(
-            TaskNotRunning(message_listener_task)
+            TaskNotRunning(message_listener_task, message=message)
         )
         self._request_processor._handler_subscription_queue.put_nowait(
-            TaskNotRunning(message_listener_task)
+            TaskNotRunning(message_listener_task, message=message)
         )
 
     def _raise_stray_errors_from_cache(self) -> None:

web3/providers/persistent/subscription_manager.py

@@ -5,6 +5,7 @@ from typing import (
     Any,
     List,
     Sequence,
+    Set,
     Union,
     cast,
     overload,
@@ -15,6 +16,7 @@ from eth_typing import (
 )
 
 from web3.exceptions import (
+    SubscriptionHandlerTaskException,
     SubscriptionProcessingFinished,
     TaskNotRunning,
     Web3TypeError,
@@ -50,19 +52,26 @@ class SubscriptionManager:
     logger: logging.Logger = logging.getLogger(
         "web3.providers.persistent.subscription_manager"
     )
-    total_handler_calls: int = 0
 
     def __init__(self, w3: "AsyncWeb3") -> None:
         self._w3 = w3
         self._provider = cast("PersistentConnectionProvider", w3.provider)
         self._subscription_container = SubscriptionContainer()
 
+        # parallelize all subscription handler calls
+        self.parallelize = False
+        self.task_timeout = 1
+        # TODO: can remove quotes from type hints once Python 3.8 support is dropped
+        self._tasks: Set["asyncio.Task[None]"] = set()
+
         # share the subscription container with the request processor so it can separate
         # subscriptions into different queues based on ``sub._handler`` presence
         self._provider._request_processor._subscription_container = (
             self._subscription_container
         )
 
+        self.total_handler_calls: int = 0
+
     def _add_subscription(self, subscription: EthSubscription[Any]) -> None:
         self._subscription_container.add_subscription(subscription)
 
@@ -86,6 +95,35 @@ class SubscriptionManager:
                     f"labels.\n    label: {subscription._label}"
                 )
 
+    # TODO: can remove quotes from type hints once Python 3.8 support is dropped
+    def _handler_task_callback(self, task: "asyncio.Task[None]") -> None:
+        """
+        Callback when a handler task completes. Similar to _message_listener_callback.
+        Puts handler exceptions into the queue to be raised in the main loop, else
+        removes the task from the set of active tasks.
+        """
+        if task.done() and not task.cancelled():
+            try:
+                task.result()
+                self._tasks.discard(task)
+            except Exception as e:
+                self.logger.exception("Subscription handler task raised an exception.")
+                self._provider._request_processor._handler_subscription_queue.put_nowait(  # noqa: E501
+                    SubscriptionHandlerTaskException(task, message=str(e))
+                )
+
+    async def _cleanup_remaining_tasks(self) -> None:
+        """Cancel and clean up all remaining tasks."""
+        if not self._tasks:
+            return
+
+        self.logger.debug("Cleaning up %d remaining tasks...", len(self._tasks))
+        for task in self._tasks:
+            if not task.done():
+                task.cancel()
+
+        self._tasks.clear()
+
     @property
     def subscriptions(self) -> List[EthSubscription[Any]]:
         return self._subscription_container.subscriptions
@@ -281,14 +319,23 @@ class SubscriptionManager:
                     sub_id
                 )
                 if sub:
-                    await sub._handler(
-                        EthSubscriptionContext(
-                            self._w3,
-                            sub,
-                            formatted_sub_response["result"],
-                            **sub._handler_context,
-                        )
+                    sub_context = EthSubscriptionContext(
+                        self._w3,
+                        sub,
+                        formatted_sub_response["result"],
+                        **sub._handler_context,
                     )
+                    if sub.parallelize is True or (
+                        sub.parallelize is None and self.parallelize
+                    ):
+                        # run the handler in a task to allow parallel processing
+                        task = asyncio.create_task(sub._handler(sub_context))
+                        self._tasks.add(task)
+                        task.add_done_callback(self._handler_task_callback)
+                    else:
+                        # await the handler in the main loop to ensure order
+                        await sub._handler(sub_context)
+
             except SubscriptionProcessingFinished:
                 if not run_forever:
                     self.logger.info(
@@ -296,14 +343,20 @@ class SubscriptionManager:
                         "Stopping subscription handling."
                     )
                     break
-            except TaskNotRunning:
-                await asyncio.sleep(0)
-                self._provider._handle_listener_task_exceptions()
+            except SubscriptionHandlerTaskException:
                 self.logger.error(
-                    "Message listener background task for the provider has stopped "
-                    "unexpectedly. Stopping subscription handling."
+                    "An exception occurred in a subscription handler task. "
+                    "Stopping subscription handling."
                 )
+                await self._cleanup_remaining_tasks()
+                raise
+            except TaskNotRunning as e:
+                self.logger.error("Stopping subscription handling: %s", e.message)
+                self._provider._handle_listener_task_exceptions()
                 break
 
         # no active handler subscriptions, clear the handler subscription queue
         self._provider._request_processor._reset_handler_subscription_queue()
+
+        if self._tasks:
+            await self._cleanup_remaining_tasks()

web3/utils/subscriptions.py

@@ -110,11 +110,14 @@ class EthSubscription(Generic[TSubscriptionResult]):
         handler: Optional[EthSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
         label: Optional[str] = None,
+        parallelize: Optional[bool] = None,
     ) -> None:
         self._subscription_params = subscription_params
         self._handler = handler_wrapper(handler)
         self._handler_context = handler_context or {}
         self._label = label
+
+        self.parallelize = parallelize
         self.handler_call_count = 0
 
     @property
@@ -128,6 +131,7 @@ class EthSubscription(Generic[TSubscriptionResult]):
         handler: Optional[EthSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
         label: Optional[str] = None,
+        parallelize: Optional[bool] = None,
     ) -> "EthSubscription[Any]":
         subscription_type = subscription_params[0]
         subscription_arg = (
@@ -135,7 +139,10 @@ class EthSubscription(Generic[TSubscriptionResult]):
         )
         if subscription_type == "newHeads":
             return NewHeadsSubscription(
-                handler=handler, handler_context=handler_context, label=label
+                handler=handler,
+                handler_context=handler_context,
+                label=label,
+                parallelize=parallelize,
             )
         elif subscription_type == "logs":
             subscription_arg = subscription_arg or {}
@@ -144,6 +151,7 @@ class EthSubscription(Generic[TSubscriptionResult]):
                 handler=handler,
                 handler_context=handler_context,
                 label=label,
+                parallelize=parallelize,
             )
         elif subscription_type == "newPendingTransactions":
             subscription_arg = subscription_arg or False
@@ -152,10 +160,14 @@ class EthSubscription(Generic[TSubscriptionResult]):
                 handler=handler,
                 handler_context=handler_context,
                 label=label,
+                parallelize=parallelize,
             )
         elif subscription_type == "syncing":
             return SyncingSubscription(
-                handler=handler, handler_context=handler_context, label=label
+                handler=handler,
+                handler_context=handler_context,
+                label=label,
+                parallelize=parallelize,
             )
         else:
             params = (
@@ -168,6 +180,7 @@ class EthSubscription(Generic[TSubscriptionResult]):
                 handler=handler,
                 handler_context=handler_context,
                 label=label,
+                parallelize=parallelize,
             )
 
     @property
@@ -206,6 +219,7 @@ class LogsSubscription(EthSubscription[LogReceipt]):
         handler: LogsSubscriptionHandler = None,
         handler_context: Optional[Dict[str, Any]] = None,
         label: Optional[str] = None,
+        parallelize: Optional[bool] = None,
     ) -> None:
         self.address = address
         self.topics = topics
@@ -222,6 +236,7 @@ class LogsSubscription(EthSubscription[LogReceipt]):
             handler=handler,
             handler_context=handler_context,
             label=label,
+            parallelize=parallelize,
         )
 
 
@@ -237,12 +252,14 @@ class NewHeadsSubscription(EthSubscription[BlockData]):
         label: Optional[str] = None,
         handler: Optional[NewHeadsSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
+        parallelize: Optional[bool] = None,
     ) -> None:
         super().__init__(
             subscription_params=("newHeads",),
             handler=handler,
             handler_context=handler_context,
             label=label,
+            parallelize=parallelize,
         )
 
 
@@ -261,6 +278,7 @@ class PendingTxSubscription(EthSubscription[Union[HexBytes, TxData]]):
         label: Optional[str] = None,
         handler: Optional[PendingTxSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
+        parallelize: Optional[bool] = None,
     ) -> None:
         self.full_transactions = full_transactions
         super().__init__(
@@ -268,6 +286,7 @@ class PendingTxSubscription(EthSubscription[Union[HexBytes, TxData]]):
             handler=handler,
             handler_context=handler_context,
             label=label,
+            parallelize=parallelize,
         )
 
 
@@ -283,10 +302,12 @@ class SyncingSubscription(EthSubscription[SyncProgress]):
         label: Optional[str] = None,
         handler: Optional[SyncingSubscriptionHandler] = None,
         handler_context: Optional[Dict[str, Any]] = None,
+        parallelize: Optional[bool] = None,
     ) -> None:
         super().__init__(
             subscription_params=("syncing",),
             handler=handler,
             handler_context=handler_context,
             label=label,
+            parallelize=parallelize,
         )

{web3-7.12.1.dist-info → web3-7.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: web3
-Version: 7.12.1
+Version: 7.13.0
 Summary: web3: A Python library for interacting with Ethereum
 Home-page: https://github.com/ethereum/web3.py
 Author: The Ethereum Foundation

{web3-7.12.1.dist-info → web3-7.13.0.dist-info}/RECORD

@@ -9,17 +9,16 @@ ens/contract_data.py,sha256=CZa7Uxzq6rT-KonwHHM_wo-5ry0j1DMbikgEaP27Uy8,148602
 ens/ens.py,sha256=-avaYLLwUAPj8cYxP5fcH5h9aVabG5xuvBkwh5yTbMQ,21722
 ens/exceptions.py,sha256=5h-t3G-lwYchYe4JgHaxD_a_llh56sS6qzo9Rpa0S0o,2442
 ens/utils.py,sha256=ql6Kqe_dmbr4K6p0YO5Gr8b9XdfMRLe9dnjNv1mrWYI,9318
-ens/specs/.DS_Store,sha256=1lFlJ5EFymdzGAUAaI30vcaaLHt3F1LwpG7xILf9jsM,6148
 ens/specs/nf.json,sha256=tPXKzdhgu9gqNi0UhKC1kzPqSBgy4yHm5TL19RQHBqU,49038
 ens/specs/normalization_spec.json,sha256=8mmjBj4OoYCn7pD4P7hqKP_qy6rpYzpyRinSH3CCP9M,3171499
 web3/__init__.py,sha256=P11QAEV_GYoZq9ij8gDzFx5tKzJY2aMXG-keg2Lg1xs,1277
 web3/constants.py,sha256=eQLRQVMFPbgpOjjkPTMHkY-syncJuO-sPX5UrCSRjzQ,564
 web3/datastructures.py,sha256=J5rdpnuS10pKUfPYqcoorkDw-aHHZNrdiW-Bh7dVDwI,11514
-web3/exceptions.py,sha256=GMIrWTkYDR0jtvtdOlgl_s6fctTibW4Ytw4So5BY4uE,9584
+web3/exceptions.py,sha256=9qWjvZM-snQTITs8FJbTMnVQygM80ciddwOkSgiioY8,9783
 web3/geth.py,sha256=xVBZWSksBo2ipesAN9V5hzDc_te7kU8ueicFdvpkSO4,7370
 web3/logs.py,sha256=ROs-mDMH_ZOecE7hfbWA5yp27G38FbLjX4lO_WtlZxQ,198
 web3/main.py,sha256=eVdSh7m_iBMf3au0Aj49TZ7NSaRbN1Ccsng9Fuu8dME,16162
-web3/manager.py,sha256=hzIrl70WWIupgEbBBQlB11l89uHHU1xCKowKgBngkqU,22689
+web3/manager.py,sha256=jlHJoGdhFFSsZNTbdUXVakchJozxqrN_NPWp1gUSMgs,22588
 web3/method.py,sha256=BCYend146F5Q149VB2VN11_Z3x8y0lJZH8ShF_VxwV4,8682
 web3/module.py,sha256=CDlnDrrWzkCJtd3gzHZ972l-6En6IyFEWwB7TXkHHLM,5617
 web3/net.py,sha256=Y3vPzHWVFkfHEZoJxjDOt4tp5ERmZrMuyi4ZFOLmIeA,1562
@@ -111,7 +110,7 @@ web3/contract/base_contract.py,sha256=vQVcne9luQ35eBheRh1Jc_jXOp2uDxIotKK9O1EQjQ
 web3/contract/contract.py,sha256=-TJJMjwybZmQo8-DtGhrjIr7TwVXFoiIsdMan1NFgQY,20562
 web3/contract/utils.py,sha256=QwJFbgojLKRb_7DrwDmXI2acwRk7zMNXHGvH5JaR1NI,18591
 web3/eth/__init__.py,sha256=qDLxOcHHIzzPD7xzwy6Wcs0lLPQieB7WN0Ax25ctit8,197
-web3/eth/async_eth.py,sha256=uuKOTRvI60r5zOj131Mbr28J6N7Tj2Hx4GJESMIoFu8,24759
+web3/eth/async_eth.py,sha256=Uz-0W2rAk8tygbk5xJkffnAA8v-mneYrYsFePViGcTI,24535
 web3/eth/base_eth.py,sha256=UUH0Fw0HVa_mBEQ_CbCDO01yCVDsj33d8yOv7Oe-QD0,6905
 web3/eth/eth.py,sha256=zYhotz6GFRVl951oljXHnnlF1GJTgFlgJlA09Soji5k,20806
 web3/gas_strategies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -122,7 +121,7 @@ web3/middleware/attrdict.py,sha256=tIoMEZ3BkmEafnwitGY70o0GS9ShfwReDMxkHuvcOwI,2
 web3/middleware/base.py,sha256=jUY19tw6iiJenDprYqkTeIESd8qPcTvNALP3Vhp86qk,5728
 web3/middleware/buffered_gas_estimate.py,sha256=EmxUd-uO959UVroPsPKkl7oDa8Tw6N8BQLB6Urng5Eo,1647
 web3/middleware/filter.py,sha256=I09sSE_q_dhWX5_24KVWhVXZNevwViI7wucJBP4TZl4,22221
-web3/middleware/formatting.py,sha256=hqe5XQE1n5Fmj6riJp7i3oIoZkd-4ChQc7UK8f3HB6I,7567
+web3/middleware/formatting.py,sha256=GPbJes2-ECQW5fbHllajGFDd4b58X-sKLef_DSnYA40,7793
 web3/middleware/gas_price_strategy.py,sha256=ZjZ6pe3z0mDGLZHYoFXp4_fZIePqukljEh9f4mZUyIA,3779
 web3/middleware/names.py,sha256=OBpsvCmcTItth4TcvUNUvcYmINnudtCHq3n6YO_BkNs,4309
 web3/middleware/proof_of_authority.py,sha256=0AT4jr5CmTdrvl8Jiy-WYy8IFDYBOEaesgHDwpn0c7M,1429
@@ -142,11 +141,11 @@ web3/providers/eth_tester/main.py,sha256=U19sNDeHs36A4IYQ0HFGyXdZvuXiYvoSMNWVuki
 web3/providers/eth_tester/middleware.py,sha256=JS-cjGF5BtF43dp-bP7QDv0RWyq1iqwiq81RhTAswjI,13730
 web3/providers/persistent/__init__.py,sha256=X7tFKJL5BXSwciq5_bRwGRB6bfdWBkIPPWMqCjXIKrA,411
 web3/providers/persistent/async_ipc.py,sha256=6HDKo9hIXhag3nyTbp6J-ZktPLnG-9iHCduQUGD7raM,5049
-web3/providers/persistent/persistent.py,sha256=79TP6mKOhUyxD3KBOEE2OeWido8qumuIl2pIiiPE-0k,19356
+web3/providers/persistent/persistent.py,sha256=tM0Opg5i_oNlW_vmkqnzkAAPww36E5_jhonXDWfhc4Y,19444
 web3/providers/persistent/persistent_connection.py,sha256=NxxS-KeJhV07agg8CtJvmE-Ff-wLggQYpz4gdgVRDNU,3011
 web3/providers/persistent/request_processor.py,sha256=QLVn5MiNwDVsO9hsHPlkUH4zW4H74HRK-duPot4H4Yk,14141
 web3/providers/persistent/subscription_container.py,sha256=yd5pjjz_YnRLuUoxZUxt29Md1VUTemdUIBq8PCJre6Y,1734
-web3/providers/persistent/subscription_manager.py,sha256=T42LQzGs4iYvsKqvIqKSMo5OLz5Qpp4YG8sEBOcqV3s,11672
+web3/providers/persistent/subscription_manager.py,sha256=QByJn3qfOT1Lt7L6BMUqNSeu_FajAGZRwLvawSajsic,13956
 web3/providers/persistent/utils.py,sha256=gfY7w1HB8xuE7OujSrbwWYjQuQ8nzRBoxoL8ESinqWM,1140
 web3/providers/persistent/websocket.py,sha256=STf31VNdwidMeAeeL1r5f8v3l66xChKkxZpnZzUiYO8,4577
 web3/providers/rpc/__init__.py,sha256=mObsuwjr7xyHnnRlwzsmbp2JgZdn2NXSSctvpye4AuQ,149
@@ -164,9 +163,9 @@ web3/utils/address.py,sha256=nzPLiWWCG9BqstDeDOcDwEpteJ8im6ywjLHKpd5akhw,1186
 web3/utils/async_exception_handling.py,sha256=OoKbLNwWcY9dxLCbOfxcQPSB1OxWraNqcw8V0ZX-JaQ,3173
 web3/utils/caching.py,sha256=miulUjLOjlOfTux8HWBklpRIa6_fVNTVFHIWcbZt27o,2591
 web3/utils/exception_handling.py,sha256=n-MtO5LNzJDVzHTzO6olzfb2_qEVtVRvink0ixswg-Y,2917
-web3/utils/subscriptions.py,sha256=RnqwQL3ekkMyCrbx-jVf6EaEkihyXTbb1LBonBHAJ_g,8617
-web3-7.12.1.dist-info/licenses/LICENSE,sha256=ENGC4gSn0kYaC_mlaXOEwCKmA6W7Z9MeSemc5O2k-h0,1095
-web3-7.12.1.dist-info/METADATA,sha256=00yj0K9jQg20LN-vIHDfMORXEzT8hQJOrl8VCIGjLq8,5621
-web3-7.12.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-web3-7.12.1.dist-info/top_level.txt,sha256=iwupuJh7wgypXrpk_awszyri3TahRr5vxSphNyvt1bU,9
-web3-7.12.1.dist-info/RECORD,,
+web3/utils/subscriptions.py,sha256=XF0bN_OjIkweSTQmB0U0nMJrLCeNYYuukoUFiV5skV0,9340
+web3-7.13.0.dist-info/licenses/LICENSE,sha256=ENGC4gSn0kYaC_mlaXOEwCKmA6W7Z9MeSemc5O2k-h0,1095
+web3-7.13.0.dist-info/METADATA,sha256=8-k-l2hjPirh12SotNzYaXchRfwcPo2GJCSLB5gVs3s,5621
+web3-7.13.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+web3-7.13.0.dist-info/top_level.txt,sha256=iwupuJh7wgypXrpk_awszyri3TahRr5vxSphNyvt1bU,9
+web3-7.13.0.dist-info/RECORD,,