45c1958d83
Changed version output accordingly to now display "{version} ({branch} branch)" if branch information is available (which should be the case if installation was performed from git).
(cherry picked from commit a48b5de)
278 lines
10 KiB
Python
278 lines
10 KiB
Python
|
|
# This file helps to compute a version number in source trees obtained from
|
|
# git-archive tarball (such as those provided by githubs download-from-tag
|
|
# feature). Distribution tarballs (build by setup.py sdist) and build
|
|
# directories (produced by setup.py build) will contain a much shorter file
|
|
# that just contains the computed version number.
|
|
|
|
# This file is released into the public domain. Generated by
|
|
# versioneer-0.10 (https://github.com/warner/python-versioneer)
|
|
|
|
# these strings will be replaced by git during git-archive
|
|
git_refnames = "$Format:%d$"
|
|
git_full = "$Format:%H$"
|
|
|
|
|
|
import subprocess
|
|
import sys
|
|
import errno
|
|
|
|
|
|
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
|
|
assert isinstance(commands, list)
|
|
p = None
|
|
for c in commands:
|
|
try:
|
|
# remember shell=False, so use git.cmd on windows, not just git
|
|
p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE,
|
|
stderr=(subprocess.PIPE if hide_stderr
|
|
else None))
|
|
break
|
|
except EnvironmentError:
|
|
e = sys.exc_info()[1]
|
|
if e.errno == errno.ENOENT:
|
|
continue
|
|
if verbose:
|
|
print("unable to run %s" % args[0])
|
|
print(e)
|
|
return None
|
|
else:
|
|
if verbose:
|
|
print("unable to find command, tried %s" % (commands,))
|
|
return None
|
|
stdout = p.communicate()[0].strip()
|
|
if sys.version >= '3':
|
|
stdout = stdout.decode()
|
|
if p.returncode != 0:
|
|
if verbose:
|
|
print("unable to run %s (error)" % args[0])
|
|
return None
|
|
return stdout
|
|
|
|
|
|
import sys
|
|
import re
|
|
import os.path
|
|
|
|
def get_gits(root, verbose=False):
|
|
if not os.path.exists(os.path.join(root, ".git")):
|
|
if verbose:
|
|
print("no .git in %s" % root)
|
|
return None
|
|
|
|
GITS = ["git"]
|
|
if sys.platform == "win32":
|
|
GITS = ["git.cmd", "git.exe"]
|
|
return GITS
|
|
|
|
|
|
def get_expanded_variables(versionfile_abs):
|
|
# the code embedded in _version.py can just fetch the value of these
|
|
# variables. When used from setup.py, we don't want to import
|
|
# _version.py, so we do it with a regexp instead. This function is not
|
|
# used from _version.py.
|
|
variables = {}
|
|
try:
|
|
f = open(versionfile_abs,"r")
|
|
for line in f.readlines():
|
|
if line.strip().startswith("git_refnames ="):
|
|
mo = re.search(r'=\s*"(.*)"', line)
|
|
if mo:
|
|
variables["refnames"] = mo.group(1)
|
|
if line.strip().startswith("git_full ="):
|
|
mo = re.search(r'=\s*"(.*)"', line)
|
|
if mo:
|
|
variables["full"] = mo.group(1)
|
|
f.close()
|
|
except EnvironmentError:
|
|
pass
|
|
return variables
|
|
|
|
def versions_from_expanded_variables(variables, tag_prefix, verbose=False):
|
|
refnames = variables["refnames"].strip()
|
|
if refnames.startswith("$Format"):
|
|
if verbose:
|
|
print("variables are unexpanded, not using")
|
|
return {} # unexpanded, so not in an unpacked git-archive tarball
|
|
refs = set([r.strip() for r in refnames.strip("()").split(",")])
|
|
# starting in git-1.8.3, tags are listed as "tag: foo-1.0" instead of
|
|
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
|
|
TAG = "tag: "
|
|
tags = set([r[len(TAG):] for r in refs if r.startswith(TAG)])
|
|
if not tags:
|
|
# Either we're using git < 1.8.3, or there really are no tags. We use
|
|
# a heuristic: assume all version tags have a digit. The old git %d
|
|
# expansion behaves like git log --decorate=short and strips out the
|
|
# refs/heads/ and refs/tags/ prefixes that would let us distinguish
|
|
# between branches and tags. By ignoring refnames without digits, we
|
|
# filter out many common branch names like "release" and
|
|
# "stabilization", as well as "HEAD" and "master".
|
|
tags = set([r for r in refs if re.search(r'\d', r)])
|
|
if verbose:
|
|
print("discarding '%s', no digits" % ",".join(refs-tags))
|
|
if verbose:
|
|
print("likely tags: %s" % ",".join(sorted(tags)))
|
|
for ref in sorted(tags):
|
|
# sorting will prefer e.g. "2.0" over "2.0rc1"
|
|
if ref.startswith(tag_prefix):
|
|
r = ref[len(tag_prefix):]
|
|
if verbose:
|
|
print("picking %s" % r)
|
|
return { "version": r,
|
|
"full": variables["full"].strip() }
|
|
# no suitable tags, so we use the full revision id
|
|
if verbose:
|
|
print("no suitable tags, using full revision id")
|
|
return { "version": variables["full"].strip(),
|
|
"full": variables["full"].strip() }
|
|
|
|
def versions_from_lookup(lookup, root, verbose=False):
|
|
GITS = get_gits(root, verbose=verbose)
|
|
if GITS is None:
|
|
return {}
|
|
|
|
stdout = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
|
|
cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
|
|
current_branch = stdout.strip()
|
|
for matcher, tag, ref_commit in lookup:
|
|
if matcher.match(current_branch):
|
|
if tag is None or ref_commit is None:
|
|
return {}
|
|
|
|
stdout = run_command(GITS, ["rev-list", "%s..HEAD" % ref_commit, "--count"], cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
num_commits = stdout.strip()
|
|
|
|
stdout =run_command(GITS, ["rev-parse", "--short", "HEAD"], cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
short_hash = stdout.strip()
|
|
|
|
stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
dirty = stdout.strip().endswith("-dirty")
|
|
|
|
stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
full = stdout.strip()
|
|
|
|
version = "%s-%s-g%s" % (tag, num_commits, short_hash)
|
|
if dirty:
|
|
version += "-dirty"
|
|
full += "-dirty"
|
|
return {"version": version, "full": full, "branch": current_branch}
|
|
|
|
return {}
|
|
|
|
def versions_from_vcs(tag_prefix, root, verbose=False):
|
|
# this runs 'git' from the root of the source tree. This only gets called
|
|
# if the git-archive 'subst' variables were *not* expanded, and
|
|
# _version.py hasn't already been rewritten with a short version string,
|
|
# meaning we're inside a checked out source tree.
|
|
|
|
GITS = get_gits(root, verbose=verbose)
|
|
if GITS is None:
|
|
return {}
|
|
|
|
stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"],
|
|
cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
if not stdout.startswith(tag_prefix):
|
|
if verbose:
|
|
print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix))
|
|
return {}
|
|
tag = stdout[len(tag_prefix):]
|
|
stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
|
|
if stdout is None:
|
|
return {}
|
|
full = stdout.strip()
|
|
if tag.endswith("-dirty"):
|
|
full += "-dirty"
|
|
|
|
stdout = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
|
|
cwd=root)
|
|
if stdout is None:
|
|
branch = None
|
|
else:
|
|
branch = stdout.strip()
|
|
return {"version": tag, "full": full, "branch": branch}
|
|
|
|
|
|
def versions_from_parentdir(parentdir_prefix, root, verbose=False):
|
|
# Source tarballs conventionally unpack into a directory that includes
|
|
# both the project name and a version string.
|
|
dirname = os.path.basename(root)
|
|
if not dirname.startswith(parentdir_prefix):
|
|
if verbose:
|
|
print("guessing rootdir is '%s', but '%s' doesn't start with prefix '%s'" %
|
|
(root, dirname, parentdir_prefix))
|
|
return None
|
|
return {"version": dirname[len(parentdir_prefix):], "full": ""}
|
|
|
|
tag_prefix = ""
|
|
parentdir_prefix = ""
|
|
versionfile_source = "src/octoprint/_version.py"
|
|
lookupfile = ".versioneer-lookup"
|
|
|
|
def parse_lookup_file(root, lookup_path=None):
|
|
if not lookup_path:
|
|
lookup_path = lookupfile
|
|
if not lookup_path:
|
|
return []
|
|
|
|
path = os.path.join(root, lookup_path)
|
|
if not os.path.exists(path):
|
|
return []
|
|
|
|
import re
|
|
lookup = []
|
|
with open(os.path.join(root, lookup_path), "r") as f:
|
|
for line in f:
|
|
if '#' in line:
|
|
line = line[:line.rindex('#')]
|
|
line = line.strip()
|
|
try:
|
|
split_line = line.split()
|
|
if len(split_line) == 3:
|
|
pattern, tag, ref_commit = split_line
|
|
lookup.append([re.compile(pattern), tag, ref_commit])
|
|
elif len(split_line) >= 1:
|
|
lookup.append([re.compile(split_line[0]), None, None])
|
|
except:
|
|
break
|
|
return lookup
|
|
|
|
def get_versions(default={"version": "unknown", "full": ""}, lookup_path=None, verbose=False):
|
|
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
|
|
# __file__, we can work backwards from there to the root. Some
|
|
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
|
|
# case we can only use expanded variables.
|
|
|
|
variables = { "refnames": git_refnames, "full": git_full }
|
|
ver = versions_from_expanded_variables(variables, tag_prefix, verbose)
|
|
if ver:
|
|
return ver
|
|
|
|
try:
|
|
root = os.path.abspath(__file__)
|
|
# versionfile_source is the relative path from the top of the source
|
|
# tree (where the .git directory might live) to this file. Invert
|
|
# this to find the root from __file__.
|
|
for i in range(len(versionfile_source.split("/"))):
|
|
root = os.path.dirname(root)
|
|
except NameError:
|
|
return default
|
|
|
|
lookup = parse_lookup_file(root, lookup_path=lookup_path)
|
|
return (versions_from_lookup(lookup, root, verbose)
|
|
or versions_from_vcs(tag_prefix, root, verbose)
|
|
or versions_from_parentdir(parentdir_prefix, root, verbose)
|
|
or default)
|
|
|