Framework Class Reference

This class combines all subsystems of the framework, and exports the main interface to Python. More...

#include <Framework.h>

Public Member Functions
	Framework ()
	Constructor.
virtual	~Framework ()
	Destructor.

Static Public Member Functions
static void	addModuleSearchPath (const std::string &path)
	Adds a new filepath to the list of filepaths which are searched for modules.
static void	setExternalsPath (const std::string &path)
	Sets the path in which the externals of the framework are located.
static ModulePtr	registerModule (const std::string &moduleName)
	Registers a new module to the framework and returns a shared pointer.
static ModulePtr	registerModule (const std::string &moduleName, const std::string &sharedLibPath)
	Registers a new module to the framework and returns a shared pointer.
static void	process (PathPtr startPath, long maxEvent=0)
	Processes up to maxEvent events by starting with the first module in the specified path.
static void	setNumberProcesses (int numProcesses)
	Function to set number of worker processes for parallel processing.
static int	getNumberProcesses ()
	Function to get number of worker processes for parallel processing.
static void	setPicklePath (const std::string &path)
	Function to set the path to the file where the pickled path is stored.
static std::string	getPicklePath ()
	Function to get the path to the file where the pickled path is stored.
static void	setStreamingObjects (const boost::python::list &streamingObjects)
	Function to set streaming objects for Tx module.
static void	setRealm (const std::string &realm)
	Function to set the execution realm.
static void	setRunType (const Const::ERunType runType)
	Function to set the run type (beam or cosmic)
static void	setCosmicRun ()
	Function to set that the script is running on cosmics data (by default it runs on beam data)
static void	setBeamRun ()
	Function to set that the script is running on beam data (by default it runs on beam data, no need to use it if the run type has not been changed before).
static void	writeSimulationSteps ()
	Function for writing the simulation steps of each event into csv files.
static std::string	findFile (const std::string &filename, const std::string &type, bool ignore_errors=false)
	Find a file.
static boost::python::list	getModuleSearchPathsPython ()
	Returns a list of all module search paths known to the framework.
static boost::python::dict	getAvailableModulesPython ()
	Returns a dictionary containing the found modules and the filenames of the shared libraries in which they can be found.
static boost::python::list	getRegisteredModulesPython ()
	Returns a list of all registered modules.
static void	exposePythonAPI ()
	Exposes methods of the Framework class to Python.

Detailed Description

This class combines all subsystems of the framework, and exports the main interface to Python.

Definition at line 28 of file Framework.h.

Constructor & Destructor Documentation

Framework()

Framework

(

)

Constructor.

Definition at line 39 of file Framework.cc.

{
  DataStore::s_DoCleanup = true;
  LogSystem::Instance().enableErrorSummary(true);
 
  if (!RandomNumbers::isInitialized()) {
    RandomNumbers::initialize();
  }
  Environment::Instance();
}

~Framework()

~Framework ( )

virtual

Destructor.

Definition at line 51 of file Framework.cc.

{
  //empty module manager of modules
  //since modules may contain shared pointers of Path objects created in Python,
  //these shared pointers have special cleanup hooks that can cause crashes if run
  //after Py_Finalize(). The framework object is cleaned up before, so this is a good place.
  ModuleManager::Instance().reset();
  DataStore::s_DoCleanup = false;
  //Also the database configuration has things to cleanup before Py_Finalize()
  Conditions::Configuration::getInstance().reset();
}

Member Function Documentation

addModuleSearchPath()

void addModuleSearchPath ( const std::string & path )

static

Adds a new filepath to the list of filepaths which are searched for modules.

If a module is requested by the method registerModule(), all module search paths are scanned for shared libraries or map files which contain the requested module.

Parameters

path	The module search path which should be added to the list of paths.

Definition at line 64 of file Framework.cc.

{
  ModuleManager::Instance().addModuleSearchPath(path);
}

exposePythonAPI()

void exposePythonAPI ( )

static

Exposes methods of the Framework class to Python.

Definition at line 314 of file Framework.cc.

{
  PyExc_ModuleNotCreatedError = PyErr_NewExceptionWithDoc("basf2.ModuleNotCreatedError",
                                                          "This exception is raised when a basf2 module could not be created for any reason",
                                                          PyExc_RuntimeError, nullptr);
  scope().attr("ModuleNotCreatedError") = handle<>(borrowed(PyExc_ModuleNotCreatedError));
  register_exception_translator<ModuleManager::ModuleNotCreatedError>(moduleNotCreatedTranslator);
  //Overloaded methods
  ModulePtr(*registerModule1)(const std::string&) = &Framework::registerModule;
  ModulePtr(*registerModule2)(const std::string&, const std::string&) = &Framework::registerModule;
 
  //don't show c++ signature in python doc to keep it simple
  docstring_options options(true, true, false);
 
  //Expose framework class
  class_<Framework, std::shared_ptr<Framework>, boost::noncopyable>("Framework", "Initialize and Cleanup functions", no_init);
  std::shared_ptr<Framework> initguard{new Framework()};
  scope().attr("__framework") = initguard;
 
  def("add_module_search_path", &Framework::addModuleSearchPath, R"DOCSTRING(
Add a directory in which to search for compiled basf2 C++ `Modules <Module>`.
 
This directory needs to contain the shared libraries containing the compiled
modules as well as companion files ending in ``.b2modmap`` which contain a list
of the module names contained in each library.
 
Note:
  The newly added path will not override existing modules
 
Parameters:
  path (str): directory containing the modules.
)DOCSTRING", args("path"));
  def("set_externals_path", &Framework::setExternalsPath, R"DOCSTRING(
Set the path to the externals to be used.
 
Warning:
  This will not change the library and executable paths but will just change
  the directory where to look for certain data files like the Evtgen particle
  definition file. Don't use this unless you really know what you are doing.
 
Parameters:
  path (str): new top level directory for the externals
)DOCSTRING", args("path"));
  def("list_module_search_paths", &Framework::getModuleSearchPathsPython, R"DOCSTRING(
Return a python list containing all the directories included in the module
search Path.
 
See:
  `add_module_search_path`
)DOCSTRING");
  def("list_available_modules", &Framework::getAvailableModulesPython, R"DOCSTRING(
Return a dictionary containing the names of all known modules
as keys and the name of the shared library containing these modules as values.
)DOCSTRING");
  def("list_registered_modules", &Framework::getRegisteredModulesPython, R"DOCSTRING(
Return a list with pointers to all previously created module instances by calling `register_module()`
)DOCSTRING");
  def("get_pickle_path", &Framework::getPicklePath, R"DOCSTRING(
Return the filename where the pickled path is or should be stored
)DOCSTRING");
  def("set_pickle_path", &Framework::setPicklePath, R"DOCSTRING(
Set the filename where the pickled path should be stored or retrieved from
)DOCSTRING", args("path"));
  def("set_nprocesses", &Framework::setNumberProcesses, R"DOCSTRING(
Sets number of worker processes for parallel processing.
 
Can be overridden using the ``-p`` argument to basf2.
 
Note:
  Setting this to 1 will have one parallel worker job which is almost always
  slower than just running without parallel processing but is still provided to
  allow debugging of parallel execution.
 
Parameters:
  nproc (int): number of worker processes. 0 to disable parallel processing.
)DOCSTRING");
  def("get_nprocesses", &Framework::getNumberProcesses, R"DOCSTRING(
Gets number of worker processes for parallel processing. 0 disables parallel processing
)DOCSTRING");
  def("set_streamobjs", &Framework::setStreamingObjects, R"DOCSTRING(
Set the names of all DataStore objects which should be sent between the
parallel processes. This can be used to improve parallel processing performance
by removing objects not required.
)DOCSTRING");
  {
    // The register_module function is overloaded with different signatures which makes
    // the boost docstring very useless so we handcraft a docstring
    docstring_options param_options(true, false, false);
    def("_register_module", registerModule1);
    def("_register_module", registerModule2, R"DOCSTRING(register_module(name, library=None)
Register a new Module.
 
This function will try to create a new instance of a module with the given name. If no library is given it will try to find the module by itself from the module search path. Optionally one can specify the name of a shared library containing the module code then this library will be loaded
 
See:
  `list_module_search_paths()`, `add_module_search_path()`
 
Parameters:
  name (str): Type of the module to create
  library (str): Optional, name of a shared library containing the module
 
Returns:
  An instance of the module if successful.
 
Raises:
  will raise a `ModuleNotCreatedError` if there is any problem creating the module.
)DOCSTRING");
  def("set_realm", &Framework::setRealm, R"DOCSTRING(
Set the basf2 execution realm.
 
The severity of log messages sometimes depends on where basf2 runs. This is controlled by the execution realm.
 
Usually the realm does not have to be set explicitly. On the HLT or express reco it should be set to 'online' and for official productions to 'production'.
)DOCSTRING", args("realm"));
  def("declare_cosmics", &Framework::setCosmicRun, R"DOCSTRING(
Set that the run is for cosmics data
)DOCSTRING");
  def("declare_beam", &Framework::setBeamRun, R"DOCSTRING(
Set that the run is for beam data
)DOCSTRING");
  def("write_simulation_steps", &Framework::writeSimulationSteps, R"DOCSTRING(
Allow basf2 to write the simulation steps of each event into csv files.
 
This function should not be used in production jobs because the execution time will significantly increase.
)DOCSTRING");
  def("_process", &Framework::process, process_overloads(R"DOCSTRING(process(path, num_events=0)
Processes up to max_events events by starting with the first module in the specified path.
 
 This method starts processing events only if there is a module in the path
 which is capable of specifying the end of the data flow.
 
 Parameters:
   path (Path): The processing starts with the first module of this path.
   max_events (int): The maximum number of events that will be processed.
       If the number is smaller than 1, all events will be processed (default).
)DOCSTRING"));
    ;
  }
 
  def("find_file", &Framework::findFile, (arg("filename"), arg("data_type") = "", arg("silent") = false), R"DOC(
  Try to find a file and return its full path
 
  If ``data_type`` is empty this function will try to find the file
 
  1. in ``$BELLE2_LOCAL_DIR``,
  2. in ``$BELLE2_RELEASE_DIR``
  3. relative to the current working directory.
 
  Other known ``data_type`` values are
 
  ``examples``
      Example data for examples and tutorials. Will try to find the file
 
      1. in ``$BELLE2_EXAMPLES_DATA_DIR``
      2. relative to the current working directory
 
  ``validation``
      Data for validation purposes. Will try to find the file in
 
      1. in ``$BELLE2_VALIDATION_DATA_DIR``
      2. relative to the current working directory
 
  ``starterkit``
      Data for starterkit purposes. Will try to find the file in
 
      1. in ``$BELLE2_STARTERKIT_DATA_DIR``
      2. relative to the current working directory
 
  .. versionadded:: release-03-00-00
 
  Arguments:
    filename (str): relative filename to look for, either in a central place or
        in the current working directory
    data_type (str): case insensitive data type to find. Either empty string or
        one of ``"examples"``, ``"validation"`` or "``starterkit``".
    silent (bool): If True don't print any errors and just return an empty
        string if the file cannot be found
  )DOC");
}

findFile()

std::string findFile ( const std::string & filename, const std::string & type, bool ignore_errors = false )

static

Find a file.

This is a wrapper around FileSystem::findFile() to be able to call it nicely from python and create a FileNotFoundError if the file cannot be found.

Known types:

• empty string: exactly like FileSystem::findFile, look in $BELLE2_LOCAL_DIR and then $BELLE2_RELEASE_DIR and then relative to local dir
• 'examples': look for example data in $BELLE2_EXAMPLES_DATA_DIR, then relative to the local directory
• 'validation': look for validation data in $BELLE2_VALIDATION_DATA_DIR, then relative to the local directory
• 'starterkit': look for starterkit data in $BELLE2_STARTERKIT_DATA_DIR, then relative to the local directory

Parameters

filename	relative filename to look for, either in a central place or in the current working directory
type	if set, specifies where to look if the file cannot be found locally
ignore_errors	if true don't print any errors and silently return None. Otherwise this function will raise a FileNotFoundError exception if the file cannot be found.

Returns

relative or absolute filename if found, empty string if not found and ignore_errors is true

Definition at line 239 of file Framework.cc.

{
  std::string result;
  if (type.empty()) {
    //behave like FileSystem.findFile by using it
    result = FileSystem::findFile(filename, ignore_errors);
  } else {
    result = FileSystem::findFile(filename, type, ignore_errors);
  }
  if (!ignore_errors and result.empty()) {
    // Still not found ... see if we raise an exception or not.
    // We want a FileNotFoundError ... so lets fudge the errno to the correct
    // error value and then create the correct exception in python
    errno = ENOENT;
    PyErr_SetFromErrnoWithFilename(PyExc_FileNotFoundError, filename.c_str());
    boost::python::throw_error_already_set();
  }
  return result;
}

getAvailableModulesPython()

boost::python::dict getAvailableModulesPython ( )

static

Returns a dictionary containing the found modules and the filenames of the shared libraries in which they can be found.

Returns

A python dictionary dictionary containing the found modules.

Definition at line 273 of file Framework.cc.

{
  boost::python::dict returnDict;
  for (const auto& modulePair : ModuleManager::Instance().getAvailableModules())
    returnDict[boost::python::object(modulePair.first)] = boost::python::object(modulePair.second);
  return returnDict;
}

getModuleSearchPathsPython()

boost::python::list getModuleSearchPathsPython ( )

static

Returns a list of all module search paths known to the framework.

Returns

A python list containing all module search paths known to the framework.

Definition at line 263 of file Framework.cc.

{
  boost::python::list returnList;
 
  for (const std::string& path : ModuleManager::Instance().getModuleSearchPaths())
    returnList.append(boost::python::object(path));
  return returnList;
}

getNumberProcesses()

int getNumberProcesses ( )

static

Function to get number of worker processes for parallel processing.

Definition at line 174 of file Framework.cc.

{
  return Environment::Instance().getNumberProcesses();
}

getPicklePath()

std::string getPicklePath ( )

static

Function to get the path to the file where the pickled path is stored.

Returns

path to file where the pickled path is stored

Definition at line 186 of file Framework.cc.

{
  return Environment::Instance().getPicklePath();
}

getRegisteredModulesPython()

boost::python::list getRegisteredModulesPython ( )

static

Returns a list of all registered modules.

Returns

A python list containing all registered modules.

Definition at line 282 of file Framework.cc.

{
  boost::python::list returnList;
 
  for (const ModulePtr& mod : ModuleManager::Instance().getCreatedModules())
    returnList.append(boost::python::object(mod));
  return returnList;
}

process()

void process ( PathPtr startPath, long maxEvent = 0 )

static

Processes up to maxEvent events by starting with the first module in the specified path.

This method starts processing events only if there is a module in the path which is capable of specifying the end of the data flow.

Parameters

startPath	The processing starts with the first module of this path.
maxEvent	The maximum number of events that will be processed. If the number is smaller than 1, all events will be processed (default).

Definition at line 88 of file Framework.cc.

{
  if (Environment::Instance().getDryRun()) {
    Environment::Instance().setJobInformation(startPath);
    return; //processing disabled!
  }
 
  static bool already_executed = false;
  static std::set<const Module*> previously_run_modules; //not a shared pointer to not screw up ownership
  static int errors_from_previous_run = 0;
  const auto moduleListUnique = startPath->buildModulePathList(true);
  if (already_executed) {
    B2WARNING("Calling process() more than once per steering file is still experimental, please check results carefully! Python modules especially should reinitialise their state in initialise() to avoid problems");
    if (startPath->buildModulePathList(true) != startPath->buildModulePathList(false)) {
      B2FATAL("Your path contains the same module instance in multiple places. Calling process() multiple times is not implemented for this case.");
    }
 
    //were any modules in moduleListUnique already run?
    for (const auto& m : moduleListUnique) {
      if (previously_run_modules.count(m.get()) > 0) {
        //only clone if modules have been run before
        startPath = std::static_pointer_cast<Path>(startPath->clone());
        break;
      }
    }
  }
  for (const auto& m : moduleListUnique) {
    previously_run_modules.insert(m.get());
  }
 
  int numLogError = LogSystem::Instance().getMessageCounter(LogConfig::c_Error);
  if (numLogError != errors_from_previous_run) {
    B2FATAL(numLogError << " ERROR(S) occurred! The processing of events will not be started.");
  }
 
  try {
    LogSystem::Instance().resetMessageCounter();
    DataStore::Instance().reset();
    DataStore::Instance().setInitializeActive(true);
 
    auto& environment = Environment::Instance();
 
    already_executed = true;
    if (environment.getNumberProcesses() == 0) {
      EventProcessor processor;
      processor.setProfileModuleName(environment.getProfileModuleName());
      processor.process(startPath, maxEvent);
    } else {
      if (environment.getUseZMQ()) {
        // If the user has not given any socket address, use a random one.
        if (environment.getZMQSocketAddress().empty()) {
          environment.setZMQSocketAddress(ZMQAddressUtils::randomSocketName());
        }
        ZMQEventProcessor processor;
        processor.process(startPath, maxEvent);
      } else {
        pEventProcessor processor;
        processor.process(startPath, maxEvent);
      }
    }
    errors_from_previous_run = LogSystem::Instance().getMessageCounter(LogConfig::c_Error);
 
    DBStore::Instance().reset();
    // Also, reset the Database connection itself. However don't reset the
    // configuration, just the actual setup. In case the user runs process()
    // again it will reinitialize correctly with the same settings.
    Database::Instance().reset(true);
  } catch (std::exception& e) {
    B2ERROR("Uncaught exception encountered: " << e.what()); //should show module name
    DataStore::Instance().reset(); // ensure we are executed before ROOT's exit handlers
    throw; //and let python's global handler do the rest
  } catch (...) {
    B2ERROR("Uncaught exception encountered!"); //should show module name
    DataStore::Instance().reset(); // ensure we are executed before ROOT's exit handlers
    throw; //and let python's global handler do the rest
    //TODO: having a stack trace would be nicer, but somehow a handler I set using std::set_terminate() never gets called
  }
}

registerModule() [1/2]

ModulePtr registerModule ( const std::string & moduleName )

static

Registers a new module to the framework and returns a shared pointer.

This method creates a new Module based on the given module name. If the shared library file containing the module was already loaded, the module is directly created. Otherwise the shared library file is dynamically loaded first.

If the module could not be registered, an exception of type ModuleNotCreatedError is thrown.

Parameters

moduleName

The unique name of the module which should be created.

Returns

A shared pointer of the newly created and registered module.

Definition at line 76 of file Framework.cc.

{
  return ModuleManager::Instance().registerModule(moduleName);
}

registerModule() [2/2]

ModulePtr registerModule ( const std::string & moduleName, const std::string & sharedLibPath )

static

Registers a new module to the framework and returns a shared pointer.

This method creates a new Module based on the given module name. If the shared library file containing the module was already loaded, the module is directly created. Otherwise the shared library file is dynamically loaded first.

If the module could not be registered, an exception of type ModuleNotCreatedError is thrown.

Parameters

moduleName	The unique name of the module which should be created.
sharedLibPath	Optional: The shared library from which the module should be registered (not a map file !).

Returns

A shared pointer of the newly created and registered module.

Definition at line 82 of file Framework.cc.

{
  return ModuleManager::Instance().registerModule(moduleName, sharedLibPath);
}

setBeamRun()

void setBeamRun ( )

static

Function to set that the script is running on beam data (by default it runs on beam data, no need to use it if the run type has not been changed before).

Definition at line 226 of file Framework.cc.

{
  Environment::Instance().setRunType(Const::c_Beam);
}

setCosmicRun()

void setCosmicRun ( )

static

Function to set that the script is running on cosmics data (by default it runs on beam data)

Definition at line 221 of file Framework.cc.

{
  Environment::Instance().setRunType(Const::c_Cosmic);
}

setExternalsPath()

void setExternalsPath ( const std::string & path )

static

Sets the path in which the externals of the framework are located.

Parameters

path	The path in which the externals of the framework are located.

Definition at line 70 of file Framework.cc.

{
  Environment::Instance().setExternalsPath(path);
}

setNumberProcesses()

void setNumberProcesses ( int numProcesses )

static

Function to set number of worker processes for parallel processing.

Definition at line 168 of file Framework.cc.

{
  Environment::Instance().setNumberProcesses(numProcesses);
}

setPicklePath()

void setPicklePath ( const std::string & path )

static

Function to set the path to the file where the pickled path is stored.

Parameters

path	path to file where the pickled path is stored

Definition at line 180 of file Framework.cc.

{
  Environment::Instance().setPicklePath(path);
}

setRealm()

void setRealm ( const std::string & realm )

static

Function to set the execution realm.

Parameters

realm

basf2 execution realm

Definition at line 197 of file Framework.cc.

{
  int irealm = -1;
  std::vector<std::string> realms;
  for (int i = LogConfig::c_None; i <= LogConfig::c_Production; i++) {
    std::string thisRealm = LogConfig::logRealmToString((LogConfig::ELogRealm)i);
    realms.push_back(thisRealm);
    if (boost::iequals(realm, thisRealm)) { //case-insensitive
      irealm = i;
      break;
    }
  }
  if (irealm < 0) {
    B2ERROR("Invalid realm! Needs to be one of " << boost::join(realms, ", "));
  } else {
    Environment::Instance().setRealm((LogConfig::ELogRealm)irealm);
  }
}

setRunType()

void setRunType ( const Const::ERunType runType )

static

Function to set the run type (beam or cosmic)

Definition at line 216 of file Framework.cc.

{
  Environment::Instance().setRunType(runType);
}

setStreamingObjects()

void setStreamingObjects ( const boost::python::list & streamingObjects )

static

Function to set streaming objects for Tx module.

Parameters

streamingObjects

objects to be streamed

Definition at line 191 of file Framework.cc.

{
  auto vec = PyObjConvUtils::convertPythonObject(streamingObjects, std::vector<std::string>());
  Environment::Instance().setStreamingObjects(vec);
}

writeSimulationSteps()

void writeSimulationSteps ( )

static

Function for writing the simulation steps of each event into csv files.

This should not be used during production jobs, but only for producing events for the Belle II Virtual Reality application.

Definition at line 231 of file Framework.cc.

{
  B2WARNING("basf2 will write the simulation steps of each event into output csv files. "
            "This is fine if you are producing events for the Belle II Virtual Reality application, "
            "otherwise this function should not be used since the execution time will significantly increase.");
  Environment::Instance().setWriteSimSteps(true);
}

---

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

• framework/pybasf2/include/Framework.h
• framework/pybasf2/src/Framework.cc