Skip to content

gh-105912: document gotcha with using os.fork on macOS #112871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 14, 2023
Merged

gh-105912: document gotcha with using os.fork on macOS #112871

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9df2d1b
gh-105912: document gotcha with using os.fork on macOS
ronaldoussoren Dec 8, 2023
38c88d6
Fix lint warning
ronaldoussoren Dec 8, 2023
1ed3962
Update Doc/library/urllib.request.rst
willingc Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Doc/library/os.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4373,6 +4373,11 @@ written in Python, such as a mail server's external command delivery program.
If you use TLS sockets in an application calling ``fork()``, see
the warning in the :mod:`ssl` documentation.

.. warning::

On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using :mod:`urllib.request`.

.. versionchanged:: 3.8
Calling ``fork()`` in a subinterpreter is no longer supported
(:exc:`RuntimeError` is raised).
Expand Down Expand Up @@ -4412,6 +4417,11 @@ written in Python, such as a mail server's external command delivery program.

.. audit-event:: os.forkpty "" os.forkpty

.. warning::

On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using :mod:`urllib.request`.

.. versionchanged:: 3.12
If Python is able to detect that your process has multiple
threads, this now raises a :exc:`DeprecationWarning`. See the
Expand Down
3 changes: 3 additions & 0 deletions Doc/library/pty.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ The :mod:`pty` module defines the following functions:
file descriptor connected to the child's controlling terminal (and also to the
child's standard input and output).

.. warning:: On macOS the use of this function is unsafe when mixed with using
higher-level system APIs, and that includes using :mod:`urllib.request`.


.. function:: openpty()

Expand Down
8 changes: 8 additions & 0 deletions Doc/library/urllib.request.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ authentication, redirections, cookies and more.
The `Requests package <https://requests.readthedocs.io/en/master/>`_
is recommended for a higher-level HTTP client interface.

.. warning::

On macOS it is unsafe to use this module in programs using
:func:`os.fork` because the :func:`getproxies` implementation for
macOS uses a higher-level system API. Set the environement variable
``no_proxy`` to ``*`` to avoid this problem
(e.g. ``os.environ["no_proxy"] = "*"``).

.. include:: ../includes/wasm-notavail.rst

The :mod:`urllib.request` module defines the following functions:
Expand Down