1 """Version and diagnostic information for the mudpy engine."""
3 # Copyright (c) 2018-2020 mudpy authors. Permission to use, copy,
4 # modify, and distribute this software is granted under terms
5 # provided in the LICENSE file distributed with this software.
11 # TODO(fungi) Clean up once Python 3.6 is the oldest interpreter supported
12 if not hasattr(__builtins__, 'ModuleNotFoundError'):
13 ModuleNotFoundError = ImportError
14 # TODO(fungi) Clean up once Python 3.8 is the oldest interpreter supported
16 import importlib.metadata
18 except ModuleNotFoundError:
25 """Version detail for a Python package."""
27 def __init__(self, package):
29 project_name = package.metadata.get('Name')
31 project_name = package.project_name
32 self.project_name = _normalize_project(project_name)
33 version = package.version
34 self.version_info = tuple(version.split('.'))
36 # Build up a human-friendly version string for display purposes
37 self.text = "%s %s" % (self.project_name, version)
39 # Obtain Git commit ID from PBR metadata if present
41 dist = importlib.metadata.distribution(self.project_name)
43 dist = pkg_resources.get_distribution(self.project_name)
46 pbr_metadata = dist.read_text("pbr.json")
48 pbr_metadata = dist.get_metadata("pbr.json")
49 except (IOError, KeyError):
52 self.git_version = json.loads(pbr_metadata)["git_version"]
54 self.git_version = None
56 self.text = "%s (%s)" % (self.text, self.git_version)
64 """Tracks info on known Python package versions."""
66 def __init__(self, project_name):
67 # Normalize the supplied name
68 project_name = _normalize_project(project_name)
70 # Python info for convenience
71 self.python_version = "%s Python %s" % (
72 sys.platform, sys.version.split(" ")[0])
74 # List of package names for this package's declared dependencies
77 for req in importlib.metadata.distribution(project_name).requires:
78 requirements.append(_normalize_project(req))
80 for req in pkg_resources.get_distribution(project_name).requires():
81 requirements.append(_normalize_project(req.project_name))
83 # Accumulators for Python package versions
84 self.dependencies = {}
87 # Loop over all installed packages
89 distributions = importlib.metadata.distributions()
91 distributions = pkg_resources.working_set
92 for package in distributions:
93 version = VersionDetail(package)
94 # Sort packages into the corresponding buckets
95 if version.project_name in requirements:
96 # This is a dependency
97 self.dependencies[version.project_name] = version
98 elif version.project_name == project_name:
99 # This is our main package
100 self.version = version
102 # This may be a transitive dep, or merely installed
103 self.environment[version.project_name] = version
105 self.dependencies_text = ", ".join(
106 sorted([x.text for x in self.dependencies.values()]))
107 self.environment_text = ", ".join(
108 sorted([x.text for x in self.environment.values()]))
111 return "Running %s on %s with dependencies %s." % (
114 self.dependencies_text,
118 def _normalize_project(project_name):
119 """Convenience function to normalize Python project names."""
121 return project_name.lower()
123 return pkg_resources.safe_name(project_name).lower()