modulefinder.py 23.4 KB
Newer Older
1
"""Find modules used by a script, using introspection."""
2

3
from __future__ import generators
4 5 6 7 8
import dis
import imp
import marshal
import os
import sys
9
import types
10
import struct
11

12
READ_MODE = "rU"
13

14
# XXX Clean up once str8's cstor matches bytes.
15 16 17 18
LOAD_CONST = bytes([dis.opname.index('LOAD_CONST')])
IMPORT_NAME = bytes([dis.opname.index('IMPORT_NAME')])
STORE_NAME = bytes([dis.opname.index('STORE_NAME')])
STORE_GLOBAL = bytes([dis.opname.index('STORE_GLOBAL')])
19
STORE_OPS = [STORE_NAME, STORE_GLOBAL]
20
HAVE_ARGUMENT = bytes([dis.HAVE_ARGUMENT])
21

22 23 24
# Modulefinder does a good job at simulating Python's, but it can not
# handle __path__ modifications packages make at runtime.  Therefore there
# is a mechanism whereby you can register extra paths in this map for a
25
# package, and it will be honored.
26 27 28 29 30 31

# Note this is a mapping is lists of paths.
packagePathMap = {}

# A Public interface
def AddPackagePath(packagename, path):
Guido van Rossum's avatar
Guido van Rossum committed
32 33 34
    paths = packagePathMap.get(packagename, [])
    paths.append(path)
    packagePathMap[packagename] = paths
35

36 37 38 39 40 41 42 43 44 45 46
replacePackageMap = {}

# This ReplacePackage mechanism allows modulefinder to work around the
# way the _xmlplus package injects itself under the name "xml" into
# sys.modules at runtime by calling ReplacePackage("_xmlplus", "xml")
# before running ModuleFinder.

def ReplacePackage(oldname, newname):
    replacePackageMap[oldname] = newname


47 48 49
class Module:

    def __init__(self, name, file=None, path=None):
50 51 52 53
        self.__name__ = name
        self.__file__ = file
        self.__path__ = path
        self.__code__ = None
54 55 56 57 58 59 60
        # The set of global names that are assigned to in the module.
        # This includes those names imported through starimports of
        # Python modules.
        self.globalnames = {}
        # The set of starimports this module did that could not be
        # resolved, ie. a starimport from a non-Python module.
        self.starimports = {}
61 62

    def __repr__(self):
Neil Schemenauer's avatar
Neil Schemenauer committed
63
        s = "Module(%r" % (self.__name__,)
64
        if self.__file__ is not None:
65
            s = s + ", %r" % (self.__file__,)
66
        if self.__path__ is not None:
67
            s = s + ", %r" % (self.__path__,)
68 69
        s = s + ")"
        return s
70 71 72

class ModuleFinder:

73
    def __init__(self, path=None, debug=0, excludes=[], replace_paths=[]):
74 75 76 77 78 79 80
        if path is None:
            path = sys.path
        self.path = path
        self.modules = {}
        self.badmodules = {}
        self.debug = debug
        self.indent = 0
81
        self.excludes = excludes
82 83
        self.replace_paths = replace_paths
        self.processed_paths = []   # Used in debugging only
84 85

    def msg(self, level, str, *args):
86 87
        if level <= self.debug:
            for i in range(self.indent):
88 89
                print("   ", end=' ')
            print(str, end=' ')
90
            for arg in args:
91 92
                print(repr(arg), end=' ')
            print()
93 94

    def msgin(self, *args):
95 96 97
        level = args[0]
        if level <= self.debug:
            self.indent = self.indent + 1
98
            self.msg(*args)
99 100

    def msgout(self, *args):
101 102 103
        level = args[0]
        if level <= self.debug:
            self.indent = self.indent - 1
104
            self.msg(*args)
105 106

    def run_script(self, pathname):
107
        self.msg(2, "run_script", pathname)
108
        fp = open(pathname, READ_MODE)
109 110
        stuff = ("", "r", imp.PY_SOURCE)
        self.load_module('__main__', fp, pathname, stuff)
111 112

    def load_file(self, pathname):
113 114
        dir, name = os.path.split(pathname)
        name, ext = os.path.splitext(name)
115
        fp = open(pathname, READ_MODE)
116 117
        stuff = (ext, "r", imp.PY_SOURCE)
        self.load_module(name, fp, pathname, stuff)
118

119 120 121
    def import_hook(self, name, caller=None, fromlist=None, level=-1):
        self.msg(3, "import_hook", name, caller, fromlist, level)
        parent = self.determine_parent(caller, level=level)
122 123 124 125 126 127
        q, tail = self.find_head_package(parent, name)
        m = self.load_tail(q, tail)
        if not fromlist:
            return q
        if m.__path__:
            self.ensure_fromlist(m, fromlist)
128
        return None
129

130 131 132
    def determine_parent(self, caller, level=-1):
        self.msgin(4, "determine_parent", caller, level)
        if not caller or level == 0:
133 134 135
            self.msgout(4, "determine_parent -> None")
            return None
        pname = caller.__name__
136 137 138 139 140 141 142 143 144
        if level >= 1: # relative import
            if caller.__path__:
                level -= 1
            if level == 0:
                parent = self.modules[pname]
                assert parent is caller
                self.msgout(4, "determine_parent ->", parent)
                return parent
            if pname.count(".") < level:
145
                raise ImportError("relative importpath too deep")
146 147 148 149
            pname = ".".join(pname.split(".")[:-level])
            parent = self.modules[pname]
            self.msgout(4, "determine_parent ->", parent)
            return parent
150 151 152 153 154 155
        if caller.__path__:
            parent = self.modules[pname]
            assert caller is parent
            self.msgout(4, "determine_parent ->", parent)
            return parent
        if '.' in pname:
156
            i = pname.rfind('.')
157 158 159 160 161 162 163
            pname = pname[:i]
            parent = self.modules[pname]
            assert parent.__name__ == pname
            self.msgout(4, "determine_parent ->", parent)
            return parent
        self.msgout(4, "determine_parent -> None")
        return None
164 165

    def find_head_package(self, parent, name):
166 167
        self.msgin(4, "find_head_package", parent, name)
        if '.' in name:
168
            i = name.find('.')
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
            head = name[:i]
            tail = name[i+1:]
        else:
            head = name
            tail = ""
        if parent:
            qname = "%s.%s" % (parent.__name__, head)
        else:
            qname = head
        q = self.import_module(head, qname, parent)
        if q:
            self.msgout(4, "find_head_package ->", (q, tail))
            return q, tail
        if parent:
            qname = head
            parent = None
            q = self.import_module(head, qname, parent)
            if q:
                self.msgout(4, "find_head_package ->", (q, tail))
                return q, tail
        self.msgout(4, "raise ImportError: No module named", qname)
190
        raise ImportError("No module named " + qname)
191 192

    def load_tail(self, q, tail):
193 194 195
        self.msgin(4, "load_tail", q, tail)
        m = q
        while tail:
196
            i = tail.find('.')
197 198 199 200 201 202
            if i < 0: i = len(tail)
            head, tail = tail[:i], tail[i+1:]
            mname = "%s.%s" % (m.__name__, head)
            m = self.import_module(head, mname, m)
            if not m:
                self.msgout(4, "raise ImportError: No module named", mname)
203
                raise ImportError("No module named " + mname)
204 205
        self.msgout(4, "load_tail ->", m)
        return m
206 207

    def ensure_fromlist(self, m, fromlist, recursive=0):
208 209 210 211 212 213 214 215 216 217 218
        self.msg(4, "ensure_fromlist", m, fromlist, recursive)
        for sub in fromlist:
            if sub == "*":
                if not recursive:
                    all = self.find_all_submodules(m)
                    if all:
                        self.ensure_fromlist(m, all, 1)
            elif not hasattr(m, sub):
                subname = "%s.%s" % (m.__name__, sub)
                submod = self.import_module(sub, subname, m)
                if not submod:
219
                    raise ImportError("No module named " + subname)
220 221

    def find_all_submodules(self, m):
222 223 224
        if not m.__path__:
            return
        modules = {}
225 226 227 228 229 230
        # 'suffixes' used to be a list hardcoded to [".py", ".pyc", ".pyo"].
        # But we must also collect Python extension modules - although
        # we cannot separate normal dlls from Python extensions.
        suffixes = []
        for triple in imp.get_suffixes():
            suffixes.append(triple[0])
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
        for dir in m.__path__:
            try:
                names = os.listdir(dir)
            except os.error:
                self.msg(2, "can't list directory", dir)
                continue
            for name in names:
                mod = None
                for suff in suffixes:
                    n = len(suff)
                    if name[-n:] == suff:
                        mod = name[:-n]
                        break
                if mod and mod != "__init__":
                    modules[mod] = mod
        return modules.keys()
247 248

    def import_module(self, partname, fqname, parent):
249 250 251 252 253 254 255 256
        self.msgin(3, "import_module", partname, fqname, parent)
        try:
            m = self.modules[fqname]
        except KeyError:
            pass
        else:
            self.msgout(3, "import_module ->", m)
            return m
257
        if fqname in self.badmodules:
258 259
            self.msgout(3, "import_module -> None")
            return None
260 261 262
        if parent and parent.__path__ is None:
            self.msgout(3, "import_module -> None")
            return None
263 264
        try:
            fp, pathname, stuff = self.find_module(partname,
265
                                                   parent and parent.__path__, parent)
266 267 268 269 270 271 272 273 274 275 276
        except ImportError:
            self.msgout(3, "import_module ->", None)
            return None
        try:
            m = self.load_module(fqname, fp, pathname, stuff)
        finally:
            if fp: fp.close()
        if parent:
            setattr(parent, partname, m)
        self.msgout(3, "import_module ->", m)
        return m
277

278 279
    def load_module(self, fqname, fp, pathname, file_info):
        suffix, mode, type = file_info
280 281 282 283 284 285
        self.msgin(2, "load_module", fqname, fp and "fp", pathname)
        if type == imp.PKG_DIRECTORY:
            m = self.load_package(fqname, pathname)
            self.msgout(2, "load_module ->", m)
            return m
        if type == imp.PY_SOURCE:
286
            co = compile(fp.read()+'\n', pathname, 'exec')
287 288 289
        elif type == imp.PY_COMPILED:
            if fp.read(4) != imp.get_magic():
                self.msgout(2, "raise ImportError: Bad magic number", pathname)
290
                raise ImportError("Bad magic number in %s" % pathname)
291 292 293 294 295
            fp.read(4)
            co = marshal.load(fp)
        else:
            co = None
        m = self.add_module(fqname)
296
        m.__file__ = pathname
297
        if co:
298 299
            if self.replace_paths:
                co = self.replace_paths_in_code(co)
300
            m.__code__ = co
301
            self.scan_code(co, m)
302 303
        self.msgout(2, "load_module ->", m)
        return m
304

305 306 307
    def _add_badmodule(self, name, caller):
        if name not in self.badmodules:
            self.badmodules[name] = {}
308 309 310 311
        if caller:
            self.badmodules[name][caller.__name__] = 1
        else:
            self.badmodules[name]["-"] = 1
312

313
    def _safe_import_hook(self, name, caller, fromlist, level=-1):
314 315 316 317 318
        # wrapper for self.import_hook() that won't raise ImportError
        if name in self.badmodules:
            self._add_badmodule(name, caller)
            return
        try:
319
            self.import_hook(name, caller, level=level)
320
        except ImportError as msg:
321 322 323 324 325 326 327 328 329
            self.msg(2, "ImportError:", str(msg))
            self._add_badmodule(name, caller)
        else:
            if fromlist:
                for sub in fromlist:
                    if sub in self.badmodules:
                        self._add_badmodule(sub, caller)
                        continue
                    try:
330
                        self.import_hook(name, caller, [sub], level=level)
331
                    except ImportError as msg:
332 333 334 335
                        self.msg(2, "ImportError:", str(msg))
                        fullname = name + "." + sub
                        self._add_badmodule(fullname, caller)

336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368
    def scan_opcodes(self, co,
                     unpack = struct.unpack):
        # Scan the code, and yield 'interesting' opcode combinations
        # Version for Python 2.4 and older
        code = co.co_code
        names = co.co_names
        consts = co.co_consts
        while code:
            c = code[0]
            if c in STORE_OPS:
                oparg, = unpack('<H', code[1:3])
                yield "store", (names[oparg],)
                code = code[3:]
                continue
            if c == LOAD_CONST and code[3] == IMPORT_NAME:
                oparg_1, oparg_2 = unpack('<xHxH', code[:6])
                yield "import", (consts[oparg_1], names[oparg_2])
                code = code[6:]
                continue
            if c >= HAVE_ARGUMENT:
                code = code[3:]
            else:
                code = code[1:]

    def scan_opcodes_25(self, co,
                     unpack = struct.unpack):
        # Scan the code, and yield 'interesting' opcode combinations
        # Python 2.5 version (has absolute and relative imports)
        code = co.co_code
        names = co.co_names
        consts = co.co_consts
        LOAD_LOAD_AND_IMPORT = LOAD_CONST + LOAD_CONST + IMPORT_NAME
        while code:
369
            c = bytes([code[0]])
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
            if c in STORE_OPS:
                oparg, = unpack('<H', code[1:3])
                yield "store", (names[oparg],)
                code = code[3:]
                continue
            if code[:9:3] == LOAD_LOAD_AND_IMPORT:
                oparg_1, oparg_2, oparg_3 = unpack('<xHxHxH', code[:9])
                level = consts[oparg_1]
                if level == 0: # absolute import
                    yield "absolute_import", (consts[oparg_2], names[oparg_3])
                else: # relative import
                    yield "relative_import", (level, consts[oparg_2], names[oparg_3])
                code = code[9:]
                continue
            if c >= HAVE_ARGUMENT:
                code = code[3:]
            else:
                code = code[1:]

389 390
    def scan_code(self, co, m):
        code = co.co_code
391 392 393 394 395 396 397 398 399 400
        if sys.version_info >= (2, 5):
            scanner = self.scan_opcodes_25
        else:
            scanner = self.scan_opcodes
        for what, args in scanner(co):
            if what == "store":
                name, = args
                m.globalnames[name] = 1
            elif what == "absolute_import":
                fromlist, name = args
401 402 403 404 405
                have_star = 0
                if fromlist is not None:
                    if "*" in fromlist:
                        have_star = 1
                    fromlist = [f for f in fromlist if f != "*"]
406
                self._safe_import_hook(name, m, fromlist, level=0)
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
                if have_star:
                    # We've encountered an "import *". If it is a Python module,
                    # the code has already been parsed and we can suck out the
                    # global names.
                    mm = None
                    if m.__path__:
                        # At this point we don't know whether 'name' is a
                        # submodule of 'm' or a global module. Let's just try
                        # the full name first.
                        mm = self.modules.get(m.__name__ + "." + name)
                    if mm is None:
                        mm = self.modules.get(name)
                    if mm is not None:
                        m.globalnames.update(mm.globalnames)
                        m.starimports.update(mm.starimports)
                        if mm.__code__ is None:
                            m.starimports[name] = 1
                    else:
                        m.starimports[name] = 1
426 427 428 429 430 431 432 433 434 435 436
            elif what == "relative_import":
                level, fromlist, name = args
                if name:
                    self._safe_import_hook(name, m, fromlist, level=level)
                else:
                    parent = self.determine_parent(m, level=level)
                    self._safe_import_hook(parent.__name__, None, fromlist, level=0)
            else:
                # We don't expect anything else from the generator.
                raise RuntimeError(what)

437 438 439 440
        for c in co.co_consts:
            if isinstance(c, type(co)):
                self.scan_code(c, m)

441
    def load_package(self, fqname, pathname):
442
        self.msgin(2, "load_package", fqname, pathname)
443 444 445
        newname = replacePackageMap.get(fqname)
        if newname:
            fqname = newname
446 447 448
        m = self.add_module(fqname)
        m.__file__ = pathname
        m.__path__ = [pathname]
449

Guido van Rossum's avatar
Guido van Rossum committed
450 451
        # As per comment at top of file, simulate runtime __path__ additions.
        m.__path__ = m.__path__ + packagePathMap.get(fqname, [])
452

453 454 455 456
        fp, buf, stuff = self.find_module("__init__", m.__path__)
        self.load_module(fqname, fp, buf, stuff)
        self.msgout(2, "load_package ->", m)
        return m
457 458

    def add_module(self, fqname):
459
        if fqname in self.modules:
460 461 462
            return self.modules[fqname]
        self.modules[fqname] = m = Module(fqname)
        return m
463

464 465
    def find_module(self, name, path, parent=None):
        if parent is not None:
466
            # assert path is not None
467
            fullname = parent.__name__+'.'+name
468 469 470 471
        else:
            fullname = name
        if fullname in self.excludes:
            self.msgout(3, "find_module -> Excluded", fullname)
472
            raise ImportError(name)
473

474 475 476
        if path is None:
            if name in sys.builtin_module_names:
                return (None, None, ("", "", imp.C_BUILTIN))
477

478 479
            path = self.path
        return imp.find_module(name, path)
480 481

    def report(self):
482 483 484
        """Print a report to stdout, listing the found modules with their
        paths, as well as modules that are missing, or seem to be missing.
        """
485 486 487
        print()
        print("  %-25s %s" % ("Name", "File"))
        print("  %-25s %s" % ("----", "----"))
488
        # Print modules found
489
        keys = sorted(self.modules.keys())
490 491 492
        for key in keys:
            m = self.modules[key]
            if m.__path__:
493
                print("P", end=' ')
494
            else:
495 496
                print("m", end=' ')
            print("%-25s" % key, m.__file__ or "")
497 498

        # Print missing modules
499 500
        missing, maybe = self.any_missing_maybe()
        if missing:
501 502
            print()
            print("Missing modules:")
503
            for name in missing:
504
                mods = sorted(self.badmodules[name].keys())
505
                print("?", name, "imported from", ', '.join(mods))
506 507
        # Print modules that may be missing, but then again, maybe not...
        if maybe:
508 509 510
            print()
            print("Submodules thay appear to be missing, but could also be", end=' ')
            print("global names in the parent package:")
511
            for name in maybe:
512
                mods = sorted(self.badmodules[name].keys())
513
                print("?", name, "imported from", ', '.join(mods))
514

515
    def any_missing(self):
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
        """Return a list of modules that appear to be missing. Use
        any_missing_maybe() if you want to know which modules are
        certain to be missing, and which *may* be missing.
        """
        missing, maybe = self.any_missing_maybe()
        return missing + maybe

    def any_missing_maybe(self):
        """Return two lists, one with modules that are certainly missing
        and one with modules that *may* be missing. The latter names could
        either be submodules *or* just global names in the package.

        The reason it can't always be determined is that it's impossible to
        tell which names are imported when "from module import *" is done
        with an extension module, short of actually importing it.
        """
532
        missing = []
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
        maybe = []
        for name in self.badmodules:
            if name in self.excludes:
                continue
            i = name.rfind(".")
            if i < 0:
                missing.append(name)
                continue
            subname = name[i+1:]
            pkgname = name[:i]
            pkg = self.modules.get(pkgname)
            if pkg is not None:
                if pkgname in self.badmodules[name]:
                    # The package tried to import this module itself and
                    # failed. It's definitely missing.
                    missing.append(name)
                elif subname in pkg.globalnames:
                    # It's a global in the package: definitely not missing.
                    pass
                elif pkg.starimports:
                    # It could be missing, but the package did an "import *"
                    # from a non-Python module, so we simply can't be sure.
                    maybe.append(name)
                else:
                    # It's not a global in the package, the package didn't
                    # do funny star imports, it's very likely to be missing.
                    # The symbol could be inserted into the package from the
                    # outside, but since that's not good style we simply list
                    # it missing.
                    missing.append(name)
            else:
                missing.append(name)
        missing.sort()
        maybe.sort()
        return missing, maybe
568

569 570
    def replace_paths_in_code(self, co):
        new_filename = original_filename = os.path.normpath(co.co_filename)
571
        for f, r in self.replace_paths:
572
            if original_filename.startswith(f):
573
                new_filename = r + original_filename[len(f):]
574 575 576
                break

        if self.debug and original_filename not in self.processed_paths:
577
            if new_filename != original_filename:
578 579 580 581 582 583 584 585 586 587 588 589
                self.msgout(2, "co_filename %r changed to %r" \
                                    % (original_filename,new_filename,))
            else:
                self.msgout(2, "co_filename %r remains unchanged" \
                                    % (original_filename,))
            self.processed_paths.append(original_filename)

        consts = list(co.co_consts)
        for i in range(len(consts)):
            if isinstance(consts[i], type(co)):
                consts[i] = self.replace_paths_in_code(consts[i])

590
        return types.CodeType(co.co_argcount, co.co_nlocals, co.co_stacksize,
Tim Peters's avatar
Tim Peters committed
591 592
                         co.co_flags, co.co_code, tuple(consts), co.co_names,
                         co.co_varnames, new_filename, co.co_name,
593 594
                         co.co_firstlineno, co.co_lnotab,
                         co.co_freevars, co.co_cellvars)
595

596 597 598 599 600

def test():
    # Parse command line
    import getopt
    try:
601
        opts, args = getopt.getopt(sys.argv[1:], "dmp:qx:")
602
    except getopt.error as msg:
603
        print(msg)
604
        return
605 606 607 608 609

    # Process options
    debug = 1
    domods = 0
    addpath = []
610
    exclude = []
611
    for o, a in opts:
612 613 614 615 616
        if o == '-d':
            debug = debug + 1
        if o == '-m':
            domods = 1
        if o == '-p':
617
            addpath = addpath + a.split(os.pathsep)
618 619
        if o == '-q':
            debug = 0
620 621
        if o == '-x':
            exclude.append(a)
622 623 624

    # Provide default arguments
    if not args:
625
        script = "hello.py"
626
    else:
627
        script = args[0]
628 629 630 631 632 633

    # Set the path based on sys.path and the script directory
    path = sys.path[:]
    path[0] = os.path.dirname(script)
    path = addpath + path
    if debug > 1:
634
        print("path:")
635
        for item in path:
636
            print("   ", repr(item))
637 638

    # Create the module finder and turn its crank
639
    mf = ModuleFinder(path, debug, exclude)
640
    for arg in args[1:]:
641 642 643 644 645 646 647 648
        if arg == '-m':
            domods = 1
            continue
        if domods:
            if arg[-2:] == '.*':
                mf.import_hook(arg[:-2], None, ["*"])
            else:
                mf.import_hook(arg)
649
        else:
650
            mf.load_file(arg)
651 652
    mf.run_script(script)
    mf.report()
653
    return mf  # for -i debugging
654 655 656 657


if __name__ == '__main__':
    try:
658
        mf = test()
659
    except KeyboardInterrupt:
660
        print("\n[interrupt]")