Changeset cdc8190 in git

Timestamp:

2012-02-09T23:34:21Z (13 years ago)

Author:

Brian Warner <warner@…>

Branches:

master

Children:

cdb9e79

Parents:

97f23e1

git-author:

Brian Warner <warner@…> (2012-02-09 23:29:43)

git-committer:

Brian Warner <warner@…> (2012-02-09 23:34:21)

Message:

Use versioneer-0.7 to make a version string from git metadata, when possible.

Files:

• .gitattributes (added)
• .gitignore (modified) (2 diffs)
• MANIFEST.in (modified) (1 diff)
• pycryptopp/__init__.py (modified) (1 diff)
• pycryptopp/_version.py (added)
• setup.py (modified) (6 diffs)
• versioneer.py (added)

.gitignore ¶

@@ -3 +3 @@
 /dist/
 
-# _version.py is generated at build time, and never checked in
-/pycryptopp/_version.py
+# extraversion.h is generated at build time, and never checked in
 /embeddedcryptopp/extraversion.h
 
@@ -21 +20 @@
 /ez_setup.pyc
 /pycryptopp/_pycryptopp.so
+/MANIFEST

MANIFEST.in ¶

@@ -1 +1 @@
 include copyright COPYING.GPL COPYING.TGPPL.html ChangeLog NEWS.rst README.rst
+include versioneer.py
 
 graft pycryptopp

pycryptopp/__init__.py ¶

@@ -3 +3 @@
 """
 
-__version__ = "unknown"
-try:
-    from _version import __version__
-except ImportError:
-    # We're running in a tree that hasn't run "./setup.py update_version",
-    # and didn't come with a _version.py, so we don't know what our version
-    # is. This should not happen very often.
-    pass
+def _build_versions():
+    from pycryptopp._version import get_versions
+    versions = get_versions()
+    # versions_from_git (as copied from python-versioneer) returns strings
+    # like "1.9.0-25-gb73aba9-dirty", which means we're in a tree with
+    # uncommited changes (-dirty), the latest checkin is revision b73aba9,
+    # the most recent tag was 1.9.0, and b73aba9 has 25 commits that weren't
+    # in 1.9.0 . The narrow-minded NormalizedVersion parser that takes our
+    # output (meant to enable sorting of version strings) refuses most of
+    # that, but accepts things like "1.9.0.post25", or "1.9.0.post25.dev0",
+    # so dumb down our output to match.
+    pieces = versions["version"].split("-")
+    if len(pieces) == 1:
+        normalized_version = pieces[0]
+    else:
+        normalized_version = "%s.post%s" % (pieces[0], pieces[1])
+    if pieces[-1] == "dirty":
+        normalized_version += ".dev0"
+    # this returns e.g.:
+    #  0.5.29.post51,
+    #  0.5.29-51-ga81fad1,
+    #  a81fad1d4afae353a40cf56fe88aa6ef0eea31a8
+    return versions["version"], normalized_version, versions["full"]
+__real_version__, __version__, __full_version__ = _build_versions()
+del _build_versions
 
 # we import our glue .so here, and then other modules use the copy in

setup.py ¶

@@ -13 +13 @@
 from setuptools import Extension, find_packages, setup
 from setuptools import Command
+
+import versioneer
+versioneer.versionfile_source = "pycryptopp/_version.py"
+versioneer.versionfile_build = "pycryptopp/_version.py"
+versioneer.tag_prefix = "pycryptopp-"
+versioneer.parentdir_prefix = "pycryptopp-"
 
 # ECDSA=False
@@ -181 +187 @@
 
 PKG='pycryptopp'
-VERSIONFILE = os.path.join(PKG, "_version.py")
-verstr = "unknown"
-try:
-    verstrline = open(VERSIONFILE, "rt").read()
-except EnvironmentError:
-    pass # Okay, there is no version file.
-else:
-    VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
-    mo = re.search(VSRE, verstrline, re.M)
-    if mo:
-        verstr = mo.group(1)
-    else:
-        print "unable to find version in %s" % (VERSIONFILE,)
-        raise RuntimeError("if %s.py exists, it is required to be well-formed" % (VERSIONFILE,))
 
 srcs = ['pycryptopp/_pycryptoppmodule.cpp',
@@ -247 +239 @@
 ###### Version updating code
 
-PY_GIT_VERSION_BODY = '''
-# This _version.py is generated from git metadata by the pycryptopp setup.py.
-# The main version number is taken from the most recent release tag. If some
-# patches have been added since the last release, this will have a -NN "build
-# number" suffix, or else a -rNN "revision number" suffix.
-
-__pkgname__ = "%(pkgname)s"
-real_version = "%(version)s"
-full_version = "%(full)s"
-verstr = "%(normalized)s"
-__version__ = verstr
-'''
-
 CPP_GIT_VERSION_BODY = '''
 /* This _version.py is generated from git metadata by the pycryptopp
@@ -270 +249 @@
 '''
 
-def run_command(args, cwd=None, verbose=False):
-    try:
-        # remember shell=False, so use git.cmd on windows, not just git
-        p = subprocess.Popen(args, stdout=subprocess.PIPE, cwd=cwd)
-    except EnvironmentError, e:
-        if verbose:
-            print "unable to run %s" % args[0]
-            print e
-        return None
-    stdout = p.communicate()[0].strip()
-    if p.returncode != 0:
-        if verbose:
-            print "unable to run %s (error)" % args[0]
-        return None
-    return stdout
-
-
-def versions_from_git(tag_prefix, verbose=False):
-    # 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
-    # in _version.py, thus the containing directory is somewhere deeper in
-    # 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.
-
-    # versions_from_git (as copied from python-versioneer) returns strings
-    # like "1.9.0-25-gb73aba9-dirty", which means we're in a tree with
-    # uncommited changes (-dirty), the latest checkin is revision b73aba9,
-    # the most recent tag was 1.9.0, and b73aba9 has 25 commits that weren't
-    # in 1.9.0 . The narrow-minded NormalizedVersion parser that takes our
-    # output (meant to enable sorting of version strings) refuses most of
-    # that. Tahoe-LAFS uses a function named suggest_normalized_version()
-    # that can handle "1.9.0.post25", so dumb down our output to match.
-
-    try:
-        source_dir = os.path.dirname(os.path.abspath(__file__))
-    except NameError:
-        # some py2exe/bbfreeze/non-CPython implementations don't do __file__
-        return {} # not always correct
-    GIT = "git"
-    if sys.platform == "win32":
-        GIT = "git.cmd"
-    stdout = run_command([GIT, "describe", "--tags", "--dirty", "--always"],
-                         cwd=source_dir)
-    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 {}
-    version = stdout[len(tag_prefix):]
-    pieces = version.split("-")
+def get_normalized_version():
+    pieces = versioneer.get_versions()["version"].split("-")
     if len(pieces) == 1:
         normalized_version = pieces[0]
     else:
         normalized_version = "%s.post%s" % (pieces[0], pieces[1])
-    stdout = run_command([GIT, "rev-parse", "HEAD"], cwd=source_dir)
-    if stdout is None:
-        return {}
-    full = stdout.strip()
-    if version.endswith("-dirty"):
-        full += "-dirty"
+    if pieces[-1] == "dirty":
         normalized_version += ".dev0"
-    return {"version": version, "normalized": normalized_version, "full": full}
-
-
-basedir = os.path.dirname(os.path.abspath(__file__))
-VERSIONFILES = [os.path.join('pycryptopp', '_version.py'),
-                os.path.join(EMBEDDED_CRYPTOPP_DIR, 'extraversion.h'),
-                ]
+    return normalized_version
+
 
 class UpdateVersion(Command):
-    description = "update _version.py from revision-control metadata"
+    description = "update extraversion.h from revision-control metadata"
     user_options = []
 
@@ -353 +269 @@
         pass
     def run(self):
-        if os.path.isdir(os.path.join(basedir, ".git")):
-            verstr = self.try_from_git()
-        else:
-            print "no version-control data found, leaving _version.py alone"
-            return
-        if verstr:
-            self.distribution.metadata.version = verstr
-
-    def try_from_git(self):
-        versions = versions_from_git("pycryptopp-", verbose=True)
-        if versions:
-            for fn in VERSIONFILES:
-                f = open(fn, "wb")
-                if fn.endswith(".py"):
-                    BODY = PY_GIT_VERSION_BODY
-                else:
-                    assert fn.endswith(".h")
-                    BODY = CPP_GIT_VERSION_BODY
-                f.write(BODY %
-                        { "pkgname": self.distribution.get_name(),
-                          "version": versions["version"],
-                          "normalized": versions["normalized"],
-                          "full": versions["full"] })
-                f.close()
-                print "git-version: wrote '%s' into '%s'" % (versions["version"], fn)
-        return versions.get("normalized", None)
+        versions = versioneer.get_versions()
+        fn = os.path.join(EMBEDDED_CRYPTOPP_DIR, 'extraversion.h')
+        f = open(fn, "wb")
+        BODY = CPP_GIT_VERSION_BODY
+        f.write(BODY %
+                { "pkgname": self.distribution.get_name(),
+                  "version": versions["version"],
+                  "normalized": get_normalized_version(),
+                  "full": versions["full"] })
+        f.close()
+        print "git-version: wrote '%s' into '%s'" % (versions["version"], fn)
+
+commands = versioneer.get_cmdclass().copy()
+commands["update_version"] = UpdateVersion
 
 setup(name=PKG,
-      version=verstr,
+      version=get_normalized_version(),
       description='Python wrappers for a few algorithms from the Crypto++ library',
       long_description=readmetext,
@@ -401 +305 @@
       test_suite=PKG+".test",
       zip_safe=False, # I prefer unzipped for easier access.
-      cmdclass={"update_version": UpdateVersion},
+      cmdclass=commands,
       )