Updating versioneer & switch to PEP440 versioning
This commit is contained in:
parent
5f0c89c553
commit
137db0b17c
5 changed files with 2028 additions and 844 deletions
|
|
@ -15,4 +15,4 @@ staging
|
||||||
fix/.*
|
fix/.*
|
||||||
|
|
||||||
# every other branch is a development branch and thus gets resolved to 1.3.0-dev for now
|
# every other branch is a development branch and thus gets resolved to 1.3.0-dev for now
|
||||||
.* 1.3.0-dev 198d3450d94be1a2
|
.* 1.3.0 198d3450d94be1a2 pep440-pre
|
||||||
|
|
|
||||||
13
setup.cfg
Normal file
13
setup.cfg
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
|
||||||
|
# See the docstring in versioneer.py for instructions. Note that you must
|
||||||
|
# re-run 'versioneer.py setup' after changing this section, and commit the
|
||||||
|
# resulting files.
|
||||||
|
|
||||||
|
[versioneer]
|
||||||
|
VCS = git
|
||||||
|
style = pep440
|
||||||
|
versionfile_source = src/octoprint/_version.py
|
||||||
|
versionfile_build = octoprint/_version.py
|
||||||
|
tag_prefix =
|
||||||
|
parentdir_prefix =
|
||||||
|
lookupfile = .versioneer-lookup
|
||||||
8
setup.py
8
setup.py
|
|
@ -58,14 +58,6 @@ EXTRA_REQUIRES = dict(
|
||||||
# Dependency links for any of the aforementioned dependencies
|
# Dependency links for any of the aforementioned dependencies
|
||||||
DEPENDENCY_LINKS = []
|
DEPENDENCY_LINKS = []
|
||||||
|
|
||||||
# Versioneer configuration
|
|
||||||
versioneer.VCS = 'git'
|
|
||||||
versioneer.versionfile_source = 'src/octoprint/_version.py'
|
|
||||||
versioneer.versionfile_build = 'octoprint/_version.py'
|
|
||||||
versioneer.tag_prefix = ''
|
|
||||||
versioneer.parentdir_prefix = ''
|
|
||||||
versioneer.lookupfile = '.versioneer-lookup'
|
|
||||||
|
|
||||||
#-----------------------------------------------------------------------------------------------------------------------
|
#-----------------------------------------------------------------------------------------------------------------------
|
||||||
# Anything below here is just command setup and general setup configuration
|
# Anything below here is just command setup and general setup configuration
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,28 +1,81 @@
|
||||||
|
|
||||||
# This file helps to compute a version number in source trees obtained from
|
# 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
|
# git-archive tarball (such as those provided by githubs download-from-tag
|
||||||
# feature). Distribution tarballs (build by setup.py sdist) and build
|
# feature). Distribution tarballs (built by setup.py sdist) and build
|
||||||
# directories (produced by setup.py build) will contain a much shorter file
|
# directories (produced by setup.py build) will contain a much shorter file
|
||||||
# that just contains the computed version number.
|
# that just contains the computed version number.
|
||||||
|
|
||||||
# This file is released into the public domain. Generated by
|
# This file is released into the public domain. Generated by
|
||||||
# versioneer-0.10 (https://github.com/warner/python-versioneer)
|
# versioneer-0.15+dev (https://github.com/warner/python-versioneer)
|
||||||
|
|
||||||
# these strings will be replaced by git during git-archive
|
|
||||||
git_refnames = "$Format:%d$"
|
|
||||||
git_full = "$Format:%H$"
|
|
||||||
|
|
||||||
|
"""Git implementation of _version.py."""
|
||||||
|
|
||||||
|
import errno
|
||||||
|
import os
|
||||||
|
import re
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
import errno
|
|
||||||
|
|
||||||
|
def get_keywords():
|
||||||
|
"""Get the keywords needed to look up the version information."""
|
||||||
|
# these strings will be replaced by git during git-archive.
|
||||||
|
# setup.py/versioneer.py will grep for the variable names, so they must
|
||||||
|
# each be defined on a line of their own. _version.py will just call
|
||||||
|
# get_keywords().
|
||||||
|
git_refnames = "$Format:%d$"
|
||||||
|
git_full = "$Format:%H$"
|
||||||
|
keywords = {"refnames": git_refnames, "full": git_full}
|
||||||
|
return keywords
|
||||||
|
|
||||||
|
|
||||||
|
class VersioneerConfig:
|
||||||
|
|
||||||
|
"""Container for Versioneer configuration parameters."""
|
||||||
|
|
||||||
|
|
||||||
|
def get_config():
|
||||||
|
"""Create, populate and return the VersioneerConfig() object."""
|
||||||
|
# these strings are filled in when 'setup.py versioneer' creates
|
||||||
|
# _version.py
|
||||||
|
cfg = VersioneerConfig()
|
||||||
|
cfg.VCS = "git"
|
||||||
|
cfg.style = "pep440"
|
||||||
|
cfg.tag_prefix = ""
|
||||||
|
cfg.parentdir_prefix = ""
|
||||||
|
cfg.versionfile_source = "src/octoprint/_version.py"
|
||||||
|
cfg.lookupfile = None
|
||||||
|
cfg.verbose = False
|
||||||
|
return cfg
|
||||||
|
|
||||||
|
|
||||||
|
class NotThisMethod(Exception):
|
||||||
|
|
||||||
|
"""Exception raised if a method is not valid for the current scenario."""
|
||||||
|
|
||||||
|
|
||||||
|
LONG_VERSION_PY = {}
|
||||||
|
HANDLERS = {}
|
||||||
|
|
||||||
|
|
||||||
|
def register_vcs_handler(vcs, method): # decorator
|
||||||
|
"""Decorator to mark a method as the handler for a particular VCS."""
|
||||||
|
def decorate(f):
|
||||||
|
"""Store f in HANDLERS[vcs][method]."""
|
||||||
|
if vcs not in HANDLERS:
|
||||||
|
HANDLERS[vcs] = {}
|
||||||
|
HANDLERS[vcs][method] = f
|
||||||
|
return f
|
||||||
|
return decorate
|
||||||
|
|
||||||
|
|
||||||
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
|
def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
|
||||||
|
"""Call the given command(s)."""
|
||||||
assert isinstance(commands, list)
|
assert isinstance(commands, list)
|
||||||
p = None
|
p = None
|
||||||
for c in commands:
|
for c in commands:
|
||||||
try:
|
try:
|
||||||
|
dispcmd = str([c] + args)
|
||||||
# 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([c] + args, cwd=cwd, stdout=subprocess.PIPE,
|
p = subprocess.Popen([c] + args, cwd=cwd, stdout=subprocess.PIPE,
|
||||||
stderr=(subprocess.PIPE if hide_stderr
|
stderr=(subprocess.PIPE if hide_stderr
|
||||||
|
|
@ -33,7 +86,7 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
|
||||||
if e.errno == errno.ENOENT:
|
if e.errno == errno.ENOENT:
|
||||||
continue
|
continue
|
||||||
if verbose:
|
if verbose:
|
||||||
print("unable to run %s" % args[0])
|
print("unable to run %s" % dispcmd)
|
||||||
print(e)
|
print(e)
|
||||||
return None
|
return None
|
||||||
else:
|
else:
|
||||||
|
|
@ -41,59 +94,67 @@ def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
|
||||||
print("unable to find command, tried %s" % (commands,))
|
print("unable to find command, tried %s" % (commands,))
|
||||||
return None
|
return None
|
||||||
stdout = p.communicate()[0].strip()
|
stdout = p.communicate()[0].strip()
|
||||||
if sys.version >= '3':
|
if sys.version_info[0] >= 3:
|
||||||
stdout = stdout.decode()
|
stdout = stdout.decode()
|
||||||
if p.returncode != 0:
|
if p.returncode != 0:
|
||||||
if verbose:
|
if verbose:
|
||||||
print("unable to run %s (error)" % args[0])
|
print("unable to run %s (error)" % dispcmd)
|
||||||
return None
|
return None
|
||||||
return stdout
|
return stdout
|
||||||
|
|
||||||
|
|
||||||
import sys
|
def versions_from_parentdir(parentdir_prefix, root, verbose):
|
||||||
import re
|
"""Try to determine the version from the parent directory name.
|
||||||
import os.path
|
|
||||||
|
|
||||||
def get_gits(root, verbose=False):
|
Source tarballs conventionally unpack into a directory that includes
|
||||||
if not os.path.exists(os.path.join(root, ".git")):
|
both the project name and a version string.
|
||||||
|
"""
|
||||||
|
dirname = os.path.basename(root)
|
||||||
|
if not dirname.startswith(parentdir_prefix):
|
||||||
if verbose:
|
if verbose:
|
||||||
print("no .git in %s" % root)
|
print("guessing rootdir is '%s', but '%s' doesn't start with "
|
||||||
return None
|
"prefix '%s'" % (root, dirname, parentdir_prefix))
|
||||||
|
raise NotThisMethod("rootdir doesn't start with parentdir_prefix")
|
||||||
GITS = ["git"]
|
return {"version": dirname[len(parentdir_prefix):],
|
||||||
if sys.platform == "win32":
|
"full-revisionid": None,
|
||||||
GITS = ["git.cmd", "git.exe"]
|
"dirty": False, "error": None}
|
||||||
return GITS
|
|
||||||
|
|
||||||
|
|
||||||
def get_expanded_variables(versionfile_abs):
|
@register_vcs_handler("git", "get_keywords")
|
||||||
|
def git_get_keywords(versionfile_abs):
|
||||||
|
"""Extract version information from the given file."""
|
||||||
# the code embedded in _version.py can just fetch the value of these
|
# 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
|
# keywords. When used from setup.py, we don't want to import _version.py,
|
||||||
# _version.py, so we do it with a regexp instead. This function is not
|
# so we do it with a regexp instead. This function is not used from
|
||||||
# used from _version.py.
|
# _version.py.
|
||||||
variables = {}
|
keywords = {}
|
||||||
try:
|
try:
|
||||||
f = open(versionfile_abs,"r")
|
f = open(versionfile_abs, "r")
|
||||||
for line in f.readlines():
|
for line in f.readlines():
|
||||||
if line.strip().startswith("git_refnames ="):
|
if line.strip().startswith("git_refnames ="):
|
||||||
mo = re.search(r'=\s*"(.*)"', line)
|
mo = re.search(r'=\s*"(.*)"', line)
|
||||||
if mo:
|
if mo:
|
||||||
variables["refnames"] = mo.group(1)
|
keywords["refnames"] = mo.group(1)
|
||||||
if line.strip().startswith("git_full ="):
|
if line.strip().startswith("git_full ="):
|
||||||
mo = re.search(r'=\s*"(.*)"', line)
|
mo = re.search(r'=\s*"(.*)"', line)
|
||||||
if mo:
|
if mo:
|
||||||
variables["full"] = mo.group(1)
|
keywords["full"] = mo.group(1)
|
||||||
f.close()
|
f.close()
|
||||||
except EnvironmentError:
|
except EnvironmentError:
|
||||||
pass
|
pass
|
||||||
return variables
|
return keywords
|
||||||
|
|
||||||
def versions_from_expanded_variables(variables, tag_prefix, verbose=False):
|
|
||||||
refnames = variables["refnames"].strip()
|
@register_vcs_handler("git", "keywords")
|
||||||
|
def git_versions_from_keywords(keywords, tag_prefix, verbose):
|
||||||
|
"""Get version information from git keywords."""
|
||||||
|
if not keywords:
|
||||||
|
raise NotThisMethod("no keywords at all, weird")
|
||||||
|
refnames = keywords["refnames"].strip()
|
||||||
if refnames.startswith("$Format"):
|
if refnames.startswith("$Format"):
|
||||||
if verbose:
|
if verbose:
|
||||||
print("variables are unexpanded, not using")
|
print("keywords are unexpanded, not using")
|
||||||
return {} # unexpanded, so not in an unpacked git-archive tarball
|
raise NotThisMethod("unexpanded keywords, not a git-archive tarball")
|
||||||
refs = set([r.strip() for r in refnames.strip("()").split(",")])
|
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
|
# 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.
|
# just "foo-1.0". If we see a "tag: " prefix, prefer those.
|
||||||
|
|
@ -110,6 +171,14 @@ def versions_from_expanded_variables(variables, tag_prefix, verbose=False):
|
||||||
tags = set([r for r in refs if re.search(r'\d', r)])
|
tags = set([r for r in refs if re.search(r'\d', r)])
|
||||||
if verbose:
|
if verbose:
|
||||||
print("discarding '%s', no digits" % ",".join(refs-tags))
|
print("discarding '%s', no digits" % ",".join(refs-tags))
|
||||||
|
|
||||||
|
branches = [r for r in refs if not r.startswith(TAG) and r != "HEAD" and not r.startswith("refs/")]
|
||||||
|
if verbose:
|
||||||
|
print("likely branches: %s" % ",".join(sorted(branches)))
|
||||||
|
branch = None
|
||||||
|
if branches:
|
||||||
|
branch = branches[0]
|
||||||
|
|
||||||
if verbose:
|
if verbose:
|
||||||
print("likely tags: %s" % ",".join(sorted(tags)))
|
print("likely tags: %s" % ",".join(sorted(tags)))
|
||||||
for ref in sorted(tags):
|
for ref in sorted(tags):
|
||||||
|
|
@ -118,161 +187,413 @@ def versions_from_expanded_variables(variables, tag_prefix, verbose=False):
|
||||||
r = ref[len(tag_prefix):]
|
r = ref[len(tag_prefix):]
|
||||||
if verbose:
|
if verbose:
|
||||||
print("picking %s" % r)
|
print("picking %s" % r)
|
||||||
return { "version": r,
|
|
||||||
"full": variables["full"].strip() }
|
result = {"version": r,
|
||||||
# no suitable tags, so we use the full revision id
|
"full-revisionid": keywords["full"].strip(),
|
||||||
|
"dirty": False, "error": None
|
||||||
|
}
|
||||||
|
if branch is not None:
|
||||||
|
result["branch"] = branch
|
||||||
|
return result
|
||||||
|
# no suitable tags, so version is "0+unknown", but full hex is still there
|
||||||
if verbose:
|
if verbose:
|
||||||
print("no suitable tags, using full revision id")
|
print("no suitable tags, using unknown + full revision id")
|
||||||
return { "version": variables["full"].strip(),
|
return {"version": "0+unknown",
|
||||||
"full": variables["full"].strip() }
|
"full-revisionid": keywords["full"].strip(),
|
||||||
|
"dirty": False, "error": "no suitable tags"}
|
||||||
|
|
||||||
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"],
|
@register_vcs_handler("git", "pieces_from_vcs")
|
||||||
cwd=root)
|
def git_pieces_from_vcs(tag_prefix, root, verbose, run_command=run_command):
|
||||||
if stdout is None:
|
"""Get version from 'git describe' in the root of the source tree.
|
||||||
return {}
|
|
||||||
|
|
||||||
current_branch = stdout.strip()
|
This only gets called if the git-archive 'subst' keywords were *not*
|
||||||
for matcher, tag, ref_commit in lookup:
|
expanded, and _version.py hasn't already been rewritten with a short
|
||||||
if matcher.match(current_branch):
|
version string, meaning we're inside a checked out source tree.
|
||||||
if tag is None or ref_commit is None:
|
"""
|
||||||
return {}
|
if not os.path.exists(os.path.join(root, ".git")):
|
||||||
|
|
||||||
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:
|
if verbose:
|
||||||
print("tag '%s' doesn't start with prefix '%s'" % (stdout, tag_prefix))
|
print("no .git in %s" % root)
|
||||||
return {}
|
raise NotThisMethod("no .git directory")
|
||||||
tag = stdout[len(tag_prefix):]
|
|
||||||
stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
|
GITS = ["git"]
|
||||||
if stdout is None:
|
if sys.platform == "win32":
|
||||||
return {}
|
GITS = ["git.cmd", "git.exe"]
|
||||||
full = stdout.strip()
|
# if there is a tag matching tag_prefix, this yields TAG-NUM-gHEX[-dirty]
|
||||||
if tag.endswith("-dirty"):
|
# if there isn't one, this yields HEX[-dirty] (no NUM)
|
||||||
full += "-dirty"
|
describe_out = run_command(GITS, ["describe", "--tags", "--dirty",
|
||||||
|
"--always", "--long",
|
||||||
|
"--match", "%s*" % tag_prefix],
|
||||||
|
cwd=root)
|
||||||
|
# --long was added in git-1.5.5
|
||||||
|
if describe_out is None:
|
||||||
|
raise NotThisMethod("'git describe' failed")
|
||||||
|
describe_out = describe_out.strip()
|
||||||
|
full_out = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
|
||||||
|
if full_out is None:
|
||||||
|
raise NotThisMethod("'git rev-parse' failed")
|
||||||
|
full_out = full_out.strip()
|
||||||
|
|
||||||
|
pieces = {}
|
||||||
|
pieces["long"] = full_out
|
||||||
|
pieces["short"] = full_out[:7] # maybe improved later
|
||||||
|
pieces["error"] = None
|
||||||
|
|
||||||
|
# parse describe_out. It will be like TAG-NUM-gHEX[-dirty] or HEX[-dirty]
|
||||||
|
# TAG might have hyphens.
|
||||||
|
git_describe = describe_out
|
||||||
|
|
||||||
|
# look for -dirty suffix
|
||||||
|
dirty = git_describe.endswith("-dirty")
|
||||||
|
pieces["dirty"] = dirty
|
||||||
|
if dirty:
|
||||||
|
git_describe = git_describe[:git_describe.rindex("-dirty")]
|
||||||
|
|
||||||
|
# figure out our branch
|
||||||
|
abbrev_ref_out = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"], cwd=root)
|
||||||
|
if abbrev_ref_out is not None:
|
||||||
|
pieces["branch"] = abbrev_ref_out.strip()
|
||||||
|
|
||||||
|
# now we have TAG-NUM-gHEX or HEX
|
||||||
|
|
||||||
|
if "-" in git_describe:
|
||||||
|
# TAG-NUM-gHEX
|
||||||
|
mo = re.search(r'^(.+)-(\d+)-g([0-9a-f]+)$', git_describe)
|
||||||
|
if not mo:
|
||||||
|
# unparseable. Maybe git-describe is misbehaving?
|
||||||
|
pieces["error"] = ("unable to parse git-describe output: '%s'"
|
||||||
|
% describe_out)
|
||||||
|
return pieces
|
||||||
|
|
||||||
|
# tag
|
||||||
|
full_tag = mo.group(1)
|
||||||
|
if not full_tag.startswith(tag_prefix):
|
||||||
|
if verbose:
|
||||||
|
fmt = "tag '%s' doesn't start with prefix '%s'"
|
||||||
|
print(fmt % (full_tag, tag_prefix))
|
||||||
|
pieces["error"] = ("tag '%s' doesn't start with prefix '%s'"
|
||||||
|
% (full_tag, tag_prefix))
|
||||||
|
return pieces
|
||||||
|
pieces["closest-tag"] = full_tag[len(tag_prefix):]
|
||||||
|
|
||||||
|
# distance: number of commits since tag
|
||||||
|
pieces["distance"] = int(mo.group(2))
|
||||||
|
|
||||||
|
# commit: short hex revision ID
|
||||||
|
pieces["short"] = mo.group(3)
|
||||||
|
|
||||||
stdout = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
|
|
||||||
cwd=root)
|
|
||||||
if stdout is None:
|
|
||||||
branch = None
|
|
||||||
else:
|
else:
|
||||||
branch = stdout.strip()
|
# HEX: no tags
|
||||||
return {"version": tag, "full": full, "branch": branch}
|
pieces["closest-tag"] = None
|
||||||
|
count_out = run_command(GITS, ["rev-list", "HEAD", "--count"],
|
||||||
|
cwd=root)
|
||||||
|
pieces["distance"] = int(count_out) # total number of commits
|
||||||
|
|
||||||
|
return pieces
|
||||||
|
|
||||||
|
|
||||||
def versions_from_parentdir(parentdir_prefix, root, verbose=False):
|
@register_vcs_handler("git", "parse_lookup_file")
|
||||||
# Source tarballs conventionally unpack into a directory that includes
|
def git_parse_lookup_file(path):
|
||||||
# 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": "", "branch": ""}
|
|
||||||
|
|
||||||
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):
|
if not os.path.exists(path):
|
||||||
return []
|
return []
|
||||||
|
|
||||||
import re
|
import re
|
||||||
lookup = []
|
lookup = []
|
||||||
with open(os.path.join(root, lookup_path), "r") as f:
|
with open(path, "r") as f:
|
||||||
for line in f:
|
for line in f:
|
||||||
if '#' in line:
|
if '#' in line:
|
||||||
line = line[:line.rindex('#')]
|
line = line[:line.rindex("#")]
|
||||||
line = line.strip()
|
line = line.strip()
|
||||||
try:
|
try:
|
||||||
split_line = line.split()
|
split_line = line.split()
|
||||||
if len(split_line) == 3:
|
if len(split_line) == 3:
|
||||||
pattern, tag, ref_commit = split_line
|
pattern, tag, ref_commit = split_line
|
||||||
lookup.append([re.compile(pattern), tag, ref_commit])
|
lookup.append([re.compile(pattern), tag, ref_commit, None])
|
||||||
|
elif len(split_line) == 4:
|
||||||
|
pattern, tag, ref_commit, render = split_line
|
||||||
|
lookup.append([re.compile(pattern), tag, ref_commit, render])
|
||||||
elif len(split_line) >= 1:
|
elif len(split_line) >= 1:
|
||||||
lookup.append([re.compile(split_line[0]), None, None])
|
lookup.append([re.compile(split_line[0]), None, None, None])
|
||||||
except:
|
except:
|
||||||
break
|
break
|
||||||
return lookup
|
return lookup
|
||||||
|
|
||||||
def get_versions(default={"version": "unknown", "full": "", "branch": "unknown"}, lookup_path=None, verbose=False):
|
@register_vcs_handler("git", "pieces_from_lookup")
|
||||||
|
def git_pieces_from_lookup(lookup, root, verbose, run_command=run_command):
|
||||||
|
GITS = ["git"]
|
||||||
|
if sys.platform == "win32":
|
||||||
|
GITS = ["git.cmd", "git.exe"]
|
||||||
|
|
||||||
|
stdout = run_command(GITS, ["rev-parse", "--abbrev-ref", "HEAD"],
|
||||||
|
cwd=root)
|
||||||
|
if stdout is None:
|
||||||
|
raise NotThisMethod("git rev-parse --abbrev-ref HEAD failed")
|
||||||
|
|
||||||
|
current_branch = stdout.strip()
|
||||||
|
for matcher, tag, ref_commit, render in lookup:
|
||||||
|
if matcher.match(current_branch):
|
||||||
|
if tag is None or ref_commit is None:
|
||||||
|
raise NotThisMethod("tag or ref_commit is unset for this branch")
|
||||||
|
|
||||||
|
stdout = run_command(GITS, ["rev-list", "%s..HEAD" % ref_commit, "--count"], cwd=root)
|
||||||
|
if stdout is None:
|
||||||
|
raise NotThisMethod("git rev-list %s..HEAD --count failed" % ref_commit)
|
||||||
|
try:
|
||||||
|
num_commits = int(stdout.strip())
|
||||||
|
except ValueError:
|
||||||
|
raise NotThisMethod("git rev-list %s..HEAD --count didn't return a valid number" % ref_commit)
|
||||||
|
|
||||||
|
stdout =run_command(GITS, ["rev-parse", "--short", "HEAD"], cwd=root)
|
||||||
|
if stdout is None:
|
||||||
|
raise NotThisMethod("git describe rev-parse --short HEAD failed")
|
||||||
|
short_hash = stdout.strip()
|
||||||
|
|
||||||
|
stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"], cwd=root)
|
||||||
|
if stdout is None:
|
||||||
|
raise NotThisMethod("git describe --tags --dirty --always failed")
|
||||||
|
dirty = stdout.strip().endswith("-dirty")
|
||||||
|
|
||||||
|
stdout = run_command(GITS, ["rev-parse", "HEAD"], cwd=root)
|
||||||
|
if stdout is None:
|
||||||
|
raise NotThisMethod("git rev-parse HEAD failed")
|
||||||
|
full = stdout.strip()
|
||||||
|
|
||||||
|
return {
|
||||||
|
"long": full,
|
||||||
|
"short": short_hash,
|
||||||
|
"dirty": dirty,
|
||||||
|
"branch": current_branch,
|
||||||
|
"closest-tag": tag,
|
||||||
|
"distance": num_commits,
|
||||||
|
"error": None,
|
||||||
|
"render": render
|
||||||
|
}
|
||||||
|
|
||||||
|
raise NotThisMethod("no matching lookup definition found")
|
||||||
|
|
||||||
|
|
||||||
|
def plus_or_dot(pieces):
|
||||||
|
"""Return a + if we don't already have one, else return a ."""
|
||||||
|
if "+" in pieces.get("closest-tag", ""):
|
||||||
|
return "."
|
||||||
|
return "+"
|
||||||
|
|
||||||
|
|
||||||
|
def render_pep440(pieces):
|
||||||
|
"""Build up version string, with post-release "local version identifier".
|
||||||
|
|
||||||
|
Our goal: TAG[+DISTANCE.gHEX[.dirty]] . Note that if you
|
||||||
|
get a tagged build and then dirty it, you'll get TAG+0.gHEX.dirty
|
||||||
|
|
||||||
|
Exceptions:
|
||||||
|
1: no tags. git_describe was just HEX. 0+untagged.DISTANCE.gHEX[.dirty]
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
if pieces["distance"] or pieces["dirty"]:
|
||||||
|
rendered += plus_or_dot(pieces)
|
||||||
|
rendered += "%d.g%s" % (pieces["distance"], pieces["short"])
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dirty"
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = "0+untagged.%d.g%s" % (pieces["distance"],
|
||||||
|
pieces["short"])
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dirty"
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render_pep440_pre(pieces):
|
||||||
|
"""TAG[.post.devDISTANCE] -- No -dirty.
|
||||||
|
|
||||||
|
Exceptions:
|
||||||
|
1: no tags. 0.post.devDISTANCE
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
if pieces["distance"]:
|
||||||
|
rendered += ".post.dev%d" % pieces["distance"]
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = "0.post.dev%d" % pieces["distance"]
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render_pep440_post(pieces):
|
||||||
|
"""TAG[.postDISTANCE[.dev0]+gHEX] .
|
||||||
|
|
||||||
|
The ".dev0" means dirty. Note that .dev0 sorts backwards
|
||||||
|
(a dirty tree will appear "older" than the corresponding clean one),
|
||||||
|
but you shouldn't be releasing software with -dirty anyways.
|
||||||
|
|
||||||
|
Exceptions:
|
||||||
|
1: no tags. 0.postDISTANCE[.dev0]
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
if pieces["distance"] or pieces["dirty"]:
|
||||||
|
rendered += ".post%d" % pieces["distance"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dev0"
|
||||||
|
rendered += plus_or_dot(pieces)
|
||||||
|
rendered += "g%s" % pieces["short"]
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = "0.post%d" % pieces["distance"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dev0"
|
||||||
|
rendered += "+g%s" % pieces["short"]
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render_pep440_old(pieces):
|
||||||
|
"""TAG[.postDISTANCE[.dev0]] .
|
||||||
|
|
||||||
|
The ".dev0" means dirty.
|
||||||
|
|
||||||
|
Eexceptions:
|
||||||
|
1: no tags. 0.postDISTANCE[.dev0]
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
if pieces["distance"] or pieces["dirty"]:
|
||||||
|
rendered += ".post%d" % pieces["distance"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dev0"
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = "0.post%d" % pieces["distance"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += ".dev0"
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render_git_describe(pieces):
|
||||||
|
"""TAG[-DISTANCE-gHEX][-dirty].
|
||||||
|
|
||||||
|
Like 'git describe --tags --dirty --always'.
|
||||||
|
|
||||||
|
Exceptions:
|
||||||
|
1: no tags. HEX[-dirty] (note: no 'g' prefix)
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
if pieces["distance"]:
|
||||||
|
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = pieces["short"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += "-dirty"
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render_git_describe_long(pieces):
|
||||||
|
"""TAG-DISTANCE-gHEX[-dirty].
|
||||||
|
|
||||||
|
Like 'git describe --tags --dirty --always -long'.
|
||||||
|
The distance/hash is unconditional.
|
||||||
|
|
||||||
|
Exceptions:
|
||||||
|
1: no tags. HEX[-dirty] (note: no 'g' prefix)
|
||||||
|
"""
|
||||||
|
if pieces["closest-tag"]:
|
||||||
|
rendered = pieces["closest-tag"]
|
||||||
|
rendered += "-%d-g%s" % (pieces["distance"], pieces["short"])
|
||||||
|
else:
|
||||||
|
# exception #1
|
||||||
|
rendered = pieces["short"]
|
||||||
|
if pieces["dirty"]:
|
||||||
|
rendered += "-dirty"
|
||||||
|
return rendered
|
||||||
|
|
||||||
|
|
||||||
|
def render(pieces, style):
|
||||||
|
"""Render the given version pieces into the requested style."""
|
||||||
|
if pieces["error"]:
|
||||||
|
return {"version": "unknown",
|
||||||
|
"full-revisionid": pieces.get("long"),
|
||||||
|
"dirty": None,
|
||||||
|
"error": pieces["error"]}
|
||||||
|
|
||||||
|
if "render" in pieces and pieces["render"] is not None:
|
||||||
|
style = pieces["render"]
|
||||||
|
|
||||||
|
if not style or style == "default":
|
||||||
|
style = "pep440" # the default
|
||||||
|
|
||||||
|
if style == "pep440":
|
||||||
|
rendered = render_pep440(pieces)
|
||||||
|
elif style == "pep440-pre":
|
||||||
|
rendered = render_pep440_pre(pieces)
|
||||||
|
elif style == "pep440-post":
|
||||||
|
rendered = render_pep440_post(pieces)
|
||||||
|
elif style == "pep440-old":
|
||||||
|
rendered = render_pep440_old(pieces)
|
||||||
|
elif style == "git-describe":
|
||||||
|
rendered = render_git_describe(pieces)
|
||||||
|
elif style == "git-describe-long":
|
||||||
|
rendered = render_git_describe_long(pieces)
|
||||||
|
else:
|
||||||
|
raise ValueError("unknown style '%s'" % style)
|
||||||
|
|
||||||
|
result = {"version": rendered, "full-revisionid": pieces["long"],
|
||||||
|
"dirty": pieces["dirty"], "error": None}
|
||||||
|
if "branch" in pieces and pieces["branch"] is not None:
|
||||||
|
result["branch"] = pieces["branch"]
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def get_versions():
|
||||||
|
"""Get version information or return default if unable to do so."""
|
||||||
# I am in _version.py, which lives at ROOT/VERSIONFILE_SOURCE. If we have
|
# 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
|
# __file__, we can work backwards from there to the root. Some
|
||||||
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
|
# py2exe/bbfreeze/non-CPython implementations don't do __file__, in which
|
||||||
# case we can only use expanded variables.
|
# case we can only use expanded keywords.
|
||||||
|
|
||||||
variables = { "refnames": git_refnames, "full": git_full }
|
cfg = get_config()
|
||||||
ver = versions_from_expanded_variables(variables, tag_prefix, verbose)
|
verbose = cfg.verbose
|
||||||
if ver:
|
|
||||||
return ver
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
root = os.path.abspath(__file__)
|
return git_versions_from_keywords(get_keywords(), cfg.tag_prefix,
|
||||||
|
verbose)
|
||||||
|
except NotThisMethod:
|
||||||
|
pass
|
||||||
|
|
||||||
|
try:
|
||||||
|
root = os.path.realpath(__file__)
|
||||||
# versionfile_source is the relative path from the top of the source
|
# versionfile_source is the relative path from the top of the source
|
||||||
# tree (where the .git directory might live) to this file. Invert
|
# tree (where the .git directory might live) to this file. Invert
|
||||||
# this to find the root from __file__.
|
# this to find the root from __file__.
|
||||||
for i in range(len(versionfile_source.split("/"))):
|
for i in cfg.versionfile_source.split('/'):
|
||||||
root = os.path.dirname(root)
|
root = os.path.dirname(root)
|
||||||
except NameError:
|
except NameError:
|
||||||
return default
|
return {"version": "0+unknown", "full-revisionid": None,
|
||||||
|
"dirty": None,
|
||||||
|
"error": "unable to find root of source tree"}
|
||||||
|
|
||||||
lookup = parse_lookup_file(root, lookup_path=lookup_path)
|
lookupfile = os.path.join(root, cfg.lookupfile if cfg.lookupfile is not None else ".versioneer-lookup")
|
||||||
return (versions_from_lookup(lookup, root, verbose)
|
if os.path.exists(lookupfile):
|
||||||
or versions_from_vcs(tag_prefix, root, verbose)
|
try:
|
||||||
or versions_from_parentdir(parentdir_prefix, root, verbose)
|
lookup_data = git_parse_lookup_file(lookupfile)
|
||||||
or default)
|
pieces = git_pieces_from_lookup(lookup_data, root, verbose)
|
||||||
|
return render(pieces, cfg.style)
|
||||||
|
except NotThisMethod:
|
||||||
|
pass
|
||||||
|
|
||||||
|
try:
|
||||||
|
pieces = git_pieces_from_vcs(cfg.tag_prefix, root, verbose)
|
||||||
|
return render(pieces, cfg.style)
|
||||||
|
except NotThisMethod:
|
||||||
|
pass
|
||||||
|
|
||||||
|
try:
|
||||||
|
if cfg.parentdir_prefix:
|
||||||
|
return versions_from_parentdir(cfg.parentdir_prefix, root, verbose)
|
||||||
|
except NotThisMethod:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return {"version": "0+unknown", "full-revisionid": None,
|
||||||
|
"dirty": None,
|
||||||
|
"error": "unable to compute version"}
|
||||||
|
|
|
||||||
2220
versioneer.py
2220
versioneer.py
File diff suppressed because it is too large
Load diff
Loading…
Reference in a new issue