python.TrigValSteering.CheckSteps.InputDependentStep Class Reference

Inheritance diagram for python.TrigValSteering.CheckSteps.InputDependentStep:

Collaboration diagram for python.TrigValSteering.CheckSteps.InputDependentStep:

Public Member Functions
	__init__ (self, name=None)
	run (self, dry_run=False)

Public Attributes
	input_file = None
	name
int	result = 1
	auto_report_result

Detailed Description

Base class for steps executed only if the input file exists

Definition at line 96 of file CheckSteps.py.

Constructor & Destructor Documentation

__init__()

python.TrigValSteering.CheckSteps.InputDependentStep.__init__	(		self,
			name = None )

Definition at line 99 of file CheckSteps.py.

    def __init__(self, name=None):
        super(InputDependentStep, self).__init__(name)
        self.input_file = None
 

Member Function Documentation

run()

python.TrigValSteering.CheckSteps.InputDependentStep.run	(		self,
			dry_run = False )

Reimplemented in python.TrigValSteering.CheckSteps.CheckFileStep.

Definition at line 103 of file CheckSteps.py.

    def run(self, dry_run=False):
        if self.input_file is None:
            self.log.error('%s misconfiguration - no input file specified',
                           self.name)
            self.result = 1
            if self.auto_report_result:
                self.report_result()
            return self.result, '# (internal) {} -> failed'.format(self.name)
 
        if not dry_run and not os.path.isfile(self.input_file):
            self.log.debug('Skipping %s because %s does not exist',
                           self.name, self.input_file)
            self.result = 0
            return self.result, '# (internal) {} -> skipped'.format(self.name)
 
        return super(InputDependentStep, self).run(dry_run)
 
 

Member Data Documentation

auto_report_result

python.TrigValSteering.CheckSteps.InputDependentStep.auto_report_result

Definition at line 108 of file CheckSteps.py.

input_file

python.TrigValSteering.CheckSteps.InputDependentStep.input_file = None

Definition at line 101 of file CheckSteps.py.

name

python.TrigValSteering.CheckSteps.InputDependentStep.name

Definition at line 106 of file CheckSteps.py.

result

python.TrigValSteering.CheckSteps.InputDependentStep.result = 1

Definition at line 107 of file CheckSteps.py.

---

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

• CheckSteps.py