PyScriptHandle.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once

 
#include "shambindings/pytypealias.hpp"
#include "shamsys/legacy/log.hpp"
#include <pybind11/embed.h>
#include <pybind11/eval.h>
#include <pybind11/pybind11.h>

 *     plt.show()
 * )");
 * \endcode
 */
struct PyScriptHandle {

    pybind11::dict locals;

    PyScriptHandle() { std::make_unique<pybind11::dict>(); }

    pybind11::dict &data() { return locals; }

     * @param name name of the python variable
     * @param arr the array to pass
     */
    template<class T>
    inline void register_array(std::string name, std::vector<T> &arr) {
        data()[name.c_str()] = arr;
    }

     * @param name name of the python variable
     * @param val the value to pass
     */
    template<class T>
    inline void register_value(std::string name, T val) {
        data()[name.c_str()] = val;
    }

     * @return true the script executed successfully
     * @return false  the script executed with an error
     */
    template<size_t N>
    inline bool exec(const char (&expr)[N], pybind11::object &&global = pybind11::globals()) {
        try {
            py::exec(expr, std::forward<pybind11::object>(global), locals);
        } catch (const std::exception &e) {
            logger::warn_ln("PyScriptHandle", "the script throwed an error :", e.what());
            return false;
        }
        return true;
    }
};