Improve usability of Remote.ls_remotes
's result
#1397
Merged
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.
Remote.ls_remotes
used to return a dict with str keys, which is inconsistent with how pygit2 generally returns structured results. This PR introducesRemoteHead
, a class with fields.Backwards compatibility with the old-style dict was kept via
RemoteHead.__getitem__
which emits aDeprecationWarning
.Also, when the
local
flag is off,RemoteHead.loid
now forwards oid zero (0000000
) as returned by libgit2 instead of making itNone
.Tangent: I think
ls_remotes
is a bit of a confusing name. Perhaps something likelist_heads
oradvertised_heads
would be more intuitive, but this could be for another PR. What do you think?