src/bindings/python/bt2/bt2/__init__.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 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
  23 import sys
  24
  25 # import all public names
  26 from bt2.clock_class import ClockClassOffset
  27 from bt2.clock_snapshot import _ClockSnapshotConst
  28 from bt2.clock_snapshot import _UnknownClockSnapshot
  29 from bt2.component import _SourceComponentClassConst
  30 from bt2.component import _FilterComponentClassConst
  31 from bt2.component import _SinkComponentClassConst
  32 from bt2.component import _SourceComponentConst
  33 from bt2.component import _FilterComponentConst
  34 from bt2.component import _SinkComponentConst
  35 from bt2.component import _UserSourceComponent
  36 from bt2.component import _UserFilterComponent
  37 from bt2.component import _UserSinkComponent
  38 from bt2.component_descriptor import ComponentDescriptor
  39 from bt2.error import ComponentClassType
  40 from bt2.error import _ErrorCause
  41 from bt2.error import _ComponentErrorCause
  42 from bt2.error import _ComponentClassErrorCause
  43 from bt2.error import _MessageIteratorErrorCause
  44 from bt2.error import _Error
  45 from bt2.event_class import EventClassLogLevel
  46 from bt2.field import _BoolField
  47 from bt2.field import _BitArrayField
  48 from bt2.field import _IntegerField
  49 from bt2.field import _UnsignedIntegerField
  50 from bt2.field import _SignedIntegerField
  51 from bt2.field import _RealField
  52 from bt2.field import _EnumerationField
  53 from bt2.field import _UnsignedEnumerationField
  54 from bt2.field import _SignedEnumerationField
  55 from bt2.field import _StringField
  56 from bt2.field import _StructureField
  57 from bt2.field import _OptionField
  58 from bt2.field import _VariantField
  59 from bt2.field import _ArrayField
  60 from bt2.field import _StaticArrayField
  61 from bt2.field import _DynamicArrayField
  62 from bt2.field import _BoolFieldConst
  63 from bt2.field import _BitArrayFieldConst
  64 from bt2.field import _IntegerFieldConst
  65 from bt2.field import _UnsignedIntegerFieldConst
  66 from bt2.field import _SignedIntegerFieldConst
  67 from bt2.field import _RealFieldConst
  68 from bt2.field import _EnumerationFieldConst
  69 from bt2.field import _UnsignedEnumerationFieldConst
  70 from bt2.field import _SignedEnumerationFieldConst
  71 from bt2.field import _StringFieldConst
  72 from bt2.field import _StructureFieldConst
  73 from bt2.field import _OptionFieldConst
  74 from bt2.field import _VariantFieldConst
  75 from bt2.field import _ArrayFieldConst
  76 from bt2.field import _StaticArrayFieldConst
  77 from bt2.field import _DynamicArrayFieldConst
  78 from bt2.field_class import IntegerDisplayBase
  79 from bt2.field_class import _BoolFieldClass
  80 from bt2.field_class import _BitArrayFieldClass
  81 from bt2.field_class import _IntegerFieldClass
  82 from bt2.field_class import _UnsignedIntegerFieldClass
  83 from bt2.field_class import _SignedIntegerFieldClass
  84 from bt2.field_class import _RealFieldClass
  85 from bt2.field_class import _EnumerationFieldClass
  86 from bt2.field_class import _UnsignedEnumerationFieldClass
  87 from bt2.field_class import _SignedEnumerationFieldClass
  88 from bt2.field_class import _StringFieldClass
  89 from bt2.field_class import _StructureFieldClass
  90 from bt2.field_class import _OptionFieldClass
  91 from bt2.field_class import _VariantFieldClass
  92 from bt2.field_class import _VariantFieldClassWithoutSelector
  93 from bt2.field_class import _VariantFieldClassWithSelector
  94 from bt2.field_class import _VariantFieldClassWithUnsignedSelector
  95 from bt2.field_class import _VariantFieldClassWithSignedSelector
  96 from bt2.field_class import _ArrayFieldClass
  97 from bt2.field_class import _StaticArrayFieldClass
  98 from bt2.field_class import _DynamicArrayFieldClass
  99 from bt2.field_class import _BoolFieldClassConst
 100 from bt2.field_class import _BitArrayFieldClassConst
 101 from bt2.field_class import _IntegerFieldClassConst
 102 from bt2.field_class import _UnsignedIntegerFieldClassConst
 103 from bt2.field_class import _SignedIntegerFieldClassConst
 104 from bt2.field_class import _RealFieldClassConst
 105 from bt2.field_class import _EnumerationFieldClassConst
 106 from bt2.field_class import _UnsignedEnumerationFieldClassConst
 107 from bt2.field_class import _SignedEnumerationFieldClassConst
 108 from bt2.field_class import _StringFieldClassConst
 109 from bt2.field_class import _StructureFieldClassConst
 110 from bt2.field_class import _OptionFieldClassConst
 111 from bt2.field_class import _VariantFieldClassConst
 112 from bt2.field_class import _VariantFieldClassWithoutSelectorConst
 113 from bt2.field_class import _VariantFieldClassWithSelectorConst
 114 from bt2.field_class import _VariantFieldClassWithUnsignedSelectorConst
 115 from bt2.field_class import _VariantFieldClassWithSignedSelectorConst
 116 from bt2.field_class import _ArrayFieldClassConst
 117 from bt2.field_class import _StaticArrayFieldClassConst
 118 from bt2.field_class import _DynamicArrayFieldClassConst
 119 from bt2.field_path import FieldPathScope
 120 from bt2.field_path import _IndexFieldPathItem
 121 from bt2.field_path import _CurrentArrayElementFieldPathItem
 122 from bt2.field_path import _CurrentOptionContentFieldPathItem
 123 from bt2.graph import Graph
 124 from bt2.integer_range_set import SignedIntegerRange
 125 from bt2.integer_range_set import UnsignedIntegerRange
 126 from bt2.integer_range_set import SignedIntegerRangeSet
 127 from bt2.integer_range_set import UnsignedIntegerRangeSet
 128 from bt2.interrupter import Interrupter
 129 from bt2.logging import LoggingLevel
 130 from bt2.logging import get_minimal_logging_level
 131 from bt2.logging import get_global_logging_level
 132 from bt2.logging import set_global_logging_level
 133 from bt2.message import _EventMessage
 134 from bt2.message import _PacketBeginningMessage
 135 from bt2.message import _PacketEndMessage
 136 from bt2.message import _StreamBeginningMessage
 137 from bt2.message import _StreamEndMessage
 138 from bt2.message import _MessageIteratorInactivityMessage
 139 from bt2.message import _DiscardedEventsMessage
 140 from bt2.message import _DiscardedPacketsMessage
 141 from bt2.message import _EventMessageConst
 142 from bt2.message import _PacketBeginningMessageConst
 143 from bt2.message import _PacketEndMessageConst
 144 from bt2.message import _StreamBeginningMessageConst
 145 from bt2.message import _StreamEndMessageConst
 146 from bt2.message import _MessageIteratorInactivityMessageConst
 147 from bt2.message import _DiscardedEventsMessageConst
 148 from bt2.message import _DiscardedPacketsMessageConst
 149 from bt2.message_iterator import _UserMessageIterator
 150 from bt2.mip import get_greatest_operative_mip_version
 151 from bt2.mip import get_maximal_mip_version
 152 from bt2.plugin import find_plugins_in_path
 153 from bt2.plugin import find_plugins
 154 from bt2.plugin import find_plugin
 155 from bt2.py_plugin import plugin_component_class
 156 from bt2.py_plugin import register_plugin
 157 from bt2.query_executor import QueryExecutor
 158 from bt2.trace_collection_message_iterator import AutoSourceComponentSpec
 159 from bt2.trace_collection_message_iterator import ComponentSpec
 160 from bt2.trace_collection_message_iterator import TraceCollectionMessageIterator
 161 from bt2.value import create_value
 162 from bt2.value import BoolValue
 163 from bt2.value import _IntegerValue
 164 from bt2.value import UnsignedIntegerValue
 165 from bt2.value import SignedIntegerValue
 166 from bt2.value import RealValue
 167 from bt2.value import StringValue
 168 from bt2.value import ArrayValue
 169 from bt2.value import MapValue
 170 from bt2.value import _BoolValueConst
 171 from bt2.value import _IntegerValueConst
 172 from bt2.value import _UnsignedIntegerValueConst
 173 from bt2.value import _SignedIntegerValueConst
 174 from bt2.value import _RealValueConst
 175 from bt2.value import _StringValueConst
 176 from bt2.value import _ArrayValueConst
 177 from bt2.value import _MapValueConst
 178 from bt2.version import __version__
 179
 180 if (sys.version_info.major, sys.version_info.minor) != (3, 4):
 181
 182     def _del_global_name(name):
 183         if name in globals():
 184             del globals()[name]
 185
 186     # remove private module names from the package
 187     _del_global_name('_native_bt')
 188     _del_global_name('clock_class')
 189     _del_global_name('clock_snapshot')
 190     _del_global_name('component')
 191     _del_global_name('connection')
 192     _del_global_name('error')
 193     _del_global_name('event')
 194     _del_global_name('event_class')
 195     _del_global_name('field')
 196     _del_global_name('field_class')
 197     _del_global_name('field_path')
 198     _del_global_name('graph')
 199     _del_global_name('integer_range_set')
 200     _del_global_name('interrupter')
 201     _del_global_name('logging')
 202     _del_global_name('message')
 203     _del_global_name('message_iterator')
 204     _del_global_name('native_bt')
 205     _del_global_name('object')
 206     _del_global_name('packet')
 207     _del_global_name('plugin')
 208     _del_global_name('port')
 209     _del_global_name('py_plugin')
 210     _del_global_name('query_executor')
 211     _del_global_name('stream')
 212     _del_global_name('stream_class')
 213     _del_global_name('trace')
 214     _del_global_name('trace_class')
 215     _del_global_name('trace_collection_message_iterator')
 216     _del_global_name('utils')
 217     _del_global_name('value')
 218     _del_global_name('version')
 219
 220     # remove private `_del_global_name` name from the package
 221     del _del_global_name
 222
 223
 224 # remove sys module name from the package
 225 del sys
 226
 227
 228 class _MemoryError(_Error):
 229     '''Raised when an operation fails due to memory issues.'''
 230
 231
 232 class UnknownObject(Exception):
 233     '''
 234     Raised when a component class handles a query for an object it doesn't
 235     know about.
 236     '''
 237
 238     pass
 239
 240
 241 class _OverflowError(_Error, OverflowError):
 242     pass
 243
 244
 245 class TryAgain(Exception):
 246     pass
 247
 248
 249 class Stop(StopIteration):
 250     pass
 251
 252
 253 class _IncompleteUserClass(Exception):
 254     pass
 255
 256
 257 def _init_and_register_exit():
 258     from bt2 import native_bt
 259     import atexit
 260
 261     atexit.register(native_bt.bt2_exit_handler)
 262     native_bt.bt2_init_from_bt2()
 263
 264
 265 _init_and_register_exit()
 266
 267 # remove private `_init_and_register_exit` name from the package
 268 del _init_and_register_exit