varun-r-mallya/py-libp2p
1
0
Fork 0
mirror of https://github.com/varun-r-mallya/py-libp2p.git synced 2026-02-11 07:30:55 +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

12
libp2p/protocol_muxer/multiselect.py
View File

@ -21,7 +21,8 @@ class Multiselect(IMultiselectMuxer):
self.handlers = {}
def add_handler(self, protocol: TProtocol, handler: StreamHandlerFn) -> None:
"""Store the handler with the given protocol.
"""
Store the handler with the given protocol.
:param protocol: protocol name
:param handler: handler function
@ -31,7 +32,8 @@ class Multiselect(IMultiselectMuxer):
async def negotiate(
self, communicator: IMultiselectCommunicator
) -> Tuple[TProtocol, StreamHandlerFn]:
"""Negotiate performs protocol selection.
"""
Negotiate performs protocol selection.
:param stream: stream to negotiate on
:return: selected protocol name, handler function
@ -63,7 +65,8 @@ class Multiselect(IMultiselectMuxer):
raise MultiselectError(error)
async def handshake(self, communicator: IMultiselectCommunicator) -> None:
"""Perform handshake to agree on multiselect protocol.
"""
Perform handshake to agree on multiselect protocol.
:param communicator: communicator to use
:raise MultiselectError: raised when handshake failed
@ -86,7 +89,8 @@ class Multiselect(IMultiselectMuxer):
def validate_handshake(handshake_contents: str) -> bool:
"""Determine if handshake is valid and should be confirmed.
"""
Determine if handshake is valid and should be confirmed.
:param handshake_contents: contents of handshake message
:return: true if handshake is complete, false otherwise

14
libp2p/protocol_muxer/multiselect_client.py
View File

@ -15,7 +15,8 @@ class MultiselectClient(IMultiselectClient):
select a protocol id to communicate over."""
async def handshake(self, communicator: IMultiselectCommunicator) -> None:
"""Ensure that the client and multiselect are both using the same
"""
Ensure that the client and multiselect are both using the same
multiselect protocol.
:param stream: stream to communicate with multiselect over
@ -37,8 +38,9 @@ class MultiselectClient(IMultiselectClient):
async def select_one_of(
self, protocols: Sequence[TProtocol], communicator: IMultiselectCommunicator
) -> TProtocol:
"""For each protocol, send message to multiselect selecting protocol
and fail if multiselect does not return same protocol. Returns first
"""
For each protocol, send message to multiselect selecting protocol and
fail if multiselect does not return same protocol. Returns first
protocol that multiselect agrees on (i.e. that multiselect selects)
:param protocol: protocol to select
@ -60,7 +62,8 @@ class MultiselectClient(IMultiselectClient):
async def try_select(
self, communicator: IMultiselectCommunicator, protocol: TProtocol
) -> TProtocol:
"""Try to select the given protocol or raise exception if fails.
"""
Try to select the given protocol or raise exception if fails.
:param communicator: communicator to use to communicate with counterparty
:param protocol: protocol to select
@ -85,7 +88,8 @@ class MultiselectClient(IMultiselectClient):
def validate_handshake(handshake_contents: str) -> bool:
"""Determine if handshake is valid and should be confirmed.
"""
Determine if handshake is valid and should be confirmed.
:param handshake_contents: contents of handshake message
:return: true if handshake is complete, false otherwise

11
libp2p/protocol_muxer/multiselect_client_interface.py
View File

@ -12,7 +12,8 @@ class IMultiselectClient(ABC):
select a protocol id to communicate over."""
async def handshake(self, communicator: IMultiselectCommunicator) -> None:
"""Ensure that the client and multiselect are both using the same
"""
Ensure that the client and multiselect are both using the same
multiselect protocol.
:param stream: stream to communicate with multiselect over
@ -23,8 +24,9 @@ class IMultiselectClient(ABC):
async def select_one_of(
self, protocols: Sequence[TProtocol], communicator: IMultiselectCommunicator
) -> TProtocol:
"""For each protocol, send message to multiselect selecting protocol
and fail if multiselect does not return same protocol. Returns first
"""
For each protocol, send message to multiselect selecting protocol and
fail if multiselect does not return same protocol. Returns first
protocol that multiselect agrees on (i.e. that multiselect selects)
:param protocol: protocol to select
@ -35,7 +37,8 @@ class IMultiselectClient(ABC):
async def try_select(
self, communicator: IMultiselectCommunicator, protocol: TProtocol
) -> TProtocol:
"""Try to select the given protocol or raise exception if fails.
"""
Try to select the given protocol or raise exception if fails.
:param communicator: communicator to use to communicate with counterparty
:param protocol: protocol to select

3
libp2p/protocol_muxer/multiselect_communicator_interface.py
View File

@ -8,7 +8,8 @@ class IMultiselectCommunicator(ABC):
@abstractmethod
async def write(self, msg_str: str) -> None:
"""Write message to stream.
"""
Write message to stream.
:param msg_str: message to write
"""

6
libp2p/protocol_muxer/multiselect_muxer_interface.py
View File

@ -15,7 +15,8 @@ class IMultiselectMuxer(ABC):
@abstractmethod
def add_handler(self, protocol: TProtocol, handler: StreamHandlerFn) -> None:
"""Store the handler with the given protocol.
"""
Store the handler with the given protocol.
:param protocol: protocol name
:param handler: handler function
@ -25,7 +26,8 @@ class IMultiselectMuxer(ABC):
async def negotiate(
self, communicator: IMultiselectCommunicator
) -> Tuple[TProtocol, StreamHandlerFn]:
"""Negotiate performs protocol selection.
"""
Negotiate performs protocol selection.
:param stream: stream to negotiate on
:return: selected protocol name, handler function