Make register_peer of PeerPoolSubscriber non-abstract

Author: cburgdorf

p2p/peer.py

@@ -538,9 +538,16 @@ async def process_sub_proto_handshake(
 class PeerPoolSubscriber(ABC):
     _msg_queue: 'asyncio.Queue[PEER_MSG_TYPE]' = None
 
-    @abstractmethod
     def register_peer(self, peer: BasePeer) -> None:
-        raise NotImplementedError("Must be implemented by subclasses")
+        """
+        Notify about each registered peer in the :class:`~p2p.peer.PeerPool`. Is called upon
+        subscription for each :class:`~p2p.peer.BasePeer` that exists in the pool at that time and
+        then for each :class:`~p2p.peer.BasePeer` that joins the pool later on.
+
+        A :class:`~p2p.peer.PeerPoolSubscriber` that wants to act upon peer registration needs to
+        overwrite this method to provide an implementation.
+        """
+        pass
 
     @property
     def msg_queue(self) -> 'asyncio.Queue[PEER_MSG_TYPE]':

p2p/shard_syncer.py

@@ -42,7 +42,6 @@
 )
 from p2p.service import BaseService
 from p2p.peer import (
-    BasePeer,
     PeerPool,
     PeerPoolSubscriber,
 )
@@ -109,9 +108,6 @@ def propose(self) -> Collation:
     #
     # Peer handling
     #
-    def register_peer(self, peer: BasePeer) -> None:
-        pass
-
     async def _run(self) -> None:
         with self.subscribe(self.peer_pool):
             while True:

p2p/state.py

@@ -33,7 +33,7 @@
 from p2p import protocol
 from p2p.cancel_token import CancelToken
 from p2p.exceptions import OperationCancelled
-from p2p.peer import BasePeer, ETHPeer, PeerPool, PeerPoolSubscriber
+from p2p.peer import ETHPeer, PeerPool, PeerPoolSubscriber
 from p2p.service import BaseService
 from p2p.utils import get_process_pool_executor
 
@@ -59,9 +59,6 @@ def __init__(self,
         self._peers_with_pending_requests: Dict[ETHPeer, float] = {}
         self._executor = get_process_pool_executor()
 
-    def register_peer(self, peer: BasePeer) -> None:
-        pass
-
     @property
     def idle_peers(self) -> List[ETHPeer]:
         # FIXME: Should probably use get_peers() and pass the TD of our head? It's not really