Return Python enums from _pygit2 #1263
Merged
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
Affected functions: - Repository.status - Repository.status_file - Repository.merge_analysis - DiffFile.flags - DiffFile.mode - DiffDelta.flags - DiffDelta.status
jdavid
requested changes
Jan 4, 2024
pygit2/__init__.py
Outdated
Comment on lines
64
to
65
| cache_enums() | ||
| del cache_enums # Don't expose this to user code |
There was a problem hiding this comment.
Maybe rename to __cache_enums() to emphasize that it's private?
There was a problem hiding this comment.
OK; in the latest commit, I had to import it explicitly from _pygit2 because from _pygit2 import * skips anything starting with an underscore.
Because the function now starts with an underscore, it won't be exposed to user code with from pygit2 import *, so I also removed the del cache_enums statement. (And if user code goes out of its way to call it anyway, the world won't stop spinning.)
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.
Following up on #1251: C functions in _pygit2 now return actual Python enums instead of ints.
For example, Repository.status() would previously return simple ints. Now it returns FileStatus which transparently demotes to ints for legacy code:
>>> repo.status() {'file1.txt': <FileStatus.CONFLICTED: 32768>, 'file2.txt': <FileStatus.INDEX_MODIFIED|WT_MODIFIED: 258>}Implementation details: References to the enums are cached via
cache_modulesso that lookups are faster. The references are decref'd infree_module(new module destructor function)Affected functions: