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