From: Daira Hopwood <daira@jacaranda.org>
Date: Fri, 21 Nov 2014 05:14:18 +0000 (+0000)
Subject: setup.py: improve error reporting when git commands fail. refs #2340
X-Git-Tag: allmydata-tahoe-1.10.1a1~105^2~3
X-Git-Url: https://git.rkrishnan.org/?a=commitdiff_plain;h=8e0ec757e7aad42410140c2f68309c1f4861cde0;p=tahoe-lafs%2Ftahoe-lafs.git

setup.py: improve error reporting when git commands fail. refs #2340

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
---

diff --git a/setup.py b/setup.py
index 4b3ad977..f18b82aa 100644
--- a/setup.py
+++ b/setup.py
@@ -260,25 +260,23 @@ verstr = %(normalized)r
 __version__ = verstr
 '''
 
-def run_command(args, cwd=None, verbose=False):
+def run_command(args, cwd=None):
     try:
         # remember shell=False, so use git.cmd on windows, not just git
         p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd)
     except EnvironmentError as e:  # if this gives a SyntaxError, note that Tahoe-LAFS requires Python 2.6+
-        if verbose:
-            print("unable to run %s" % args[0])
-            print(e)
+        print("Warning: unable to run %r." % (" ".join(args),))
+        print(e)
         return None
     stdout = p.communicate()[0].strip()
     if p.returncode != 0:
-        if verbose:
-            print("unable to run %s (error)" % args[0])
+        print("Warning: %r returned error code %r." % (" ".join(args), p.returncode))
         return None
     return stdout
 
 
-def versions_from_git(tag_prefix, verbose=False):
-    # this runs 'git' from the directory that contains this file. That either
+def versions_from_git(tag_prefix):
+    # This runs 'git' from the directory that contains this file. That either
     # means someone ran a setup.py command (and this code is in
     # versioneer.py, thus the containing directory is the root of the source
     # tree), or someone ran a project-specific entry point (and this code is
@@ -299,19 +297,21 @@ def versions_from_git(tag_prefix, verbose=False):
 
     try:
         source_dir = os.path.dirname(os.path.abspath(__file__))
-    except NameError:
+    except NameError as e:
         # some py2exe/bbfreeze/non-CPython implementations don't do __file__
-        return {} # not always correct
+        print("Warning: unable to find version because we could not obtain the source directory.")
+        print(e)
+        return {}
     GIT = "git"
     if sys.platform == "win32":
         GIT = "git.cmd"
     stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"],
                          cwd=source_dir)
     if stdout is None:
+        # run_command already complained.
         return {}
     if not stdout.startswith(tag_prefix):
-        if verbose:
-            print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix))
+        print("Warning: tag %r doesn't start with prefix %r." % (stdout, tag_prefix))
         return {}
     version = stdout[len(tag_prefix):]
     pieces = version.split("-")
@@ -322,6 +322,7 @@ def versions_from_git(tag_prefix, verbose=False):
 
     stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=source_dir)
     if stdout is None:
+        # run_command already complained.
         return {}
     full = stdout.strip()
     if version.endswith("-dirty"):
@@ -358,7 +359,7 @@ class UpdateVersion(Command):
             self.distribution.metadata.version = verstr
 
     def try_from_git(self):
-        versions = versions_from_git("allmydata-tahoe-", verbose=True)
+        versions = versions_from_git("allmydata-tahoe-")
         if versions:
             fn = 'src/allmydata/_version.py'
             f = open(fn, "wb")