Skip to content
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.

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

warnings.catch_warnings is not thread safe or async safe #128384

Open
nascheme opened this issue Dec 31, 2024 · 0 comments
Open

warnings.catch_warnings is not thread safe or async safe #128384

nascheme opened this issue Dec 31, 2024 · 0 comments
Labels
stdlib Python modules in the Lib dir topic-asyncio topic-free-threading type-bug An unexpected behavior, bug, or error

Comments

@nascheme
Copy link
Member

nascheme commented Dec 31, 2024

Bug report

Bug description:

This is an old issue but it has become more urgent to fix given free-threaded Python. A simple example to show how the current context manager can fail:

from concurrent.futures import ThreadPoolExecutor

import warnings

def test_warning():
    with warnings.catch_warnings():
        warnings.simplefilter("ignore")
        warnings.warn("my warning", UserWarning)

tpe = ThreadPoolExecutor(max_workers=10)

threads = [tpe.submit(test_warning) for _ in range(100)]
[t.result() for t in threads]

Since test_warning() is running in separate threads, there is no consistent ordering of which context manager exits first. That means the filters value that gets restored is also not consistent (a race between the threads about which version of the filters value they will restore).

The context manager is also not friendly to async code. These issues have been reported before:

The fairly obvious fix to this issue is to use contextvars, similar to how the decimal module uses a context. This is both thread safe and friendly to async code.

The warnings module itself has some "shallow" thread safety issues but these are relatively easy to fix and no API changes are needed.

CPython versions tested on:

CPython main branch

Operating systems tested on:

Linux

Linked PRs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stdlib Python modules in the Lib dir topic-asyncio topic-free-threading type-bug An unexpected behavior, bug, or error
Projects
Status: Todo
Development

No branches or pull requests

2 participants