python.TrigValSteering.PyStep.PyStep Class Reference

Inheritance diagram for python.TrigValSteering.PyStep.PyStep:

Collaboration diagram for python.TrigValSteering.PyStep.PyStep:

Public Member Functions
def	__init__ (self, func, **kwargs)
def	run (self, dry_run=False)

Public Attributes
	func
	func_kwargs
	output_stream
	result

Detailed Description

Step calling a python function

Definition at line 13 of file PyStep.py.

Constructor & Destructor Documentation

__init__()

def python.TrigValSteering.PyStep.PyStep.__init__	(		self,
			func,
		**	kwargs
	)

Definition at line 16 of file PyStep.py.

   def __init__(self, func, **kwargs):
      name = kwargs.get('name') or func.__name__
      super(PyStep, self).__init__(name)
      self.func = func
      self.func_kwargs = dict([(k,v) for k,v in kwargs.items() if k != 'name'])
      self.output_stream = Step.OutputStream.STDOUT_ONLY
 

Member Function Documentation

run()

def python.TrigValSteering.PyStep.PyStep.run	(		self,
			dry_run = False
	)

Definition at line 23 of file PyStep.py.

   def run(self, dry_run=False):
 
      self.log.info('Running %s step', self.name)
 
      dest = sys.stdout
      if self.output_stream == self.OutputStream.NO_PRINT:
         dest = None
      elif self.output_stream in [self.OutputStream.FILE_ONLY, self.OutputStream.FILE_AND_STDOUT]:
         dest = open(self.get_log_file_name(), 'w')
 
      if dry_run:
         self.result = 0
      else:
         try:
            with contextlib.redirect_stdout(dest), contextlib.redirect_stderr(dest):
               self.result = self.func(**self.func_kwargs)
 
            # Poor man's implementation of 'tee'
            if self.output_stream == self.OutputStream.FILE_AND_STDOUT:
               dest.close()
               print(open(dest.name).read())
 
            # In case function does not return a value, assume success
            if self.result is None:
               self.result = 0
         except Exception as e:
            self.log.error('Exception calling %s: %s', self.func.__name__, e)
            self.result = 1
 
      return self.result, f'# (internal) {self.func.__name__}'

Member Data Documentation

func

python.TrigValSteering.PyStep.PyStep.func

Definition at line 19 of file PyStep.py.

func_kwargs

python.TrigValSteering.PyStep.PyStep.func_kwargs

Definition at line 20 of file PyStep.py.

output_stream

python.TrigValSteering.PyStep.PyStep.output_stream

Definition at line 21 of file PyStep.py.

result

python.TrigValSteering.PyStep.PyStep.result

Definition at line 34 of file PyStep.py.

---

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

• PyStep.py