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.

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

Jump to bottom

Document the thread safety of functools.lru_cache #93179

Closed
pfmoore opened this issue May 24, 2022 · 0 comments
Closed

Document the thread safety of functools.lru_cache #93179

pfmoore opened this issue May 24, 2022 · 0 comments
Assignees
@rhettinger
Labels
docs Documentation in the Doc dir

Comments

@pfmoore
Copy link
Member

pfmoore commented May 24, 2022 •
edited by bedevere-bot
Loading

Documentation

The documentation doesn't state whether functools.lru_cache (and decorators derived from it like functools.cache) are thread safe, meaning that it's not clear that it's safe to (for example) populate the cache by running the function in multiple threads. The comments in the source code certainly imply that it's intended to be thread safe, but I'll admit I haven't double checked all the details.

Can the thread safety be made explicit in the docs?

Linked PRs
@pfmoore pfmoore added the docs Documentation in the Doc dir label May 24, 2022
@pfmoore pfmoore mentioned this issue May 24, 2022
Open
@rhettinger rhettinger self-assigned this May 25, 2022
@josh-willis josh-willis mentioned this issue Aug 3, 2022
Merged
rhettinger added a commit to rhettinger/cpython that referenced this issue Aug 13, 2022
@rhettinger
pythonGH-93179: Document the thread safety of functools.lru_cache
1f034ed
@bedevere-bot bedevere-bot mentioned this issue Aug 13, 2022
Merged
rhettinger added a commit that referenced this issue Aug 18, 2022
@rhettinger
GH-93179: Document the thread safety of functools.lru_cache (GH-95970)
ba4bb7e
@bedevere-bot bedevere-bot mentioned this issue Aug 19, 2022
Merged
rhettinger added a commit that referenced this issue Aug 21, 2022
@rhettinger
GH-93179: Document the thread safety of functools.lru_cache (GH-96101)
eea8f42
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Dec 24, 2022
@rhettinger @miss-islington
pythonGH-93179: Document the thread safety of functools.lru_cache (py…
598f49b 
…thonGH-95970)

(cherry picked from commit ba4bb7e)

Co-authored-by: Raymond Hettinger <[email protected]>
@bedevere-bot bedevere-bot mentioned this issue Dec 24, 2022
Merged
miss-islington added a commit that referenced this issue Dec 24, 2022
@miss-islington @rhettinger
GH-93179: Document the thread safety of functools.lru_cache (GH-95970)
3b70487 
(cherry picked from commit ba4bb7e)

Co-authored-by: Raymond Hettinger <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rhettinger rhettinger

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pfmoore @rhettinger