gh-141004: Document PyRun_InteractiveOneObject (GH-141405)
This commit is contained in:
@@ -100,6 +100,20 @@ the same library that the Python runtime is using.
|
|||||||
Otherwise, Python may not handle script file with LF line ending correctly.
|
Otherwise, Python may not handle script file with LF line ending correctly.
|
||||||
|
|
||||||
|
|
||||||
|
.. 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* 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
|
||||||
|
from the :file:`errcode.h` include file distributed as part of Python if
|
||||||
|
there was a parse error. (Note that :file:`errcode.h` is not included by
|
||||||
|
:file:`Python.h`, so must be included specifically if needed.)
|
||||||
|
|
||||||
|
|
||||||
.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename)
|
.. c:function:: int PyRun_InteractiveOne(FILE *fp, const char *filename)
|
||||||
|
|
||||||
This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below,
|
This is a simplified interface to :c:func:`PyRun_InteractiveOneFlags` below,
|
||||||
@@ -108,17 +122,10 @@ the same library that the Python runtime is using.
|
|||||||
|
|
||||||
.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
|
.. c:function:: int PyRun_InteractiveOneFlags(FILE *fp, const char *filename, PyCompilerFlags *flags)
|
||||||
|
|
||||||
Read and execute a single statement from a file associated with an
|
Similar to :c:func:`PyRun_InteractiveOneObject`, but *filename* is a
|
||||||
interactive device according to the *flags* argument. The user will be
|
:c:expr:`const char*`, which is decoded from the
|
||||||
prompted using ``sys.ps1`` and ``sys.ps2``. *filename* is decoded from the
|
|
||||||
:term:`filesystem encoding and error handler`.
|
:term:`filesystem encoding and error handler`.
|
||||||
|
|
||||||
Returns ``0`` when the input was
|
|
||||||
executed successfully, ``-1`` if there was an exception, or an error code
|
|
||||||
from the :file:`errcode.h` include file distributed as part of Python if
|
|
||||||
there was a parse error. (Note that :file:`errcode.h` is not included by
|
|
||||||
:file:`Python.h`, so must be included specifically if needed.)
|
|
||||||
|
|
||||||
|
|
||||||
.. c:function:: int PyRun_InteractiveLoop(FILE *fp, const char *filename)
|
.. c:function:: int PyRun_InteractiveLoop(FILE *fp, const char *filename)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user