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

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2014-11-21 05:14:18 +00:00
parent 5218e87ed1
commit 8e0ec757e7

View File

@ -260,25 +260,23 @@ verstr = %(normalized)r
__version__ = verstr __version__ = verstr
''' '''
def run_command(args, cwd=None, verbose=False): def run_command(args, cwd=None):
try: try:
# remember shell=False, so use git.cmd on windows, not just git # remember shell=False, so use git.cmd on windows, not just git
p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd) 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+ except EnvironmentError as e: # if this gives a SyntaxError, note that Tahoe-LAFS requires Python 2.6+
if verbose: print("Warning: unable to run %r." % (" ".join(args),))
print("unable to run %s" % args[0]) print(e)
print(e)
return None return None
stdout = p.communicate()[0].strip() stdout = p.communicate()[0].strip()
if p.returncode != 0: if p.returncode != 0:
if verbose: print("Warning: %r returned error code %r." % (" ".join(args), p.returncode))
print("unable to run %s (error)" % args[0])
return None return None
return stdout return stdout
def versions_from_git(tag_prefix, verbose=False): def versions_from_git(tag_prefix):
# this runs 'git' from the directory that contains this file. That either # This runs 'git' from the directory that contains this file. That either
# means someone ran a setup.py command (and this code is in # means someone ran a setup.py command (and this code is in
# versioneer.py, thus the containing directory is the root of the source # 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 # 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: try:
source_dir = os.path.dirname(os.path.abspath(__file__)) 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__ # 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" GIT = "git"
if sys.platform == "win32": if sys.platform == "win32":
GIT = "git.cmd" GIT = "git.cmd"
stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"], stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"],
cwd=source_dir) cwd=source_dir)
if stdout is None: if stdout is None:
# run_command already complained.
return {} return {}
if not stdout.startswith(tag_prefix): if not stdout.startswith(tag_prefix):
if verbose: print("Warning: tag %r doesn't start with prefix %r." % (stdout, tag_prefix))
print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix))
return {} return {}
version = stdout[len(tag_prefix):] version = stdout[len(tag_prefix):]
pieces = version.split("-") 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) stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=source_dir)
if stdout is None: if stdout is None:
# run_command already complained.
return {} return {}
full = stdout.strip() full = stdout.strip()
if version.endswith("-dirty"): if version.endswith("-dirty"):
@ -358,7 +359,7 @@ class UpdateVersion(Command):
self.distribution.metadata.version = verstr self.distribution.metadata.version = verstr
def try_from_git(self): def try_from_git(self):
versions = versions_from_git("allmydata-tahoe-", verbose=True) versions = versions_from_git("allmydata-tahoe-")
if versions: if versions:
fn = 'src/allmydata/_version.py' fn = 'src/allmydata/_version.py'
f = open(fn, "wb") f = open(fn, "wb")