diff --git a/can/listener.py b/can/listener.py index 5616f110a..5a52d3303 100644 --- a/can/listener.py +++ b/can/listener.py @@ -106,6 +106,7 @@ def get_message(self, timeout: float = 0.5) -> Message | None: not block after :meth:`can.BufferedReader.stop` has been called. :param timeout: The number of seconds to wait for a new message. + Use :meth:`get_message_nowait` for an explicit non-blocking read. :return: the received :class:`can.Message` or `None`, if the queue is empty. """ try: @@ -116,6 +117,17 @@ def get_message(self, timeout: float = 0.5) -> Message | None: except Empty: return None + def get_message_nowait(self) -> Message | None: + """ + Retrieve the oldest queued message without waiting. + + :return: the received :class:`can.Message`, or ``None`` if the queue is empty. + """ + try: + return self.buffer.get(block=False) + except Empty: + return None + def stop(self) -> None: """Prohibits any more additions to this reader.""" self.is_stopped = True diff --git a/doc/changelog.d/1919.feature.rst b/doc/changelog.d/1919.feature.rst new file mode 100644 index 000000000..3fcbaf30e --- /dev/null +++ b/doc/changelog.d/1919.feature.rst @@ -0,0 +1 @@ +Added ``BufferedReader.get_message_nowait()`` for explicit non-blocking reads. diff --git a/test/listener_test.py b/test/listener_test.py index 77fd0d2e0..5593f93c5 100644 --- a/test/listener_test.py +++ b/test/listener_test.py @@ -158,6 +158,19 @@ def testBufferedListenerReceives(self): a_listener.stop() self.assertIsNotNone(a_listener.get_message(0.1)) + def testBufferedListenerGetMessageNowait(self): + listener = can.BufferedReader() + self.assertIsNone(listener.get_message_nowait()) + + first = generate_message(0xDADADA) + second = generate_message(0x123) + listener(first) + listener(second) + + self.assertIs(listener.get_message_nowait(), first) + self.assertIs(listener.get_message_nowait(), second) + self.assertIsNone(listener.get_message_nowait()) + def test_deprecated_loop_arg(recwarn): try: