From ada4d48b6e786b1b21819ce7f06b9f087460f4cb Mon Sep 17 00:00:00 2001 From: Alex Stokes Date: Tue, 24 Sep 2019 15:35:48 -0700 Subject: [PATCH] remove overly verbose comments --- libp2p/protocol_muxer/multiselect.py | 19 ------------------- libp2p/protocol_muxer/multiselect_client.py | 19 ------------------- 2 files changed, 38 deletions(-) diff --git a/libp2p/protocol_muxer/multiselect.py b/libp2p/protocol_muxer/multiselect.py index a0fa91f4..88f7e37e 100644 --- a/libp2p/protocol_muxer/multiselect.py +++ b/libp2p/protocol_muxer/multiselect.py @@ -39,34 +39,26 @@ class Multiselect(IMultiselectMuxer): :return: selected protocol name, handler function :raise MultiselectError: raised when negotiation failed """ - - # Perform handshake to ensure multiselect protocol IDs match await self.handshake(communicator) - # Read and respond to commands until a valid protocol ID is sent while True: - # Read message try: command = await communicator.read() except MultiselectCommunicatorError as error: raise MultiselectError(error) - # Command is ls or a protocol if command == "ls": # TODO: handle ls command pass else: protocol = TProtocol(command) if protocol in self.handlers: - # Tell counterparty we have decided on a protocol try: await communicator.write(protocol) except MultiselectCommunicatorError as error: raise MultiselectError(error) - # Return the decided on protocol return protocol, self.handlers[protocol] - # Tell counterparty this protocol was not found try: await communicator.write(PROTOCOL_NOT_FOUND_MSG) except MultiselectCommunicatorError as error: @@ -78,30 +70,22 @@ class Multiselect(IMultiselectMuxer): :param communicator: communicator to use :raise MultiselectError: raised when handshake failed """ - - # TODO: Use format used by go repo for messages - - # Send our MULTISELECT_PROTOCOL_ID to other party try: await communicator.write(MULTISELECT_PROTOCOL_ID) except MultiselectCommunicatorError as error: raise MultiselectError(error) - # Read in the protocol ID from other party try: handshake_contents = await communicator.read() except MultiselectCommunicatorError as error: raise MultiselectError(error) - # Confirm that the protocols are the same if not validate_handshake(handshake_contents): raise MultiselectError( "multiselect protocol ID mismatch: " f"received handshake_contents={handshake_contents}" ) - # Handshake succeeded if this point is reached - def validate_handshake(handshake_contents: str) -> bool: """ @@ -109,7 +93,4 @@ def validate_handshake(handshake_contents: str) -> bool: :param handshake_contents: contents of handshake message :return: true if handshake is complete, false otherwise """ - - # TODO: Modify this when format used by go repo for messages - # is added return handshake_contents == MULTISELECT_PROTOCOL_ID diff --git a/libp2p/protocol_muxer/multiselect_client.py b/libp2p/protocol_muxer/multiselect_client.py index 24db70a0..07ea5e7f 100644 --- a/libp2p/protocol_muxer/multiselect_client.py +++ b/libp2p/protocol_muxer/multiselect_client.py @@ -23,27 +23,19 @@ class MultiselectClient(IMultiselectClient): :param stream: stream to communicate with multiselect over :raise MultiselectClientError: raised when handshake failed """ - - # TODO: Use format used by go repo for messages - - # Send our MULTISELECT_PROTOCOL_ID to counterparty try: await communicator.write(MULTISELECT_PROTOCOL_ID) except MultiselectCommunicatorError as error: raise MultiselectClientError(error) - # Read in the protocol ID from other party try: handshake_contents = await communicator.read() except MultiselectCommunicatorError as error: raise MultiselectClientError(str(error)) - # Confirm that the protocols are the same if not validate_handshake(handshake_contents): raise MultiselectClientError("multiselect protocol ID mismatch") - # Handshake succeeded if this point is reached - async def select_one_of( self, protocols: Sequence[TProtocol], communicator: IMultiselectCommunicator ) -> TProtocol: @@ -56,11 +48,8 @@ class MultiselectClient(IMultiselectClient): :return: selected protocol :raise MultiselectClientError: raised when protocol negotiation failed """ - # Perform handshake to ensure multiselect protocol IDs match await self.handshake(communicator) - # For each protocol, attempt to select that protocol - # and return the first protocol selected for protocol in protocols: try: selected_protocol = await self.try_select(communicator, protocol) @@ -68,7 +57,6 @@ class MultiselectClient(IMultiselectClient): except MultiselectClientError: pass - # No protocols were found, so return no protocols supported error raise MultiselectClientError("protocols not supported") async def try_select( @@ -81,20 +69,16 @@ class MultiselectClient(IMultiselectClient): :raise MultiselectClientError: raised when protocol negotiation failed :return: selected protocol """ - - # Tell counterparty we want to use protocol try: await communicator.write(protocol) except MultiselectCommunicatorError as error: raise MultiselectClientError(error) - # Get what counterparty says in response try: response = await communicator.read() except MultiselectCommunicatorError as error: raise MultiselectClientError(str(error)) - # Return protocol if response is equal to protocol or raise error if response == protocol: return protocol if response == PROTOCOL_NOT_FOUND_MSG: @@ -108,7 +92,4 @@ def validate_handshake(handshake_contents: str) -> bool: :param handshake_contents: contents of handshake message :return: true if handshake is complete, false otherwise """ - - # TODO: Modify this when format used by go repo for messages - # is added return handshake_contents == MULTISELECT_PROTOCOL_ID