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

Add exception raised to docstring

Browse Source
This commit is contained in:
NIC619
2019-09-19 22:19:36 +08:00
parent c6294ad19b
commit 7fc958e7be
8 changed files with 29 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libp2p/protocol_muxer/multiselect_communicator.py
View File

@ -14,6 +14,9 @@ class MultiselectCommunicator(IMultiselectCommunicator):
self.read_writer = read_writer
async def write(self, msg_str: str) -> None:
"""
:raise MultiselectCommunicatorError: raised when failed to write to underlying reader
"""
msg_bytes = encode_delim(msg_str.encode())
try:
await self.read_writer.write(msg_bytes)
@ -23,6 +26,9 @@ class MultiselectCommunicator(IMultiselectCommunicator):
)
async def read(self) -> str:
"""
:raise MultiselectCommunicatorError: raised when failed to read from underlying reader
"""
try:
data = await read_delim(self.read_writer)
# `IOException` includes `IncompleteReadError` and `StreamError`