Commit f89d065
committed
Fix git.objects.__all__ and make submodules explicit
The submodules being made explicit here are of course Python
submodules, not git submodules.
The git.objects.submodule Python submodule (which is *about* git
submodules) is made explicit here (as are the names imported from
that Python submodule's own Python submodules) along with the other
Python submodules of git.objects.
Unlike some other submodules, but like the top-level git module
until #1659, git.objects already defined __all__ but it was
dynamically constructed. As with git.__all__ previously (as noted
in #1859), I have used https://github.com/EliahKagan/deltall here
to check that it is safe, sufficient, and probably necessary to
replace this dynamically constructed __all__ with a literal list of
strings in which all of the original elements are included. See:
https://gist.github.com/EliahKagan/e627603717ca5f9cafaf8de9d9f27ad7
Running the modattrs.py script, and diffing against the output from
before the current import refactoring began, reveals two changes to
module contents as a result of the change here:
- git.objects no longer contains `inspect`, which it imported just
to build the dynamically constructed __all__. Because this was
not itself included in that __all__ or otherwise made public or
used out of git.objects, that is okay. This is exactly analogous
to the situation in 8197e90, which removed it from the top-level
git module after #1659.
- The top-level git module now has has new attributes blob, commit,
submodule, and tree, aliasing the corresponding modules. This
has happened as a result of them being put in git.objects.__all__
along with various names imported from them. (As noted in some
prior commits, there are tradeoffs associated with doing this,
and it may be that such elements of __all__ should be removed,
here and elsewhere.)1 parent 01c95eb commit f89d065
1 file changed
Lines changed: 26 additions & 11 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,15 +3,30 @@ | |||
| 3 | 3 | ||
| 4 | 4 | """Import all submodules' main classes into the package space.""" | |
| 5 | 5 | ||
| 6 | - import inspect | ||
| 6 | + __all__ = [ | ||
| 7 | + "base", | ||
| 8 | + "blob", | ||
| 9 | + "commit", | ||
| 10 | + "submodule", | ||
| 11 | + "tag", | ||
| 12 | + "tree", | ||
| 13 | + "IndexObject", | ||
| 14 | + "Object", | ||
| 15 | + "Blob", | ||
| 16 | + "Commit", | ||
| 17 | + "Submodule", | ||
| 18 | + "UpdateProgress", | ||
| 19 | + "RootModule", | ||
| 20 | + "RootUpdateProgress", | ||
| 21 | + "TagObject", | ||
| 22 | + "Tree", | ||
| 23 | + "TreeModifier", | ||
| 24 | + ] | ||
| 7 | 25 | ||
| 8 | - from .base import * # noqa: F403 | ||
| 9 | - from .blob import * # noqa: F403 | ||
| 10 | - from .commit import * # noqa: F403 | ||
| 11 | - from .submodule.base import * # noqa: F403 | ||
| 12 | - from .submodule.root import * # noqa: F403 | ||
| 13 | - from .tag import * # noqa: F403 | ||
| 14 | - from .tree import * # noqa: F403 | ||
| 15 | - | ||
| 16 | - # Must come after submodule was made available. | ||
| 17 | - __all__ = [name for name, obj in locals().items() if not (name.startswith("_") or inspect.ismodule(obj))] | ||
| 26 | + from .base import IndexObject, Object | ||
| 27 | + from .blob import Blob | ||
| 28 | + from .commit import Commit | ||
| 29 | + from .submodule.base import Submodule, UpdateProgress | ||
| 30 | + from .submodule.root import RootModule, RootUpdateProgress | ||
| 31 | + from .tag import TagObject | ||
| 32 | + from .tree import Tree, TreeModifier | ||
0 commit comments