Как получить текст исключения Python

Question

Я хочу встроить Python в мое приложение C++. Я использую библиотеку Boost - отличный инструмент. Но у меня есть одна проблема.

Если функция python выдает исключение, я хочу перехватить его и напечатать ошибку в моем приложении или получить некоторую подробную информацию, такую ​​как номер строки в скрипте python, которая вызвала ошибку.

Как мне это сделать? Я не могу найти какие-либо функции для получения подробной информации об исключениях в Python API или Boost.

try {
module=import("MyModule"); //this line will throw excetion if MyModule contains an   error
} catch ( error_already_set const & ) {
//Here i can said that i have error, but i cant determine what caused an error
std::cout << "error!" << std::endl;
}

PyErr_Print () просто печатает текст ошибки в stderr и очищает ошибку, чтобы это не могло быть решением

Answer 1

Ну, я узнал, как это сделать.

Без повышения (только сообщение об ошибке, потому что код для извлечения информации из traceback слишком тяжел для размещения здесь):

PyObject *ptype, *pvalue, *ptraceback;
PyErr_Fetch(&ptype, &pvalue, &ptraceback);
//pvalue contains error message
//ptraceback contains stack snapshot and many other information
//(see python traceback structure)

//Get error message
char *pStrErrorMessage = PyString_AsString(pvalue);

И BOOST версия

try{
//some code that throws an error
}catch(error_already_set &){

    PyObject *ptype, *pvalue, *ptraceback;
    PyErr_Fetch(&ptype, &pvalue, &ptraceback);

    handle<> hType(ptype);
    object extype(hType);
    handle<> hTraceback(ptraceback);
    object traceback(hTraceback);

    //Extract error message
    string strErrorMessage = extract<string>(pvalue);

    //Extract line number (top entry of call stack)
    // if you want to extract another levels of call stack
    // also process traceback.attr("tb_next") recurently
    long lineno = extract<long> (traceback.attr("tb_lineno"));
    string filename = extract<string>(traceback.attr("tb_frame").attr("f_code").attr("co_filename"));
    string funcname = extract<string>(traceback.attr("tb_frame").attr("f_code").attr("co_name"));
... //cleanup here

Answer 2

Это самый надежный метод, который я когда-либо мог придумать:

    try {
        ...
    }
    catch (bp::error_already_set) {
        if (PyErr_Occurred()) {
            msg = handle_pyerror(); 
        }
        py_exception = true;
        bp::handle_exception();
        PyErr_Clear();
    }
    if (py_exception) 
    ....


// decode a Python exception into a string
std::string handle_pyerror()
{
    using namespace boost::python;
    using namespace boost;

    PyObject *exc,*val,*tb;
    object formatted_list, formatted;
    PyErr_Fetch(&exc,&val,&tb);
    handle<> hexc(exc),hval(allow_null(val)),htb(allow_null(tb)); 
    object traceback(import("traceback"));
    if (!tb) {
        object format_exception_only(traceback.attr("format_exception_only"));
        formatted_list = format_exception_only(hexc,hval);
    } else {
        object format_exception(traceback.attr("format_exception"));
        formatted_list = format_exception(hexc,hval,htb);
    }
    formatted = str("\n").join(formatted_list);
    return extract<std::string>(formatted);
}

Answer 3

В Python C API, PyObject_Str возвращает новую ссылку на строковый объект Python с строковой формой объекта Python, который вы передаете в качестве аргумента - точно так же, как str(o) в коде Python. Обратите внимание, что у объекта исключения нет "информации, подобной номеру строки" - это находится в объекте трассировки (вы можете использовать PyErr_Fetch чтобы получить как объект исключения, так и объект трассировки). Не знаю, что (если вообще) предоставляет Boost, чтобы упростить использование этих конкретных функций C API, но, в худшем случае, вы всегда можете прибегнуть к этим функциям, так как они предлагаются в самом C API.

Answer 4

Этот поток был очень полезен для меня, но у меня возникли проблемы с API Python C, когда я попытался извлечь само сообщение об ошибке без отслеживания. Я нашел множество способов сделать это в Python, но не смог найти способа сделать это в C++. Наконец, я придумал следующую версию, которая как можно меньше использует C API и вместо этого больше полагается на ускоренный питон.

PyErr_Print();

using namespace boost::python;

exec("import traceback, sys", mainNamespace_);
auto pyErr = eval("str(sys.last_value)", mainNamespace_);
auto pyStackTrace = eval("'\\n'.join(traceback.format_exception(sys.last_type, sys.last_value, sys.last_traceback))", mainNamespace_);

stackTraceString_ = extract<std::string>(pyStackTrace);
errorSummary_ = extract<std::string>(pyErr);

Причина, по которой это работает, заключается в том, что PyErr_Print() также устанавливает значение дляsys.last_value, sys.last_type, а также sys.last_traceback. Им присвоены те же значения, что иsys.exc_info даст, так что это функционально похоже на следующий код Python:

import traceback
import sys

try:
    raise RuntimeError("This is a test")
except:
    err_type = sys.exc_info()[0]
    value = sys.exc_info()[1]
    tb = sys.exc_info()[2]

    stack_trace = "\n".join(traceback.format_exception(err_type, value, tb))
    error_summary = str(value)


print(stack_trace)
print(error_summary)

Надеюсь, кому-то это пригодится!

Answer 5

Вот код, основанный на некоторых других ответах и ​​комментариях, красиво отформатированный с использованием современного C++ и комментариев. Минимально протестирован, но вроде работает.

      #include <string>
#include <boost/python.hpp>
#include <Python.h>

// Return the current Python error and backtrace as a string, or throw
// an exception if there was none.
std::string python_error_string() {
  using namespace boost::python;

  PyObject* ptype = nullptr;
  PyObject* pvalue = nullptr;
  PyObject* ptraceback = nullptr;

  // Fetch the exception information. If there was no error ptype will be set
  // to null. The other two values might set to null anyway.
  PyErr_Fetch(&ptype, &pvalue, &ptraceback);
  if (ptype == nullptr) {
    throw std::runtime_error("A Python error was detected but when we called "
                             "PyErr_Fetch() it returned null indicating that "
                             "there was no error.");
  }

  // Sometimes pvalue is not an instance of ptype. This converts it. It's
  // done lazily for performance reasons.
  PyErr_NormalizeException(&ptype, &pvalue, &ptraceback);
  if (ptraceback != nullptr) {
    PyException_SetTraceback(pvalue, ptraceback);
  }

  // Get Boost handles to the Python objects so we get an easier API.
  handle<> htype(ptype);
  handle<> hvalue(allow_null(pvalue));
  handle<> htraceback(allow_null(ptraceback));

  // Import the `traceback` module and use it to format the exception.
  object traceback = import("traceback");
  object format_exception = traceback.attr("format_exception");
  object formatted_list = format_exception(htype, hvalue, htraceback);
  object formatted = str("\n").join(formatted_list);
  return extract<std::string>(formatted);
}

Кстати, мне было любопытно, почему все используют вместо handle. Видимо это отключает вывод аргументов шаблона. Не уверен, зачем вам это здесь, но все равно это не то же самое, и в документах Boost говорится, что использовать handle<> тоже, так что я думаю, на это есть веская причина.