setup: refactor versions-and-paths and use pkg_resources to find them

Using pkg_resources is probably better if it works -- zope.interface doesn't have a __version__ attribute that we can query, but pkg_resources knows zope.interface's version number, for one thing.
This code falls back to the old way -- looking at the __version__ attributes and __file__ attributes -- if the pkg_resources way doesn't answer.
Note that this patch also changes the capitalization of "Nevow", "Twisted", and "pyOpenSSL", and the spelling of "allmydata-tahoe".  These changes are not frivolous: they are reflecting the fact that we are naming Python packages (technically called Python "distributions") instead of Python modules (technically and confusingly called Python "packages") here.  The package ("distribution") is named "allmydata-tahoe".  The module ("package") is named "allmydata".

diff --git a/_auto_deps.py b/_auto_deps.py
index 8d45bf8615a32f2f53f146550c35633a25faada1..2c8f8e33133f567217fad99295589c658dab8425 100644 (file)
--- a/_auto_deps.py
+++ b/_auto_deps.py
@@ -58,3 +58,7 @@ def require_auto_deps():
             # but it shows a too-old version, then we'll get a
             # VersionConflict error instead of DistributionNotFound.
             pass
+
+def get_package_versions_from_setuptools():
+    import pkg_resources
+    return dict([(p.project_name, (p.version, p.location)) for p in pkg_resources.require('allmydata-tahoe')])

diff --git a/src/allmydata/__init__.py b/src/allmydata/__init__.py
index 290da2078acead3a0d6038188f7911e0e3bfa58d..a442d8426c43e49903e2543121dc3f3b937d7459 100644 (file)
--- a/src/allmydata/__init__.py
+++ b/src/allmydata/__init__.py
@@ -21,7 +21,7 @@ del hush_pyflakes
 import _auto_deps
 _auto_deps.require_auto_deps()
 
-import os, platform, re, subprocess
+import os, platform, re, subprocess, sys
 _distributor_id_cmdline_re = re.compile("(?:Distributor ID:)\s*(.*)", re.I)
 _release_cmdline_re = re.compile("(?:Release:)\s*(.*)", re.I)
 
@@ -120,57 +120,60 @@ def get_platform():
     else:
         return platform.platform()
 
-def get_package_versions():
-    import OpenSSL, allmydata, foolscap, nevow, platform, pycryptopp, setuptools, simplejson, twisted, zfec
-
-    return {
-        'pyopenssl': OpenSSL.__version__,
-        'allmydata': allmydata.__version__,
-        'foolscap': foolscap.__version__,
-        'nevow': nevow.__version__,
-        'pycryptopp': pycryptopp.__version__,
-        'setuptools': setuptools.__version__,
-        'simplejson': simplejson.__version__,
-        'twisted': twisted.__version__,
-        'zfec': zfec.__version__,
-        'python': platform.python_version(),
-        'platform': get_platform()
+def get_package_versions_and_locations():
+    # because there are a few dependencies that are outside setuptools's ken (Python and
+    # platform), and because setuptools might fail to find something even though import finds
+    # it:
+    import OpenSSL, allmydata, foolscap, nevow, platform, pycryptopp, setuptools, simplejson, twisted, zfec, zope.interface
+
+    d1 = {
+        'pyOpenSSL': (OpenSSL.__version__, os.path.dirname(OpenSSL.__file__)),
+        'allmydata-tahoe': (allmydata.__version__, os.path.dirname(allmydata.__file__)),
+        'foolscap': (foolscap.__version__, os.path.dirname(foolscap.__file__)),
+        'Nevow': (nevow.__version__, os.path.dirname(nevow.__file__)),
+        'pycryptopp': (pycryptopp.__version__, os.path.dirname(pycryptopp.__file__)),
+        'setuptools': (setuptools.__version__, os.path.dirname(setuptools.__file__)),
+        'simplejson': (simplejson.__version__, os.path.dirname(simplejson.__file__)),
+        'zope.interface': ('unknown', os.path.dirname(zope.interface.__file__)),
+        'Twisted': (twisted.__version__, os.path.dirname(twisted.__file__)),
+        'zfec': (zfec.__version__, os.path.dirname(zfec.__file__)),
+        'python': (platform.python_version(), sys.executable),
+        'platform': (get_platform(), None),
         }
 
+    # But we prefer to get all the dependencies as known by setuptools:
+    import pkg_resources
+    try:
+        d2 = _auto_deps.get_package_versions_from_setuptools()
+    except pkg_resources.DistributionNotFound:
+        # See docstring in _auto_deps.require_auto_deps() to explain why it makes sense to ignore this exception.
+        pass
+    else:
+        d1.update(d2)
+
+    return d1
+
+def get_package_versions():
+    return dict([(k, v) for k, (v, l) in get_package_versions_and_locations().iteritems()])
+
 def get_package_locations():
-    import OpenSSL, allmydata, foolscap, nevow, platform, pycryptopp, setuptools, simplejson, twisted, zfec
-
-    return {
-        'pyopenssl': os.path.dirname(OpenSSL.__file__),
-        'allmydata': os.path.dirname(allmydata.__file__),
-        'foolscap': os.path.dirname(foolscap.__file__),
-        'nevow': os.path.dirname(nevow.__file__),
-        'pycryptopp': os.path.dirname(pycryptopp.__file__),
-        'setuptools': os.path.dirname(setuptools.__file__),
-        'simplejson': os.path.dirname(simplejson.__file__),
-        'twisted': os.path.dirname(twisted.__file__),
-        'zfec': os.path.dirname(zfec.__file__),
-        'python': platform.python_version(),
-        'platform': get_platform()
-        }
+    return dict([(k, l) for k, (v, l) in get_package_versions_and_locations().iteritems()])
 
 def get_package_versions_string(show_paths=False):
-    versions = get_package_versions()
-    paths = None
-    if show_paths:
-        paths = get_package_locations()
-
+    vers_and_locs = get_package_versions_and_locations()
     res = []
-    for p in ["allmydata", "foolscap", "pycryptopp", "zfec", "twisted", "nevow", "python", "platform"]:
-        if versions.has_key(p):
-            info = str(p) + ": " + str(versions[p])
-            del versions[p]
-        else:
-            info = str(p) + ": UNKNOWN"
+    for p in ["allmydata-tahoe", "foolscap", "pycryptopp", "zfec", "Twisted", "Nevow", "zope.interface", "python", "platform"]:
+        (ver, loc) = vers_and_locs.get(p, ('UNKNOWN', 'UNKNOWN'))
+        info = str(p) + ": " + str(ver)
         if show_paths:
-            info = info + " (%s)" % str(paths[p])
+            info = info + " (%s)" % str(loc)
         res.append(info)
+        if vers_and_locs.has_key(p):
+            del vers_and_locs[p]
 
-    for p, v in versions.iteritems():
-        res.append(str(p) + ": " + str(v))
+    for p, (v, loc) in vers_and_locs.iteritems():
+        info = str(p) + ": " + str(v)
+        if show_paths:
+            info = info + " (%s)" % str(loc)
+        res.append(info)
     return ', '.join(res)