Add type hint to pubsub notifee/interface

This commit is contained in:
NIC619
2019-07-26 17:30:51 +08:00
parent 3549f2ff8b
commit a0aa105867
2 changed files with 48 additions and 17 deletions

View File

@ -1,23 +1,45 @@
from libp2p.network.notifee_interface import INotifee
from typing import (
List,
Sequence,
)
from multiaddr import Multiaddr
from libp2p.network.connection.raw_connection import (
RawConnection,
)
from libp2p.network.notifee_interface import (
INotifee,
)
from libp2p.network.network_interface import (
INetwork,
)
from libp2p.network.stream.net_stream_interface import (
INetStream,
)
from libp2p.peer.id import (
ID,
)
class PubsubNotifee(INotifee):
# pylint: disable=too-many-instance-attributes, cell-var-from-loop
def __init__(self, initiator_peers_queue):
initiator_peers_queue: List[ID]
def __init__(self, initiator_peers_queue: Sequence[ID]) -> None:
"""
:param initiator_peers_queue: queue to add new peers to so that pubsub
can process new peers after we connect to them
"""
self.initiator_peers_queue = initiator_peers_queue
self.initiator_peers_queue = List(initiator_peers_queue)
async def opened_stream(self, network, stream):
async def opened_stream(self, network: INetwork, stream: INetStream) -> None:
pass
async def closed_stream(self, network, stream):
async def closed_stream(self, network: INetwork, stream: INetStream) -> None:
pass
async def connected(self, network, conn):
async def connected(self, network: INetwork, conn: RawConnection) -> None:
"""
Add peer_id to initiator_peers_queue, so that this peer_id can be used to
create a stream and we only want to have one pubsub stream with each peer.
@ -30,11 +52,11 @@ class PubsubNotifee(INotifee):
if conn.initiator:
await self.initiator_peers_queue.put(conn.peer_id)
async def disconnected(self, network, conn):
async def disconnected(self, network: INetwork, conn: RawConnection) -> None:
pass
async def listen(self, network, multiaddr):
async def listen(self, network: INetwork, multiaddr: Multiaddr) -> None:
pass
async def listen_close(self, network, multiaddr):
async def listen_close(self, network: INetwork, multiaddr: Multiaddr) -> None:
pass