bpo-31338

[warsaw]

Over in http://bugs.python.org/issue31338 the idea to implement a macro called Py_UNREACHABLE() was proposed. This would be used in cases where you'd be tempted to use an assert(0) or abort(), i.e. for code paths you do not expect will ever be reached.

Using Py_UNREACHABLE() has a few advantages:

• Consistency; it's easy to search for such code paths;
• The intent is clear;
• Being a macro, we adjust this on a per-compiler basis in case we need to make it more friendly (although the default implementation makes gcc, clang, and MSVC happy).
• We can define it differently for other use cases, such as adding a common debugging entry point, or printing __FILE__ and __LINE__, etc.

I've changed the examples described in bpo-31338, but may not have gotten them all.

For now, this is defined strictly as abort() which is the simplest thing that make the common compilers happy.

I've also added some documentation about Py_UNREACHABLE() and a few other macros in pymacros.h.

https://bugs.python.org/issue31338

[vstinner]

LGTM.

[warsaw]

Thanks @Haypo !

[encukou]

The Py_UNREACHABLE() doc entry is missing versionadded, see #4337