René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Note in post_clear_cache docstring may be out of date","articleBody":"The `git.index.util.post_clear_cache` decorator has this note in its docstring:\r\n\r\nhttps://github.com/gitpython-developers/GitPython/blob/fe1934c5c90e617d49a38a6c36b1eb17dea47013/git/index/util.py#L72-L74\r\n\r\nThis decorator is applied to the `merge_tree`, `move`, and `remove` methods of `git.index.IndexFile` (and nowhere else).\r\n\r\nAs such, that note in the decorator's docstring suggests an intended design direction for the `IndexFile` implementation in GitPython: that, if performance considerations permit, it should eventually make little to no use of `git` commands, unlike GitPython as a whole.\r\n\r\nBy now, my guess is that the intended direction is known, and my (somewhat less certain) guess is that this goal may have been abandoned, becuase:\r\n\r\n- GitPython is considered to be in maintenance mode (per [the README](https://github.com/gitpython-developers/GitPython?tab=readme-ov-file#development-status)).\r\n- [In a review comment](https://github.com/gitpython-developers/GitPython/pull/1770#discussion_r1425130807), if I understood correctly, you have expressed the hope that `IndexFile` is not heavily used, due to not having reached some of its original design goals.\r\n\r\n*However*, there is also now a longer-term vision for GitPython, beyond maintaining the current feature set, articulated in https://github.com/Byron/gitoxide/discussions/1074 under \"GitPython…\".\r\n\r\nIf in the future the `IndexFile` implementation will be rewritten to use gitoxide's (future) Python bindings, then this docstring note is actually of *greater* relevance than before. But then it should still be updated to no longer characterize the aspiration to implement all of `IndexFile` without git subprocess calls as infeasible for performance reasons. And possibly even to mention gitoxide?\r\n\r\nBecause of that, I'm unsure if this note should be removed or updated (if, if updated, then how), or simply left as-is for the time being.","author":{"url":"https://github.com/EliahKagan","@type":"Person","name":"EliahKagan"},"datePublished":"2024-02-26T18:02:17.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":6},"url":"https://github.com/1847/GitPython/issues/1847"}