From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> Date: Fri, 1 May 2020 18:04:25 +0000 (-0700) Subject: bpo-39691: Clarify io.open_code behavior (GH-19824) X-Git-Tag: v3.8.3~16 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c9d7d32b6dc6140f7fcbf1ae1120df6d59fc28d0;p=thirdparty%2FPython%2Fcpython.git bpo-39691: Clarify io.open_code behavior (GH-19824) (cherry picked from commit 831d58d7865cb98fa09227dc614f4f3ce6af968b) Co-authored-by: Shantanu --- diff --git a/Doc/library/io.rst b/Doc/library/io.rst index 70e01153d419..32151a0ace45 100644 --- a/Doc/library/io.rst +++ b/Doc/library/io.rst @@ -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