feat: Add get_keys_at_ref method to Python bindings for historical state access #103
Conversation
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
Expose the historical access functionality to Python, allowing users to
retrieve all key-value pairs at any git reference (commit, branch, or tag).
## Changes
### Python Bindings (src/python.rs)
- Add `get_keys_at_ref(reference: str) -> List[Tuple[bytes, bytes]]` method
- Properly handles HashMap to Python list of tuples conversion
- Thread-safe implementation with error handling
### Type Stubs (prollytree.pyi)
- Add complete type signature for `get_keys_at_ref`
- Include comprehensive documentation with examples
- Document all supported reference types (commits, branches, tags, HEAD~n, etc.)
### Testing
- Add comprehensive unit test `test_get_keys_at_ref`
- Verify access to historical states at different commits
- Test both commit hashes and symbolic references
## API Usage
```python
# Get all keys at a specific commit
pairs = store.get_keys_at_ref("abc123def")
# Get all keys from the main branch
pairs = store.get_keys_at_ref("main")
# Get all keys from current HEAD
pairs = store.get_keys_at_ref("HEAD")
```
This method is essential for time-travel debugging, auditing, and
understanding the complete state of the store at any point in history.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
zhangfengcdt
force-pushed
the
feature/get_keys_at_ref
branch
from
c19339f to
a683b45
Compare
- Added MAX_KEYS_LIMIT constant set to 1024 - Updated get_keys_at_ref to enforce limit with warning message - Updated both PyVersionedKvStore and PyWorktreeVersionedKvStore list_keys methods - Warning message suggests using more specific queries or pagination - Prevents excessive memory usage when dealing with large datasets
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.
Exposes the
get_keys_at_refmethod to Python, allowing users to retrieve all key-value pairs at any historical reference point.Changes
get_keys_at_refmethod toPyVersionedKvStorein Python bindings.pyifile for proper IDE supportUse Cases
This feature enables Python users to:
Example Usage