From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 12 Nov 2025 22:59:55 +0000 (+0100)
Subject: [3.13] gh-141004: Document `PyRun_InteractiveOneObject` (GH-141405) (GH-141486)
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f127ff7dafd8985e6a23ad8e02de6dd66758ae51;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-141004: Document `PyRun_InteractiveOneObject` (GH-141405) (GH-141486)

gh-141004: Document `PyRun_InteractiveOneObject` (GH-141405)
(cherry picked from commit 26b7df2430cd5a9ee772bfa6ee03a73bd0b11619)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
---

diff --git a/Doc/c-api/veryhigh.rst b/Doc/c-api/veryhigh.rst
index 916c616dfee5..3b07b5fbed59 100644
--- a/Doc/c-api/veryhigh.rst
+++ b/Doc/c-api/veryhigh.rst
@@ -100,18 +100,12 @@ the same library that the Python runtime is using.
       Otherwise, Python may not handle script file with LF line ending correctly.
 
 
-.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename)
-
-   This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below,
-   leaving *flags* set to ``NULL``.
-
-
-.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
+.. c:function:: int PyRun_InteractiveOneObject(FILE *fp, PyObject *filename, PyCompilerFlags *flags)
 
    Read and execute a single statement from a file associated with an
    interactive device according to the *flags* argument.  The user will be
-   prompted using ``sys.ps1`` and ``sys.ps2``.  *filename* is decoded from the
-   :term:`filesystem encoding and error handler`.
+   prompted using ``sys.ps1`` and ``sys.ps2``. *filename* must be a Python
+   :class:`str` object.
 
    Returns ``0`` when the input was
    executed successfully, ``-1`` if there was an exception, or an error code
@@ -120,6 +114,19 @@ the same library that the Python runtime is using.
    :file:`Python.h`, so must be included specifically if needed.)
 
 
+.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename)
+
+   This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below,
+   leaving *flags* set to ``NULL``.
+
+
+.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
+
+   Similar to :c:func:`PyRun_InteractiveOneObject`, but *filename* is a
+   :c:expr:`const char*`, which is decoded from the
+   :term:`filesystem encoding and error handler`.
+
+
 .. c:function:: int PyRun_InteractiveLoop(FILE *fp, const char *filename)
 
    This is a simplified interface to :c:func:`PyRun_InteractiveLoopFlags` below,