]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-39691: Clarify io.open_code behavior (GH-19824)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 1 May 2020 18:04:25 +0000 (11:04 -0700)
committerGitHub <noreply@github.com>
Fri, 1 May 2020 18:04:25 +0000 (11:04 -0700)
(cherry picked from commit 831d58d7865cb98fa09227dc614f4f3ce6af968b)

Co-authored-by: Shantanu <hauntsaninja@users.noreply.github.com>
Doc/library/io.rst

index 70e01153d41966e79656d52ce413ffb3c2facd8c..32151a0ace458e2b4647942e6d0a02d513ae0a69 100644 (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