d-mercator/python/pybind11/tests/test_exceptions.cpp at main · networkgeometry/d-mercator · GitHub

History

347 lines (306 loc) · 11.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

tests/test_custom-exceptions.cpp -- exception translation

BSD-style license that can be found in the LICENSE file.

#include "test_exceptions.h"

#include "local_bindings.h"

#include "pybind11_tests.h"

#include <exception>

#include <stdexcept>

#include <utility>

// A type that should be raised as an exception in Python

class MyException : public std::exception {

public:

explicit MyException(const char *m) : message{m} {}

const char *what() const noexcept override { return message.c_str(); }

private:

std::string message = "";

};

// A type that should be translated to a standard Python exception

class MyException2 : public std::exception {

public:

explicit MyException2(const char *m) : message{m} {}

const char *what() const noexcept override { return message.c_str(); }

private:

std::string message = "";

};

// A type that is not derived from std::exception (and is thus unknown)

class MyException3 {

public:

explicit MyException3(const char *m) : message{m} {}

virtual const char *what() const noexcept { return message.c_str(); }

// Rule of 5 BEGIN: to preempt compiler warnings.

MyException3(const MyException3 &) = default;

MyException3(MyException3 &&) = default;

MyException3 &operator=(const MyException3 &) = default;

MyException3 &operator=(MyException3 &&) = default;

virtual ~MyException3() = default;

// Rule of 5 END.

private:

std::string message = "";

};

// A type that should be translated to MyException

// and delegated to its exception translator

class MyException4 : public std::exception {

public:

explicit MyException4(const char *m) : message{m} {}

const char *what() const noexcept override { return message.c_str(); }

private:

std::string message = "";

};

// Like the above, but declared via the helper function

class MyException5 : public std::logic_error {

public:

explicit MyException5(const std::string &what) : std::logic_error(what) {}

};

// Inherits from MyException5

class MyException5_1 : public MyException5 {

using MyException5::MyException5;

};

// Exception that will be caught via the module local translator.

class MyException6 : public std::exception {

public:

explicit MyException6(const char *m) : message{m} {}

const char *what() const noexcept override { return message.c_str(); }

private:

std::string message = "";

};

struct PythonCallInDestructor {

explicit PythonCallInDestructor(const py::dict &d) : d(d) {}

~PythonCallInDestructor() { d["good"] = true; }

py::dict d;

};

struct PythonAlreadySetInDestructor {

explicit PythonAlreadySetInDestructor(const py::str &s) : s(s) {}

~PythonAlreadySetInDestructor() {

py::dict foo;

try {

// Assign to a py::object to force read access of nonexistent dict entry

py::object o = foo["bar"];

} catch (py::error_already_set &ex) {

ex.discard_as_unraisable(s);

}

py::str s;

};

std::string error_already_set_what(const py::object &exc_type, const py::object &exc_value) {

PyErr_SetObject(exc_type.ptr(), exc_value.ptr());

return py::error_already_set().what();

}

TEST_SUBMODULE(exceptions, m) {

m.def("throw_std_exception",

[]() { throw std::runtime_error("This exception was intentionally thrown."); });

// make a new custom exception and use it as a translation target

static py::exception<MyException> ex(m, "MyException");

py::register_exception_translator([](std::exception_ptr p) {

try {

if (p) {

std::rethrow_exception(p);

}

} catch (const MyException &e) {

// Set MyException as the active python error

ex(e.what());

}

});

// register new translator for MyException2

// no need to store anything here because this type will

// never by visible from Python

py::register_exception_translator([](std::exception_ptr p) {

try {

if (p) {

std::rethrow_exception(p);

}

} catch (const MyException2 &e) {

// Translate this exception to a standard RuntimeError

PyErr_SetString(PyExc_RuntimeError, e.what());

}

});

// register new translator for MyException4

// which will catch it and delegate to the previously registered

// translator for MyException by throwing a new exception

py::register_exception_translator([](std::exception_ptr p) {

try {

if (p) {

std::rethrow_exception(p);

}

} catch (const MyException4 &e) {

throw MyException(e.what());

}

});

// A simple exception translation:

auto ex5 = py::register_exception<MyException5>(m, "MyException5");

// A slightly more complicated one that declares MyException5_1 as a subclass of MyException5

py::register_exception<MyException5_1>(m, "MyException5_1", ex5.ptr());

// py::register_local_exception<LocalSimpleException>(m, "LocalSimpleException")

py::register_local_exception_translator([](std::exception_ptr p) {

try {

if (p) {

std::rethrow_exception(p);

}

} catch (const MyException6 &e) {

PyErr_SetString(PyExc_RuntimeError, e.what());

}

});

m.def("throws1", []() { throw MyException("this error should go to a custom type"); });

m.def("throws2",

[]() { throw MyException2("this error should go to a standard Python exception"); });

m.def("throws3", []() { throw MyException3("this error cannot be translated"); });

m.def("throws4", []() { throw MyException4("this error is rethrown"); });

m.def("throws5",

[]() { throw MyException5("this is a helper-defined translated exception"); });

m.def("throws5_1", []() { throw MyException5_1("MyException5 subclass"); });

m.def("throws6", []() { throw MyException6("MyException6 only handled in this module"); });

m.def("throws_logic_error", []() {

throw std::logic_error("this error should fall through to the standard handler");

});

m.def("throws_overflow_error", []() { throw std::overflow_error(""); });

m.def("throws_local_error", []() { throw LocalException("never caught"); });

m.def("throws_local_simple_error", []() { throw LocalSimpleException("this mod"); });

m.def("exception_matches", []() {

py::dict foo;

try {

// Assign to a py::object to force read access of nonexistent dict entry

py::object o = foo["bar"];

} catch (py::error_already_set &ex) {

if (!ex.matches(PyExc_KeyError)) {

throw;

}

return true;

}

return false;

});

m.def("exception_matches_base", []() {

py::dict foo;

try {

// Assign to a py::object to force read access of nonexistent dict entry

py::object o = foo["bar"];

} catch (py::error_already_set &ex) {

if (!ex.matches(PyExc_Exception)) {

throw;

}

return true;

}

return false;

});

m.def("modulenotfound_exception_matches_base", []() {

try {

// On Python >= 3.6, this raises a ModuleNotFoundError, a subclass of ImportError

py::module_::import("nonexistent");

} catch (py::error_already_set &ex) {

if (!ex.matches(PyExc_ImportError)) {

throw;

}

return true;

}

return false;

});

m.def("throw_already_set", [](bool err) {

if (err) {

PyErr_SetString(PyExc_ValueError, "foo");

}

try {

throw py::error_already_set();

} catch (const std::runtime_error &e) {

if ((err && e.what() != std::string("ValueError: foo"))

|| (!err

&& e.what()

!= std::string("Internal error: pybind11::error_already_set called "

"while Python error indicator not set."))) {

PyErr_Clear();

throw std::runtime_error("error message mismatch");

}

PyErr_Clear();

if (err) {

PyErr_SetString(PyExc_ValueError, "foo");

}

throw py::error_already_set();

});

m.def("python_call_in_destructor", [](const py::dict &d) {

bool retval = false;

try {

PythonCallInDestructor set_dict_in_destructor(d);

PyErr_SetString(PyExc_ValueError, "foo");

throw py::error_already_set();

} catch (const py::error_already_set &) {

retval = true;

}

return retval;

});

m.def("python_alreadyset_in_destructor", [](const py::str &s) {

PythonAlreadySetInDestructor alreadyset_in_destructor(s);

return true;

});

// test_nested_throws

m.def("try_catch",

[m](const py::object &exc_type, const py::function &f, const py::args &args) {

try {

f(*args);

} catch (py::error_already_set &ex) {

if (ex.matches(exc_type)) {

py::print(ex.what());

} else {

// Simply `throw;` also works and is better, but using `throw ex;`

// here to cover that situation (as observed in the wild).

throw ex; // Invokes the copy ctor.

}

});

// Test repr that cannot be displayed

m.def("simple_bool_passthrough", [](bool x) { return x; });

m.def("throw_should_be_translated_to_key_error", []() { throw shared_exception(); });

m.def("raise_from", []() {

PyErr_SetString(PyExc_ValueError, "inner");

py::raise_from(PyExc_ValueError, "outer");

throw py::error_already_set();

});

m.def("raise_from_already_set", []() {

try {

PyErr_SetString(PyExc_ValueError, "inner");

throw py::error_already_set();

} catch (py::error_already_set &e) {

py::raise_from(e, PyExc_ValueError, "outer");

throw py::error_already_set();

}

});

m.def("throw_nested_exception", []() {

try {

throw std::runtime_error("Inner Exception");

} catch (const std::runtime_error &) {

std::throw_with_nested(std::runtime_error("Outer Exception"));

}

});

m.def("error_already_set_what", [](const py::object &exc_type, const py::object &exc_value) {

PyErr_SetObject(exc_type.ptr(), exc_value.ptr());

std::string what = py::error_already_set().what();

bool py_err_set_after_what = (PyErr_Occurred() != nullptr);

PyErr_Clear();

return py::make_tuple(std::move(what), py_err_set_after_what);

});

m.def("test_cross_module_interleaved_error_already_set", []() {

auto cm = py::module_::import("cross_module_interleaved_error_already_set");

auto interleaved_error_already_set

= reinterpret_cast<void (*)()>(PyLong_AsVoidPtr(cm.attr("funcaddr").ptr()));

interleaved_error_already_set();

});

m.def("test_error_already_set_double_restore", [](bool dry_run) {

PyErr_SetString(PyExc_ValueError, "Random error.");

py::error_already_set e;

e.restore();

PyErr_Clear();

if (!dry_run) {

e.restore();

}

});

// https://github.com/pybind/pybind11/issues/4075

m.def("test_pypy_oserror_normalization", []() {

try {

py::module_::import("io").attr("open")("this_filename_must_not_exist", "r");

} catch (const py::error_already_set &e) {

return py::str(e.what()); // str must be built before e goes out of scope.

}

return py::str("UNEXPECTED");

});

}

d-mercator/python/pybind11/tests/test_exceptions.cpp at main · networkgeometry/d-mercator · GitHub

Uh oh!

Expand file tree

Breadcrumbs

test_exceptions.cpp

Latest commit

History

Breadcrumbs

test_exceptions.cpp

File metadata and controls