Function reportPythonError

src/EnergyPlus/PythonEngine.cc:114–184

#if LINK_WITH_PYTHON

    void reportPythonError([[maybe_unused]] EnergyPlusData &state)
    {
        PyObject *exc_type = nullptr;
        PyObject *exc_value = nullptr;
        PyObject *exc_tb = nullptr;
        PyErr_Fetch(&exc_type, &exc_value, &exc_tb);
        // Normalizing the exception is needed. Without it, our custom EnergyPlusException go through just fine
        // but any ctypes built-in exception for eg will have wrong types
        PyErr_NormalizeException(&exc_type, &exc_value, &exc_tb);
        PyObject *str_exc_value = PyObject_Repr(exc_value); // Now a unicode object
        PyObject *pyStr2 = PyUnicode_AsEncodedString(str_exc_value, "utf-8", "Error ~");
        Py_DECREF(str_exc_value);
        char *strExcValue = PyBytes_AsString(pyStr2); // NOLINT(hicpp-signed-bitwise)
        Py_DECREF(pyStr2);
        EnergyPlus::ShowContinueError(state, "Python error description follows: ");
        EnergyPlus::ShowContinueError(state, strExcValue);

        // See if we can get a full traceback.
        // Calls into python, and does the same as capturing the exception in `e`
        // then `print(traceback.format_exception(e.type, e.value, e.tb))`
        PyObject *pModuleName = PyUnicode_DecodeFSDefault("traceback");
        PyObject *pyth_module = PyImport_Import(pModuleName);
        Py_DECREF(pModuleName);

        if (pyth_module == nullptr) {
            EnergyPlus::ShowContinueError(state, "Cannot find 'traceback' module in reportPythonError(), this is weird");
            return;
        }

        PyObject *pyth_func = PyObject_GetAttrString(pyth_module, "format_exception");
        Py_DECREF(pyth_module); // PyImport_Import returns a new reference, decrement it

        if ((pyth_func != nullptr) || (PyCallable_Check(pyth_func) != 0)) {

            PyObject *pyth_val = PyObject_CallFunction(pyth_func, "OOO", exc_type, exc_value, exc_tb);

            // traceback.format_exception returns a list, so iterate on that
            if ((pyth_val == nullptr) || !PyList_Check(pyth_val)) { // NOLINT(hicpp-signed-bitwise)
                EnergyPlus::ShowContinueError(state, "In reportPythonError(), traceback.format_exception did not return a list.");
                return;
            }

            Py_ssize_t numVals = PyList_Size(pyth_val);
            if (numVals == 0) {
                EnergyPlus::ShowContinueError(state, "No traceback available");
                return;
            }

            EnergyPlus::ShowContinueError(state, "Python traceback follows: ");

            EnergyPlus::ShowContinueError(state, "```");

            for (Py_ssize_t itemNum = 0; itemNum < numVals; itemNum++) {
                PyObject *item = PyList_GetItem(pyth_val, itemNum);
                if (PyUnicode_Check(item)) { // NOLINT(hicpp-signed-bitwise) -- something inside Python code causes warning
                    std::string traceback_line = PyUnicode_AsUTF8(item);
                    if (!traceback_line.empty() && traceback_line[traceback_line.length() - 1] == '\n') {
                        traceback_line.erase(traceback_line.length() - 1);