python: standardize intra-bt2 imports
[babeltrace.git] / src / bindings / python / bt2 / bt2 / message_iterator.py
index 5b4cc1bdb3df458691f6b03b29993bb03b811529..f0a47ec72818dcce89071e8ec2ae203e0844d96f 100644 (file)
@@ -2,7 +2,9 @@
 #
 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
 
-from bt2 import native_bt, object, utils
+from bt2 import native_bt
+from bt2 import object as bt2_object
+from bt2 import utils as bt2_utils
 from bt2 import message as bt2_message
 import collections.abc
 from bt2 import stream as bt2_stream
@@ -18,9 +20,16 @@ class _MessageIterator(collections.abc.Iterator):
         raise NotImplementedError
 
 
-class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageIterator):
-    _get_ref = staticmethod(native_bt.message_iterator_get_ref)
-    _put_ref = staticmethod(native_bt.message_iterator_put_ref)
+class _UserComponentInputPortMessageIterator(
+    bt2_object._SharedObject, _MessageIterator
+):
+    @staticmethod
+    def _get_ref(ptr):
+        native_bt.message_iterator_get_ref(ptr)
+
+    @staticmethod
+    def _put_ref(ptr):
+        native_bt.message_iterator_put_ref(ptr)
 
     def __init__(self, ptr):
         self._current_msgs = []
@@ -32,8 +41,8 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
             status, msgs = native_bt.bt2_self_component_port_input_get_msg_range(
                 self._ptr
             )
-            utils._handle_func_status(
-                status, 'unexpected error: cannot advance the message iterator'
+            bt2_utils._handle_func_status(
+                status, "unexpected error: cannot advance the message iterator"
             )
             self._current_msgs = msgs
             self._at = 0
@@ -45,9 +54,9 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
 
     def can_seek_beginning(self):
         (status, res) = native_bt.message_iterator_can_seek_beginning(self._ptr)
-        utils._handle_func_status(
+        bt2_utils._handle_func_status(
             status,
-            'cannot check whether or not message iterator can seek its beginning',
+            "cannot check whether or not message iterator can seek its beginning",
         )
         return res != 0
 
@@ -57,21 +66,21 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
         self._at = 0
 
         status = native_bt.message_iterator_seek_beginning(self._ptr)
-        utils._handle_func_status(status, 'cannot seek message iterator beginning')
+        bt2_utils._handle_func_status(status, "cannot seek message iterator beginning")
 
     def can_seek_ns_from_origin(self, ns_from_origin):
-        utils._check_int64(ns_from_origin)
+        bt2_utils._check_int64(ns_from_origin)
         (status, res) = native_bt.message_iterator_can_seek_ns_from_origin(
             self._ptr, ns_from_origin
         )
-        utils._handle_func_status(
+        bt2_utils._handle_func_status(
             status,
-            'cannot check whether or not message iterator can seek given ns from origin',
+            "cannot check whether or not message iterator can seek given ns from origin",
         )
         return res != 0
 
     def seek_ns_from_origin(self, ns_from_origin):
-        utils._check_int64(ns_from_origin)
+        bt2_utils._check_int64(ns_from_origin)
 
         # Forget about buffered messages, they won't be valid after seeking.
         self._current_msgs.clear()
@@ -80,8 +89,8 @@ class _UserComponentInputPortMessageIterator(object._SharedObject, _MessageItera
         status = native_bt.message_iterator_seek_ns_from_origin(
             self._ptr, ns_from_origin
         )
-        utils._handle_func_status(
-            status, 'message iterator cannot seek given ns from origin'
+        bt2_utils._handle_func_status(
+            status, "message iterator cannot seek given ns from origin"
         )
 
     @property
@@ -94,7 +103,7 @@ class _MessageIteratorConfiguration:
         self._ptr = ptr
 
     def can_seek_forward(self, value):
-        utils._check_bool(value)
+        bt2_utils._check_bool(value)
         native_bt.self_message_iterator_configuration_set_can_seek_forward(
             self._ptr, value
         )
@@ -104,8 +113,7 @@ class _MessageIteratorConfiguration:
 
 # 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
-# created when an output port message iterator is created on this output port.
+# created on the input port on the other side of the connection.
 #
 # Its purpose is to feed the messages that should go out through this output
 # port.
@@ -170,7 +178,7 @@ class _UserMessageIterator(_MessageIterator):
         except Exception:
             raise
 
-        utils._check_type(msg, bt2_message._MessageConst)
+        bt2_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
@@ -185,12 +193,12 @@ class _UserMessageIterator(_MessageIterator):
         #   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, '_user_can_seek_beginning'):
+        if hasattr(self, "_user_can_seek_beginning"):
             can_seek_beginning = self._user_can_seek_beginning()
-            utils._check_bool(can_seek_beginning)
+            bt2_utils._check_bool(can_seek_beginning)
             return can_seek_beginning
         else:
-            return hasattr(self, '_user_seek_beginning')
+            return hasattr(self, "_user_seek_beginning")
 
     def _bt_seek_beginning_from_native(self):
         self._user_seek_beginning()
@@ -205,18 +213,21 @@ class _UserMessageIterator(_MessageIterator):
         # - Otherwise, if there is a `_user_seek_ns_from_origin` method,
         #   we presume it's possible.
 
-        if hasattr(self, '_user_can_seek_ns_from_origin'):
+        if hasattr(self, "_user_can_seek_ns_from_origin"):
             can_seek_ns_from_origin = self._user_can_seek_ns_from_origin(ns_from_origin)
-            utils._check_bool(can_seek_ns_from_origin)
+            bt2_utils._check_bool(can_seek_ns_from_origin)
             return can_seek_ns_from_origin
         else:
-            return hasattr(self, '_user_seek_ns_from_origin')
+            return hasattr(self, "_user_seek_ns_from_origin")
 
     def _bt_seek_ns_from_origin_from_native(self, ns_from_origin):
         self._user_seek_ns_from_origin(ns_from_origin)
 
     def _create_message_iterator(self, input_port):
-        utils._check_type(input_port, bt2_port._UserComponentInputPort)
+        bt2_utils._check_type(input_port, bt2_port._UserComponentInputPort)
+
+        if not input_port.is_connected:
+            raise ValueError("input port is not connected")
 
         (
             status,
@@ -224,26 +235,26 @@ class _UserMessageIterator(_MessageIterator):
         ) = native_bt.bt2_message_iterator_create_from_message_iterator(
             self._bt_ptr, input_port._ptr
         )
-        utils._handle_func_status(status, 'cannot create message iterator object')
+        bt2_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, default_clock_snapshot=None):
-        utils._check_type(event_class, bt2_event_class._EventClass)
+        bt2_utils._check_type(event_class, bt2_event_class._EventClass)
 
         if event_class.stream_class.supports_packets:
-            utils._check_type(parent, bt2_packet._Packet)
+            bt2_utils._check_type(parent, bt2_packet._Packet)
         else:
-            utils._check_type(parent, bt2_stream._Stream)
+            bt2_utils._check_type(parent, bt2_stream._Stream)
 
         if default_clock_snapshot is not None:
             if event_class.stream_class.default_clock_class is None:
                 raise ValueError(
-                    'event messages in this stream must not have a default clock snapshot'
+                    "event messages in this stream must not have a default clock snapshot"
                 )
 
-            utils._check_uint64(default_clock_snapshot)
+            bt2_utils._check_uint64(default_clock_snapshot)
 
             if event_class.stream_class.supports_packets:
                 ptr = native_bt.message_event_create_with_packet_and_default_clock_snapshot(
@@ -256,7 +267,7 @@ class _UserMessageIterator(_MessageIterator):
         else:
             if event_class.stream_class.default_clock_class is not None:
                 raise ValueError(
-                    'event messages in this stream must have a default clock snapshot'
+                    "event messages in this stream must have a default clock snapshot"
                 )
 
             if event_class.stream_class.supports_packets:
@@ -269,27 +280,27 @@ class _UserMessageIterator(_MessageIterator):
                 )
 
         if ptr is None:
-            raise bt2._MemoryError('cannot create event message object')
+            raise bt2._MemoryError("cannot create event message object")
 
         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)
+        bt2_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
         )
 
         if ptr is None:
-            raise bt2._MemoryError('cannot create inactivity message object')
+            raise bt2._MemoryError("cannot create inactivity message object")
 
         return bt2_message._MessageIteratorInactivityMessage(ptr)
 
     def _create_stream_beginning_message(self, stream, default_clock_snapshot=None):
-        utils._check_type(stream, bt2_stream._Stream)
+        bt2_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')
+            raise bt2._MemoryError("cannot create stream beginning message object")
 
         msg = bt2_message._StreamBeginningMessage(ptr)
 
@@ -299,11 +310,11 @@ class _UserMessageIterator(_MessageIterator):
         return msg
 
     def _create_stream_end_message(self, stream, default_clock_snapshot=None):
-        utils._check_type(stream, bt2_stream._Stream)
+        bt2_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')
+            raise bt2._MemoryError("cannot create stream end message object")
 
         msg = bt2_message._StreamEndMessage(ptr)
 
@@ -313,7 +324,7 @@ class _UserMessageIterator(_MessageIterator):
         return msg
 
     def _create_packet_beginning_message(self, packet, default_clock_snapshot=None):
-        utils._check_type(packet, bt2_packet._Packet)
+        bt2_utils._check_type(packet, bt2_packet._Packet)
 
         if packet.stream.cls.packets_have_beginning_default_clock_snapshot:
             if default_clock_snapshot is None:
@@ -321,7 +332,7 @@ class _UserMessageIterator(_MessageIterator):
                     "packet beginning messages in this stream must have a default clock snapshot"
                 )
 
-            utils._check_uint64(default_clock_snapshot)
+            bt2_utils._check_uint64(default_clock_snapshot)
             ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot(
                 self._bt_ptr, packet._ptr, default_clock_snapshot
             )
@@ -334,12 +345,12 @@ class _UserMessageIterator(_MessageIterator):
             ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr)
 
         if ptr is None:
-            raise bt2._MemoryError('cannot create packet beginning message object')
+            raise bt2._MemoryError("cannot create packet beginning message object")
 
         return bt2_message._PacketBeginningMessage(ptr)
 
     def _create_packet_end_message(self, packet, default_clock_snapshot=None):
-        utils._check_type(packet, bt2_packet._Packet)
+        bt2_utils._check_type(packet, bt2_packet._Packet)
 
         if packet.stream.cls.packets_have_end_default_clock_snapshot:
             if default_clock_snapshot is None:
@@ -347,7 +358,7 @@ class _UserMessageIterator(_MessageIterator):
                     "packet end messages in this stream must have a default clock snapshot"
                 )
 
-            utils._check_uint64(default_clock_snapshot)
+            bt2_utils._check_uint64(default_clock_snapshot)
             ptr = native_bt.message_packet_end_create_with_default_clock_snapshot(
                 self._bt_ptr, packet._ptr, default_clock_snapshot
             )
@@ -360,39 +371,49 @@ class _UserMessageIterator(_MessageIterator):
             ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr)
 
         if ptr is None:
-            raise bt2._MemoryError('cannot create packet end message object')
+            raise bt2._MemoryError("cannot create packet end message object")
 
         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)
+        bt2_utils._check_type(stream, bt2_stream._Stream)
 
         if not stream.cls.supports_discarded_events:
-            raise ValueError('stream class does not support discarded events')
+            raise ValueError("stream class does not support discarded events")
 
         if stream.cls.discarded_events_have_default_clock_snapshots:
             if beg_clock_snapshot is None or end_clock_snapshot is None:
                 raise ValueError(
-                    'discarded events have default clock snapshots for this stream class'
+                    "discarded events have default clock snapshots for this stream class"
+                )
+
+            bt2_utils._check_uint64(beg_clock_snapshot)
+            bt2_utils._check_uint64(end_clock_snapshot)
+
+            if beg_clock_snapshot > end_clock_snapshot:
+                raise ValueError(
+                    "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format(
+                        beg_clock_snapshot, end_clock_snapshot
+                    )
                 )
 
-            utils._check_uint64(beg_clock_snapshot)
-            utils._check_uint64(end_clock_snapshot)
-            ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots(
-                self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
+            ptr = (
+                native_bt.message_discarded_events_create_with_default_clock_snapshots(
+                    self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
+                )
             )
         else:
             if beg_clock_snapshot is not None or end_clock_snapshot is not None:
                 raise ValueError(
-                    'discarded events have no default clock snapshots for this stream class'
+                    "discarded events have no default clock snapshots for this stream class"
                 )
 
             ptr = native_bt.message_discarded_events_create(self._bt_ptr, stream._ptr)
 
         if ptr is None:
-            raise bt2._MemoryError('cannot discarded events message object')
+            raise bt2._MemoryError("cannot discarded events message object")
 
         msg = bt2_message._DiscardedEventsMessage(ptr)
 
@@ -404,32 +425,42 @@ 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)
+        bt2_utils._check_type(stream, bt2_stream._Stream)
 
         if not stream.cls.supports_discarded_packets:
-            raise ValueError('stream class does not support discarded packets')
+            raise ValueError("stream class does not support discarded packets")
 
         if stream.cls.discarded_packets_have_default_clock_snapshots:
             if beg_clock_snapshot is None or end_clock_snapshot is None:
                 raise ValueError(
-                    'discarded packets have default clock snapshots for this stream class'
+                    "discarded packets have default clock snapshots for this stream class"
+                )
+
+            bt2_utils._check_uint64(beg_clock_snapshot)
+            bt2_utils._check_uint64(end_clock_snapshot)
+
+            if beg_clock_snapshot > end_clock_snapshot:
+                raise ValueError(
+                    "beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})".format(
+                        beg_clock_snapshot, end_clock_snapshot
+                    )
                 )
 
-            utils._check_uint64(beg_clock_snapshot)
-            utils._check_uint64(end_clock_snapshot)
-            ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots(
-                self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
+            ptr = (
+                native_bt.message_discarded_packets_create_with_default_clock_snapshots(
+                    self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot
+                )
             )
         else:
             if beg_clock_snapshot is not None or end_clock_snapshot is not None:
                 raise ValueError(
-                    'discarded packets have no default clock snapshots for this stream class'
+                    "discarded packets have no default clock snapshots for this stream class"
                 )
 
             ptr = native_bt.message_discarded_packets_create(self._bt_ptr, stream._ptr)
 
         if ptr is None:
-            raise bt2._MemoryError('cannot discarded packets message object')
+            raise bt2._MemoryError("cannot discarded packets message object")
 
         msg = bt2_message._DiscardedPacketsMessage(ptr)
 
This page took 0.032052 seconds and 4 git commands to generate.