Repository navigation
π docs(descriptor): clarify native lock protocol compatibility - #905
Merged
gaborbernat merged 1 commit intoNov 3, 2026
Merged
Conversation
gaborbernat
enabled auto-merge (squash)
November 3, 2026 15:53
gaborbernat
disabled auto-merge
November 3, 2026 16:28
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
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.
The descriptor-lock guide currently describes both native backends as one-byte locks and recommends the API for conda-style byte-offset protocols. The implementation uses a whole-file
flockon Unix and a one-byteLockFileExrange at offset 0 on Windows; seeking the descriptor does not select a different range.Clarify that contract in the guide and API docstring, and replace the interoperability recommendation with the requirement to match the existing protocol's primitive and range. Conda's offset-21 protocol illustrates why the API is not a portable replacement. The Unix explanation accounts for operating-system and filesystem differences in
flock/lockfinteraction. Add a documentation changelog fragment.Validation on macOS 27.2 arm64, Python 3.15.2:
tox -e docs(Sphinx-W), with generated how-to, API and Unreleased content checked.release-creator validate-news --base main.python -m pytest tests/test_filelock.py -k descriptor: 23 passed, 500 deselected.Windows behavior was checked against the source and documented API contract, not executed. The local probe is not a conda integration test or a cross-platform test suite.