SetModuleParameters Class Reference

Inheritance diagram for SetModuleParameters:

Collaboration diagram for SetModuleParameters:

Public Member Functions
def	setUp (self)
def	check_parameters (self, module, **params)
def	check_unset (self, module)
def	test_simple (self)
def	test_double (self)
def	test_empty (self)
def	test_missing (self)
def	test_undefined_param (self)
def	test_condition (self)
def	test_condition_recursive (self)
def	test_subevent (self)
def	test_subevent_recursive (self)
def	test_condition_subevent (self)

Public Attributes
	m1
	first test module
	m2
	second test module
	m3
	third test module
	path
	main test path
	subpath
	secondary test path

Detailed Description

Test fixture to check setting of parameters for modules in a path by name

Definition at line 17 of file module_setparameters.py.

Member Function Documentation

check_parameters()

def check_parameters	(		self,
			module,
		**	params
	)

Check if the parameters of a module are set explicitly to a given value

module: basf2.Module instance
params: named parameters of to check for

Definition at line 39 of file module_setparameters.py.

    def check_parameters(self, module, **params):
        """Check if the parameters of a module are set explicitly to a given value
 
        module: basf2.Module instance
        params: named parameters of to check for
        """
        for p in module.available_params():
            if p.name in params:
                self.assertTrue(p.setInSteering)
                self.assertEqual(p.values, params[p.name])
 

check_unset()

def check_unset	(		self,
			module
	)

Check that all parameters of a given module are not set explicitely

Definition at line 50 of file module_setparameters.py.

    def check_unset(self, module):
        """Check that all parameters of a given module are not set explicitely"""
        for p in module.available_params():
            self.assertFalse(p.setInSteering)
 

setUp()

def setUp

(

self

)

Setup a path with a few EventInfoSetter modules with special names

Definition at line 20 of file module_setparameters.py.

    def setUp(self):
        """Setup a path with a few EventInfoSetter modules with special names"""
        
        self.m1 = basf2.register_module("EventInfoSetter")
        self.m1.set_name("evt1")
        
        self.m2 = basf2.register_module("EventInfoSetter")
        self.m2.set_name("evt2")
        
        self.m3 = basf2.register_module("EventInfoSetter")
        self.m3.set_name("evt1")
        
        self.path = basf2.create_path()
        
        self.subpath = basf2.create_path()
        self.path.add_module(self.m1)
        self.path.add_module(self.m2)
        self.subpath.add_module(self.m3)
 

test_condition()

def test_condition

(

self

)

check that modules in a condition sub path are not affected by default

Definition at line 90 of file module_setparameters.py.

    def test_condition(self):
        """check that modules in a condition sub path are not affected by default"""
        self.m2.if_true(self.subpath)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3])
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_unset(self.m3)
 

test_condition_recursive()

def test_condition_recursive

(

self

)

check that modules in a condition sub path are affected in recursive mode

Definition at line 98 of file module_setparameters.py.

    def test_condition_recursive(self):
        """check that modules in a condition sub path are affected in recursive mode"""
        self.m2.if_true(self.subpath)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3], recursive=True)
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_parameters(self.m3, evtNumList=[1, 2, 3])
 

test_condition_subevent()

def test_condition_subevent

(

self

)

check that it also works with a conditions and a for_each sub path in recursive mode

Definition at line 122 of file module_setparameters.py.

    def test_condition_subevent(self):
        """check that it also works with a conditions and a for_each sub path in recursive mode"""
        sub2 = basf2.create_path()
        m4 = sub2.add_module("EventInfoSetter")
        m4.set_name("evt1")
        self.m2.if_true(self.subpath)
        self.path.for_each("foo", "foos", sub2)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3], recursive=True)
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_parameters(self.m3, evtNumList=[1, 2, 3])
        self.check_parameters(m4, evtNumList=[1, 2, 3])
 
 

test_double()

def test_double

(

self

)

Check that it also works if more than one module with the name exists

Definition at line 67 of file module_setparameters.py.

    def test_double(self):
        """Check that it also works if more than one module with the name exists"""
        self.path.add_module(self.m3)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3])
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_parameters(self.m3, evtNumList=[1, 2, 3])
 

test_empty()

def test_empty

(

self

)

Make sure that not supplying any parameters gives a ValueError

Definition at line 75 of file module_setparameters.py.

    def test_empty(self):
        """Make sure that not supplying any parameters gives a ValueError"""
        with self.assertRaises(ValueError):
            basf2.set_module_parameters(self.path, "evt1")
 

test_missing()

def test_missing

(

self

)

Make sure that not finding any module of the given name raises a KeyError

Definition at line 80 of file module_setparameters.py.

    def test_missing(self):
        """Make sure that not finding any module of the given name raises a KeyError"""
        with self.assertRaises(KeyError):
            basf2.set_module_parameters(self.path, "evt3", evtNumList=[0])
 

test_simple()

def test_simple

(

self

)

Check setting the parameters for one module and that it does not affect the other modules

Definition at line 55 of file module_setparameters.py.

    def test_simple(self):
        """Check setting the parameters for one module and that it does not affect the other modules"""
        self.check_unset(self.m1)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3])
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_unset(self.m3)
        basf2.set_module_parameters(self.path, "evt2", evtNumList=[4])
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_parameters(self.m2, evtNumList=[4])
        self.check_unset(self.m3)
 

test_subevent()

def test_subevent

(

self

)

check that modules in a for_each sub path are not affected by default

Definition at line 106 of file module_setparameters.py.

    def test_subevent(self):
        """check that modules in a for_each sub path are not affected by default"""
        self.path.for_each("foo", "foos", self.subpath)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3])
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_unset(self.m3)
 

test_subevent_recursive()

def test_subevent_recursive

(

self

)

check that modules in a for_each sub path are affected in recursive mode

Definition at line 114 of file module_setparameters.py.

    def test_subevent_recursive(self):
        """check that modules in a for_each sub path are affected in recursive mode"""
        self.path.for_each("foo", "foos", self.subpath)
        basf2.set_module_parameters(self.path, "evt1", evtNumList=[1, 2, 3], recursive=True)
        self.check_parameters(self.m1, evtNumList=[1, 2, 3])
        self.check_unset(self.m2)
        self.check_parameters(self.m3, evtNumList=[1, 2, 3])
 

test_undefined_param()

def test_undefined_param

(

self

)

Make sure that being unable to set the parameter raises a RuntimeError

Definition at line 85 of file module_setparameters.py.

    def test_undefined_param(self):
        """Make sure that being unable to set the parameter raises a RuntimeError"""
        with self.assertRaises(RuntimeError):
            basf2.set_module_parameters(self.path, "evt1", foo="bar")
 

Member Data Documentation

m1

m1

first test module

Definition at line 23 of file module_setparameters.py.

m2

m2

second test module

Definition at line 26 of file module_setparameters.py.

m3

m3

third test module

Definition at line 29 of file module_setparameters.py.

path

path

main test path

Definition at line 32 of file module_setparameters.py.

subpath

subpath

secondary test path

Definition at line 34 of file module_setparameters.py.

---

The documentation for this class was generated from the following file:

• framework/tests/module_setparameters.py