Skip to content

Commit

Permalink
pythongh-107162: Document errcode.h usage in its comment
Browse files Browse the repository at this point in the history
  • Loading branch information
vstinner committed Jul 24, 2023
1 parent 0a9b339 commit 28729e0
Showing 1 changed file with 18 additions and 9 deletions.
27 changes: 18 additions & 9 deletions Include/errcode.h
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
// Error codes passed around between file input, tokenizer, parser and
// interpreter. This is necessary so we can turn them into Python
// exceptions at a higher level. Note that some errors have a
// slightly different meaning when passed from the tokenizer to the
// parser than when passed from the parser to the interpreter; e.g.
// the parser only returns E_EOF when it hits EOF immediately, and it
// never returns E_OK.
//
// The PyRun_InteractiveOneObjectEx() function can return E_EOF, same as its
// variants:
//
// * PyRun_InteractiveOneObject()
// * PyRun_InteractiveOneFlags()
// * PyRun_InteractiveOne()
//
// These error codes are also used by the internal C API of the parser and the
// tokenizer.

#ifndef Py_ERRCODE_H
#define Py_ERRCODE_H
#ifdef __cplusplus
extern "C" {
#endif


/* Error codes passed around between file input, tokenizer, parser and
interpreter. This is necessary so we can turn them into Python
exceptions at a higher level. Note that some errors have a
slightly different meaning when passed from the tokenizer to the
parser than when passed from the parser to the interpreter; e.g.
the parser only returns E_EOF when it hits EOF immediately, and it
never returns E_OK. */

#define E_OK 10 /* No error */
#define E_EOF 11 /* End Of File */
#define E_INTR 12 /* Interrupted */
Expand Down

0 comments on commit 28729e0

Please sign in to comment.