test_exceptions.cpp revision 11986
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com tests/test_custom-exceptions.cpp -- exception translation 311986Sandreas.sandberg@arm.com 411986Sandreas.sandberg@arm.com Copyright (c) 2016 Pim Schellart <P.Schellart@princeton.edu> 511986Sandreas.sandberg@arm.com 611986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 711986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 811986Sandreas.sandberg@arm.com*/ 911986Sandreas.sandberg@arm.com 1011986Sandreas.sandberg@arm.com#include "pybind11_tests.h" 1111986Sandreas.sandberg@arm.com 1211986Sandreas.sandberg@arm.com// A type that should be raised as an exeption in Python 1311986Sandreas.sandberg@arm.comclass MyException : public std::exception { 1411986Sandreas.sandberg@arm.compublic: 1511986Sandreas.sandberg@arm.com explicit MyException(const char * m) : message{m} {} 1611986Sandreas.sandberg@arm.com virtual const char * what() const noexcept override {return message.c_str();} 1711986Sandreas.sandberg@arm.comprivate: 1811986Sandreas.sandberg@arm.com std::string message = ""; 1911986Sandreas.sandberg@arm.com}; 2011986Sandreas.sandberg@arm.com 2111986Sandreas.sandberg@arm.com// A type that should be translated to a standard Python exception 2211986Sandreas.sandberg@arm.comclass MyException2 : public std::exception { 2311986Sandreas.sandberg@arm.compublic: 2411986Sandreas.sandberg@arm.com explicit MyException2(const char * m) : message{m} {} 2511986Sandreas.sandberg@arm.com virtual const char * what() const noexcept override {return message.c_str();} 2611986Sandreas.sandberg@arm.comprivate: 2711986Sandreas.sandberg@arm.com std::string message = ""; 2811986Sandreas.sandberg@arm.com}; 2911986Sandreas.sandberg@arm.com 3011986Sandreas.sandberg@arm.com// A type that is not derived from std::exception (and is thus unknown) 3111986Sandreas.sandberg@arm.comclass MyException3 { 3211986Sandreas.sandberg@arm.compublic: 3311986Sandreas.sandberg@arm.com explicit MyException3(const char * m) : message{m} {} 3411986Sandreas.sandberg@arm.com virtual const char * what() const noexcept {return message.c_str();} 3511986Sandreas.sandberg@arm.comprivate: 3611986Sandreas.sandberg@arm.com std::string message = ""; 3711986Sandreas.sandberg@arm.com}; 3811986Sandreas.sandberg@arm.com 3911986Sandreas.sandberg@arm.com// A type that should be translated to MyException 4011986Sandreas.sandberg@arm.com// and delegated to its exception translator 4111986Sandreas.sandberg@arm.comclass MyException4 : public std::exception { 4211986Sandreas.sandberg@arm.compublic: 4311986Sandreas.sandberg@arm.com explicit MyException4(const char * m) : message{m} {} 4411986Sandreas.sandberg@arm.com virtual const char * what() const noexcept override {return message.c_str();} 4511986Sandreas.sandberg@arm.comprivate: 4611986Sandreas.sandberg@arm.com std::string message = ""; 4711986Sandreas.sandberg@arm.com}; 4811986Sandreas.sandberg@arm.com 4911986Sandreas.sandberg@arm.com 5011986Sandreas.sandberg@arm.com// Like the above, but declared via the helper function 5111986Sandreas.sandberg@arm.comclass MyException5 : public std::logic_error { 5211986Sandreas.sandberg@arm.compublic: 5311986Sandreas.sandberg@arm.com explicit MyException5(const std::string &what) : std::logic_error(what) {} 5411986Sandreas.sandberg@arm.com}; 5511986Sandreas.sandberg@arm.com 5611986Sandreas.sandberg@arm.com// Inherits from MyException5 5711986Sandreas.sandberg@arm.comclass MyException5_1 : public MyException5 { 5811986Sandreas.sandberg@arm.com using MyException5::MyException5; 5911986Sandreas.sandberg@arm.com}; 6011986Sandreas.sandberg@arm.com 6111986Sandreas.sandberg@arm.comvoid throws1() { 6211986Sandreas.sandberg@arm.com throw MyException("this error should go to a custom type"); 6311986Sandreas.sandberg@arm.com} 6411986Sandreas.sandberg@arm.com 6511986Sandreas.sandberg@arm.comvoid throws2() { 6611986Sandreas.sandberg@arm.com throw MyException2("this error should go to a standard Python exception"); 6711986Sandreas.sandberg@arm.com} 6811986Sandreas.sandberg@arm.com 6911986Sandreas.sandberg@arm.comvoid throws3() { 7011986Sandreas.sandberg@arm.com throw MyException3("this error cannot be translated"); 7111986Sandreas.sandberg@arm.com} 7211986Sandreas.sandberg@arm.com 7311986Sandreas.sandberg@arm.comvoid throws4() { 7411986Sandreas.sandberg@arm.com throw MyException4("this error is rethrown"); 7511986Sandreas.sandberg@arm.com} 7611986Sandreas.sandberg@arm.com 7711986Sandreas.sandberg@arm.comvoid throws5() { 7811986Sandreas.sandberg@arm.com throw MyException5("this is a helper-defined translated exception"); 7911986Sandreas.sandberg@arm.com} 8011986Sandreas.sandberg@arm.com 8111986Sandreas.sandberg@arm.comvoid throws5_1() { 8211986Sandreas.sandberg@arm.com throw MyException5_1("MyException5 subclass"); 8311986Sandreas.sandberg@arm.com} 8411986Sandreas.sandberg@arm.com 8511986Sandreas.sandberg@arm.comvoid throws_logic_error() { 8611986Sandreas.sandberg@arm.com throw std::logic_error("this error should fall through to the standard handler"); 8711986Sandreas.sandberg@arm.com} 8811986Sandreas.sandberg@arm.com 8911986Sandreas.sandberg@arm.comstruct PythonCallInDestructor { 9011986Sandreas.sandberg@arm.com PythonCallInDestructor(const py::dict &d) : d(d) {} 9111986Sandreas.sandberg@arm.com ~PythonCallInDestructor() { d["good"] = true; } 9211986Sandreas.sandberg@arm.com 9311986Sandreas.sandberg@arm.com py::dict d; 9411986Sandreas.sandberg@arm.com}; 9511986Sandreas.sandberg@arm.com 9611986Sandreas.sandberg@arm.comtest_initializer custom_exceptions([](py::module &m) { 9711986Sandreas.sandberg@arm.com // make a new custom exception and use it as a translation target 9811986Sandreas.sandberg@arm.com static py::exception<MyException> ex(m, "MyException"); 9911986Sandreas.sandberg@arm.com py::register_exception_translator([](std::exception_ptr p) { 10011986Sandreas.sandberg@arm.com try { 10111986Sandreas.sandberg@arm.com if (p) std::rethrow_exception(p); 10211986Sandreas.sandberg@arm.com } catch (const MyException &e) { 10311986Sandreas.sandberg@arm.com // Set MyException as the active python error 10411986Sandreas.sandberg@arm.com ex(e.what()); 10511986Sandreas.sandberg@arm.com } 10611986Sandreas.sandberg@arm.com }); 10711986Sandreas.sandberg@arm.com 10811986Sandreas.sandberg@arm.com // register new translator for MyException2 10911986Sandreas.sandberg@arm.com // no need to store anything here because this type will 11011986Sandreas.sandberg@arm.com // never by visible from Python 11111986Sandreas.sandberg@arm.com py::register_exception_translator([](std::exception_ptr p) { 11211986Sandreas.sandberg@arm.com try { 11311986Sandreas.sandberg@arm.com if (p) std::rethrow_exception(p); 11411986Sandreas.sandberg@arm.com } catch (const MyException2 &e) { 11511986Sandreas.sandberg@arm.com // Translate this exception to a standard RuntimeError 11611986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_RuntimeError, e.what()); 11711986Sandreas.sandberg@arm.com } 11811986Sandreas.sandberg@arm.com }); 11911986Sandreas.sandberg@arm.com 12011986Sandreas.sandberg@arm.com // register new translator for MyException4 12111986Sandreas.sandberg@arm.com // which will catch it and delegate to the previously registered 12211986Sandreas.sandberg@arm.com // translator for MyException by throwing a new exception 12311986Sandreas.sandberg@arm.com py::register_exception_translator([](std::exception_ptr p) { 12411986Sandreas.sandberg@arm.com try { 12511986Sandreas.sandberg@arm.com if (p) std::rethrow_exception(p); 12611986Sandreas.sandberg@arm.com } catch (const MyException4 &e) { 12711986Sandreas.sandberg@arm.com throw MyException(e.what()); 12811986Sandreas.sandberg@arm.com } 12911986Sandreas.sandberg@arm.com }); 13011986Sandreas.sandberg@arm.com 13111986Sandreas.sandberg@arm.com // A simple exception translation: 13211986Sandreas.sandberg@arm.com auto ex5 = py::register_exception<MyException5>(m, "MyException5"); 13311986Sandreas.sandberg@arm.com // A slightly more complicated one that declares MyException5_1 as a subclass of MyException5 13411986Sandreas.sandberg@arm.com py::register_exception<MyException5_1>(m, "MyException5_1", ex5.ptr()); 13511986Sandreas.sandberg@arm.com 13611986Sandreas.sandberg@arm.com m.def("throws1", &throws1); 13711986Sandreas.sandberg@arm.com m.def("throws2", &throws2); 13811986Sandreas.sandberg@arm.com m.def("throws3", &throws3); 13911986Sandreas.sandberg@arm.com m.def("throws4", &throws4); 14011986Sandreas.sandberg@arm.com m.def("throws5", &throws5); 14111986Sandreas.sandberg@arm.com m.def("throws5_1", &throws5_1); 14211986Sandreas.sandberg@arm.com m.def("throws_logic_error", &throws_logic_error); 14311986Sandreas.sandberg@arm.com 14411986Sandreas.sandberg@arm.com m.def("throw_already_set", [](bool err) { 14511986Sandreas.sandberg@arm.com if (err) 14611986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_ValueError, "foo"); 14711986Sandreas.sandberg@arm.com try { 14811986Sandreas.sandberg@arm.com throw py::error_already_set(); 14911986Sandreas.sandberg@arm.com } catch (const std::runtime_error& e) { 15011986Sandreas.sandberg@arm.com if ((err && e.what() != std::string("ValueError: foo")) || 15111986Sandreas.sandberg@arm.com (!err && e.what() != std::string("Unknown internal error occurred"))) 15211986Sandreas.sandberg@arm.com { 15311986Sandreas.sandberg@arm.com PyErr_Clear(); 15411986Sandreas.sandberg@arm.com throw std::runtime_error("error message mismatch"); 15511986Sandreas.sandberg@arm.com } 15611986Sandreas.sandberg@arm.com } 15711986Sandreas.sandberg@arm.com PyErr_Clear(); 15811986Sandreas.sandberg@arm.com if (err) 15911986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_ValueError, "foo"); 16011986Sandreas.sandberg@arm.com throw py::error_already_set(); 16111986Sandreas.sandberg@arm.com }); 16211986Sandreas.sandberg@arm.com 16311986Sandreas.sandberg@arm.com m.def("python_call_in_destructor", [](py::dict d) { 16411986Sandreas.sandberg@arm.com try { 16511986Sandreas.sandberg@arm.com PythonCallInDestructor set_dict_in_destructor(d); 16611986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_ValueError, "foo"); 16711986Sandreas.sandberg@arm.com throw py::error_already_set(); 16811986Sandreas.sandberg@arm.com } catch (const py::error_already_set&) { 16911986Sandreas.sandberg@arm.com return true; 17011986Sandreas.sandberg@arm.com } 17111986Sandreas.sandberg@arm.com return false; 17211986Sandreas.sandberg@arm.com }); 17311986Sandreas.sandberg@arm.com}); 174