Skip to content

gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject #141413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ZeroIntensity merged 4 commits into from
Nov 11, 2025
Merged

gh-141004: Document PyFile_OpenCode and PyFile_OpenCodeObject #141413

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a52e949
Document PyFile_OpenCode() and PyFile_OpenCodeObject().
ZeroIntensity Nov 11, 2025
682cdbf
Remove stray newline change.
ZeroIntensity Nov 11, 2025
598c259
Document the string as UTF-8.
ZeroIntensity Nov 11, 2025
145d2d2
Update Doc/c-api/file.rst
ZeroIntensity Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Document PyFile_OpenCode() and PyFile_OpenCodeObject().
  • Loading branch information
@ZeroIntensity
ZeroIntensity committed Nov 11, 2025
commit a52e9495f4fe77bf39654ef102ebac99ff994340
25 changes: 25 additions & 0 deletions Doc/c-api/file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,30 @@ the :mod:`io` APIs instead.
.. versionadded:: 3.8


.. c:function:: PyObject *PyFile_OpenCodeObject(PyObject *path)

Open *path* and read the text. *path* must be a Python :class:`str`
Comment thread
ZeroIntensity marked this conversation as resolved.
Outdated
object. The behavior of this function may be overridden by
:c:func:`PyFile_SetOpenCodeHook` to allow for some preprocessing of the
text.

This is analogous to :func:`io.open_code` in Python.
Comment thread
StanFromIreland marked this conversation as resolved.

On success, this function returns a :term:`strong reference` to a Python
file object. On failure, this function returns ``NULL`` with an exception
set.

.. versionadded:: 3.8


.. c:function:: PyObject *PyFile_OpenCode(const char *path)

Similar to :c:func:`PyFile_OpenCodeObject`, but *path* is a
:c:expr:`const char*` that is decoded by the
:term:`filesystem encoding and error handler`.

@StanFromIreland StanFromIreland Nov 11, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

UTF-8 encoding, no (also implied by the parameter name)?

cpython/Objects/fileobject.c

Line 528 in d890aba

PyObject *pathobj = PyUnicode_FromString(utf8path);

@ZeroIntensity ZeroIntensity Nov 11, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, good catch.


.. versionadded:: 3.8


.. c:function:: int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)

Expand All @@ -108,3 +132,4 @@ the :mod:`io` APIs instead.

Write string *s* to file object *p*. Return ``0`` on success or ``-1`` on
failure; the appropriate exception will be set.