PyUtils.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      Base/Py/PyUtils.cpp
//! @brief     IOmplements various functions from PyUtils namespace
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifdef BORNAGAIN_PYTHON
 
#include "Base/Py/PyUtils.h"
#include "Base/Py/PyCore.h"
#include "Base/Util/SysUtils.h"
#include <iostream>
#include <sstream>
#include <stdexcept>
 
std::string BaseUtils::Python::toString(PyObject* obj)
{
    std::string result;
    PyObject* pyStr = PyUnicode_AsEncodedString(obj, "utf-8", "replace");
    if (pyStr != nullptr) {
        result = std::string(PyBytes_AsString(pyStr));
        Py_DecRef(pyStr);
    }
    return result;
}
 
std::vector<std::string> BaseUtils::Python::toVectorString(PyObject* obj)
{
    std::vector<std::string> result;
 
    if (PyTuple_Check(obj)) {
        for (Py_ssize_t i = 0; i < PyTuple_Size(obj); i++) {
            PyObject* value = PyTuple_GetItem(obj, i);
            result.push_back(toString(value));
        }
    } else if (PyList_Check(obj)) {
        for (Py_ssize_t i = 0; i < PyList_Size(obj); i++) {
            PyObject* value = PyList_GetItem(obj, i);
            result.push_back(toString(value));
        }
    } else
        throw std::runtime_error(
            "BaseUtils::Python::toVectorString() -> Error. Unexpected object.");
 
    return result;
}
 
std::string BaseUtils::Python::toString(char* c)
{
    if (c)
        return c;
    return "";
}
 
std::string BaseUtils::Python::toString(wchar_t* c)
{
    if (!c)
        return "";
    std::wstring wstr(c);
    return std::string(wstr.begin(), wstr.end());
}
 
PyObject* BaseUtils::Python::import_bornagain(const std::vector<std::string>& paths)
{
    if (Py_IsInitialized())
        return nullptr;
 
    Py_InitializeEx(0); // like Py_Initialize, but skip registration of signal handlers
 
    if (!paths.empty()) {
        PyObject* sysPath = PySys_GetObject((char*)"path");
        for (const std::string& path : paths)
            PyList_Append(sysPath, PyString_FromString(path.c_str()));
    }
 
    // Stores signal handler before numpy's mess it up.
    // This is to make ctrl-c working from terminal.
#ifndef _WIN32
    PyOS_sighandler_t sighandler;
    sighandler = PyOS_getsig(SIGINT);
#endif
 
    PyObject* pmod = PyImport_ImportModule("bornagain");
    if (!pmod) {
        PyErr_Print();
        throw std::runtime_error("Can't load bornagain");
    }
 
    // restores single handler to make ctr-c alive.
#ifndef _WIN32
    PyOS_setsig(SIGINT, sighandler);
#endif
 
    return pmod;
}
 
std::string BaseUtils::Python::pythonRuntimeInfo()
{
    Py_InitializeEx(0);
 
    std::stringstream result;
 
    // Runtime environment
    result << std::string(60, '=') << "\n";
    result << "PATH: " << BaseUtils::System::getenv("PATH") << "\n";
    result << "PYTHONPATH: " << BaseUtils::System::getenv("PYTHONPATH") << "\n";
    result << "PYTHONHOME: " << BaseUtils::System::getenv("PYTHONHOME") << "\n";
 
    // Embedded Python details
    result << "Py_GetProgramName(): " << BaseUtils::Python::toString(Py_GetProgramName()) << "\n";
    result << "Py_GetProgramFullPath(): " << BaseUtils::Python::toString(Py_GetProgramFullPath())
           << "\n";
    result << "Py_GetPath(): " << BaseUtils::Python::toString(Py_GetPath()) << "\n";
    result << "Py_GetPythonHome(): " << BaseUtils::Python::toString(Py_GetPythonHome()) << "\n";
 
    // Runtime Python's sys.path
    PyObject* sysPath = PySys_GetObject((char*)"path");
    auto content = BaseUtils::Python::toVectorString(sysPath);
    result << "sys.path: ";
    for (auto s : content)
        result << s << ",";
    result << "\n";
 
    return result.str();
}
 
// Attempt to retrieve Python stack trace
// https://stackoverflow.com/questions/1796510/accessing-a-python-traceback-from-the-c-api
 
std::string BaseUtils::Python::pythonStackTrace()
{
    std::stringstream result;
 
    if (PyErr_Occurred()) {
        PyObject *ptype, *pvalue, *ptraceback, *pystr;
 
        PyErr_Fetch(&ptype, &pvalue, &ptraceback);
        pystr = PyObject_Str(pvalue);
        if (char* str = PyString_AsString(pystr))
            result << std::string(str) << "\n";
 
        PyObject* module_name = PyString_FromString("traceback");
        PyObject* pyth_module = PyImport_Import(module_name);
        Py_DecRef(module_name);
 
        if (pyth_module) {
            result << "\n";
            PyObject* pyth_func = PyObject_GetAttrString(pyth_module, "format_exception");
            if (pyth_func && PyCallable_Check(pyth_func)) {
                PyObject* pyth_val =
                    PyObject_CallFunctionObjArgs(pyth_func, ptype, pvalue, ptraceback, NULL);
                if (pyth_val) {
                    pystr = PyObject_Str(pyth_val);
                    if (char* str = PyString_AsString(pystr))
                        result << std::string(str);
                    Py_DecRef(pyth_val);
                }
            }
            result << "\n";
        }
    }
 
    result << "\n";
    result << pythonRuntimeInfo();
    result << "\n";
 
    return result.str();
}
 
PyObject* BaseUtils::Python::createNumpyArray(const std::vector<double>& data)
{
    const size_t ndim(1);
    npy_int ndim_numpy = ndim;
    auto* ndimsizes_numpy = new npy_intp[ndim];
    ndimsizes_numpy[0] = data.size();
 
    // creating standalone numpy array
    PyObject* pyarray = PyArray_SimpleNew(ndim_numpy, ndimsizes_numpy, NPY_DOUBLE);
    delete[] ndimsizes_numpy;
    if (pyarray == nullptr)
        throw std::runtime_error("ExportDatafield() -> Panic in PyArray_SimpleNew");
 
    // getting pointer to data buffer of numpy array
    double* array_buffer = (double*)PyArray_DATA((PyArrayObject*)pyarray);
 
    for (size_t index = 0; index < data.size(); ++index)
        *array_buffer++ = data[index];
 
    return pyarray;
}
 
#endif // BORNAGAIN_PYTHON