py_compile.py 2.62 KB
Newer Older
Guido van Rossum's avatar
Guido van Rossum committed
1 2 3 4
"""Routine to "compile" a .py file to a .pyc (or .pyo) file.

This module has intimate knowledge of the format of .pyc files.
"""
5

6 7
import imp
MAGIC = imp.get_magic()
8 9

def wr_long(f, x):
Guido van Rossum's avatar
Guido van Rossum committed
10 11 12 13 14 15 16 17 18 19 20 21 22
    "Internal; write a 32-bit int to a file in little-endian order."
    f.write(chr( x        & 0xff))
    f.write(chr((x >> 8)  & 0xff))
    f.write(chr((x >> 16) & 0xff))
    f.write(chr((x >> 24) & 0xff))

def compile(file, cfile=None, dfile=None):
    """Byte-compile one Python source file to Python bytecode.

    Arguments:

    file:  source filename
    cfile: target filename; defaults to source with 'c' or 'o' appended
23
           ('c' normally, 'o' in optimizing mode, giving .pyc or .pyo)
Guido van Rossum's avatar
Guido van Rossum committed
24
    dfile: purported filename; defaults to source (this is the filename
25
           that will show up in error messages)
Guido van Rossum's avatar
Guido van Rossum committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46

    Note that it isn't necessary to byte-compile Python modules for
    execution efficiency -- Python itself byte-compiles a module when
    it is loaded, and if it can, writes out the bytecode to the
    corresponding .pyc (or .pyo) file.

    However, if a Python installation is shared between users, it is a
    good idea to byte-compile all modules upon installation, since
    other users may not be able to write in the source directories,
    and thus they won't be able to write the .pyc/.pyo file, and then
    they would be byte-compiling every module each time it is loaded.
    This can slow down program start-up considerably.

    See compileall.py for a script/module that uses this module to
    byte-compile all installed files (or all files in selected
    directories).

    """
    import os, marshal, __builtin__
    f = open(file)
    try:
47
        timestamp = long(os.fstat(f.fileno())[8])
Guido van Rossum's avatar
Guido van Rossum committed
48
    except AttributeError:
49
        timestamp = long(os.stat(file)[8])
Guido van Rossum's avatar
Guido van Rossum committed
50 51 52
    codestring = f.read()
    f.close()
    if codestring and codestring[-1] != '\n':
53
        codestring = codestring + '\n'
54 55 56 57 58 59 60 61 62
    try:
        codeobject = __builtin__.compile(codestring, dfile or file, 'exec')
    except SyntaxError, detail:
        import traceback, sys, string
        lines = traceback.format_exception_only(SyntaxError, detail)
        for line in lines:
            sys.stderr.write(string.replace(line, 'File "<string>"',
                                            'File "%s"' % (dfile or file)))
        return
Guido van Rossum's avatar
Guido van Rossum committed
63
    if not cfile:
64
        cfile = file + (__debug__ and 'c' or 'o')
Guido van Rossum's avatar
Guido van Rossum committed
65 66 67 68 69 70 71 72 73
    fc = open(cfile, 'wb')
    fc.write('\0\0\0\0')
    wr_long(fc, timestamp)
    marshal.dump(codeobject, fc)
    fc.flush()
    fc.seek(0, 0)
    fc.write(MAGIC)
    fc.close()
    if os.name == 'mac':
74 75
        import macfs
        macfs.FSSpec(cfile).SetCreatorType('Pyth', 'PYC ')