2 Decentralized storage grid.
4 community web site: U{https://tahoe-lafs.org/}
7 class PackagingError(EnvironmentError):
9 Raised when there is an error in packaging of Tahoe-LAFS or its
10 dependencies which makes it impossible to proceed safely.
14 __version__ = "unknown"
16 from allmydata._version import __version__
18 # We're running in a tree that hasn't run "./setup.py darcsver", and didn't
19 # come with a _version.py, so we don't know what our version is. This should
20 # not happen very often.
23 __appname__ = "unknown"
25 from allmydata._appname import __appname__
27 # We're running in a tree that hasn't run "./setup.py". This shouldn't happen.
30 # __full_version__ is the one that you ought to use when identifying yourself in the
31 # "application" part of the Tahoe versioning scheme:
32 # https://tahoe-lafs.org/trac/tahoe-lafs/wiki/Versioning
33 __full_version__ = __appname__ + '/' + str(__version__)
35 import os, platform, re, subprocess, sys, traceback
36 _distributor_id_cmdline_re = re.compile("(?:Distributor ID:)\s*(.*)", re.I)
37 _release_cmdline_re = re.compile("(?:Release:)\s*(.*)", re.I)
39 _distributor_id_file_re = re.compile("(?:DISTRIB_ID\s*=)\s*(.*)", re.I)
40 _release_file_re = re.compile("(?:DISTRIB_RELEASE\s*=)\s*(.*)", re.I)
42 global _distname,_version
46 def get_linux_distro():
47 """ Tries to determine the name of the Linux OS distribution name.
49 First, try to parse a file named "/etc/lsb-release". If it exists, and
50 contains the "DISTRIB_ID=" line and the "DISTRIB_RELEASE=" line, then return
51 the strings parsed from that file.
53 If that doesn't work, then invoke platform.dist().
55 If that doesn't work, then try to execute "lsb_release", as standardized in
58 http://refspecs.freestandards.org/LSB_1.0.0/gLSB/lsbrelease.html
60 The current version of the standard is here:
62 http://refspecs.freestandards.org/LSB_3.2.0/LSB-Core-generic/LSB-Core-generic/lsbrelease.html
64 that lsb_release emitted, as strings.
66 Returns a tuple (distname,version). Distname is what LSB calls a
67 "distributor id", e.g. "Ubuntu". Version is what LSB calls a "release",
70 A version of this has been submitted to python as a patch for the standard
71 library module "platform":
73 http://bugs.python.org/issue3937
75 global _distname,_version
76 if _distname and _version:
77 return (_distname, _version)
80 etclsbrel = open("/etc/lsb-release", "rU")
81 for line in etclsbrel:
82 m = _distributor_id_file_re.search(line)
84 _distname = m.group(1).strip()
85 if _distname and _version:
86 return (_distname, _version)
87 m = _release_file_re.search(line)
89 _version = m.group(1).strip()
90 if _distname and _version:
91 return (_distname, _version)
92 except EnvironmentError:
95 (_distname, _version) = platform.dist()[:2]
96 if _distname and _version:
97 return (_distname, _version)
100 p = subprocess.Popen(["lsb_release", "--all"], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
103 for line in p.stdout.readlines():
104 m = _distributor_id_cmdline_re.search(line)
106 _distname = m.group(1).strip()
107 if _distname and _version:
108 return (_distname, _version)
110 m = _release_cmdline_re.search(p.stdout.read())
112 _version = m.group(1).strip()
113 if _distname and _version:
114 return (_distname, _version)
115 except EnvironmentError:
118 if os.path.exists("/etc/arch-release"):
119 return ("Arch_Linux", "")
121 return (_distname,_version)
124 # Our version of platform.platform(), telling us both less and more than the
125 # Python Standard Library's version does.
126 # We omit details such as the Linux kernel version number, but we add a
127 # more detailed and correct rendition of the Linux distribution and
128 # distribution-version.
129 if "linux" in platform.system().lower():
130 return platform.system()+"-"+"_".join(get_linux_distro())+"-"+platform.machine()+"-"+"_".join([x for x in platform.architecture() if x])
132 return platform.platform()
135 from allmydata.util import verlib
136 def normalized_version(verstr, what=None):
138 return verlib.NormalizedVersion(verlib.suggest_normalized_version(verstr))
139 except (StandardError, verlib.IrrationalVersionError):
140 cls, value, trace = sys.exc_info()
141 raise PackagingError, ("could not parse %s due to %s: %s"
142 % (what or repr(verstr), cls.__name__, value)), trace
145 def get_package_versions_and_locations():
147 from _auto_deps import package_imports, deprecation_messages, \
148 user_warning_messages, runtime_warning_messages, warning_imports
150 def package_dir(srcfile):
151 return os.path.dirname(os.path.dirname(os.path.normcase(os.path.realpath(srcfile))))
153 # pkg_resources.require returns the distribution that pkg_resources attempted to put
154 # on sys.path, which can differ from the one that we actually import due to #1258,
155 # or any other bug that causes sys.path to be set up incorrectly. Therefore we
156 # must import the packages in order to check their versions and paths.
158 # This warning is generated by twisted, PyRex, and possibly other packages,
159 # but can happen at any time, not only when they are imported. See ticket #1129.
160 warnings.filterwarnings("ignore", category=DeprecationWarning,
161 message="BaseException.message has been deprecated as of Python 2.6",
164 # This is to suppress various DeprecationWarnings, UserWarnings, and RuntimeWarnings
165 # (listed in _auto_deps.py) that occur when modules are imported.
167 for msg in deprecation_messages:
168 warnings.filterwarnings("ignore", category=DeprecationWarning, message=msg, append=True)
169 for msg in user_warning_messages:
170 warnings.filterwarnings("ignore", category=UserWarning, message=msg, append=True)
171 for msg in runtime_warning_messages:
172 warnings.filterwarnings("ignore", category=RuntimeWarning, message=msg, append=True)
174 for modulename in warning_imports:
176 __import__(modulename)
180 for ign in runtime_warning_messages + user_warning_messages + deprecation_messages:
181 warnings.filters.pop()
185 def get_version(module, attr):
186 return str(getattr(module, attr, 'unknown'))
188 for pkgname, modulename in [(__appname__, 'allmydata')] + package_imports:
191 __import__(modulename)
192 module = sys.modules[modulename]
194 etype, emsg, etrace = sys.exc_info()
195 trace_info = (etype, str(emsg), ([None] + traceback.extract_tb(etrace))[-1])
196 packages.append( (pkgname, (None, None, trace_info)) )
199 if pkgname == 'setuptools' and hasattr(module, '_distribute'):
200 # distribute does not report its version in any module variables
201 comment = 'distribute'
202 packages.append( (pkgname, (get_version(module, '__version__'), package_dir(module.__file__), comment)) )
203 elif pkgname == 'python':
204 packages.append( (pkgname, (platform.python_version(), sys.executable, None)) )
205 elif pkgname == 'platform':
206 packages.append( (pkgname, (get_platform(), None, None)) )
211 def check_requirement(req, vers_and_locs):
212 # TODO: check [] options
213 # We support only disjunctions of <=, >=, and ==
215 reqlist = req.split(',')
216 name = reqlist[0].split('<=')[0].split('>=')[0].split('==')[0].strip(' ').split('[')[0]
217 if name not in vers_and_locs:
218 raise PackagingError("no version info for %s" % (name,))
219 if req.strip(' ') == name:
221 (actual, location, comment) = vers_and_locs[name]
223 # comment is (type, message, (filename, line number, function name, text)) for the original ImportError
224 raise ImportError("for requirement %r: %s" % (req, comment))
225 if actual == 'unknown':
227 actualver = normalized_version(actual, what="actual version %r of %s from %r" % (actual, name, location))
232 required = s[1].strip(' ')
233 if actualver <= normalized_version(required, what="required maximum version %r in %r" % (required, req)):
234 return # maximum requirement met
238 required = s[1].strip(' ')
239 if actualver >= normalized_version(required, what="required minimum version %r in %r" % (required, req)):
240 return # minimum requirement met
244 required = s[1].strip(' ')
245 if actualver == normalized_version(required, what="required exact version %r in %r" % (required, req)):
246 return # exact requirement met
248 raise PackagingError("no version info or could not understand requirement %r" % (req,))
250 msg = ("We require %s, but could only find version %s.\n" % (req, actual))
251 if location and location != 'unknown':
252 msg += "The version we found is from %r.\n" % (location,)
253 msg += ("To resolve this problem, uninstall that version, either using your\n"
254 "operating system's package manager or by moving aside the directory.")
255 raise PackagingError(msg)
258 _vers_and_locs_list = get_package_versions_and_locations()
261 def cross_check_pkg_resources_versus_import():
262 """This function returns a list of errors due to any failed cross-checks."""
265 from _auto_deps import install_requires
267 pkg_resources_vers_and_locs = dict([(p.project_name.lower(), (str(p.version), p.location))
268 for p in pkg_resources.require(install_requires)])
270 return cross_check(pkg_resources_vers_and_locs, _vers_and_locs_list)
273 def cross_check(pkg_resources_vers_and_locs, imported_vers_and_locs_list):
274 """This function returns a list of errors due to any failed cross-checks."""
277 not_pkg_resourceable = set(['python', 'platform', __appname__.lower()])
278 not_import_versionable = set(['zope.interface', 'mock', 'pyasn1'])
279 ignorable = set(['argparse', 'pyutil', 'zbase32', 'distribute', 'twisted-web', 'twisted-core'])
281 for name, (imp_ver, imp_loc, imp_comment) in imported_vers_and_locs_list:
283 if name not in not_pkg_resourceable:
284 if name not in pkg_resources_vers_and_locs:
285 if name == "setuptools" and "distribute" in pkg_resources_vers_and_locs:
286 pr_ver, pr_loc = pkg_resources_vers_and_locs["distribute"]
287 if not (os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc))
288 and imp_comment == "distribute"):
289 errors.append("Warning: dependency 'setuptools' found to be version %r of 'distribute' from %r "
290 "by pkg_resources, but 'import setuptools' gave version %r [%s] from %r. "
291 "A version mismatch is expected, but a location mismatch is not."
292 % (pr_ver, pr_loc, imp_ver, imp_comment or 'probably *not* distribute', imp_loc))
294 errors.append("Warning: dependency %r (version %r imported from %r) was not found by pkg_resources."
295 % (name, imp_ver, imp_loc))
298 pr_ver, pr_loc = pkg_resources_vers_and_locs[name]
300 pr_normver = normalized_version(pr_ver)
302 errors.append("Warning: version number %r found for dependency %r by pkg_resources could not be parsed. "
303 "The version found by import was %r from %r. "
304 "pkg_resources thought it should be found at %r. "
305 "The exception was %s: %s"
306 % (pr_ver, name, imp_ver, imp_loc, pr_loc, e.__class__.__name__, e))
308 if imp_ver == 'unknown':
309 if name not in not_import_versionable:
310 errors.append("Warning: unexpectedly could not find a version number for dependency %r imported from %r. "
311 "pkg_resources thought it should be version %r at %r."
312 % (name, imp_loc, pr_ver, pr_loc))
315 imp_normver = normalized_version(imp_ver)
317 errors.append("Warning: version number %r found for dependency %r (imported from %r) could not be parsed. "
318 "pkg_resources thought it should be version %r at %r. "
319 "The exception was %s: %s"
320 % (imp_ver, name, imp_loc, pr_ver, pr_loc, e.__class__.__name__, e))
322 if pr_ver == 'unknown' or (pr_normver != imp_normver):
323 if not os.path.normpath(os.path.realpath(pr_loc)) == os.path.normpath(os.path.realpath(imp_loc)):
324 errors.append("Warning: dependency %r found to have version number %r (normalized to %r, from %r) "
325 "by pkg_resources, but version %r (normalized to %r, from %r) by import."
326 % (name, pr_ver, str(pr_normver), pr_loc, imp_ver, str(imp_normver), imp_loc))
328 imported_packages = set([p.lower() for (p, _) in imported_vers_and_locs_list])
329 for pr_name, (pr_ver, pr_loc) in pkg_resources_vers_and_locs.iteritems():
330 if pr_name not in imported_packages and pr_name not in ignorable:
331 errors.append("Warning: dependency %r (version %r) found by pkg_resources not found by import."
337 def get_error_string(errors, debug=False):
338 from allmydata._auto_deps import install_requires
340 msg = "\n%s\n" % ("\n".join(errors),)
343 "For debugging purposes, the PYTHONPATH was\n"
345 "install_requires was\n"
347 "sys.path after importing pkg_resources was\n"
349 % (os.environ.get('PYTHONPATH'), install_requires, (os.pathsep+"\n ").join(sys.path)) )
352 def check_all_requirements():
353 """This function returns a list of errors due to any failed checks."""
355 from allmydata._auto_deps import install_requires
359 # We require at least 2.5 on all platforms.
360 # (On Python 3, we'll have failed long before this point.)
361 if sys.version_info < (2, 5):
363 version_string = ".".join(map(str, sys.version_info))
365 version_string = repr(sys.version_info)
366 errors.append("Tahoe-LAFS current requires Python v2.5 or greater (but less than v3), not %s"
369 vers_and_locs = dict(_vers_and_locs_list)
370 for requirement in install_requires:
372 check_requirement(requirement, vers_and_locs)
373 except (ImportError, PackagingError), e:
374 errors.append("%s: %s" % (e.__class__.__name__, e))
377 raise PackagingError(get_error_string(errors, debug=True))
379 check_all_requirements()
382 def get_package_versions():
383 return dict([(k, v) for k, (v, l, c) in _vers_and_locs_list])
385 def get_package_locations():
386 return dict([(k, l) for k, (v, l, c) in _vers_and_locs_list])
388 def get_package_versions_string(show_paths=False, debug=False):
390 for p, (v, loc, comment) in _vers_and_locs_list:
391 info = str(p) + ": " + str(v)
393 info = info + " [%s]" % str(comment)
395 info = info + " (%s)" % str(loc)
398 output = ",\n".join(res) + "\n"
400 if not hasattr(sys, 'frozen'):
401 errors = cross_check_pkg_resources_versus_import()
403 output += get_error_string(errors, debug=debug)