gh-135801: Fix inaccurate module info for SyntaxWarnings duri 8000 ng AST parsing #135829
Conversation
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
All commit authors signed the Contributor License Agreement. |
| */ | ||
| int | ||
| _PyErr_EmitSyntaxWarningFromCompiler(PyObject *msg, PyObject *filename, int lineno, int col_offset, | ||
| int end_lineno, int end_col_offset) |
There was a problem hiding this comment.
_PyErr_EmitSyntaxWarning is called from compile.c and ast_preprocess.c. Arguably, these are both parts of "the compiler". Why do we need to introduce a new function for this rather than fix _PyErr_EmitSyntaxWarning?
This commit addresses the inaccurate module information provided for SyntaxWarnings during AST parsing, specifically reported in issue #135801.
Previously,
_PyErr_EmitSyntaxWarning(used by the compiler) relied on_PyErr_WarnExplicitObjectWithContextto infer the module name from the call stack. During compilation, this often resulted in misleading module names likesysorimportlib._bootstrap, making it difficult to filter warnings effectively (e.g., using-W error::SyntaxWarning:test).To resolve this, a new internal function
_PyErr_EmitSyntaxWarningFromCompilerwas introduced inPython/errors.c. This function explicitly callsPyErr_WarnExplicitObjectwith aNULLmodule argument, forcing the warning system to derive the module name from the filename provided by the compiler.The
normalize_modulefunction inPython/_warnings.cwas also refined. Instead of simple string manipulation or problematic pure C path parsing, it now leverages Python'sos.pathmodule (via Python C API calls likebasename,splitext, anddirname). This ensures robust and accurate extraction of module names from arbitrary file paths, including correct handling of__init__.pyfiles, thereby providing correct module information for compiler-generatedSyntaxWarningmessages.This approach ensures cross-platform compatibility and reliability by utilizing Python's battle-tested path handling capabilities, directly addressing the core issue reported.