Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add __all__ in git.exc #1719

Merged
merged 3 commits into from
Oct 20, 2023
Merged

Add __all__ in git.exc #1719

merged 3 commits into from
Oct 20, 2023

Commits on Oct 20, 2023

  1. Remove now-unused import in top-level __init__.py 

    The inspect module was only used to dynamically generate __all__,
which is statically written since c862845. Although it includes
everything it originally had for compatibility (8edc53b), this did
not include modules, since the comprehension used to generate it
omitted those (which is what it needed the inspect module for).
So it was not, and is not, listed in __all__, and can be removed.
    @EliahKagan
    EliahKagan committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    8197e90 View commit details
    Browse the repository at this point in the history

  2. Add __all__ in git.exc, adjust __init__.py imports 

    The git.exc module imports exceptions from gitdb.exc to republish
them, as well as defining its own (also for use from outside). But
because it did not define __all__, the intent for the exceptions it
imported was unclear, since names that are introduced by imports
and not present in __all__ are not generally considered public,
even when __all__ is absent and a "*" import would reimport them.

This rectifies that by adding __all__ and listing both imported and
newly introduced exceptions explicitly in it. Although this
strictly expands which names are public under typical conventions,
it strictly contracts which names are imported by a "*" import,
because the presence of __all__ suppresses names not listed in it
from being imported that way. However, because under typical
conventions those other names are not considered public, and they
were not even weakly documented as public, this should be okay.

(Even though this is not a breaking change, in that code it would
break would already technically be broken... if it turns out that
it is common to wrongly rely on the availabiliy of those names,
then this may need to be revisited and slightly modified.)

This brings the readily identified public interface of git.exc in
line with what is weakly implied (and intended) by its docstring.

This also modifies __init__.py accordingly: The top-level git
module has for some time used a "*" import on git.exc, causing
the extra names originally meant as implementation details to be
included. Because its own __all__ was dynamically generated until
c862845, gitpython-developers#1659 also added 8edc53b to retain the formerly present
names in __all__. So the change here imports those names from the
modules that deliberately provide them, to preserve compatibility.
    @EliahKagan
    EliahKagan committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    7545b80 View commit details
    Browse the repository at this point in the history

  3. Remove @UnusedImport from an import that is used 

    Inclusion in __all__ is considered a use.
    @EliahKagan
    EliahKagan committed Oct 20, 2023
    Configuration menu
    Copy the full SHA
    2af3679 View commit details
    Browse the repository at this point in the history