mirror of
https://github.com/varun-r-mallya/py-libp2p.git
synced 2025-12-31 20:36:24 +00:00
4b1860766d
* feat: Replace mplex with yamux as default multiplexer in py-libp2p * Retain Mplex alongside Yamux in new_swarm with messaging that Yamux is preferred * moved !BBHII to a constant YAMUX_HEADER_FORMAT at the top of yamux.py with a comment explaining its structure * renamed the news fragment to 534.feature.rst and updated the description * renamed the news fragment to 534.feature.rst and updated the description * added a docstring to clarify that Yamux does not support deadlines natively * Remove the __main__ block entirely from test_yamux.py * Replaced the print statements in test_yamux.py with logging.debug * Added a comment linking to the spec for clarity * Raise NotImplementedError in YamuxStream.set_deadline per review * Add muxed_conn to YamuxStream and test deadline NotImplementedError * Fix Yamux implementation to meet libp2p spec * Fix None handling in YamuxStream.read and Yamux.read_stream * Fix test_connected_peers.py to correctly handle peer connections * fix: Ensure StreamReset is raised on read after local reset in yamux * fix: Map MuxedStreamError to StreamClosed in NetStream.write for Yamux * fix: Raise MuxedStreamReset in Yamux.read_stream for closed streams * fix: Correct Yamux stream read behavior for NetStream tests Fixed est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed ( ecv_closed=True) for =-1 reads, ensuring data is only returned after remote closure. * fix: Correct Yamux stream read behavior for NetStream tests Fixed est_net_stream_read_after_remote_closed by updating NetStream.read to raise StreamEOF when the stream is remotely closed and no data is available, aligning with test expectations and Fixed est_net_stream_read_until_eof by modifying YamuxStream.read to block until the stream is closed ( ecv_closed=True) for =-1 reads, ensuring data is only returned after remote closure. * fix: raise StreamEOF when reading from closed stream with empty buffer * fix: prioritize returning buffered data even after stream reset * fix: prioritize returning buffered data even after stream reset * fix: Ensure test_net_stream_read_after_remote_closed_and_reset passes in full suite * fix: Add __init__.py to yamux module to fix documentation build * fix: Add __init__.py to yamux module to fix documentation build * fix: Add libp2p.stream_muxer.yamux to libp2p.stream_muxer.rst toctree * fix: Correct title underline length in libp2p.stream_muxer.yamux.rst * fix: Add a = so that is matches the libp2p.stream\_muxer.yamux length * fix(tests): Resolve race condition in network notification test * fix: fixing failing tests and examples with yamux and noise * refactor: remove debug logging and improve x25519 tests * fix: Add functionality for users to choose between Yamux and Mplex * fix: increased trio sleep to 0.1 sec for slow environment * feat: Add test for switching between Yamux and mplex * refactor: move host fixtures to interop tests * chore: Update __init__.py removing unused import removed unused ```python import os import logging ``` * lint: fix import order * fix: Resolve conftest.py conflict by removing trio test support * fix: Resolve test skipping by keeping trio test support * Fix: add a newline at end of the file --------- Co-authored-by: acul71 <luca.pisani@birdo.net> Co-authored-by: acul71 <34693171+acul71@users.noreply.github.com>
89 lines
2.5 KiB
Python
89 lines
2.5 KiB
Python
from typing import (
|
|
Optional,
|
|
)
|
|
|
|
from libp2p.abc import (
|
|
IMuxedStream,
|
|
INetStream,
|
|
)
|
|
from libp2p.custom_types import (
|
|
TProtocol,
|
|
)
|
|
from libp2p.stream_muxer.exceptions import (
|
|
MuxedStreamClosed,
|
|
MuxedStreamEOF,
|
|
MuxedStreamError,
|
|
MuxedStreamReset,
|
|
)
|
|
|
|
from .exceptions import (
|
|
StreamClosed,
|
|
StreamEOF,
|
|
StreamReset,
|
|
)
|
|
|
|
|
|
# TODO: Handle exceptions from `muxed_stream`
|
|
# TODO: Add stream state
|
|
# - Reference: https://github.com/libp2p/go-libp2p-swarm/blob/99831444e78c8f23c9335c17d8f7c700ba25ca14/swarm_stream.go # noqa: E501
|
|
class NetStream(INetStream):
|
|
muxed_stream: IMuxedStream
|
|
protocol_id: Optional[TProtocol]
|
|
|
|
def __init__(self, muxed_stream: IMuxedStream) -> None:
|
|
self.muxed_stream = muxed_stream
|
|
self.muxed_conn = muxed_stream.muxed_conn
|
|
self.protocol_id = None
|
|
|
|
def get_protocol(self) -> TProtocol:
|
|
"""
|
|
:return: protocol id that stream runs on
|
|
"""
|
|
return self.protocol_id
|
|
|
|
def set_protocol(self, protocol_id: TProtocol) -> None:
|
|
"""
|
|
:param protocol_id: protocol id that stream runs on
|
|
"""
|
|
self.protocol_id = protocol_id
|
|
|
|
async def read(self, n: int = None) -> bytes:
|
|
"""
|
|
Read from stream.
|
|
|
|
:param n: number of bytes to read
|
|
:return: bytes of input
|
|
"""
|
|
try:
|
|
return await self.muxed_stream.read(n)
|
|
except MuxedStreamEOF as error:
|
|
raise StreamEOF() from error
|
|
except MuxedStreamReset as error:
|
|
raise StreamReset() from error
|
|
|
|
async def write(self, data: bytes) -> None:
|
|
"""
|
|
Write to stream.
|
|
|
|
:return: number of bytes written
|
|
"""
|
|
try:
|
|
await self.muxed_stream.write(data)
|
|
except (MuxedStreamClosed, MuxedStreamError) as error:
|
|
raise StreamClosed() from error
|
|
|
|
async def close(self) -> None:
|
|
"""Close stream."""
|
|
await self.muxed_stream.close()
|
|
|
|
async def reset(self) -> None:
|
|
await self.muxed_stream.reset()
|
|
|
|
def get_remote_address(self) -> Optional[tuple[str, int]]:
|
|
"""Delegate to the underlying muxed stream."""
|
|
return self.muxed_stream.get_remote_address()
|
|
|
|
# TODO: `remove`: Called by close and write when the stream is in specific states.
|
|
# It notifies `ClosedStream` after `SwarmConn.remove_stream` is called.
|
|
# Reference: https://github.com/libp2p/go-libp2p-swarm/blob/99831444e78c8f23c9335c17d8f7c700ba25ca14/swarm_stream.go # noqa: E501
|