varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-12 16:10:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enforce pre-summary newline in docstrings

Browse Source
This commit is contained in:
Dominik Muhs
2019-10-24 20:10:45 +02:00
parent 87ed98d7af
commit bafdd8512d
52 changed files with 349 additions and 199 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libp2p/transport/listener_interface.py
View File

@ -7,7 +7,8 @@ from multiaddr import Multiaddr
class IListener(ABC):
@abstractmethod
async def listen(self, maddr: Multiaddr) -> bool:
"""put listener in listening mode and wait for incoming connections.
"""
put listener in listening mode and wait for incoming connections.
:param maddr: multiaddr of peer
:return: return True if successful
@ -15,7 +16,8 @@ class IListener(ABC):
@abstractmethod
def get_addrs(self) -> List[Multiaddr]:
"""retrieve list of addresses the listener is listening on.
"""
retrieve list of addresses the listener is listening on.
:return: return list of addrs
"""

12
libp2p/transport/tcp/tcp.py
View File

@ -22,7 +22,8 @@ class TCPListener(IListener):
self.handler = handler_function
async def listen(self, maddr: Multiaddr) -> bool:
"""put listener in listening mode and wait for incoming connections.
"""
put listener in listening mode and wait for incoming connections.
:param maddr: maddr of peer
:return: return True if successful
@ -38,7 +39,8 @@ class TCPListener(IListener):
return True
def get_addrs(self) -> List[Multiaddr]:
"""retrieve list of addresses the listener is listening on.
"""
retrieve list of addresses the listener is listening on.
:return: return list of addrs
"""
@ -57,7 +59,8 @@ class TCPListener(IListener):
class TCP(ITransport):
async def dial(self, maddr: Multiaddr) -> IRawConnection:
"""dial a transport to peer listening on multiaddr.
"""
dial a transport to peer listening on multiaddr.
:param maddr: multiaddr of peer
:return: `RawConnection` if successful
@ -74,7 +77,8 @@ class TCP(ITransport):
return RawConnection(reader, writer, True)
def create_listener(self, handler_function: THandler) -> TCPListener:
"""create listener on transport.
"""
create listener on transport.
:param handler_function: a function called when a new connection is received
that takes a connection as argument which implements interface-connection

6
libp2p/transport/transport_interface.py
View File

@ -11,7 +11,8 @@ from .typing import THandler
class ITransport(ABC):
@abstractmethod
async def dial(self, maddr: Multiaddr) -> IRawConnection:
"""dial a transport to peer listening on multiaddr.
"""
dial a transport to peer listening on multiaddr.
:param multiaddr: multiaddr of peer
:param self_id: peer_id of the dialer (to send to receiver)
@ -20,7 +21,8 @@ class ITransport(ABC):
@abstractmethod
def create_listener(self, handler_function: THandler) -> IListener:
"""create listener on transport.
"""
create listener on transport.
:param handler_function: a function called when a new conntion is received
that takes a connection as argument which implements interface-connection