Basf2CalculationProcess Class Reference

Inheritance diagram for Basf2CalculationProcess:

Public Member Functions
	__init__ (self, result_queue, log_file_name, parameters, path, random_seed=None, max_event=0)
	prepare (self)
	initialize_output (self)
	start_process (self)
	save_log (self)
	get_log (self)
	get (self, name)
	get_keys (self)

Public Attributes
	random_seed = random_seed
	Random seed to set.
	path = path
	Path to process.
	max_event = max_event
	The maximum number of events to process.
bool	already_run = False
	True if already started/run.
	log_file_name = log_file_name
	Name of the log file to use.
	log_file_content = None
	Saved log file content after the run.
	result_queue = result_queue
	Result queue as a reference.
	parameters = parameters
	Parameters in process_parameter_space.
	progress_queue_local
	Create the queue for the progress python module.
	progress_queue_remote = Pipe()
	Create the queue for the progress python module.
bool	is_valid = True
	Set to false, if you do not want this process to show up in the process bar calculations.

Detailed Description

Overload implementation of the HEPProcess with the correct handling of the path calculation.

Definition at line 17 of file calculation_process.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			result_queue,
			log_file_name,
			parameters,
			path,
			random_seed = None,
			max_event = 0 )

Create a new basf2 calculation process.

Definition at line 23 of file calculation_process.py.

    def __init__(self, result_queue, log_file_name, parameters, path, random_seed=None, max_event=0):
        """Create a new basf2 calculation process."""
        
        self.random_seed = random_seed
        
        self.path = path
        
        self.max_event = max_event
 
        super().__init__(result_queue=result_queue, log_file_name=log_file_name,
                         parameters=parameters)
 

Member Function Documentation

get()

get ( self, name )

inherited

Return an item from the result queue. Only gives a result if the calculation has finished.
Use the Calculation for a better handling.

Definition at line 76 of file calculation_process.py.

    def get(self, name):
        """
        Return an item from the result queue. Only gives a result if the calculation has finished.
        Use the Calculation for a better handling.
        """
        if not self.is_alive():
            return self.result_queue.get(name)
 

get_keys()

get_keys ( self )

inherited

Return the names of all item from the result queue. Only gives a result if the calculation has finished.
Use the Calculation for a better handling.

Definition at line 84 of file calculation_process.py.

    def get_keys(self):
        """
        Return the names of all item from the result queue. Only gives a result if the calculation has finished.
        Use the Calculation for a better handling.
        """
        if not self.is_alive():
            return self.result_queue.get_keys()
 

get_log()

get_log ( self )

inherited

Return the log file content.
Use the methods of the Calculation for a better handling.

Definition at line 65 of file calculation_process.py.

    def get_log(self):
        """
        Return the log file content.
        Use the methods of the Calculation for a better handling.
        """
        if self.is_alive():
            return open(self.log_file_name).read()
        else:
            self.save_log()
            return self.log_file_content
 

initialize_output()

initialize_output

(

self

)

Make sure all output by python and or C is written to the same output file

Definition at line 50 of file calculation_process.py.

    def initialize_output(self):
        """
        Make sure all output by python and or C is written to the same output file
        """
        # reset stdout/stderr (notebooks forward them over zmq)
        sys.stdout = sys.__stdout__
        sys.stderr = sys.__stderr__
 
        # open filename
        logfile = open(self.log_file_name, "wb", 0)
 
        # redirect stdout/stderr to logfile
        os.dup2(logfile.fileno(), sys.stdout.fileno())
        os.dup2(logfile.fileno(), sys.stderr.fileno())
 
        # reset logging to use the new file descriptors
        _basf2.reset_log()
        _basf2.logging.zero_counters()
        _basf2.logging.add_json()
 

prepare()

prepare

(

self

)

A function to prepare a path with the modules given in path.

Reimplemented from CalculationProcess.

Definition at line 35 of file calculation_process.py.

    def prepare(self):
        """
        A function to prepare a path with the modules given in path.
        """
        if self.path:
            # import late due to side effects with importing ROOT
            from hep_ipython_tools.ipython_handler_basf2 import python_modules
            # Add the progress python module
            self.path.add_module(python_modules.ProgressPython(self.progress_queue_remote))
            # Add the print collections python module
            self.path.add_module(python_modules.PrintCollections(self.result_queue))
        else:
            
            self.is_valid = False
 

save_log()

save_log ( self )

inherited

Delete the log file and copy its content to the class.

Definition at line 56 of file calculation_process.py.

    def save_log(self):
        """
        Delete the log file and copy its content to the class.
        """
        if self.log_file_content is None:
            self.log_file_content = open(self.log_file_name).read()
            os.unlink(self.log_file_name)
            self.log_file_name = None
 

start_process()

start_process

(

self

)

The function given to the process to start the calculation.
Do not call by yourself.
Resets the logging system, logs onto console and a file and sets the queues
(the result queue and the process queue) correctly.

Reimplemented from CalculationProcess.

Definition at line 70 of file calculation_process.py.

    def start_process(self):
        """
        The function given to the process to start the calculation.
        Do not call by yourself.
        Resets the logging system, logs onto console and a file and sets the queues
        (the result queue and the process queue) correctly.
        """
 
        if not self.path:
            return
 
        try:
            if self.random_seed is not None:
                _basf2.set_random_seed(self.random_seed)
 
            # setup output capture
            self.initialize_output()
 
            # and start processing
            _basf2.process(self.path, self.max_event)
 
            self.result_queue.put("ipython.statistics", Basf2CalculationQueueStatistics(_basf2.statistics))
 
            # import ROOT late due to all the side effects
            from ROOT import Belle2  # noqa
            store_arrays = list(Belle2.PyStoreArray.list())
            all_arrays = list(dict(Belle2.DataStore.Instance().getStoreEntryMap(Belle2.DataStore.c_Event)).keys())
 
            nodes = dict(
                name="",
                children=[
                    dict(
                        index=i,
                        name=store_array,
                        key=store_array,
                        relation=[
                            other_store_array for other_store_array in store_arrays if Belle2.DataStore.relationName(
                                store_array,
                                other_store_array) in all_arrays]) for i,
                    store_array in enumerate(store_arrays)])
            nodes_json = json.dumps(nodes)
            self.result_queue.put("ipython.dependencies", nodes_json)
 
        finally:
            self.result_queue.queue.close()
 
            self.progress_queue_remote.send("end")
            self.progress_queue_remote.close()

Member Data Documentation

already_run

bool already_run = False

inherited

True if already started/run.

Create a new calculation process instance. The parameters here are the absolute standard. You probably have to redefine the
constructor in your own class.

Definition at line 30 of file calculation_process.py.

is_valid

bool is_valid = True

inherited

Set to false, if you do not want this process to show up in the process bar calculations.

Definition at line 48 of file calculation_process.py.

log_file_content

log_file_content = None

inherited

Saved log file content after the run.

Delete the log file and copy its content to the class.

Definition at line 36 of file calculation_process.py.

log_file_name

log_file_name = log_file_name

inherited

Name of the log file to use.

Delete the log file and copy its content to the class.

Return the log file content.
Use the methods of the Calculation for a better handling.

Definition at line 33 of file calculation_process.py.

max_event

max_event = max_event

The maximum number of events to process.

Leave 0 to process al events

Definition at line 30 of file calculation_process.py.

parameters

parameters = parameters

inherited

Parameters in process_parameter_space.

Definition at line 42 of file calculation_process.py.

path

path = path

Path to process.

Definition at line 28 of file calculation_process.py.

progress_queue_local

progress_queue_local

inherited

Create the queue for the progress python module.

Definition at line 45 of file calculation_process.py.

progress_queue_remote

progress_queue_remote = Pipe()

inherited

Create the queue for the progress python module.

Definition at line 45 of file calculation_process.py.

random_seed

random_seed = random_seed

Random seed to set.

None will not set it.

Definition at line 26 of file calculation_process.py.

result_queue

result_queue = result_queue

inherited

Result queue as a reference.

Definition at line 39 of file calculation_process.py.

---

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

• framework/scripts/hep_ipython_tools/ipython_handler_basf2/calculation_process.py