From: Tom Tromey <tromey@adacore.com>
To: gdb-patches@sourceware.org
Cc: Tom Tromey <tromey@adacore.com>
Subject: [PATCH] Set __file__ when source'ing a Python script
Date: Fri, 8 Mar 2024 12:25:43 -0700 [thread overview]
Message-ID: <20240308192543.3578375-1-tromey@adacore.com> (raw)
This patch arranges to set __file__ when source'ing a Python script.
This fixes a problem that was introduced by the "source" rewrite, and
then pointed out by Lancelot Six.
---
gdb/python/python.c | 73 +++++++++++++++++++++++++----
gdb/testsuite/gdb.python/source2.py | 3 ++
2 files changed, 66 insertions(+), 10 deletions(-)
diff --git a/gdb/python/python.c b/gdb/python/python.c
index 57f6bd571d5..e2ac315f9f5 100644
--- a/gdb/python/python.c
+++ b/gdb/python/python.c
@@ -288,12 +288,13 @@ gdbpy_check_quit_flag (const struct extension_language_defn *extlang)
/* Evaluate a Python command like PyRun_SimpleString, but takes a
Python start symbol, and does not automatically print the stack on
- errors. FILENAME is used to set the file name in error
- messages. */
+ errors. FILENAME is used to set the file name in error messages;
+ NULL means that this is evaluating a string, not the contents of a
+ file. */
static int
eval_python_command (const char *command, int start_symbol,
- const char *filename = "<string>")
+ const char *filename = nullptr)
{
PyObject *m, *d;
@@ -305,17 +306,69 @@ eval_python_command (const char *command, int start_symbol,
if (d == NULL)
return -1;
+ bool file_set = false;
+ if (filename != nullptr)
+ {
+ gdbpy_ref<> file = host_string_to_python_string ("__file__");
+ if (file == nullptr)
+ return -1;
+
+ /* PyDict_GetItemWithError returns a borrowed reference. */
+ PyObject *found = PyDict_GetItemWithError (d, file.get ());
+ if (found == nullptr)
+ {
+ if (PyErr_Occurred ())
+ return -1;
+
+ gdbpy_ref<> filename_obj = host_string_to_python_string (filename);
+ if (filename_obj == nullptr)
+ return -1;
+
+ if (PyDict_SetItem (d, file.get (), filename_obj.get ()) < 0)
+ return -1;
+ if (PyDict_SetItemString (d, "__cached__", Py_None) < 0)
+ return -1;
+
+ file_set = true;
+ }
+ }
+
/* Use this API because it is in Python 3.2. */
- gdbpy_ref<> code (Py_CompileStringExFlags (command, filename, start_symbol,
+ gdbpy_ref<> code (Py_CompileStringExFlags (command,
+ filename == nullptr
+ ? "<string>"
+ : filename,
+ start_symbol,
nullptr, -1));
- if (code == nullptr)
- return -1;
- gdbpy_ref<> result (PyEval_EvalCode (code.get (), d, d));
- if (result == nullptr)
- return -1;
+ int result = -1;
+ if (code != nullptr)
+ {
+ gdbpy_ref<> eval_result (PyEval_EvalCode (code.get (), d, d));
+ if (eval_result != nullptr)
+ result = 0;
+ }
+
+ if (file_set)
+ {
+ /* If there's already an exception occurring, preserve it and
+ restore it before returning from this function. */
+ std::optional<gdbpy_err_fetch> save_error;
+ if (result < 0)
+ save_error.emplace ();
+
+ /* CPython also just ignores errors here. These should be
+ expected to be exceedingly rare anyway. */
+ if (PyDict_DelItemString (d, "__file__") < 0)
+ PyErr_Clear ();
+ if (PyDict_DelItemString (d, "__cached__") < 0)
+ PyErr_Clear ();
- return 0;
+ if (save_error.has_value ())
+ save_error->restore ();
+ }
+
+ return result;
}
/* Implementation of the gdb "python-interactive" command. */
diff --git a/gdb/testsuite/gdb.python/source2.py b/gdb/testsuite/gdb.python/source2.py
index 60d59d9056e..79dc1c26524 100644
--- a/gdb/testsuite/gdb.python/source2.py
+++ b/gdb/testsuite/gdb.python/source2.py
@@ -15,4 +15,7 @@
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
+# Make sure __file__ is defined.
+assert type(__file__) == str
+
print("y%ss" % "e")
--
2.43.0
next reply other threads:[~2024-03-08 19:25 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-08 19:25 Tom Tromey [this message]
2024-03-15 18:56 ` Lancelot SIX
2024-03-17 14:07 ` Andrew Burgess
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240308192543.3578375-1-tromey@adacore.com \
--to=tromey@adacore.com \
--cc=gdb-patches@sourceware.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).