Commit fcc7418
committed
Don't explicitly list direct submodules in __all__
This is for non-toplevel __all__, as git.__all__ already did not
do this.
As noted in some of the previous commit messags that added them,
omitting them might be a bit safer in terms of the impact of bugs
bugs in code using GitPython, in that unexpected modules, some of
which have the same name as other modules within GitPython, won't
be imported due to wildcard imports from intermediate subpackages
(those that are below the top-level git package/module but collect
non-subpackage modules). Though it is hard to know, since some of
these would have been imported before, when an __all__ was not
defined at that level.
However, a separate benefit of omitting them is consistency with
git.__all__, which does not list the direct Python submodules of
the git module.
This does not affect the output of the modattrs.py script, because
the attributes exist with the same objects as their values as a
result of those Python submodules being imported (in "from" imports
and otherwise), including when importing the top-level git module.1 parent 00f4cbc commit fcc7418
5 files changed
Lines changed: 2 additions & 31 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,10 +4,6 @@ | |||
| 4 | 4 | """Initialize the index package.""" | |
| 5 | 5 | ||
| 6 | 6 | __all__ = [ | |
| 7 | - "base", | ||
| 8 | - "fun", | ||
| 9 | - "typ", | ||
| 10 | - "util", | ||
| 11 | 7 | "BaseIndexEntry", | |
| 12 | 8 | "BlobFilter", | |
| 13 | 9 | "CheckoutError", | |
@@ -16,6 +12,5 @@ | |||
| 16 | 12 | "StageType", | |
| 17 | 13 | ] | |
| 18 | 14 | ||
| 19 | - from . import base, fun, typ, util | ||
| 20 | 15 | from .base import CheckoutError, IndexFile | |
| 21 | 16 | from .typ import BaseIndexEntry, BlobFilter, IndexEntry, StageType | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -4,12 +4,6 @@ | |||
| 4 | 4 | """Import all submodules' main classes into the package space.""" | |
| 5 | 5 | ||
| 6 | 6 | __all__ = [ | |
| 7 | - "base", | ||
| 8 | - "blob", | ||
| 9 | - "commit", | ||
| 10 | - "submodule", | ||
| 11 | - "tag", | ||
| 12 | - "tree", | ||
| 13 | 7 | "IndexObject", | |
| 14 | 8 | "Object", | |
| 15 | 9 | "Blob", | |
@@ -23,7 +17,6 @@ | |||
| 23 | 17 | "TreeModifier", | |
| 24 | 18 | ] | |
| 25 | 19 | ||
| 26 | - from . import base, blob, commit, submodule, tag, tree | ||
| 27 | 20 | from .base import IndexObject, Object | |
| 28 | 21 | from .blob import Blob | |
| 29 | 22 | from .commit import Commit | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,16 +1,7 @@ | |||
| 1 | 1 | # This module is part of GitPython and is released under the | |
| 2 | 2 | # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/ | |
| 3 | 3 | ||
| 4 | - __all__ = [ | ||
| 5 | - "base", | ||
| 6 | - "root", | ||
| 7 | - "util", | ||
| 8 | - "Submodule", | ||
| 9 | - "UpdateProgress", | ||
| 10 | - "RootModule", | ||
| 11 | - "RootUpdateProgress", | ||
| 12 | - ] | ||
| 4 | + __all__ = ["Submodule", "UpdateProgress", "RootModule", "RootUpdateProgress"] | ||
| 13 | 5 | ||
| 14 | - from . import base, root, util | ||
| 15 | 6 | from .base import Submodule, UpdateProgress | |
| 16 | 7 | from .root import RootModule, RootUpdateProgress | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -2,12 +2,6 @@ | |||
| 2 | 2 | # 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/ | |
| 3 | 3 | ||
| 4 | 4 | __all__ = [ | |
| 5 | - "head", | ||
| 6 | - "log", | ||
| 7 | - "reference", | ||
| 8 | - "remote", | ||
| 9 | - "symbolic", | ||
| 10 | - "tag", | ||
| 11 | 5 | "HEAD", | |
| 12 | 6 | "Head", | |
| 13 | 7 | "RefLog", | |
@@ -19,7 +13,6 @@ | |||
| 19 | 13 | "TagReference", | |
| 20 | 14 | ] | |
| 21 | 15 | ||
| 22 | - from . import head, log, reference, remote, symbolic, tag | ||
| 23 | 16 | from .head import HEAD, Head | |
| 24 | 17 | from .log import RefLog, RefLogEntry | |
| 25 | 18 | from .reference import Reference | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -3,7 +3,6 @@ | |||
| 3 | 3 | ||
| 4 | 4 | """Initialize the repo package.""" | |
| 5 | 5 | ||
| 6 | - __all__ = ["base", "fun", "Repo"] | ||
| 6 | + __all__ = ["Repo"] | ||
| 7 | 7 | ||
| 8 | - from . import base, fun | ||
| 9 | 8 | from .base import Repo | |
0 commit comments