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

18
libp2p/stream_muxer/mplex/mplex_stream.py
View File

@ -34,7 +34,8 @@ class MplexStream(IMuxedStream):
_buf: bytearray
def __init__(self, name: str, stream_id: StreamID, muxed_conn: "Mplex") -> None:
"""create new MuxedStream in muxer.
"""
create new MuxedStream in muxer.
:param stream_id: stream id of this stream
:param muxed_conn: muxed connection of this muxed_stream
@ -112,7 +113,8 @@ class MplexStream(IMuxedStream):
return bytes(payload)
async def read(self, n: int = -1) -> bytes:
"""Read up to n bytes. Read possibly returns fewer than `n` bytes, if
"""
Read up to n bytes. Read possibly returns fewer than `n` bytes, if
there are not enough bytes in the Mplex buffer. If `n == -1`, read
until EOF.
@ -141,7 +143,8 @@ class MplexStream(IMuxedStream):
return bytes(payload)
async def write(self, data: bytes) -> int:
"""write to stream.
"""
write to stream.
:return: number of bytes written
"""
@ -212,7 +215,8 @@ class MplexStream(IMuxedStream):
# TODO deadline not in use
def set_deadline(self, ttl: int) -> bool:
"""set deadline for muxed stream.
"""
set deadline for muxed stream.
:return: True if successful
"""
@ -221,7 +225,8 @@ class MplexStream(IMuxedStream):
return True
def set_read_deadline(self, ttl: int) -> bool:
"""set read deadline for muxed stream.
"""
set read deadline for muxed stream.
:return: True if successful
"""
@ -229,7 +234,8 @@ class MplexStream(IMuxedStream):
return True
def set_write_deadline(self, ttl: int) -> bool:
"""set write deadline for muxed stream.
"""
set write deadline for muxed stream.
:return: True if successful
"""