]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-38778: Document that os.fork is not allowed in subinterpreters (GH-17123)
authorPhil Connell <pconnell@gmail.com>
Fri, 15 Nov 2019 16:56:03 +0000 (16:56 +0000)
committerMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Fri, 15 Nov 2019 16:56:03 +0000 (08:56 -0800)
Small docs update for [bpo-34651](https://bugs.python.org/issue34651).

Other references to fork (e.g. the PyOS.*Fork functions or discussions of fork() when embedding Python) point back to os.fork, so I don't think any other updates are needed.

https://bugs.python.org/issue38778

Automerge-Triggered-By: @ericsnowcurrently
Doc/library/os.rst
Misc/NEWS.d/next/Documentation/2019-11-12-15-31-09.bpo-38778.PHhTlv.rst [new file with mode: 0644]

index 652d8de4e384f1f4718ff529df68b477ecfeb5cb..4fec647828e25067f2e103ce384eae76a1cb122e 100644 (file)
@@ -3478,7 +3478,11 @@ written in Python, such as a mail server's external command delivery program.
    parent.  If an error occurs :exc:`OSError` is raised.
 
    Note that some platforms including FreeBSD <= 6.3 and Cygwin have
-   known issues when using fork() from a thread.
+   known issues when using ``fork()`` from a thread.
+
+   .. versionchanged:: 3.8
+      Calling ``fork()`` in a subinterpreter is no longer supported
+      (:exc:`RuntimeError` is raised).
 
    .. warning::
 
@@ -3495,6 +3499,10 @@ written in Python, such as a mail server's external command delivery program.
    master end of the pseudo-terminal.  For a more portable approach, use the
    :mod:`pty` module.  If an error occurs :exc:`OSError` is raised.
 
+   .. versionchanged:: 3.8
+      Calling ``forkpty()`` in a subinterpreter is no longer supported
+      (:exc:`RuntimeError` is raised).
+
    .. availability:: some flavors of Unix.
 
 
diff --git a/Misc/NEWS.d/next/Documentation/2019-11-12-15-31-09.bpo-38778.PHhTlv.rst b/Misc/NEWS.d/next/Documentation/2019-11-12-15-31-09.bpo-38778.PHhTlv.rst
new file mode 100644 (file)
index 0000000..053e1d2
--- /dev/null
@@ -0,0 +1 @@
+Document the fact that :exc:`RuntimeError` is raised if :meth:`os.fork` is called in a subinterpreter.