bt2: make it work for Python 3.4
[babeltrace.git] / src / bindings / python / bt2 / bt2 / stream.py
CommitLineData
81447b5b
PP
1# The MIT License (MIT)
2#
3# Copyright (c) 2016-2017 Philippe Proulx <pproulx@efficios.com>
4#
5# Permission is hereby granted, free of charge, to any person obtaining a copy
6# of this software and associated documentation files (the "Software"), to deal
7# in the Software without restriction, including without limitation the rights
8# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9# copies of the Software, and to permit persons to whom the Software is
10# furnished to do so, subject to the following conditions:
11#
12# The above copyright notice and this permission notice shall be included in
13# all copies or substantial portions of the Software.
14#
15# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21# THE SOFTWARE.
22
a728f6c3 23from bt2 import native_bt, utils
c946c9de
PP
24from bt2 import object as bt2_object
25from bt2 import packet as bt2_packet
c946c9de 26from bt2 import stream_class as bt2_stream_class
b2df5780 27from bt2 import value as bt2_value
81447b5b
PP
28import bt2
29
30
7868a02e
SM
31def _bt2_trace():
32 from bt2 import trace as bt2_trace
33
34 return bt2_trace
35
36
9cbe0c59 37class _StreamConst(bt2_object._SharedObject):
a728f6c3
SM
38 _get_ref = staticmethod(native_bt.stream_get_ref)
39 _put_ref = staticmethod(native_bt.stream_put_ref)
9cbe0c59
FD
40 _borrow_class_ptr = staticmethod(native_bt.stream_borrow_class_const)
41 _borrow_user_attributes_ptr = staticmethod(
42 native_bt.stream_borrow_user_attributes_const
43 )
44 _create_value_from_ptr_and_get_ref = staticmethod(
45 bt2_value._create_from_const_ptr_and_get_ref
46 )
47 _borrow_trace_ptr = staticmethod(native_bt.stream_borrow_trace_const)
48 _stream_class_pycls = bt2_stream_class._StreamClassConst
7868a02e 49 _trace_pycls = property(lambda _: _bt2_trace()._TraceConst)
81447b5b 50
81447b5b 51 @property
c88be1c8 52 def cls(self):
9cbe0c59 53 stream_class_ptr = self._borrow_class_ptr(self._ptr)
a728f6c3 54 assert stream_class_ptr is not None
9cbe0c59 55 return self._stream_class_pycls._create_from_ptr_and_get_ref(stream_class_ptr)
81447b5b
PP
56
57 @property
58 def name(self):
839d52a5 59 return native_bt.stream_get_name(self._ptr)
81447b5b 60
b2df5780
PP
61 @property
62 def user_attributes(self):
9cbe0c59 63 ptr = self._borrow_user_attributes_ptr(self._ptr)
b2df5780 64 assert ptr is not None
9cbe0c59 65 return self._create_value_from_ptr_and_get_ref(ptr)
b2df5780 66
f6a5e476
PP
67 @property
68 def id(self):
839d52a5 69 id = native_bt.stream_get_id(self._ptr)
f6a5e476
PP
70 return id if id >= 0 else None
71
9cbe0c59
FD
72 @property
73 def trace(self):
74 trace_ptr = self._borrow_trace_ptr(self._ptr)
75 assert trace_ptr is not None
76 return self._trace_pycls._create_from_ptr_and_get_ref(trace_ptr)
77
78
79class _Stream(_StreamConst):
80 _borrow_class_ptr = staticmethod(native_bt.stream_borrow_class)
81 _borrow_user_attributes_ptr = staticmethod(native_bt.stream_borrow_user_attributes)
82 _create_value_from_ptr_and_get_ref = staticmethod(
83 bt2_value._create_from_ptr_and_get_ref
84 )
85 _borrow_trace_ptr = staticmethod(native_bt.stream_borrow_trace)
86 _stream_class_pycls = bt2_stream_class._StreamClass
7868a02e 87 _trace_pycls = property(lambda _: _bt2_trace()._Trace)
9cbe0c59 88
81447b5b 89 def create_packet(self):
37a93d41 90 if not self.cls.supports_packets:
3b2be708 91 raise ValueError(
61d96b89
FD
92 'cannot create packet: stream class does not support packets'
93 )
37a93d41 94
839d52a5 95 packet_ptr = native_bt.packet_create(self._ptr)
81447b5b
PP
96
97 if packet_ptr is None:
614743a5 98 raise bt2._MemoryError('cannot create packet object')
81447b5b 99
c946c9de 100 return bt2_packet._Packet._create_from_ptr(packet_ptr)
3c978533 101
9cbe0c59
FD
102 def _user_attributes(self, user_attributes):
103 value = bt2_value.create_value(user_attributes)
104 utils._check_type(value, bt2_value.MapValue)
105 native_bt.stream_set_user_attributes(self._ptr, value._ptr)
106
107 _user_attributes = property(
108 fget=_StreamConst.user_attributes.fget, fset=_user_attributes
109 )
110
111 def _name(self, name):
112 utils._check_str(name)
113 native_bt.stream_set_name(self._ptr, name)
114
115 _name = property(fget=_StreamConst.name.fget, fset=_name)
This page took 0.05118 seconds and 4 git commands to generate.