Changeset 1675589 in git

Timestamp:

2012-03-13T02:42:54Z (13 years ago)

Author:

Zooko O'Whielacronx <zooko@…>

Branches:

master

Children:

4e43e1c

Parents:

6b21e80

git-author:

Zooko O'Whielacronx <zooko@…> (2012-03-12 02:01:26)

git-committer:

Zooko O'Whielacronx <zooko@…> (2012-03-13 02:42:54)

Message:

don't run versioneer at runtime

don't run versioneer whenever importing pycryptopp at runtime, instead depend on a fixed version number in _version.py.
This means the _version.py can be stale between when you change something in git (including dirtying the working directory tree) and when you next run "python setup.py update_version" or any of the setup.py commands which setup.cfg links to update_version.
This is less functionality, but there was at least one bug in the more functional version that I don't want to work on right now (why wasn't the _version.py inside the ./build/ directory not getting updated on "python setup.py install"), and also I'm a bit uncomfortable with all of that Python code and that interaction with the system (invoking git) at runtime.

Files:

• .gitignore (modified) (1 diff)
• setup.py (modified) (4 diffs)
• src/pycryptopp/__init__.py (modified) (2 diffs)
• src/pycryptopp/_version.py (deleted)

.gitignore ¶

@@ -5 +5 @@
 # extraversion.h is generated at build time, and never checked in
 /src-cryptopp/extraversion.h
+/src/pycryptopp/_version.py
 
 # the .egg-info is mostly generated during 'setup.py bdist_egg' ..

setup.py ¶

@@ -247 +247 @@
 data_files = [(doc_loc, data_fnames)]
 
-commands = versioneer.get_cmdclass().copy()
+commands = {}
 
 ###### Version updating code
@@ -271 +271 @@
     return normalized_version
 
+def read_version_py(infname):
+    try:
+        verstrline = open(infname, "rt").read()
+    except EnvironmentError:
+        return None
+    else:
+        VSRE = r"^verstr = ['\"]([^'\"]*)['\"]"
+        mo = re.search(VSRE, verstrline, re.M)
+        if mo:
+            return mo.group(1)
+
+VERSION_BODY = '''
+# This is the version of this tree, as created by %(versiontool)s from the darcs patch
+# information: 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. Please see
+# pyutil.version_class for a description of what the different fields mean.
+
+__pkgname__ = "%(pkgname)s"
+verstr = "%(pkgversion)s"
+try:
+    from pyutil.version_class import Version as pyutil_Version
+    __version__ = pyutil_Version(verstr)
+except (ImportError, ValueError):
+    # Maybe there is no pyutil installed.
+    from distutils.version import LooseVersion as distutils_Version
+    __version__ = distutils_Version(verstr)
+'''
 
 class UpdateVersion(Command):
@@ -291 +319 @@
                   "full": versions["full"] })
         f.close()
-        print "git-version: wrote '%s' into '%s'" % (versions["version"], fn)
+        self.write_version_py(get_normalized_version(), os.path.join('src', 'pycryptopp', '_version.py'), "pycryptopp's setup.py", VERSION_BODY, 'pycryptopp')
+        print "git-version: wrote '%s' into '%s' and '%s'" % (versions["version"], fn, os.path.join('src', 'pycryptopp', '_version.py'))
+
+    def write_version_py(self, verstr, outfname, EXE_NAME, version_body, pkgname):
+        f = open(outfname, "wb+")
+        f.write(version_body % {
+                'versiontool': EXE_NAME,
+                'pkgversion': verstr,
+                'pkgname': pkgname,
+                })
+        f.close()
+
 commands["update_version"] = UpdateVersion
 
@@ -318 +357 @@
 
 setup(name=PKG,
-      version=get_normalized_version(),
+      version=read_version_py(os.path.join('src', 'pycryptopp', '_version.py')),
       description='Python wrappers for a few algorithms from the Crypto++ library',
       long_description=readmetext,

src/pycryptopp/__init__.py ¶

@@ -2 +2 @@
 pycryptopp - Python wrappers for Crypto++
 """
-
-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
@@ -34 +8 @@
 import _pycryptopp
 __doc__ = _pycryptopp.__doc__
+__version__ = _pycryptopp.__version__
 
 def _import_my_names(thismodule, prefix):