docs: clarify per-thread scope of FileLock configuration#543
Merged
gaborbernat merged 1 commit intoMay 23, 2026
Merged
Conversation
…local=True When thread_local=True (the default for sync locks), every field of FileLockContext lives on threading.local — not only the lock counter and file descriptor that the existing docs call out. This change makes that explicit in the BaseFileLock/BaseAsyncFileLock docstrings and in docs/concepts.rst, and adds behaviour-pinning tests for the per-thread setter visibility under thread_local=True and the cross-thread visibility under thread_local=False. No behaviour change; documentation and tests only.
Gares95
force-pushed
the
docs/clarify-thread-local-context-fields
branch
from
908ef0a to
a94d6d0
Compare
gaborbernat
approved these changes
May 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarifies that when
thread_local=True(the default for syncFileLock/SoftFileLock), every field of the internalFileLockContextlives onthreading.local, including the configuration valuespoll_interval,timeout,blocking,mode, andlifetime— not only the lock counter and file descriptor that the existing docs name.Updates:
BaseFileLock.__init__andBaseAsyncFileLock.__init__docstrings.docs/concepts.rst"Thread-local vs shared state" section.tests/test_filelock.pycovering setter visibility under boththread_local=Trueandthread_local=False.No behaviour change; documentation and tests only.
Test plan
tox run/pytest tests/passes locally (440 passed, 25 skipped on Python 3.12 / Linux).pre-commit run --all-filespasses.test_thread_local_setter_visibilityandtest_non_thread_local_setter_visibilitypass for bothFileLockandSoftFileLock.