6574804013

Committed 19 Oct 2023 12:47PM UTC coverage: 51.937% (+1.2%) from 50.777%

Build # 6574804013

Build Type

Pull #327

github

Committed by

Christian-B

Commit Message

typing changes

Pull Request Pull Request #327: Type Annotations and Checking

Run Details

105 of 1288 branches covered (0.0%)

Branch coverage included in aggregate %.

2375 of 2375 new or added lines in 180 files covered. (100.0%)

4775 of 8108 relevant lines covered (58.89%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

57.58

/spinnman/connections/udp_packet_connections/sdp_connection.py

# Copyright (c) 2015 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import struct
from typing import Callable, Optional
from spinn_utilities.overrides import overrides
from spinnman.messages.sdp import SDPMessage, SDPFlag
from .udp_connection import UDPConnection
from spinnman.connections.abstract_classes import Listenable
from spinnman.exceptions import SpinnmanUnsupportedOperationException

_TWO_SKIP = struct.Struct("<2x")


class SDPConnection(UDPConnection, Listenable[SDPMessage]):
    """
    A connection that talks SpiNNaker Datagram Protocol.
    """
    __slots__ = (
        "_chip_x",
        "_chip_y")

    def __init__(
            self, chip_x: int, chip_y: int,
            local_host: Optional[str] = None,
            local_port: Optional[int] = None,
            remote_host: Optional[str] = None,
            remote_port: Optional[int] = None):
        """
        :param int chip_x: The optional x-coordinate of the chip at the remote
            end of the connection. If not specified, it will not be possible
            to send SDP messages that require a response with this connection.
        :param int chip_y: The optional y-coordinate of the chip at the remote
            end of the connection. If not specified, it will not be possible
            to send SDP messages that require a response with this connection.
        :param str local_host: The optional IP address or host name of the
            local interface to listen on
        :param int local_port: The optional local port to listen on
        :param str remote_host: The optional remote host name or IP address to
            send messages to. If not specified, sending will not be possible
            using this connection
        :param int remote_port: The optional remote port number to send
            messages to. If not specified, sending will not be possible using
            this connection
        """
        # pylint: disable=too-many-arguments
        super().__init__(local_host, local_port, remote_host, remote_port)
        self._chip_x = chip_x
        self._chip_y = chip_y

    def receive_sdp_message(
            self, timeout: Optional[float] = None) -> SDPMessage:
        """
        Receives an SDP message from this connection.  Blocks until the
        message has been received, or a timeout occurs.

        :param int timeout:
            The time in seconds to wait for the message to arrive; if not
            specified, will wait forever, or until the connection is closed.
        :return: The received SDP message
        :rtype: SDPMessage
        :raise SpinnmanIOException:
            If there is an error receiving the message
        :raise SpinnmanTimeoutException:
            If there is a timeout before a message is received
        :raise SpinnmanInvalidPacketException:
            If the received packet is not a valid SDP message
        :raise SpinnmanInvalidParameterException:
            If one of the fields of the SDP message is invalid
        """
        data = self.receive(timeout)
        return SDPMessage.from_bytestring(data, 2)

    def send_sdp_message(self, sdp_message: SDPMessage):
        """
        Sends an SDP message down this connection.

        :param SDPMessage sdp_message: The SDP message to be sent
        :raise SpinnmanIOException:
            If there is an error sending the message.
        """
        if self._chip_x is None or self._chip_y is None:
            raise SpinnmanUnsupportedOperationException(
                "send on receive-only connection")
        # If a reply is expected, the connection should
        if sdp_message.sdp_header.flags == SDPFlag.REPLY_EXPECTED:
            sdp_message.sdp_header.update_for_send(self._chip_x, self._chip_y)
        else:
            sdp_message.sdp_header.update_for_send(0, 0)
        self.send(_TWO_SKIP.pack() + sdp_message.bytestring)

    @overrides(Listenable.get_receive_method)
    def get_receive_method(  # type: ignore[override]
            self) -> Callable[[], SDPMessage]:
        return self.receive_sdp_message

    def __repr__(self) -> str:
        return (
            f"SDPConnection(chip_x={self._chip_x}, chip_y={self._chip_y}, "
            f"local_host={self.local_ip_address}, local_port={self.local_port}"
            f", remote_host={self.remote_ip_address}, "
            f"remote_port={self.remote_port})")

1	# Copyright (c) 2015 The University of Manchester
2	#
3	# Licensed under the Apache License, Version 2.0 (the "License");
4	# you may not use this file except in compliance with the License.
5	# You may obtain a copy of the License at
6	#
7	# https://www.apache.org/licenses/LICENSE-2.0
8	#
9	# Unless required by applicable law or agreed to in writing, software
10	# distributed under the License is distributed on an "AS IS" BASIS,
11	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	# See the License for the specific language governing permissions and
13	# limitations under the License.
14
15	import struct	1✔
16	from typing import Callable, Optional	1✔
17	from spinn_utilities.overrides import overrides	1✔
18	from spinnman.messages.sdp import SDPMessage, SDPFlag	1✔
19	from .udp_connection import UDPConnection	1✔
20	from spinnman.connections.abstract_classes import Listenable	1✔
21	from spinnman.exceptions import SpinnmanUnsupportedOperationException	1✔
22
23	_TWO_SKIP = struct.Struct("<2x")	1✔
24
25
26	class SDPConnection(UDPConnection, Listenable[SDPMessage]):	1✔
27	"""
28	A connection that talks SpiNNaker Datagram Protocol.
29	"""
30	__slots__ = (	1✔
31	"_chip_x",
32	"_chip_y")
33
34	def __init__(	1✔
35	self, chip_x: int, chip_y: int,
36	local_host: Optional[str] = None,
37	local_port: Optional[int] = None,
38	remote_host: Optional[str] = None,
39	remote_port: Optional[int] = None):
40	"""
41	:param int chip_x: The optional x-coordinate of the chip at the remote
42	end of the connection. If not specified, it will not be possible
43	to send SDP messages that require a response with this connection.
44	:param int chip_y: The optional y-coordinate of the chip at the remote
45	end of the connection. If not specified, it will not be possible
46	to send SDP messages that require a response with this connection.
47	:param str local_host: The optional IP address or host name of the
48	local interface to listen on
49	:param int local_port: The optional local port to listen on
50	:param str remote_host: The optional remote host name or IP address to
51	send messages to. If not specified, sending will not be possible
52	using this connection
53	:param int remote_port: The optional remote port number to send
54	messages to. If not specified, sending will not be possible using
55	this connection
56	"""
57	# pylint: disable=too-many-arguments
58	super().__init__(local_host, local_port, remote_host, remote_port)	1✔
59	self._chip_x = chip_x	1✔
60	self._chip_y = chip_y	1✔
61
62	def receive_sdp_message(	1✔
63	self, timeout: Optional[float] = None) -> SDPMessage:
64	"""
65	Receives an SDP message from this connection. Blocks until the
66	message has been received, or a timeout occurs.
67
68	:param int timeout:
69	The time in seconds to wait for the message to arrive; if not
70	specified, will wait forever, or until the connection is closed.
71	:return: The received SDP message
72	:rtype: SDPMessage
73	:raise SpinnmanIOException:
74	If there is an error receiving the message
75	:raise SpinnmanTimeoutException:
76	If there is a timeout before a message is received
77	:raise SpinnmanInvalidPacketException:
78	If the received packet is not a valid SDP message
79	:raise SpinnmanInvalidParameterException:
80	If one of the fields of the SDP message is invalid
81	"""
82	data = self.receive(timeout)	×
83	return SDPMessage.from_bytestring(data, 2)	×
84
85	def send_sdp_message(self, sdp_message: SDPMessage):	1✔
86	"""
87	Sends an SDP message down this connection.
88
89	:param SDPMessage sdp_message: The SDP message to be sent
90	:raise SpinnmanIOException:
91	If there is an error sending the message.
92	"""
93	if self._chip_x is None or self._chip_y is None:	×
94	raise SpinnmanUnsupportedOperationException(	×
95	"send on receive-only connection")
96	# If a reply is expected, the connection should
97	if sdp_message.sdp_header.flags == SDPFlag.REPLY_EXPECTED:	×
98	sdp_message.sdp_header.update_for_send(self._chip_x, self._chip_y)	×
99	else:
100	sdp_message.sdp_header.update_for_send(0, 0)	×
101	self.send(_TWO_SKIP.pack() + sdp_message.bytestring)	×
102
103	@overrides(Listenable.get_receive_method)	1✔
104	def get_receive_method( # type: ignore[override]	1✔
105	self) -> Callable[[], SDPMessage]:
106	return self.receive_sdp_message	×
107
108	def __repr__(self) -> str:	1✔
109	return (	×
110	f"SDPConnection(chip_x={self._chip_x}, chip_y={self._chip_y}, "
111	f"local_host={self.local_ip_address}, local_port={self.local_port}"
112	f", remote_host={self.remote_ip_address}, "
113	f"remote_port={self.remote_port})")

SpiNNakerManchester / SpiNNMan / 6574804013

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous