Skip to content

Fix c-api/file.rst indexes #114608

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
merged 2 commits into from
Jan 27, 2024
Merged

Fix c-api/file.rst indexes #114608

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a7228c
Fix `c-api/file.rst` indexes
sobolevn Jan 26, 2024
0998130
Restore initial layout
sobolevn Jan 26, 2024
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
17 changes: 10 additions & 7 deletions Doc/c-api/file.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,18 +60,21 @@ the :mod:`io` APIs instead.
raised if the end of the file is reached immediately.


.. c:type:: PyObject * (*Py_OpenCodeHookFunction)(PyObject *, void *)

Equivalent of :c:expr:`PyObject *(\*)(PyObject *path,
void *userData)`, where *path* is guaranteed to be
:c:type:`PyUnicodeObject`.

.. versionadded:: 3.8


.. c:function:: int PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction handler)

Overrides the normal behavior of :func:`io.open_code` to pass its parameter
through the provided handler.

The handler is a function of type:

.. c:type:: Py_OpenCodeHookFunction

Equivalent of :c:expr:`PyObject *(\*)(PyObject *path,
void *userData)`, where *path* is guaranteed to be
:c:type:`PyUnicodeObject`.
The *handler* is a function of type :c:type:`Py_OpenCodeHookFunction`.

The *userData* pointer is passed into the hook function. Since hook
functions may be called from different runtimes, this pointer should not
Expand Down