Use as_tuple_of_middlewares() to get around typing issues

- Use an internal method for the ``NamedMiddlewareOnion`` to generate
  the tuple of middlewares, instead of relying on ``tuple()``.

Author: fselmo

web3/datastructures.py

@@ -268,6 +268,14 @@ def _replace_with_new_name(self, old: TKey, new: TKey) -> None:
                 self._queue.move_to_end(key)
         del self._queue[old]
 
+    def as_tuple_of_middlewares(self) -> Tuple[TValue, ...]:
+        """
+        This helps with type hinting since we return `Iterator[TKey]` type, though it's
+        actually a `Iterator[TValue]` type, for the `__iter__()` method. This is in
+        order to satisfy the `Mapping` interface.
+        """
+        return tuple(self._queue.values())
+
     def __iter__(self) -> Iterator[TKey]:
         elements = self._queue.values()
         if not isinstance(elements, Sequence):

web3/providers/async_base.py

@@ -85,17 +85,16 @@ def __init__(self) -> None:
         self._request_cache = SimpleCache(1000)
 
     async def request_func(
-        self, async_w3: "AsyncWeb3", middlewares: MiddlewareOnion
+        self, async_w3: "AsyncWeb3", middleware_onion: MiddlewareOnion
     ) -> Callable[..., Coroutine[Any, Any, RPCResponse]]:
-        # type ignored b/c tuple(MiddlewareOnion) converts to tuple of middlewares
-        middlewares: Tuple[Middleware, ...] = tuple(middlewares)  # type: ignore
+        middlewares: Tuple[Middleware, ...] = middleware_onion.as_tuple_of_middlewares()
 
         cache_key = self._request_func_cache[0]
-        if cache_key != middlewares:  # type: ignore
+        if cache_key != middlewares:
             self._request_func_cache = (
                 middlewares,
                 await async_combine_middlewares(
-                    middlewares=middlewares,  # type: ignore
+                    middlewares=middlewares,
                     async_w3=async_w3,
                     provider_request_fn=self.make_request,
                 ),

web3/providers/base.py

@@ -82,24 +82,23 @@ def __init__(self) -> None:
         self._request_cache = SimpleCache(1000)
 
     def request_func(
-        self, w3: "Web3", middlewares: MiddlewareOnion
+        self, w3: "Web3", middleware_onion: MiddlewareOnion
     ) -> Callable[..., RPCResponse]:
         """
         @param w3 is the web3 instance
-        @param middlewares is an iterable of middlewares,
+        @param middleware_onion is an iterable of middlewares,
             ordered by first to execute
         @returns a function that calls all the middleware and
             eventually self.make_request()
         """
-        # type ignored b/c tuple(MiddlewareOnion) converts to tuple of middlewares
-        middlewares: Tuple[Middleware] = tuple(middlewares)  # type: ignore
+        middlewares: Tuple[Middleware, ...] = middleware_onion.as_tuple_of_middlewares()
 
         cache_key = self._request_func_cache[0]
-        if cache_key != middlewares:  # type: ignore
+        if cache_key != middlewares:
             self._request_func_cache = (
                 middlewares,
                 combine_middlewares(
-                    middlewares=middlewares,  # type: ignore
+                    middlewares=middlewares,
                     w3=w3,
                     provider_request_fn=self.make_request,
                 ),

web3/providers/eth_tester/main.py

@@ -79,19 +79,20 @@ def __init__(self) -> None:
         self.api_endpoints = API_ENDPOINTS
 
     async def request_func(
-        self, async_w3: "AsyncWeb3", middlewares: "MiddlewareOnion"
+        self, async_w3: "AsyncWeb3", middleware_onion: "MiddlewareOnion"
     ) -> Callable[..., Coroutine[Any, Any, RPCResponse]]:
         # override the request_func to add the ethereum_tester_middleware
 
-        # type ignored bc tuple(MiddlewareOnion) converts to tuple of middlewares
-        middlewares = tuple(middlewares) + tuple(self._middlewares)  # type: ignore
+        middlewares = middleware_onion.as_tuple_of_middlewares() + tuple(
+            self._middlewares
+        )
 
         cache_key = self._request_func_cache[0]
-        if cache_key != middlewares:  # type: ignore
+        if cache_key != middlewares:
             self._request_func_cache = (
                 middlewares,
                 await async_combine_middlewares(
-                    middlewares=middlewares,  # type: ignore
+                    middlewares=middlewares,
                     async_w3=async_w3,
                     provider_request_fn=self.make_request,
                 ),
@@ -154,19 +155,20 @@ def __init__(
             self.api_endpoints = api_endpoints
 
     def request_func(
-        self, w3: "Web3", middlewares: "MiddlewareOnion"
+        self, w3: "Web3", middleware_onion: "MiddlewareOnion"
     ) -> Callable[..., RPCResponse]:
         # override the request_func to add the ethereum_tester_middleware
 
-        # type ignored bc tuple(MiddlewareOnion) converts to tuple of middlewares
-        middlewares = tuple(middlewares) + tuple(self._middlewares)  # type: ignore
+        middlewares = middleware_onion.as_tuple_of_middlewares() + tuple(
+            self._middlewares
+        )
 
         cache_key = self._request_func_cache[0]
-        if cache_key != middlewares:  # type: ignore
+        if cache_key != middlewares:
             self._request_func_cache = (
                 middlewares,
                 combine_middlewares(
-                    middlewares=middlewares,  # type: ignore
+                    middlewares=middlewares,
                     w3=w3,
                     provider_request_fn=self.make_request,
                 ),