PR feedback

Author: pipermerriam

tests/p2p/test_peer_collect_sub_proto_msgs.py

@@ -36,7 +36,7 @@ async def test_peer_subscriber_filters_messages(request, event_loop):
 
     assert collector not in peer._subscribers
 
-    # yeild to let remote and peer transmit.
+    # yield to let remote and peer transmit.
 
     all_messages = collector.get_messages()
     assert len(all_messages) == 5

trinity/protocol/common/managers.py

@@ -99,11 +99,16 @@ def _normalize_response(self, msg: ResponseType) -> ReturnType:
         pass
 
     @abstractmethod
-    def __call__(self) -> ReturnType:  # type: ignore
+    def __call__(self) -> ReturnType:
         """
         Subclasses must both implement this method and override the call
         signature to properly construct the `Request` object and pass it into
         `get_from_peer`
+
+        NOTE: It is expected that subclasses will override this method and
+        change the signature.  The change in signature is expected to result in
+        a type checking failure, and thus all subclasses will also be required
+        to add an `# type: ignore` comment to make the type checker happy.
         """
         pass
 

trinity/protocol/eth/managers.py

@@ -36,6 +36,9 @@ class GetBlockHeadersRequestManager(BaseRequestManager):
 
     _response_msg_type: Type[Command] = BlockHeaders
 
+    # All `RequestManager` classes are expected to implement the `__call__`
+    # method, including changing the function signature, thus the
+    # `# type: ignore` here is both expected and required.
     async def __call__(self,  # type: ignore
                        block_number_or_hash: BlockIdentifier,
                        max_headers: int = None,

trinity/protocol/les/managers.py

@@ -43,6 +43,9 @@ class GetBlockHeadersRequestManager(BaseRequestManager):
 
     _response_msg_type: Type[Command] = BlockHeaders
 
+    # All `RequestManager` classes are expected to implement the `__call__`
+    # method, including changing the function signature, thus the
+    # `# type: ignore` here is both expected and required.
     async def __call__(self,  # type: ignore
                        block_number_or_hash: BlockIdentifier,
                        max_headers: int = None,