Replace GitPython with pygit2 #2120
Draft
Conversation
This file contains 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
mgorny
force-pushed
the
pygit2
branch
2 times, most recently
from
f6dadb8
to
e90a067
Compare
mgorny
commented
Nov 6, 2024
Comment on lines
+12
to
+17
| if search_parent_directories: | ||
| path = pygit2.discover_repository(path) | ||
| if path is not None: | ||
| repo = pygit2.Repository( | ||
| path, pygit2.enums.RepositoryOpenFlag.NO_SEARCH | ||
| ) |
There was a problem hiding this comment.
FWICS we never call it with search_parent_directories=False. If we were to remove that kwarg, we could just remove NO_SEARCH (or we could change flags based on the arg value — but I've figured doing it more explicitly is more readable).
Replace the use of GitPython package with pygit2. The latter seems to have better git support, in particular it supports the newer index versions 3 and 4. Since it is backed by the libgit2 library that is also used by Cargo, it seems to have the best chances of being updated for compatibility with new git versions. Admittedly, the API feels very low-level. In particular, it is necessary to explicitly request writing changes to index back, and explicitly reread it when it's modified externally (e.g. via another `pygit2.Repository` instance, as in tests). On the plus side, it does not invoke `git` at all -- everything is done by the library. Fixes conda-forge#2116
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.
Checklist
newsentrypython conda_smithy/schema.py)Replace the use of GitPython package with pygit2. The latter seems to have better git support, in particular it supports the newer index versions 3 and 4. Since it is backed by the libgit2 library that is also used by Cargo, it seems to have the best chances of being updated for compatibility with new git versions.
Admittedly, the API feels very low-level. In particular, it is necessary to explicitly request writing changes to index back, and explicitly reread it when it's modified externally (e.g. via another
pygit2.Repositoryinstance, as in tests). On the plus side, it does not invokegitat all -- everything is done by the library.Fixes #2116
So far focused on
feedstock_io.pyand its tests. I need to figure out how to test the changes to other files properly, given that the tests mock the entiregit.Repo.clone_fromcall.