tests/bindings/python/bt2/utils.py

   1 #
   2 # Copyright (C) 2019 EfficiOS Inc.
   3 #
   4 # This program is free software; you can redistribute it and/or
   5 # modify it under the terms of the GNU General Public License
   6 # as published by the Free Software Foundation; only version 2
   7 # of the License.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  17 #
  18
  19 import bt2
  20
  21 # Run callable `func` in the context of a component's __init__ method.  The
  22 # callable is passed the Component being instantiated.
  23 #
  24 # The value returned by the callable is returned by run_in_component_init.
  25
  26 def run_in_component_init(func):
  27     class MySink(bt2._UserSinkComponent):
  28         def __init__(self, params):
  29             nonlocal res_bound
  30             res_bound = func(self)
  31
  32         def _consume(self):
  33             pass
  34
  35         def _graph_is_configured(self):
  36             pass
  37
  38     g = bt2.Graph()
  39     res_bound = None
  40     g.add_component(MySink, 'comp')
  41
  42     # We deliberately use a different variable for returning the result than
  43     # the variable bound to the MySink.__init__ context and delete res_bound.
  44     # The MySink.__init__ context stays alive until the end of the program, so
  45     # if res_bound were to still point to our result, it would contribute an
  46     # unexpected reference to the refcount of the result, from the point of view
  47     # of the user of this function.  It would then affect destruction tests,
  48     # for example, which want to test what happens when the refcount of a Python
  49     # object reaches 0.
  50
  51     res = res_bound
  52     del res_bound
  53     return res
  54
  55 # Create an empty trace class with default values.
  56
  57 def get_default_trace_class():
  58     def f(comp_self):
  59         return comp_self._create_trace_class()
  60
  61     return run_in_component_init(f)