bt2: Add remaining trace-ir `*Const` classes and adapt tests
[babeltrace.git] / src / bindings / python / bt2 / bt2 / message_iterator.py
index 07c707dba31c013182c0f9ffc3177ebc72b12108..d28beb25a30c6cb9d3f710c8d7d8b77d47e10ff2 100644 (file)
 # THE SOFTWARE.
 
 from bt2 import native_bt, object, utils
-import bt2.message
+from bt2 import message as bt2_message
 import collections.abc
-import bt2.component
-import bt2.port
+from bt2 import stream as bt2_stream
+from bt2 import event_class as bt2_event_class
+from bt2 import packet as bt2_packet
+from bt2 import port as bt2_port
+from bt2 import clock_class as bt2_clock_class
 import bt2
 
 
@@ -51,7 +54,7 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator):
         msg_ptr = self._current_msgs[self._at]
         self._at += 1
 
-        return bt2.message._create_from_ptr(msg_ptr)
+        return bt2_message._create_from_ptr(msg_ptr)
 
     @property
     def can_seek_beginning(self):
@@ -59,7 +62,7 @@ class _GenericMessageIterator(object._SharedObject, _MessageIterator):
         return res != 0
 
     def seek_beginning(self):
-        # Forget about buffered messages, they won't be valid after seeking..
+        # Forget about buffered messages, they won't be valid after seeking.
         self._current_msgs.clear()
         self._at = 0
 
@@ -84,20 +87,6 @@ class _UserComponentInputPortMessageIterator(_GenericMessageIterator):
     )
 
 
-# This is created when the user wants to iterate on a component's output port,
-# from outside the graph.
-class _OutputPortMessageIterator(_GenericMessageIterator):
-    _get_msg_range = staticmethod(native_bt.bt2_port_output_get_msg_range)
-    _get_ref = staticmethod(native_bt.port_output_message_iterator_get_ref)
-    _put_ref = staticmethod(native_bt.port_output_message_iterator_put_ref)
-    _can_seek_beginning = staticmethod(
-        native_bt.port_output_message_iterator_can_seek_beginning
-    )
-    _seek_beginning = staticmethod(
-        native_bt.port_output_message_iterator_seek_beginning
-    )
-
-
 # This is extended by the user to implement component classes in Python.  It
 # is created for a given output port when an input port message iterator is
 # created on the input port on the other side of the connection.  It is also
@@ -122,7 +111,7 @@ class _UserMessageIterator(_MessageIterator):
         return self
 
     def _bt_init_from_native(self, self_output_port_ptr):
-        self_output_port = bt2.port._create_self_from_ptr_and_get_ref(
+        self_output_port = bt2_port._create_self_from_ptr_and_get_ref(
             self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT
         )
         self.__init__(self_output_port)
@@ -138,7 +127,11 @@ class _UserMessageIterator(_MessageIterator):
     def addr(self):
         return int(self._bt_ptr)
 
-    def _finalize(self):
+    @property
+    def _is_interrupted(self):
+        return bool(native_bt.self_message_iterator_is_interrupted(self._bt_ptr))
+
+    def _user_finalize(self):
         pass
 
     def __next__(self):
@@ -150,10 +143,10 @@ class _UserMessageIterator(_MessageIterator):
             msg = next(self)
         except StopIteration:
             raise bt2.Stop
-        except:
+        except Exception:
             raise
 
-        utils._check_type(msg, bt2.message._Message)
+        utils._check_type(msg, bt2_message._MessageConst)
 
         # The reference we return will be given to the message array.
         # However, the `msg` Python object may stay alive, if the user has kept
@@ -165,41 +158,38 @@ class _UserMessageIterator(_MessageIterator):
     def _bt_can_seek_beginning_from_native(self):
         # Here, we mimic the behavior of the C API:
         #
-        # - If the iterator has a _can_seek_beginning attribute, read it and use
-        #   that result.
-        # - Otherwise, the presence or absence of a `_seek_beginning`
+        # - If the iterator has a _user_can_seek_beginning attribute,
+        #   read it and use that result.
+        # - Otherwise, the presence or absence of a `_user_seek_beginning`
         #   method indicates whether the iterator can seek beginning.
-        if hasattr(self, '_can_seek_beginning'):
-            can_seek_beginning = self._can_seek_beginning
+        if hasattr(self, '_user_can_seek_beginning'):
+            can_seek_beginning = self._user_can_seek_beginning
             utils._check_bool(can_seek_beginning)
             return can_seek_beginning
         else:
-            return hasattr(self, '_seek_beginning')
+            return hasattr(self, '_user_seek_beginning')
 
     def _bt_seek_beginning_from_native(self):
-        self._seek_beginning()
+        self._user_seek_beginning()
 
     def _create_input_port_message_iterator(self, input_port):
-        utils._check_type(input_port, bt2.port._UserComponentInputPort)
+        utils._check_type(input_port, bt2_port._UserComponentInputPort)
 
-        msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_message_iterator(
+        status, msg_iter_ptr = native_bt.bt2_self_component_port_input_message_iterator_create_from_message_iterator(
             self._bt_ptr, input_port._ptr
         )
-
-        if msg_iter_ptr is None:
-            raise bt2.CreationError('cannot create message iterator object')
+        utils._handle_func_status(status, 'cannot create message iterator object')
+        assert msg_iter_ptr is not None
 
         return _UserComponentInputPortMessageIterator(msg_iter_ptr)
 
-    def _create_event_message(
-        self, event_class, parent=None, default_clock_snapshot=None
-    ):
-        utils._check_type(event_class, bt2.event_class._EventClass)
+    def _create_event_message(self, event_class, parent, default_clock_snapshot=None):
+        utils._check_type(event_class, bt2_event_class._EventClass)
 
         if event_class.stream_class.supports_packets:
-            utils._check_type(parent, bt2.packet._Packet)
+            utils._check_type(parent, bt2_packet._Packet)
         else:
-            utils._check_type(parent, bt2.stream._Stream)
+            utils._check_type(parent, bt2_stream._Stream)
 
         if default_clock_snapshot is not None:
             if event_class.stream_class.default_clock_class is None:
@@ -235,10 +225,10 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot create event message object')
 
-        return bt2.message._EventMessage(ptr)
+        return bt2_message._EventMessage(ptr)
 
     def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot):
-        utils._check_type(clock_class, bt2.clock_class._ClockClass)
+        utils._check_type(clock_class, bt2_clock_class._ClockClass)
         ptr = native_bt.message_message_iterator_inactivity_create(
             self._bt_ptr, clock_class._ptr, clock_snapshot
         )
@@ -246,16 +236,16 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot create inactivity message object')
 
-        return bt2.message._MessageIteratorInactivityMessage(ptr)
+        return bt2_message._MessageIteratorInactivityMessage(ptr)
 
     def _create_stream_beginning_message(self, stream, default_clock_snapshot=None):
-        utils._check_type(stream, bt2.stream._Stream)
+        utils._check_type(stream, bt2_stream._Stream)
 
         ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr)
         if ptr is None:
             raise bt2._MemoryError('cannot create stream beginning message object')
 
-        msg = bt2.message._StreamBeginningMessage(ptr)
+        msg = bt2_message._StreamBeginningMessage(ptr)
 
         if default_clock_snapshot is not None:
             msg._default_clock_snapshot = default_clock_snapshot
@@ -263,13 +253,13 @@ class _UserMessageIterator(_MessageIterator):
         return msg
 
     def _create_stream_end_message(self, stream, default_clock_snapshot=None):
-        utils._check_type(stream, bt2.stream._Stream)
+        utils._check_type(stream, bt2_stream._Stream)
 
         ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr)
         if ptr is None:
             raise bt2._MemoryError('cannot create stream end message object')
 
-        msg = bt2.message._StreamEndMessage(ptr)
+        msg = bt2_message._StreamEndMessage(ptr)
 
         if default_clock_snapshot is not None:
             msg._default_clock_snapshot = default_clock_snapshot
@@ -277,7 +267,7 @@ class _UserMessageIterator(_MessageIterator):
         return msg
 
     def _create_packet_beginning_message(self, packet, default_clock_snapshot=None):
-        utils._check_type(packet, bt2.packet._Packet)
+        utils._check_type(packet, bt2_packet._Packet)
 
         if packet.stream.cls.packets_have_beginning_default_clock_snapshot:
             if default_clock_snapshot is None:
@@ -300,10 +290,10 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot create packet beginning message object')
 
-        return bt2.message._PacketBeginningMessage(ptr)
+        return bt2_message._PacketBeginningMessage(ptr)
 
     def _create_packet_end_message(self, packet, default_clock_snapshot=None):
-        utils._check_type(packet, bt2.packet._Packet)
+        utils._check_type(packet, bt2_packet._Packet)
 
         if packet.stream.cls.packets_have_end_default_clock_snapshot:
             if default_clock_snapshot is None:
@@ -326,12 +316,12 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot create packet end message object')
 
-        return bt2.message._PacketEndMessage(ptr)
+        return bt2_message._PacketEndMessage(ptr)
 
     def _create_discarded_events_message(
         self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None
     ):
-        utils._check_type(stream, bt2.stream._Stream)
+        utils._check_type(stream, bt2_stream._Stream)
 
         if not stream.cls.supports_discarded_events:
             raise ValueError('stream class does not support discarded events')
@@ -358,7 +348,7 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot discarded events message object')
 
-        msg = bt2.message._DiscardedEventsMessage(ptr)
+        msg = bt2_message._DiscardedEventsMessage(ptr)
 
         if count is not None:
             msg._count = count
@@ -368,7 +358,7 @@ class _UserMessageIterator(_MessageIterator):
     def _create_discarded_packets_message(
         self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None
     ):
-        utils._check_type(stream, bt2.stream._Stream)
+        utils._check_type(stream, bt2_stream._Stream)
 
         if not stream.cls.supports_discarded_packets:
             raise ValueError('stream class does not support discarded packets')
@@ -395,7 +385,7 @@ class _UserMessageIterator(_MessageIterator):
         if ptr is None:
             raise bt2._MemoryError('cannot discarded packets message object')
 
-        msg = bt2.message._DiscardedPacketsMessage(ptr)
+        msg = bt2_message._DiscardedPacketsMessage(ptr)
 
         if count is not None:
             msg._count = count
This page took 0.028806 seconds and 4 git commands to generate.