From 2c6f8520ad68e1ca0c9554d705c39790e7d3ef5f Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Thu, 6 Jun 2019 18:32:03 -0400 Subject: [PATCH] bt2: prepend `_` prefix to names of classes that the user cannot create Signed-off-by: Philippe Proulx Change-Id: Icf47793836daede471372be16fb278884eb54f38 Reviewed-on: https://review.lttng.org/c/babeltrace/+/1393 Reviewed-by: Simon Marchi --- bindings/python/bt2/bt2/component.py | 2 +- bindings/python/bt2/bt2/event.py | 3 ++- bindings/python/bt2/bt2/event_class.py | 4 ++-- bindings/python/bt2/bt2/message_iterator.py | 2 +- bindings/python/bt2/bt2/stream.py | 2 +- bindings/python/bt2/bt2/stream_class.py | 9 +++++---- bindings/python/bt2/bt2/trace.py | 6 +++--- bindings/python/bt2/bt2/trace_class.py | 13 +++++++------ tests/bindings/python/bt2/test_trace_class.py | 2 +- 9 files changed, 23 insertions(+), 20 deletions(-) diff --git a/bindings/python/bt2/bt2/component.py b/bindings/python/bt2/bt2/component.py index e26acf61..5889e8ab 100644 --- a/bindings/python/bt2/bt2/component.py +++ b/bindings/python/bt2/bt2/component.py @@ -639,7 +639,7 @@ class _UserComponent(metaclass=_UserComponentType): if tc_ptr is None: raise bt2.CreationError('could not create trace class') - tc = bt2.TraceClass._create_from_ptr(tc_ptr) + tc = bt2._TraceClass._create_from_ptr(tc_ptr) if env is not None: for key, value in env.items(): diff --git a/bindings/python/bt2/bt2/event.py b/bindings/python/bt2/bt2/event.py index 442ab2b8..66882bdf 100644 --- a/bindings/python/bt2/bt2/event.py +++ b/bindings/python/bt2/bt2/event.py @@ -22,6 +22,7 @@ from bt2 import native_bt, object, utils import bt2.clock_class +import bt2.event_class import bt2.packet import bt2.stream import bt2.field @@ -34,7 +35,7 @@ class _Event(object._UniqueObject): def event_class(self): event_class_ptr = native_bt.event_borrow_class(self._ptr) assert event_class_ptr is not None - return bt2.EventClass._create_from_ptr_and_get_ref(event_class_ptr) + return bt2.event_class._EventClass._create_from_ptr_and_get_ref(event_class_ptr) @property def name(self): diff --git a/bindings/python/bt2/bt2/event_class.py b/bindings/python/bt2/bt2/event_class.py index d63c9347..d3141b86 100644 --- a/bindings/python/bt2/bt2/event_class.py +++ b/bindings/python/bt2/bt2/event_class.py @@ -45,7 +45,7 @@ class EventClassLogLevel: DEBUG = native_bt.EVENT_CLASS_LOG_LEVEL_DEBUG -class EventClass(object._SharedObject): +class _EventClass(object._SharedObject): _get_ref = staticmethod(native_bt.event_class_get_ref) _put_ref = staticmethod(native_bt.event_class_put_ref) @@ -54,7 +54,7 @@ class EventClass(object._SharedObject): sc_ptr = native_bt.event_class_borrow_stream_class(self._ptr) if sc_ptr is not None: - return bt2.stream_class.StreamClass._create_from_ptr_and_get_ref(sc_ptr) + return bt2.stream_class._StreamClass._create_from_ptr_and_get_ref(sc_ptr) @property def name(self): diff --git a/bindings/python/bt2/bt2/message_iterator.py b/bindings/python/bt2/bt2/message_iterator.py index 26ec4091..dd5da109 100644 --- a/bindings/python/bt2/bt2/message_iterator.py +++ b/bindings/python/bt2/bt2/message_iterator.py @@ -150,7 +150,7 @@ class _UserMessageIterator(_MessageIterator): 'stream class has no default clock class, default_clock_snapshot should be None') def _create_event_message(self, event_class, packet, default_clock_snapshot=None): - utils._check_type(event_class, bt2.event_class.EventClass) + utils._check_type(event_class, bt2.event_class._EventClass) utils._check_type(packet, bt2.packet._Packet) self._validate_default_clock_snapshot(packet.stream.stream_class, default_clock_snapshot) diff --git a/bindings/python/bt2/bt2/stream.py b/bindings/python/bt2/bt2/stream.py index 3798ec6a..df304925 100644 --- a/bindings/python/bt2/bt2/stream.py +++ b/bindings/python/bt2/bt2/stream.py @@ -34,7 +34,7 @@ class _Stream(bt2.object._SharedObject): def stream_class(self): stream_class_ptr = native_bt.stream_borrow_class(self._ptr) assert stream_class_ptr is not None - return bt2.stream_class.StreamClass._create_from_ptr_and_get_ref(stream_class_ptr) + return bt2.stream_class._StreamClass._create_from_ptr_and_get_ref(stream_class_ptr) @property def name(self): diff --git a/bindings/python/bt2/bt2/stream_class.py b/bindings/python/bt2/bt2/stream_class.py index 684b952b..54b5b38b 100644 --- a/bindings/python/bt2/bt2/stream_class.py +++ b/bindings/python/bt2/bt2/stream_class.py @@ -22,12 +22,13 @@ from bt2 import native_bt, object, utils import bt2.field_class +import bt2.event_class import collections.abc import bt2.stream import bt2 -class StreamClass(object._SharedObject, collections.abc.Mapping): +class _StreamClass(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.stream_class_get_ref) _put_ref = staticmethod(native_bt.stream_class_put_ref) @@ -38,7 +39,7 @@ class StreamClass(object._SharedObject, collections.abc.Mapping): if ec_ptr is None: raise KeyError(key) - return bt2.EventClass._create_from_ptr_and_get_ref(ec_ptr) + return bt2.event_class._EventClass._create_from_ptr_and_get_ref(ec_ptr) def __len__(self): count = native_bt.stream_class_get_event_class_count(self._ptr) @@ -70,7 +71,7 @@ class StreamClass(object._SharedObject, collections.abc.Mapping): utils._check_uint64(id) ec_ptr = native_bt.event_class_create_with_id(self._ptr, id) - event_class = bt2.event_class.EventClass._create_from_ptr(ec_ptr) + event_class = bt2.event_class._EventClass._create_from_ptr(ec_ptr) if name is not None: event_class._name = name @@ -94,7 +95,7 @@ class StreamClass(object._SharedObject, collections.abc.Mapping): tc_ptr = native_bt.stream_class_borrow_trace_class_const(self._ptr) if tc_ptr is not None: - return bt2.TraceClass._create_from_ptr_and_get_ref(tc_ptr) + return bt2._TraceClass._create_from_ptr_and_get_ref(tc_ptr) @property def name(self): diff --git a/bindings/python/bt2/bt2/trace.py b/bindings/python/bt2/bt2/trace.py index ba7b89d8..47dab8f7 100644 --- a/bindings/python/bt2/bt2/trace.py +++ b/bindings/python/bt2/bt2/trace.py @@ -30,11 +30,11 @@ import functools def _trace_destruction_listener_from_native(user_listener, trace_ptr): - trace = bt2.trace.Trace._create_from_ptr_and_get_ref(trace_ptr) + trace = bt2.trace._Trace._create_from_ptr_and_get_ref(trace_ptr) user_listener(trace) -class Trace(object._SharedObject, collections.abc.Mapping): +class _Trace(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.trace_get_ref) _put_ref = staticmethod(native_bt.trace_put_ref) @@ -75,7 +75,7 @@ class Trace(object._SharedObject, collections.abc.Mapping): _name = property(fset=_name) def create_stream(self, stream_class, id=None, name=None): - utils._check_type(stream_class, bt2.stream_class.StreamClass) + utils._check_type(stream_class, bt2.stream_class._StreamClass) if stream_class.assigns_automatic_stream_id: if id is not None: diff --git a/bindings/python/bt2/bt2/trace_class.py b/bindings/python/bt2/bt2/trace_class.py index 40783b41..5713db8c 100644 --- a/bindings/python/bt2/bt2/trace_class.py +++ b/bindings/python/bt2/bt2/trace_class.py @@ -22,10 +22,11 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. -__all__ = ['TraceClass'] +__all__ = ['_TraceClass'] import bt2 from bt2 import native_bt, utils, object +import bt2.stream_class import uuid as uuidp import collections.abc import functools @@ -95,11 +96,11 @@ class _StreamClassIterator(collections.abc.Iterator): def _trace_class_destruction_listener_from_native(user_listener, trace_class_ptr): - trace_class = bt2.trace_class.TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) + trace_class = bt2.trace_class._TraceClass._create_from_ptr_and_get_ref(trace_class_ptr) user_listener(trace_class) -class TraceClass(object._SharedObject, collections.abc.Mapping): +class _TraceClass(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.trace_class_get_ref) _put_ref = staticmethod(native_bt.trace_class_put_ref) @@ -125,7 +126,7 @@ class TraceClass(object._SharedObject, collections.abc.Mapping): if trace_ptr is None: raise bt2.CreationError('cannot create trace class object') - trace = bt2.trace.Trace._create_from_ptr(trace_ptr) + trace = bt2.trace._Trace._create_from_ptr(trace_ptr) if name is not None: trace._name = name @@ -148,7 +149,7 @@ class TraceClass(object._SharedObject, collections.abc.Mapping): if sc_ptr is None: raise KeyError(key) - return bt2.StreamClass._create_from_ptr_and_get_ref(sc_ptr) + return bt2.stream_class._StreamClass._create_from_ptr_and_get_ref(sc_ptr) def __iter__(self): for idx in range(len(self)): @@ -190,7 +191,7 @@ class TraceClass(object._SharedObject, collections.abc.Mapping): utils._check_uint64(id) sc_ptr = native_bt.stream_class_create_with_id(self._ptr, id) - sc = bt2.stream_class.StreamClass._create_from_ptr(sc_ptr) + sc = bt2.stream_class._StreamClass._create_from_ptr(sc_ptr) if name is not None: sc._name = name diff --git a/tests/bindings/python/bt2/test_trace_class.py b/tests/bindings/python/bt2/test_trace_class.py index 4f19b4a2..b36dafa1 100644 --- a/tests/bindings/python/bt2/test_trace_class.py +++ b/tests/bindings/python/bt2/test_trace_class.py @@ -122,7 +122,7 @@ class TraceClassTestCase(unittest.TestCase): tc, sc1, sc2, sc3 = self._create_trace_class_with_some_stream_classes() for sc_id, stream_class in tc.items(): - self.assertIsInstance(stream_class, bt2.stream_class.StreamClass) + self.assertIsInstance(stream_class, bt2.stream_class._StreamClass) if sc_id == 12: self.assertEqual(stream_class.addr, sc1.addr) -- 2.34.1