Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 1 | """Find modules used by a script, using introspection.""" |
Thomas Heller | 919000e | 2002-11-25 20:21:59 +0000 | [diff] [blame] | 2 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 3 | import dis |
Eric Snow | 32439d6 | 2015-05-02 19:15:18 -0600 | [diff] [blame] | 4 | import importlib._bootstrap_external |
Brett Cannon | 73b969e | 2012-12-22 19:34:21 -0500 | [diff] [blame] | 5 | import importlib.machinery |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 6 | import marshal |
| 7 | import os |
Barry | d42e582 | 2020-04-14 20:16:06 +0100 | [diff] [blame] | 8 | import io |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 9 | import sys |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 10 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 11 | |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 12 | LOAD_CONST = dis.opmap['LOAD_CONST'] |
| 13 | IMPORT_NAME = dis.opmap['IMPORT_NAME'] |
| 14 | STORE_NAME = dis.opmap['STORE_NAME'] |
| 15 | STORE_GLOBAL = dis.opmap['STORE_GLOBAL'] |
Victor Stinner | 7e50978 | 2016-04-12 18:17:06 +0200 | [diff] [blame] | 16 | STORE_OPS = STORE_NAME, STORE_GLOBAL |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 17 | EXTENDED_ARG = dis.EXTENDED_ARG |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 18 | |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 19 | # Old imp constants: |
| 20 | |
| 21 | _SEARCH_ERROR = 0 |
| 22 | _PY_SOURCE = 1 |
| 23 | _PY_COMPILED = 2 |
| 24 | _C_EXTENSION = 3 |
| 25 | _PKG_DIRECTORY = 5 |
| 26 | _C_BUILTIN = 6 |
| 27 | _PY_FROZEN = 7 |
| 28 | |
Guido van Rossum | f1b5a0e | 1998-05-18 20:21:56 +0000 | [diff] [blame] | 29 | # Modulefinder does a good job at simulating Python's, but it can not |
| 30 | # handle __path__ modifications packages make at runtime. Therefore there |
| 31 | # is a mechanism whereby you can register extra paths in this map for a |
Thomas Wouters | 7e47402 | 2000-07-16 12:04:32 +0000 | [diff] [blame] | 32 | # package, and it will be honored. |
Guido van Rossum | f1b5a0e | 1998-05-18 20:21:56 +0000 | [diff] [blame] | 33 | |
| 34 | # Note this is a mapping is lists of paths. |
| 35 | packagePathMap = {} |
| 36 | |
| 37 | # A Public interface |
| 38 | def AddPackagePath(packagename, path): |
Éric Araujo | cee6bb5 | 2011-08-01 15:29:07 +0200 | [diff] [blame] | 39 | packagePathMap.setdefault(packagename, []).append(path) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 40 | |
Thomas Heller | c7aaf95 | 2002-11-14 18:45:11 +0000 | [diff] [blame] | 41 | replacePackageMap = {} |
| 42 | |
Martin v. Löwis | 2f48d89 | 2011-05-09 08:05:43 +0200 | [diff] [blame] | 43 | # This ReplacePackage mechanism allows modulefinder to work around |
| 44 | # situations in which a package injects itself under the name |
| 45 | # of another package into sys.modules at runtime by calling |
| 46 | # ReplacePackage("real_package_name", "faked_package_name") |
Thomas Heller | c7aaf95 | 2002-11-14 18:45:11 +0000 | [diff] [blame] | 47 | # before running ModuleFinder. |
| 48 | |
| 49 | def ReplacePackage(oldname, newname): |
| 50 | replacePackageMap[oldname] = newname |
| 51 | |
| 52 | |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 53 | def _find_module(name, path=None): |
| 54 | """An importlib reimplementation of imp.find_module (for our purposes).""" |
| 55 | |
| 56 | # It's necessary to clear the caches for our Finder first, in case any |
| 57 | # modules are being added/deleted/modified at runtime. In particular, |
| 58 | # test_modulefinder.py changes file tree contents in a cache-breaking way: |
| 59 | |
| 60 | importlib.machinery.PathFinder.invalidate_caches() |
| 61 | |
| 62 | spec = importlib.machinery.PathFinder.find_spec(name, path) |
| 63 | |
| 64 | if spec is None: |
| 65 | raise ImportError("No module named {name!r}".format(name=name), name=name) |
| 66 | |
| 67 | # Some special cases: |
| 68 | |
| 69 | if spec.loader is importlib.machinery.BuiltinImporter: |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 70 | return None, None, ("", "", _C_BUILTIN) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 71 | |
| 72 | if spec.loader is importlib.machinery.FrozenImporter: |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 73 | return None, None, ("", "", _PY_FROZEN) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 74 | |
| 75 | file_path = spec.origin |
| 76 | |
| 77 | if spec.loader.is_package(name): |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 78 | return None, os.path.dirname(file_path), ("", "", _PKG_DIRECTORY) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 79 | |
| 80 | if isinstance(spec.loader, importlib.machinery.SourceFileLoader): |
| 81 | kind = _PY_SOURCE |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 82 | |
| 83 | elif isinstance(spec.loader, importlib.machinery.ExtensionFileLoader): |
| 84 | kind = _C_EXTENSION |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 85 | |
| 86 | elif isinstance(spec.loader, importlib.machinery.SourcelessFileLoader): |
| 87 | kind = _PY_COMPILED |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 88 | |
| 89 | else: # Should never happen. |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 90 | return None, None, ("", "", _SEARCH_ERROR) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 91 | |
Barry | d42e582 | 2020-04-14 20:16:06 +0100 | [diff] [blame] | 92 | file = io.open_code(file_path) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 93 | suffix = os.path.splitext(file_path)[-1] |
| 94 | |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 95 | return file, file_path, (suffix, "rb", kind) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 96 | |
| 97 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 98 | class Module: |
| 99 | |
| 100 | def __init__(self, name, file=None, path=None): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 101 | self.__name__ = name |
| 102 | self.__file__ = file |
| 103 | self.__path__ = path |
| 104 | self.__code__ = None |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 105 | # The set of global names that are assigned to in the module. |
| 106 | # This includes those names imported through starimports of |
| 107 | # Python modules. |
| 108 | self.globalnames = {} |
| 109 | # The set of starimports this module did that could not be |
| 110 | # resolved, ie. a starimport from a non-Python module. |
| 111 | self.starimports = {} |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 112 | |
| 113 | def __repr__(self): |
Neil Schemenauer | 32d23c9 | 2004-02-15 16:43:20 +0000 | [diff] [blame] | 114 | s = "Module(%r" % (self.__name__,) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 115 | if self.__file__ is not None: |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 116 | s = s + ", %r" % (self.__file__,) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 117 | if self.__path__ is not None: |
Walter Dörwald | 70a6b49 | 2004-02-12 17:35:32 +0000 | [diff] [blame] | 118 | s = s + ", %r" % (self.__path__,) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 119 | s = s + ")" |
| 120 | return s |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 121 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 122 | class ModuleFinder: |
| 123 | |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 124 | def __init__(self, path=None, debug=0, excludes=None, replace_paths=None): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 125 | if path is None: |
| 126 | path = sys.path |
| 127 | self.path = path |
| 128 | self.modules = {} |
| 129 | self.badmodules = {} |
| 130 | self.debug = debug |
| 131 | self.indent = 0 |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 132 | self.excludes = excludes if excludes is not None else [] |
| 133 | self.replace_paths = replace_paths if replace_paths is not None else [] |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 134 | self.processed_paths = [] # Used in debugging only |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 135 | |
| 136 | def msg(self, level, str, *args): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 137 | if level <= self.debug: |
| 138 | for i in range(self.indent): |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 139 | print(" ", end=' ') |
| 140 | print(str, end=' ') |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 141 | for arg in args: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 142 | print(repr(arg), end=' ') |
| 143 | print() |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 144 | |
| 145 | def msgin(self, *args): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 146 | level = args[0] |
| 147 | if level <= self.debug: |
| 148 | self.indent = self.indent + 1 |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 149 | self.msg(*args) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 150 | |
| 151 | def msgout(self, *args): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 152 | level = args[0] |
| 153 | if level <= self.debug: |
| 154 | self.indent = self.indent - 1 |
Guido van Rossum | 68468eb | 2003-02-27 20:14:51 +0000 | [diff] [blame] | 155 | self.msg(*args) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 156 | |
| 157 | def run_script(self, pathname): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 158 | self.msg(2, "run_script", pathname) |
Barry | d42e582 | 2020-04-14 20:16:06 +0100 | [diff] [blame] | 159 | with io.open_code(pathname) as fp: |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 160 | stuff = ("", "rb", _PY_SOURCE) |
Brett Cannon | 028011f | 2010-10-30 00:26:48 +0000 | [diff] [blame] | 161 | self.load_module('__main__', fp, pathname, stuff) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 162 | |
| 163 | def load_file(self, pathname): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 164 | dir, name = os.path.split(pathname) |
| 165 | name, ext = os.path.splitext(name) |
Barry | d42e582 | 2020-04-14 20:16:06 +0100 | [diff] [blame] | 166 | with io.open_code(pathname) as fp: |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 167 | stuff = (ext, "rb", _PY_SOURCE) |
Brett Cannon | 028011f | 2010-10-30 00:26:48 +0000 | [diff] [blame] | 168 | self.load_module(name, fp, pathname, stuff) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 169 | |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 170 | def import_hook(self, name, caller=None, fromlist=None, level=-1): |
| 171 | self.msg(3, "import_hook", name, caller, fromlist, level) |
| 172 | parent = self.determine_parent(caller, level=level) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 173 | q, tail = self.find_head_package(parent, name) |
| 174 | m = self.load_tail(q, tail) |
| 175 | if not fromlist: |
| 176 | return q |
| 177 | if m.__path__: |
| 178 | self.ensure_fromlist(m, fromlist) |
Thomas Heller | 318b7b9 | 2002-11-26 08:06:50 +0000 | [diff] [blame] | 179 | return None |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 180 | |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 181 | def determine_parent(self, caller, level=-1): |
| 182 | self.msgin(4, "determine_parent", caller, level) |
| 183 | if not caller or level == 0: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 184 | self.msgout(4, "determine_parent -> None") |
| 185 | return None |
| 186 | pname = caller.__name__ |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 187 | if level >= 1: # relative import |
| 188 | if caller.__path__: |
| 189 | level -= 1 |
| 190 | if level == 0: |
| 191 | parent = self.modules[pname] |
| 192 | assert parent is caller |
| 193 | self.msgout(4, "determine_parent ->", parent) |
| 194 | return parent |
| 195 | if pname.count(".") < level: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 196 | raise ImportError("relative importpath too deep") |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 197 | pname = ".".join(pname.split(".")[:-level]) |
| 198 | parent = self.modules[pname] |
| 199 | self.msgout(4, "determine_parent ->", parent) |
| 200 | return parent |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 201 | if caller.__path__: |
| 202 | parent = self.modules[pname] |
| 203 | assert caller is parent |
| 204 | self.msgout(4, "determine_parent ->", parent) |
| 205 | return parent |
| 206 | if '.' in pname: |
Walter Dörwald | aaab30e | 2002-09-11 20:36:02 +0000 | [diff] [blame] | 207 | i = pname.rfind('.') |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 208 | pname = pname[:i] |
| 209 | parent = self.modules[pname] |
| 210 | assert parent.__name__ == pname |
| 211 | self.msgout(4, "determine_parent ->", parent) |
| 212 | return parent |
| 213 | self.msgout(4, "determine_parent -> None") |
| 214 | return None |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 215 | |
| 216 | def find_head_package(self, parent, name): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 217 | self.msgin(4, "find_head_package", parent, name) |
| 218 | if '.' in name: |
Walter Dörwald | aaab30e | 2002-09-11 20:36:02 +0000 | [diff] [blame] | 219 | i = name.find('.') |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 220 | head = name[:i] |
| 221 | tail = name[i+1:] |
| 222 | else: |
| 223 | head = name |
| 224 | tail = "" |
| 225 | if parent: |
| 226 | qname = "%s.%s" % (parent.__name__, head) |
| 227 | else: |
| 228 | qname = head |
| 229 | q = self.import_module(head, qname, parent) |
| 230 | if q: |
| 231 | self.msgout(4, "find_head_package ->", (q, tail)) |
| 232 | return q, tail |
| 233 | if parent: |
| 234 | qname = head |
| 235 | parent = None |
| 236 | q = self.import_module(head, qname, parent) |
| 237 | if q: |
| 238 | self.msgout(4, "find_head_package ->", (q, tail)) |
| 239 | return q, tail |
| 240 | self.msgout(4, "raise ImportError: No module named", qname) |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 241 | raise ImportError("No module named " + qname) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 242 | |
| 243 | def load_tail(self, q, tail): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 244 | self.msgin(4, "load_tail", q, tail) |
| 245 | m = q |
| 246 | while tail: |
Walter Dörwald | aaab30e | 2002-09-11 20:36:02 +0000 | [diff] [blame] | 247 | i = tail.find('.') |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 248 | if i < 0: i = len(tail) |
| 249 | head, tail = tail[:i], tail[i+1:] |
| 250 | mname = "%s.%s" % (m.__name__, head) |
| 251 | m = self.import_module(head, mname, m) |
| 252 | if not m: |
| 253 | self.msgout(4, "raise ImportError: No module named", mname) |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 254 | raise ImportError("No module named " + mname) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 255 | self.msgout(4, "load_tail ->", m) |
| 256 | return m |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 257 | |
| 258 | def ensure_fromlist(self, m, fromlist, recursive=0): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 259 | self.msg(4, "ensure_fromlist", m, fromlist, recursive) |
| 260 | for sub in fromlist: |
| 261 | if sub == "*": |
| 262 | if not recursive: |
| 263 | all = self.find_all_submodules(m) |
| 264 | if all: |
| 265 | self.ensure_fromlist(m, all, 1) |
| 266 | elif not hasattr(m, sub): |
| 267 | subname = "%s.%s" % (m.__name__, sub) |
| 268 | submod = self.import_module(sub, subname, m) |
| 269 | if not submod: |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 270 | raise ImportError("No module named " + subname) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 271 | |
| 272 | def find_all_submodules(self, m): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 273 | if not m.__path__: |
| 274 | return |
| 275 | modules = {} |
Brett Cannon | f299abd | 2015-04-13 14:21:02 -0400 | [diff] [blame] | 276 | # 'suffixes' used to be a list hardcoded to [".py", ".pyc"]. |
Thomas Heller | aaf1c8d | 2003-11-14 10:28:42 +0000 | [diff] [blame] | 277 | # But we must also collect Python extension modules - although |
| 278 | # we cannot separate normal dlls from Python extensions. |
| 279 | suffixes = [] |
Brett Cannon | cb66eb0 | 2012-05-11 12:58:42 -0400 | [diff] [blame] | 280 | suffixes += importlib.machinery.EXTENSION_SUFFIXES[:] |
| 281 | suffixes += importlib.machinery.SOURCE_SUFFIXES[:] |
| 282 | suffixes += importlib.machinery.BYTECODE_SUFFIXES[:] |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 283 | for dir in m.__path__: |
| 284 | try: |
| 285 | names = os.listdir(dir) |
Andrew Svetlov | ad28c7f | 2012-12-18 22:02:39 +0200 | [diff] [blame] | 286 | except OSError: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 287 | self.msg(2, "can't list directory", dir) |
| 288 | continue |
| 289 | for name in names: |
| 290 | mod = None |
| 291 | for suff in suffixes: |
| 292 | n = len(suff) |
| 293 | if name[-n:] == suff: |
| 294 | mod = name[:-n] |
| 295 | break |
| 296 | if mod and mod != "__init__": |
| 297 | modules[mod] = mod |
| 298 | return modules.keys() |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 299 | |
| 300 | def import_module(self, partname, fqname, parent): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 301 | self.msgin(3, "import_module", partname, fqname, parent) |
| 302 | try: |
| 303 | m = self.modules[fqname] |
| 304 | except KeyError: |
| 305 | pass |
| 306 | else: |
| 307 | self.msgout(3, "import_module ->", m) |
| 308 | return m |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 309 | if fqname in self.badmodules: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 310 | self.msgout(3, "import_module -> None") |
| 311 | return None |
Thomas Heller | 2e7c832 | 2004-05-11 15:10:59 +0000 | [diff] [blame] | 312 | if parent and parent.__path__ is None: |
| 313 | self.msgout(3, "import_module -> None") |
| 314 | return None |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 315 | try: |
| 316 | fp, pathname, stuff = self.find_module(partname, |
Just van Rossum | f0dfbaf | 2003-03-05 17:23:48 +0000 | [diff] [blame] | 317 | parent and parent.__path__, parent) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 318 | except ImportError: |
| 319 | self.msgout(3, "import_module ->", None) |
| 320 | return None |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 321 | |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 322 | try: |
| 323 | m = self.load_module(fqname, fp, pathname, stuff) |
| 324 | finally: |
Éric Araujo | 1e3a68d | 2011-07-28 23:35:29 +0200 | [diff] [blame] | 325 | if fp: |
| 326 | fp.close() |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 327 | if parent: |
| 328 | setattr(parent, partname, m) |
| 329 | self.msgout(3, "import_module ->", m) |
| 330 | return m |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 331 | |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 332 | def load_module(self, fqname, fp, pathname, file_info): |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 333 | suffix, mode, type = file_info |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 334 | self.msgin(2, "load_module", fqname, fp and "fp", pathname) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 335 | if type == _PKG_DIRECTORY: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 336 | m = self.load_package(fqname, pathname) |
| 337 | self.msgout(2, "load_module ->", m) |
| 338 | return m |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 339 | if type == _PY_SOURCE: |
Anthony Sottile | 39652cd | 2020-04-22 11:42:53 -0700 | [diff] [blame] | 340 | co = compile(fp.read(), pathname, 'exec') |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 341 | elif type == _PY_COMPILED: |
Brett Cannon | 0f38478 | 2014-02-28 10:50:34 -0500 | [diff] [blame] | 342 | try: |
Benjamin Peterson | 42aa93b | 2017-12-09 10:26:52 -0800 | [diff] [blame] | 343 | data = fp.read() |
| 344 | importlib._bootstrap_external._classify_pyc(data, fqname, {}) |
Brett Cannon | 0f38478 | 2014-02-28 10:50:34 -0500 | [diff] [blame] | 345 | except ImportError as exc: |
| 346 | self.msgout(2, "raise ImportError: " + str(exc), pathname) |
| 347 | raise |
Benjamin Peterson | 42aa93b | 2017-12-09 10:26:52 -0800 | [diff] [blame] | 348 | co = marshal.loads(memoryview(data)[16:]) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 349 | else: |
| 350 | co = None |
| 351 | m = self.add_module(fqname) |
Guido van Rossum | ab045f9 | 1998-03-06 19:55:10 +0000 | [diff] [blame] | 352 | m.__file__ = pathname |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 353 | if co: |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 354 | if self.replace_paths: |
| 355 | co = self.replace_paths_in_code(co) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 356 | m.__code__ = co |
Guido van Rossum | 3c51cf2 | 1998-03-05 05:15:07 +0000 | [diff] [blame] | 357 | self.scan_code(co, m) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 358 | self.msgout(2, "load_module ->", m) |
| 359 | return m |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 360 | |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 361 | def _add_badmodule(self, name, caller): |
| 362 | if name not in self.badmodules: |
| 363 | self.badmodules[name] = {} |
Benjamin Peterson | c0747cf | 2008-11-03 20:31:38 +0000 | [diff] [blame] | 364 | if caller: |
| 365 | self.badmodules[name][caller.__name__] = 1 |
| 366 | else: |
| 367 | self.badmodules[name]["-"] = 1 |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 368 | |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 369 | def _safe_import_hook(self, name, caller, fromlist, level=-1): |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 370 | # wrapper for self.import_hook() that won't raise ImportError |
| 371 | if name in self.badmodules: |
| 372 | self._add_badmodule(name, caller) |
| 373 | return |
| 374 | try: |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 375 | self.import_hook(name, caller, level=level) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 376 | except ImportError as msg: |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 377 | self.msg(2, "ImportError:", str(msg)) |
| 378 | self._add_badmodule(name, caller) |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 379 | except SyntaxError as msg: |
| 380 | self.msg(2, "SyntaxError:", str(msg)) |
| 381 | self._add_badmodule(name, caller) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 382 | else: |
| 383 | if fromlist: |
| 384 | for sub in fromlist: |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 385 | fullname = name + "." + sub |
| 386 | if fullname in self.badmodules: |
| 387 | self._add_badmodule(fullname, caller) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 388 | continue |
| 389 | try: |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 390 | self.import_hook(name, caller, [sub], level=level) |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 391 | except ImportError as msg: |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 392 | self.msg(2, "ImportError:", str(msg)) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 393 | self._add_badmodule(fullname, caller) |
| 394 | |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 395 | def scan_opcodes(self, co): |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 396 | # Scan the code, and yield 'interesting' opcode combinations |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 397 | code = co.co_code |
| 398 | names = co.co_names |
| 399 | consts = co.co_consts |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 400 | opargs = [(op, arg) for _, op, arg in dis._unpack_opargs(code) |
| 401 | if op != EXTENDED_ARG] |
| 402 | for i, (op, oparg) in enumerate(opargs): |
| 403 | if op in STORE_OPS: |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 404 | yield "store", (names[oparg],) |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 405 | continue |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 406 | if (op == IMPORT_NAME and i >= 2 |
| 407 | and opargs[i-1][0] == opargs[i-2][0] == LOAD_CONST): |
| 408 | level = consts[opargs[i-2][1]] |
| 409 | fromlist = consts[opargs[i-1][1]] |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 410 | if level == 0: # absolute import |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 411 | yield "absolute_import", (fromlist, names[oparg]) |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 412 | else: # relative import |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 413 | yield "relative_import", (level, fromlist, names[oparg]) |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 414 | continue |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 415 | |
Guido van Rossum | 3c51cf2 | 1998-03-05 05:15:07 +0000 | [diff] [blame] | 416 | def scan_code(self, co, m): |
| 417 | code = co.co_code |
Serhiy Storchaka | 02d9f5e | 2016-05-08 23:43:50 +0300 | [diff] [blame] | 418 | scanner = self.scan_opcodes |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 419 | for what, args in scanner(co): |
| 420 | if what == "store": |
| 421 | name, = args |
| 422 | m.globalnames[name] = 1 |
| 423 | elif what == "absolute_import": |
| 424 | fromlist, name = args |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 425 | have_star = 0 |
| 426 | if fromlist is not None: |
| 427 | if "*" in fromlist: |
| 428 | have_star = 1 |
| 429 | fromlist = [f for f in fromlist if f != "*"] |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 430 | self._safe_import_hook(name, m, fromlist, level=0) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 431 | if have_star: |
| 432 | # We've encountered an "import *". If it is a Python module, |
| 433 | # the code has already been parsed and we can suck out the |
| 434 | # global names. |
| 435 | mm = None |
| 436 | if m.__path__: |
| 437 | # At this point we don't know whether 'name' is a |
| 438 | # submodule of 'm' or a global module. Let's just try |
| 439 | # the full name first. |
| 440 | mm = self.modules.get(m.__name__ + "." + name) |
| 441 | if mm is None: |
| 442 | mm = self.modules.get(name) |
| 443 | if mm is not None: |
| 444 | m.globalnames.update(mm.globalnames) |
| 445 | m.starimports.update(mm.starimports) |
| 446 | if mm.__code__ is None: |
| 447 | m.starimports[name] = 1 |
| 448 | else: |
| 449 | m.starimports[name] = 1 |
Guido van Rossum | fc2a0a8 | 2006-10-27 23:06:01 +0000 | [diff] [blame] | 450 | elif what == "relative_import": |
| 451 | level, fromlist, name = args |
| 452 | if name: |
| 453 | self._safe_import_hook(name, m, fromlist, level=level) |
| 454 | else: |
| 455 | parent = self.determine_parent(m, level=level) |
| 456 | self._safe_import_hook(parent.__name__, None, fromlist, level=0) |
| 457 | else: |
| 458 | # We don't expect anything else from the generator. |
| 459 | raise RuntimeError(what) |
| 460 | |
Guido van Rossum | 3c51cf2 | 1998-03-05 05:15:07 +0000 | [diff] [blame] | 461 | for c in co.co_consts: |
| 462 | if isinstance(c, type(co)): |
| 463 | self.scan_code(c, m) |
| 464 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 465 | def load_package(self, fqname, pathname): |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 466 | self.msgin(2, "load_package", fqname, pathname) |
Thomas Heller | c7aaf95 | 2002-11-14 18:45:11 +0000 | [diff] [blame] | 467 | newname = replacePackageMap.get(fqname) |
| 468 | if newname: |
| 469 | fqname = newname |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 470 | m = self.add_module(fqname) |
| 471 | m.__file__ = pathname |
| 472 | m.__path__ = [pathname] |
Guido van Rossum | f1b5a0e | 1998-05-18 20:21:56 +0000 | [diff] [blame] | 473 | |
Guido van Rossum | e7e632a | 1998-09-14 16:02:28 +0000 | [diff] [blame] | 474 | # As per comment at top of file, simulate runtime __path__ additions. |
| 475 | m.__path__ = m.__path__ + packagePathMap.get(fqname, []) |
Guido van Rossum | f1b5a0e | 1998-05-18 20:21:56 +0000 | [diff] [blame] | 476 | |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 477 | fp, buf, stuff = self.find_module("__init__", m.__path__) |
Brett Cannon | 028011f | 2010-10-30 00:26:48 +0000 | [diff] [blame] | 478 | try: |
| 479 | self.load_module(fqname, fp, buf, stuff) |
| 480 | self.msgout(2, "load_package ->", m) |
| 481 | return m |
| 482 | finally: |
| 483 | if fp: |
| 484 | fp.close() |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 485 | |
| 486 | def add_module(self, fqname): |
Guido van Rossum | e2b70bc | 2006-08-18 22:13:04 +0000 | [diff] [blame] | 487 | if fqname in self.modules: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 488 | return self.modules[fqname] |
| 489 | self.modules[fqname] = m = Module(fqname) |
| 490 | return m |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 491 | |
Just van Rossum | f0dfbaf | 2003-03-05 17:23:48 +0000 | [diff] [blame] | 492 | def find_module(self, name, path, parent=None): |
| 493 | if parent is not None: |
Thomas Heller | 2e7c832 | 2004-05-11 15:10:59 +0000 | [diff] [blame] | 494 | # assert path is not None |
Just van Rossum | f0dfbaf | 2003-03-05 17:23:48 +0000 | [diff] [blame] | 495 | fullname = parent.__name__+'.'+name |
Guido van Rossum | 03f7f08 | 2001-10-18 19:15:32 +0000 | [diff] [blame] | 496 | else: |
| 497 | fullname = name |
| 498 | if fullname in self.excludes: |
| 499 | self.msgout(3, "find_module -> Excluded", fullname) |
Collin Winter | ce36ad8 | 2007-08-30 01:19:48 +0000 | [diff] [blame] | 500 | raise ImportError(name) |
Guido van Rossum | 78fc363 | 1998-03-20 17:37:24 +0000 | [diff] [blame] | 501 | |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 502 | if path is None: |
| 503 | if name in sys.builtin_module_names: |
Barry | 9b0b5d2 | 2020-04-20 15:58:42 +0100 | [diff] [blame] | 504 | return (None, None, ("", "", _C_BUILTIN)) |
Guido van Rossum | 78fc363 | 1998-03-20 17:37:24 +0000 | [diff] [blame] | 505 | |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 506 | path = self.path |
Brandt Bucher | 9d7b2c0 | 2019-04-07 01:00:41 -0700 | [diff] [blame] | 507 | |
| 508 | return _find_module(name, path) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 509 | |
| 510 | def report(self): |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 511 | """Print a report to stdout, listing the found modules with their |
| 512 | paths, as well as modules that are missing, or seem to be missing. |
| 513 | """ |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 514 | print() |
| 515 | print(" %-25s %s" % ("Name", "File")) |
| 516 | print(" %-25s %s" % ("----", "----")) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 517 | # Print modules found |
Guido van Rossum | d59cde8 | 2007-06-12 00:25:08 +0000 | [diff] [blame] | 518 | keys = sorted(self.modules.keys()) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 519 | for key in keys: |
| 520 | m = self.modules[key] |
| 521 | if m.__path__: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 522 | print("P", end=' ') |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 523 | else: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 524 | print("m", end=' ') |
| 525 | print("%-25s" % key, m.__file__ or "") |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 526 | |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 527 | # Print missing modules |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 528 | missing, maybe = self.any_missing_maybe() |
| 529 | if missing: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 530 | print() |
| 531 | print("Missing modules:") |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 532 | for name in missing: |
Guido van Rossum | d59cde8 | 2007-06-12 00:25:08 +0000 | [diff] [blame] | 533 | mods = sorted(self.badmodules[name].keys()) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 534 | print("?", name, "imported from", ', '.join(mods)) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 535 | # Print modules that may be missing, but then again, maybe not... |
| 536 | if maybe: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 537 | print() |
Ezio Melotti | 30b9d5d | 2013-08-17 15:50:46 +0300 | [diff] [blame] | 538 | print("Submodules that appear to be missing, but could also be", end=' ') |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 539 | print("global names in the parent package:") |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 540 | for name in maybe: |
Guido van Rossum | d59cde8 | 2007-06-12 00:25:08 +0000 | [diff] [blame] | 541 | mods = sorted(self.badmodules[name].keys()) |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 542 | print("?", name, "imported from", ', '.join(mods)) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 543 | |
Guido van Rossum | 03f7f08 | 2001-10-18 19:15:32 +0000 | [diff] [blame] | 544 | def any_missing(self): |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 545 | """Return a list of modules that appear to be missing. Use |
| 546 | any_missing_maybe() if you want to know which modules are |
| 547 | certain to be missing, and which *may* be missing. |
| 548 | """ |
| 549 | missing, maybe = self.any_missing_maybe() |
| 550 | return missing + maybe |
| 551 | |
| 552 | def any_missing_maybe(self): |
| 553 | """Return two lists, one with modules that are certainly missing |
| 554 | and one with modules that *may* be missing. The latter names could |
| 555 | either be submodules *or* just global names in the package. |
| 556 | |
| 557 | The reason it can't always be determined is that it's impossible to |
| 558 | tell which names are imported when "from module import *" is done |
| 559 | with an extension module, short of actually importing it. |
| 560 | """ |
Guido van Rossum | 03f7f08 | 2001-10-18 19:15:32 +0000 | [diff] [blame] | 561 | missing = [] |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 562 | maybe = [] |
| 563 | for name in self.badmodules: |
| 564 | if name in self.excludes: |
| 565 | continue |
| 566 | i = name.rfind(".") |
| 567 | if i < 0: |
| 568 | missing.append(name) |
| 569 | continue |
| 570 | subname = name[i+1:] |
| 571 | pkgname = name[:i] |
| 572 | pkg = self.modules.get(pkgname) |
| 573 | if pkg is not None: |
| 574 | if pkgname in self.badmodules[name]: |
| 575 | # The package tried to import this module itself and |
| 576 | # failed. It's definitely missing. |
| 577 | missing.append(name) |
| 578 | elif subname in pkg.globalnames: |
| 579 | # It's a global in the package: definitely not missing. |
| 580 | pass |
| 581 | elif pkg.starimports: |
| 582 | # It could be missing, but the package did an "import *" |
| 583 | # from a non-Python module, so we simply can't be sure. |
| 584 | maybe.append(name) |
| 585 | else: |
| 586 | # It's not a global in the package, the package didn't |
| 587 | # do funny star imports, it's very likely to be missing. |
| 588 | # The symbol could be inserted into the package from the |
| 589 | # outside, but since that's not good style we simply list |
| 590 | # it missing. |
| 591 | missing.append(name) |
| 592 | else: |
| 593 | missing.append(name) |
| 594 | missing.sort() |
| 595 | maybe.sort() |
| 596 | return missing, maybe |
Guido van Rossum | 03f7f08 | 2001-10-18 19:15:32 +0000 | [diff] [blame] | 597 | |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 598 | def replace_paths_in_code(self, co): |
| 599 | new_filename = original_filename = os.path.normpath(co.co_filename) |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 600 | for f, r in self.replace_paths: |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 601 | if original_filename.startswith(f): |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 602 | new_filename = r + original_filename[len(f):] |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 603 | break |
| 604 | |
| 605 | if self.debug and original_filename not in self.processed_paths: |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 606 | if new_filename != original_filename: |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 607 | self.msgout(2, "co_filename %r changed to %r" \ |
| 608 | % (original_filename,new_filename,)) |
| 609 | else: |
| 610 | self.msgout(2, "co_filename %r remains unchanged" \ |
| 611 | % (original_filename,)) |
| 612 | self.processed_paths.append(original_filename) |
| 613 | |
| 614 | consts = list(co.co_consts) |
| 615 | for i in range(len(consts)): |
| 616 | if isinstance(consts[i], type(co)): |
| 617 | consts[i] = self.replace_paths_in_code(consts[i]) |
| 618 | |
Victor Stinner | a9f05d6 | 2019-05-24 23:57:23 +0200 | [diff] [blame] | 619 | return co.replace(co_consts=tuple(consts), co_filename=new_filename) |
Guido van Rossum | 6b767ac | 2001-03-20 20:43:34 +0000 | [diff] [blame] | 620 | |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 621 | |
| 622 | def test(): |
| 623 | # Parse command line |
| 624 | import getopt |
| 625 | try: |
Guido van Rossum | baf0603 | 1998-08-25 14:06:55 +0000 | [diff] [blame] | 626 | opts, args = getopt.getopt(sys.argv[1:], "dmp:qx:") |
Guido van Rossum | b940e11 | 2007-01-10 16:19:56 +0000 | [diff] [blame] | 627 | except getopt.error as msg: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 628 | print(msg) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 629 | return |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 630 | |
| 631 | # Process options |
| 632 | debug = 1 |
| 633 | domods = 0 |
| 634 | addpath = [] |
Guido van Rossum | baf0603 | 1998-08-25 14:06:55 +0000 | [diff] [blame] | 635 | exclude = [] |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 636 | for o, a in opts: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 637 | if o == '-d': |
| 638 | debug = debug + 1 |
| 639 | if o == '-m': |
| 640 | domods = 1 |
| 641 | if o == '-p': |
Walter Dörwald | aaab30e | 2002-09-11 20:36:02 +0000 | [diff] [blame] | 642 | addpath = addpath + a.split(os.pathsep) |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 643 | if o == '-q': |
| 644 | debug = 0 |
Guido van Rossum | baf0603 | 1998-08-25 14:06:55 +0000 | [diff] [blame] | 645 | if o == '-x': |
| 646 | exclude.append(a) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 647 | |
| 648 | # Provide default arguments |
| 649 | if not args: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 650 | script = "hello.py" |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 651 | else: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 652 | script = args[0] |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 653 | |
| 654 | # Set the path based on sys.path and the script directory |
| 655 | path = sys.path[:] |
| 656 | path[0] = os.path.dirname(script) |
| 657 | path = addpath + path |
| 658 | if debug > 1: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 659 | print("path:") |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 660 | for item in path: |
Guido van Rossum | be19ed7 | 2007-02-09 05:37:30 +0000 | [diff] [blame] | 661 | print(" ", repr(item)) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 662 | |
| 663 | # Create the module finder and turn its crank |
Guido van Rossum | baf0603 | 1998-08-25 14:06:55 +0000 | [diff] [blame] | 664 | mf = ModuleFinder(path, debug, exclude) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 665 | for arg in args[1:]: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 666 | if arg == '-m': |
| 667 | domods = 1 |
| 668 | continue |
| 669 | if domods: |
| 670 | if arg[-2:] == '.*': |
| 671 | mf.import_hook(arg[:-2], None, ["*"]) |
| 672 | else: |
| 673 | mf.import_hook(arg) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 674 | else: |
Guido van Rossum | 912a14c | 1998-03-05 04:56:37 +0000 | [diff] [blame] | 675 | mf.load_file(arg) |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 676 | mf.run_script(script) |
| 677 | mf.report() |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 678 | return mf # for -i debugging |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 679 | |
| 680 | |
| 681 | if __name__ == '__main__': |
| 682 | try: |
Just van Rossum | e29310a | 2002-12-31 16:33:00 +0000 | [diff] [blame] | 683 | mf = test() |
Guido van Rossum | 75dc496 | 1998-03-05 03:42:00 +0000 | [diff] [blame] | 684 | except KeyboardInterrupt: |
Éric Araujo | 1e3a68d | 2011-07-28 23:35:29 +0200 | [diff] [blame] | 685 | print("\n[interrupted]") |