Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

bpo-39691: Clarify io.open_code behavior (GH-19824)

This commit is contained in:
Shantanu 2020-05-01 10:52:10 -07:00 committed by GitHub
parent 4168f1e460
commit 831d58d786
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Doc/library/io.rst
View File

@ -132,12 +132,13 @@ High-level Module Interface
Opens the provided file with mode ``'rb'``. This function should be used
when the intent is to treat the contents as executable code.
``path`` should be an absolute path.
``path`` should be a :class:`str` and an absolute path.
The behavior of this function may be overridden by an earlier call to the
:c:func:`PyFile_SetOpenCodeHook`, however, it should always be considered
interchangeable with ``open(path, 'rb')``. Overriding the behavior is
intended for additional validation or preprocessing of the file.
:c:func:`PyFile_SetOpenCodeHook`. However, assuming that ``path`` is a
:class:`str` and an absolute path, ``open_code(path)`` should always behave
the same as ``open(path, 'rb')``. Overriding the behavior is intended for
additional validation or preprocessing of the file.
.. versionadded:: 3.8