X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fstream_class.py;h=885ba746dae01ae37b9db9ae5a0873453fe58804;hb=f5567ea88d172767b34373bc6e402da8bfd85ef8;hp=8a65fac7f8ba92a2c94c500975001ba79d81cf15;hpb=f0a42b33ac3951cd5cb2ee0f66ac04437a681621;p=babeltrace.git diff --git a/src/bindings/python/bt2/bt2/stream_class.py b/src/bindings/python/bt2/bt2/stream_class.py index 8a65fac7..885ba746 100644 --- a/src/bindings/python/bt2/bt2/stream_class.py +++ b/src/bindings/python/bt2/bt2/stream_class.py @@ -1,34 +1,21 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils from bt2 import field_class as bt2_field_class from bt2 import event_class as bt2_event_class -from bt2 import trace_class as bt2_trace_class from bt2 import clock_class as bt2_clock_class from bt2 import value as bt2_value import collections.abc +def _bt2_trace_class(): + from bt2 import trace_class as bt2_trace_class + + return bt2_trace_class + + class _StreamClassConst(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.stream_class_get_ref) _put_ref = staticmethod(native_bt.stream_class_put_ref) @@ -50,9 +37,12 @@ class _StreamClassConst(object._SharedObject, collections.abc.Mapping): _borrow_default_clock_class_ptr = staticmethod( native_bt.stream_class_borrow_default_clock_class_const ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.stream_class_borrow_user_attributes_const + ) _event_class_cls = property(lambda _: bt2_event_class._EventClassConst) - _trace_class_cls = property(lambda _: bt2_trace_class._TraceClassConst) + _trace_class_cls = property(lambda _: _bt2_trace_class()._TraceClassConst) _clock_class_cls = property(lambda _: bt2_clock_class._ClockClassConst) def __getitem__(self, key): @@ -88,7 +78,7 @@ class _StreamClassConst(object._SharedObject, collections.abc.Mapping): @property def user_attributes(self): - ptr = native_bt.stream_class_borrow_user_attributes(self._ptr) + ptr = self._borrow_user_attributes_ptr(self._ptr) assert ptr is not None return bt2_value._create_from_ptr_and_get_ref(ptr) @@ -193,8 +183,12 @@ class _StreamClass(_StreamClassConst): _borrow_default_clock_class_ptr = staticmethod( native_bt.stream_class_borrow_default_clock_class ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.stream_class_borrow_user_attributes + ) + _event_class_cls = property(lambda s: bt2_event_class._EventClass) - _trace_class_cls = property(lambda s: bt2_trace_class._TraceClass) + _trace_class_cls = property(lambda s: _bt2_trace_class()._TraceClass) _clock_class_cls = property(lambda s: bt2_clock_class._ClockClass) def create_event_class( @@ -207,17 +201,27 @@ class _StreamClass(_StreamClassConst): specific_context_field_class=None, payload_field_class=None, ): + # Validate parameters before we create the object. + bt2_event_class._EventClass._validate_create_params( + name, + user_attributes, + log_level, + emf_uri, + specific_context_field_class, + payload_field_class, + ) + if self.assigns_automatic_event_class_id: if id is not None: raise ValueError( - 'id provided, but stream class assigns automatic event class ids' + "id provided, but stream class assigns automatic event class ids" ) ec_ptr = native_bt.event_class_create(self._ptr) else: if id is None: raise ValueError( - 'id not provided, but stream class does not assign automatic event class ids' + "id not provided, but stream class does not assign automatic event class ids" ) utils._check_uint64(id) @@ -247,60 +251,32 @@ class _StreamClass(_StreamClassConst): def _user_attributes(self, user_attributes): value = bt2_value.create_value(user_attributes) - utils._check_type(value, bt2_value.MapValue) native_bt.stream_class_set_user_attributes(self._ptr, value._ptr) _user_attributes = property(fset=_user_attributes) def _name(self, name): - utils._check_str(name) status = native_bt.stream_class_set_name(self._ptr, name) utils._handle_func_status(status, "cannot set stream class object's name") _name = property(fset=_name) def _assigns_automatic_event_class_id(self, auto_id): - utils._check_bool(auto_id) - return native_bt.stream_class_set_assigns_automatic_event_class_id( - self._ptr, auto_id - ) + native_bt.stream_class_set_assigns_automatic_event_class_id(self._ptr, auto_id) _assigns_automatic_event_class_id = property(fset=_assigns_automatic_event_class_id) def _assigns_automatic_stream_id(self, auto_id): - utils._check_bool(auto_id) - return native_bt.stream_class_set_assigns_automatic_stream_id( - self._ptr, auto_id - ) + native_bt.stream_class_set_assigns_automatic_stream_id(self._ptr, auto_id) _assigns_automatic_stream_id = property(fset=_assigns_automatic_stream_id) def _set_supports_packets(self, supports, with_begin_cs=False, with_end_cs=False): - utils._check_bool(supports) - utils._check_bool(with_begin_cs) - utils._check_bool(with_end_cs) - - if not supports and (with_begin_cs or with_end_cs): - raise ValueError( - 'cannot not support packets, but have default clock snapshots' - ) - - if not supports and self.packet_context_field_class is not None: - raise ValueError('stream class already has a packet context field class') - native_bt.stream_class_set_supports_packets( self._ptr, supports, with_begin_cs, with_end_cs ) def _set_supports_discarded_events(self, supports, with_cs=False): - utils._check_bool(supports) - utils._check_bool(with_cs) - - if not supports and with_cs: - raise ValueError( - 'cannot not support discarded events, but have default clock snapshots' - ) - native_bt.stream_class_set_supports_discarded_events( self._ptr, supports, with_cs ) @@ -308,19 +284,6 @@ class _StreamClass(_StreamClassConst): _supports_discarded_events = property(fset=_set_supports_discarded_events) def _set_supports_discarded_packets(self, supports, with_cs): - utils._check_bool(supports) - utils._check_bool(with_cs) - - if supports and not self.supports_packets: - raise ValueError( - 'cannot support discarded packets, but not support packets' - ) - - if not supports and with_cs: - raise ValueError( - 'cannot not support discarded packets, but have default clock snapshots' - ) - native_bt.stream_class_set_supports_discarded_packets( self._ptr, supports, with_cs ) @@ -328,39 +291,129 @@ class _StreamClass(_StreamClassConst): _supports_discarded_packets = property(fset=_set_supports_discarded_packets) def _packet_context_field_class(self, packet_context_field_class): + status = native_bt.stream_class_set_packet_context_field_class( + self._ptr, packet_context_field_class._ptr + ) + utils._handle_func_status( + status, "cannot set stream class' packet context field class" + ) + + _packet_context_field_class = property(fset=_packet_context_field_class) + + def _event_common_context_field_class(self, event_common_context_field_class): + set_context_fn = native_bt.stream_class_set_event_common_context_field_class + status = set_context_fn(self._ptr, event_common_context_field_class._ptr) + utils._handle_func_status( + status, "cannot set stream class' event context field type" + ) + + _event_common_context_field_class = property(fset=_event_common_context_field_class) + + def _default_clock_class(self, clock_class): + native_bt.stream_class_set_default_clock_class(self._ptr, clock_class._ptr) + + _default_clock_class = property(fset=_default_clock_class) + + @classmethod + def _validate_create_params( + cls, + name, + user_attributes, + packet_context_field_class, + event_common_context_field_class, + default_clock_class, + assigns_automatic_event_class_id, + assigns_automatic_stream_id, + supports_packets, + packets_have_beginning_default_clock_snapshot, + packets_have_end_default_clock_snapshot, + supports_discarded_events, + discarded_events_have_default_clock_snapshots, + supports_discarded_packets, + discarded_packets_have_default_clock_snapshots, + ): + # Name + if name is not None: + utils._check_str(name) + + # User attributes + if user_attributes is not None: + value = bt2_value.create_value(user_attributes) + utils._check_type(value, bt2_value.MapValue) + + # Packet context field class if packet_context_field_class is not None: + if not supports_packets: + raise ValueError( + "cannot have a packet context field class without supporting packets" + ) + utils._check_type( packet_context_field_class, bt2_field_class._StructureFieldClass ) - if not self.supports_packets: - raise ValueError('stream class does not support packets') - - status = native_bt.stream_class_set_packet_context_field_class( - self._ptr, packet_context_field_class._ptr - ) - utils._handle_func_status( - status, "cannot set stream class' packet context field class" - ) - - _packet_context_field_class = property(fset=_packet_context_field_class) - - def _event_common_context_field_class(self, event_common_context_field_class): + # Event common context field class if event_common_context_field_class is not None: utils._check_type( event_common_context_field_class, bt2_field_class._StructureFieldClass ) - set_context_fn = native_bt.stream_class_set_event_common_context_field_class - status = set_context_fn(self._ptr, event_common_context_field_class._ptr) - utils._handle_func_status( - status, "cannot set stream class' event context field type" - ) + # Default clock class + if default_clock_class is not None: + utils._check_type(default_clock_class, bt2_clock_class._ClockClass) - _event_common_context_field_class = property(fset=_event_common_context_field_class) + # Assigns automatic event class id + utils._check_bool(assigns_automatic_event_class_id) - def _default_clock_class(self, clock_class): - utils._check_type(clock_class, bt2_clock_class._ClockClass) - native_bt.stream_class_set_default_clock_class(self._ptr, clock_class._ptr) + # Assigns automatic stream id + utils._check_bool(assigns_automatic_stream_id) - _default_clock_class = property(fset=_default_clock_class) + # Packets + utils._check_bool(supports_packets) + utils._check_bool(packets_have_beginning_default_clock_snapshot) + utils._check_bool(packets_have_end_default_clock_snapshot) + + if not supports_packets: + if packets_have_beginning_default_clock_snapshot: + raise ValueError( + "cannot not support packets, but have packet beginning default clock snapshot" + ) + if packets_have_end_default_clock_snapshot: + raise ValueError( + "cannot not support packets, but have packet end default clock snapshots" + ) + + # Discarded events + utils._check_bool(supports_discarded_events) + utils._check_bool(discarded_events_have_default_clock_snapshots) + + if discarded_events_have_default_clock_snapshots: + if not supports_discarded_events: + raise ValueError( + "cannot not support discarded events, but have default clock snapshots for discarded event messages" + ) + + if default_clock_class is None: + raise ValueError( + "cannot have no default clock class, but have default clock snapshots for discarded event messages" + ) + + # Discarded packets + utils._check_bool(supports_discarded_packets) + utils._check_bool(discarded_packets_have_default_clock_snapshots) + + if supports_discarded_packets and not supports_packets: + raise ValueError( + "cannot support discarded packets, but not support packets" + ) + + if discarded_packets_have_default_clock_snapshots: + if not supports_discarded_packets: + raise ValueError( + "cannot not support discarded packets, but have default clock snapshots for discarded packet messages" + ) + + if default_clock_class is None: + raise ValueError( + "cannot have no default clock class, but have default clock snapshots for discarded packet messages" + )