Minor additional cleanup

kenodegard · kenodegard · commit 79a36a54b889 · 2017-07-25T10:09:52.000-05:00
Added additional information in the import warning/error that tells the
user how to silence the warning/error. Also added a GIT_OK variable
that allows for a quick check whether the refresh has succeeded instead
of needing to test an actual git command.
diff --git a/git/__init__.py b/git/__init__.py
@@ -60,12 +60,19 @@ def _init_externals():
 
 
 #{ Initialize git executable path
+GIT_OK = None
+
 def refresh(path=None):
     """Convenience method for setting the git executable path."""
+    global GIT_OK
+    GIT_OK = False
+
     if not Git.refresh(path=path):
         return
     if not FetchInfo.refresh():
         return
+
+    GIT_OK = True
 #} END initialize git executable path
 
 #################
diff --git a/git/cmd.py b/git/cmd.py
@@ -191,13 +191,15 @@ def __setstate__(self, d):
 
     # Provide the full path to the git executable. Otherwise it assumes git is in the path
     _git_exec_env_var = "GIT_PYTHON_GIT_EXECUTABLE"
+    _refresh_env_var = "GIT_PYTHON_REFRESH"
     GIT_PYTHON_GIT_EXECUTABLE = None
     # note that the git executable is actually found during the refresh step in
     # the top level __init__
 
     @classmethod
     def refresh(cls, path=None):
-        """This gets called by the refresh function (see the top level __init__).
+        """This gets called by the refresh function (see the top level
+        __init__).
         """
         # discern which path to refresh with
         if path is not None:
@@ -214,17 +216,21 @@ def refresh(cls, path=None):
         try:
             cls().version()
             has_git = True
-        except GitCommandNotFound:
+        except (GitCommandNotFound, PermissionError):
+            # - a GitCommandNotFound error is spawned by ourselves
+            # - a PermissionError is spawned if the git executable provided
+            #   cannot be executed for whatever reason
             pass
 
         # warn or raise exception if test failed
         if not has_git:
             err = dedent("""\
-                Bad git executable. The git executable must be specified in one of the following ways:
-                    (1) be included in your $PATH, or
-                    (2) be set via $GIT_PYTHON_GIT_EXECUTABLE, or
-                    (3) explicitly set via git.refresh.
-                """)
+                Bad git executable.
+                The git executable must be specified in one of the following ways:
+                    - be included in your $PATH
+                    - be set via $%s
+                    - explicitly set via git.refresh()
+                """) % cls._git_exec_env_var
 
             # revert to whatever the old_git was
             cls.GIT_PYTHON_GIT_EXECUTABLE = old_git
@@ -241,36 +247,53 @@ def refresh(cls, path=None):
                 #   1|w|warn|warning
                 #   2|r|raise|e|error
 
-                mode = os.environ.get("GIT_PYTHON_REFRESH", "raise").lower()
+                mode = os.environ.get(cls._refresh_env_var, "raise").lower()
 
-                quiet = ["0", "q", "quiet", "s", "silence", "n", "none"]
-                warn = ["1", "w", "warn", "warning"]
-                error = ["2", "e", "error", "r", "raise"]
+                quiet = ["quiet", "q", "silence", "s", "none", "n", "0"]
+                warn = ["warn", "w", "warning", "1"]
+                error = ["error", "e", "raise", "r", "2"]
 
                 if mode in quiet:
                     pass
-                elif mode in warn:
-                    print(dedent("""\
-                        WARNING: %s
+                elif mode in warn or mode in error:
+                    err = dedent("""\
+                        %s
                         All git commands will error until this is rectified.
 
-                        This initial warning can be silenced in the future by setting the environment variable:
-                        export GIT_PYTHON_REFRESH=quiet
-                        """) % err)
-                elif mode in error:
-                    raise ImportError(err)
+                        This initial warning can be silenced or aggravated in the future by setting the
+                        $%s environment variable. Use one of the following values:
+                            - %s: for no warning or exception
+                            - %s: for a printed warning
+                            - %s: for a raised exception
+
+                        Example:
+                            export %s=%s
+                        """) % (
+                        err,
+                        cls._refresh_env_var,
+                        "|".join(quiet),
+                        "|".join(warn),
+                        "|".join(error),
+                        cls._refresh_env_var,
+                        quiet[0])
+
+                    if mode in warn:
+                        print("WARNING: %s" % err)
+                    else:
+                        raise ImportError(err)
                 else:
                     err = dedent("""\
-                        GIT_PYTHON_REFRESH environment variable has been set but it has been set with an invalid value.
+                        %s environment variable has been set but it has been set with an invalid value.
 
                         Use only the following values:
-                            (1) {quiet}: for no warning or exception
-                            (2) {warn}: for a printed warning
-                            (3) {error}: for a raised exception
-                        """).format(
-                        quiet="|".join(quiet),
-                        warn="|".join(warn),
-                        error="|".join(error))
+                            - %s: for no warning or exception
+                            - %s: for a printed warning
+                            - %s: for a raised exception
+                        """) % (
+                        cls._refresh_env_var,
+                        "|".join(quiet),
+                        "|".join(warn),
+                        "|".join(error))
                     raise ImportError(err)
 
                 # we get here if this was the init refresh and the refresh mode
diff --git a/git/remote.py b/git/remote.py
@@ -221,7 +221,8 @@ class FetchInfo(object):
 
     @classmethod
     def refresh(cls):
-        """This gets called by the setup function (see the top level __init__).
+        """This gets called by the refresh function (see the top level
+        __init__).
         """
         # clear the old values in _flag_map
         try:
