export symbols using __all__ to avoid typing errors#1371
Merged
jdavid merged 4 commits intolibgit2:masterfrom May 7, 2025
Merged
export symbols using __all__ to avoid typing errors#1371jdavid merged 4 commits intolibgit2:masterfrom
__all__ to avoid typing errors#1371jdavid merged 4 commits intolibgit2:masterfrom
Conversation
Member
import sys
before = set(dir())
from pygit2 import *
after = set(dir())
imported_symbols = after - before
print(len(imported_symbols))This prints 412, while in this PR Also put |
Contributor
Author
|
That's a lot missed symbols! Submitted new commits - first one just added all symbols in A-z order, second one categorized them so it will be easier to discard some specific cateogires and then maintain it. This is how I was testing it: Test symbols without before = set(dir())
from pygit2 import *
after = set(dir())
imported_symbols = after - before - {"before"}
import pygit2
all_symbols = set(pygit2.__all__test)
print(len(all_symbols)) # 411
print(len(imported_symbols)) # 411
assert len(diff:=(all_symbols - imported_symbols)) == 0, diff
assert len(diff:=(imported_symbols - all_symbols)) == 0, diffTest with before = set(dir())
from pygit2 import *
after = set(dir())
imported_symbols = after - before - {"before"}
import pygit2
assert len(imported_symbols) == len(set(pygit2.__all__)) == 411
assert set(imported_symbols) == set(pygit2.__all__) |
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
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.
Mentioned in #1322
Explanation on how it works - https://github.com/microsoft/pyright/blob/main/docs/typed-libraries.md#library-interface
Example failing snippet:
Wanted to solve that particular error with missing
Repositorysymbol and I'm not very familar with pygit2 repository - so please advice if any symbols should be removed or added.Currently I've included all symbols that are imported in
__init__, exceptffi,C(looked like something private), to make it fully compatible with currentfrom pygit2 import *behaviour (definingi__all__is limiting wild card import).