varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-09 14:40:53 +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

13
libp2p/peer/addrbook_interface.py
View File

@ -12,7 +12,8 @@ class IAddrBook(ABC):
@abstractmethod
def add_addr(self, peer_id: ID, addr: Multiaddr, ttl: int) -> None:
"""Calls add_addrs(peer_id, [addr], ttl)
"""
Calls add_addrs(peer_id, [addr], ttl)
:param peer_id: the peer to add address for
:param addr: multiaddress of the peer
@ -21,9 +22,10 @@ class IAddrBook(ABC):
@abstractmethod
def add_addrs(self, peer_id: ID, addrs: Sequence[Multiaddr], ttl: int) -> None:
"""Adds addresses for a given peer all with the same time-to-live. If
one of the addresses already exists for the peer and has a longer TTL,
no operation should take place. If one of the addresses exists with a
"""
Adds addresses for a given peer all with the same time-to-live. If one
of the addresses already exists for the peer and has a longer TTL, no
operation should take place. If one of the addresses exists with a
shorter TTL, extend the TTL to equal param ttl.
:param peer_id: the peer to add address for
@ -40,7 +42,8 @@ class IAddrBook(ABC):
@abstractmethod
def clear_addrs(self, peer_id: ID) -> None:
"""Removes all previously stored addresses.
"""
Removes all previously stored addresses.
:param peer_id: peer to remove addresses of
"""

3
libp2p/peer/peerstore.py
View File

@ -17,7 +17,8 @@ class PeerStore(IPeerStore):
self.peer_map = {}
def __create_or_get_peer(self, peer_id: ID) -> PeerData:
"""Returns the peer data for peer_id or creates a new peer data (and
"""
Returns the peer data for peer_id or creates a new peer data (and
stores it in peer_map) if peer data for peer_id does not yet exist.
:param peer_id: peer ID