pyRunner.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2020-2025 European Southern Observatory (ESO)
//
// SPDX-License-Identifier: LGPL-3.0-only
 
#ifndef HLCC_PFSSIMHLCC_PYRUNNER_HPP
#define HLCC_PFSSIMHLCC_PYRUNNER_HPP
 
#include <string>
#include <vector>
#include <mutex>
 
#include <pybind11/embed.h>
 
#include "pfssimhlcc/config.hpp"
#include "pfssimhlcc/executionStatistics.hpp"
 
 
namespace py = pybind11;
 
namespace hlcc::pfssimhlcc {
 
#pragma GCC visibility push(hidden) // When removing this pragma should also remove the pop
                                    // '#pragma GCC visibility pop' further down in the code.
 
class PyRunner {
 
    struct ScriptData {
        std::string m_py_mod_name;
        std::string m_py_obj_name;
        std::string m_python_file_name;
        py::module m_python_module;
        py::object m_python_obj;
        py::function m_python_execute_function;
        py::function m_python_terminate_function;
        std::shared_ptr<ExecTimeStats> exec_stats_ptr;
    };
 
public:
    PyRunner(const PyRunner&)            = delete;  
    PyRunner& operator=(const PyRunner&) = delete;  
 
    explicit PyRunner(const ConfigPack &config_pack);
    virtual ~PyRunner();
    void ReloadPythonModules();
    void RunPythonExecuteFunctions(int64_t iteration_timestamp_ms);
    void RunPythonTerminateFunctions();
    void UpdateConfiguration(const ConfigPack &config_pack);
 
    int GetNumberModulesLoaded();
 
    std::vector<ExecTimeStats::StatisticsCollection> GetExecutionStatistics();
 
private:
    /* Name of method name to be called in every script*/
    static std::string py_execute_method_name;
    /* Name of method name to be called before Exit*/
    static std::string py_terminate_method_name;
    /* List containin all the modules to be processed */
    std::vector<SvDescription> m_sv_list;
    /* Interpreter initialized flag */
    bool m_interpreter_initialized;
    /* container for all scripts data */
    std::vector<ScriptData> m_scripts;
    /* Application configuration */
    py::dict m_configuration;
    /* Scripts shared data */
    py::dict m_scripts_data;
 
    void InitializeInterpreter();
    void FinalizeInterpreter();
    void LoadPythonModules(const std::vector<SvDescription> &modules_name);
    void UnloadPythonModules();
    void BuildPyConfiguration(py::dict cfg, const ConfigPack &cfg_pack);
    std::string ExtractNameOfObject(const std::string &name_of_module) const;
 
};
 
#pragma GCC visibility pop
 
} // namespace hlcc::pfssimhlcc
 
#endif  // HLCC_PFSSIMHLCC_PYRUNNER_HPP