Skip to content
Browse files

initial, versioneer-ification

  • Loading branch information
warner committed Feb 10, 2015
1 parent 82d8d02 commit d782a8b63baa9687166a1a8a4f63535855746937
Showing with 1,116 additions and 0 deletions.
  1. +1 −0 .gitattributes
  2. +1 −0 .gitignore
  3. +2 −0
  4. +24 −0
  5. +4 −0 src/wormhole/
  6. +183 −0 src/wormhole/
  7. +901 −0
@@ -0,0 +1 @@
src/wormhole/ export-subst
@@ -21,6 +21,7 @@ var/

# PyInstaller
# Usually these files are written by a python script from a template
@@ -0,0 +1,2 @@
include src/wormhole/
@@ -0,0 +1,24 @@

from setuptools import setup

import versioneer
versioneer.VCS = "git"
versioneer.versionfile_source = "src/wormhole/"
versioneer.versionfile_build = "wormhole/"
versioneer.tag_prefix = ""
versioneer.parentdir_prefix = "wormhole-sync"

commands = versioneer.get_cmdclass()

description="Securely transfer data between computers",
author="Brian Warner",
package_dir={"": "src"},
@@ -0,0 +1,4 @@

from ._version import get_versions
__version__ = get_versions()['version']
del get_versions
@@ -0,0 +1,183 @@

# 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 (built by sdist) and build
# directories (produced by 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.12 (

# these strings will be replaced by git during git-archive
git_refnames = "$Format:%d$"
git_full = "$Format:%H$"

# these strings are filled in when ' versioneer' creates
tag_prefix = ""
parentdir_prefix = "wormhole-sync"
versionfile_source = "src/wormhole/"

import os, sys, re, subprocess, errno

def run_command(commands, args, cwd=None, verbose=False, hide_stderr=False):
assert isinstance(commands, list)
p = None
for c in commands:
# 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))
except EnvironmentError:
e = sys.exc_info()[1]
if e.errno == errno.ENOENT:
if verbose:
print("unable to run %s" % args[0])
return None
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

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": ""}

def git_get_keywords(versionfile_abs):
# the code embedded in can just fetch the value of these
# keywords. When used from, we don't want to import,
# so we do it with a regexp instead. This function is not used from
keywords = {}
f = open(versionfile_abs,"r")
for line in f.readlines():
if line.strip().startswith("git_refnames ="):
mo ='=\s*"(.*)"', line)
if mo:
keywords["refnames"] =
if line.strip().startswith("git_full ="):
mo ='=\s*"(.*)"', line)
if mo:
keywords["full"] =
except EnvironmentError:
return keywords

def git_versions_from_keywords(keywords, tag_prefix, verbose=False):
if not keywords:
return {} # keyword-finding function failed to find keywords
refnames = keywords["refnames"].strip()
if refnames.startswith("$Format"):
if verbose:
print("keywords 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'\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": keywords["full"].strip() }
# no suitable tags, so we use the full revision id
if verbose:
print("no suitable tags, using full revision id")
return { "version": keywords["full"].strip(),
"full": keywords["full"].strip() }

def git_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' keywords were *not* expanded, and
# hasn't already been rewritten with a short version string,
# meaning we're inside a checked out source tree.

if not os.path.exists(os.path.join(root, ".git")):
if verbose:
print("no .git in %s" % root)
return {}

GITS = ["git"]
if sys.platform == "win32":
GITS = ["git.cmd", "git.exe"]
stdout = run_command(GITS, ["describe", "--tags", "--dirty", "--always"],
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"
return {"version": tag, "full": full}

def get_versions(default={"version": "unknown", "full": ""}, verbose=False):
# I am in, 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 keywords.

keywords = { "refnames": git_refnames, "full": git_full }
ver = git_versions_from_keywords(keywords, tag_prefix, verbose)
if ver:
return ver

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(os.sep))):
root = os.path.dirname(root)
except NameError:
return default

return (git_versions_from_vcs(tag_prefix, root, verbose)
or versions_from_parentdir(parentdir_prefix, root, verbose)
or default)

0 comments on commit d782a8b

Please sign in to comment.
You can’t perform that action at this time.