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

(cherry picked from commit 831d58d786)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2020-05-01 11:04:25 -07:00 committed by GitHub
parent 71e6122b44
commit c9d7d32b6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 4 deletions

View File

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