code.py 9.79 KB
Newer Older
1
"""Utilities needed to emulate Python's interactive interpreter.
2 3

"""
4

5 6
# Inspired by similar code by Jeff Epler and Fredrik Lundh.

7

8 9
import sys
import traceback
10
from codeop import CommandCompiler, compile_command
11

12
__all__ = ["InteractiveInterpreter", "InteractiveConsole", "interact",
13 14
           "compile_command"]

15 16 17 18 19 20
class InteractiveInterpreter:
    """Base class for InteractiveConsole.

    This class deals with parsing and interpreter state (the user's
    namespace); it doesn't deal with input buffering or prompting or
    input file naming (the filename is always passed in explicitly).
21 22 23

    """

24
    def __init__(self, locals=None):
25 26
        """Constructor.

27 28 29 30
        The optional 'locals' argument specifies the dictionary in
        which code will be executed; it defaults to a newly created
        dictionary with key "__name__" set to "__console__" and key
        "__doc__" set to None.
31 32 33

        """
        if locals is None:
34
            locals = {"__name__": "__console__", "__doc__": None}
35
        self.locals = locals
36
        self.compile = CommandCompiler()
37

38 39
    def runsource(self, source, filename="<input>", symbol="single"):
        """Compile and run some source in the interpreter.
40

41
        Arguments are as for compile_command().
42

43
        One several things can happen:
44

45 46 47
        1) The input is incorrect; compile_command() raised an
        exception (SyntaxError or OverflowError).  A syntax traceback
        will be printed by calling the showsyntaxerror() method.
48 49

        2) The input is incomplete, and more input is required;
50
        compile_command() returned None.  Nothing happens.
51 52

        3) The input is complete; compile_command() returned a code
53 54
        object.  The code is executed by calling self.runcode() (which
        also handles run-time exceptions, except for SystemExit).
55

56
        The return value is True in case 2, False in the other cases (unless
57 58 59
        an exception is raised).  The return value can be used to
        decide whether to use sys.ps1 or sys.ps2 to prompt the next
        line.
60 61 62

        """
        try:
63
            code = self.compile(source, filename, symbol)
64
        except (OverflowError, SyntaxError, ValueError):
65
            # Case 1
66
            self.showsyntaxerror(filename)
67
            return False
68

69
        if code is None:
70
            # Case 2
71
            return True
72 73

        # Case 3
74
        self.runcode(code)
75
        return False
76 77 78 79 80 81 82 83 84 85 86 87 88

    def runcode(self, code):
        """Execute a code object.

        When an exception occurs, self.showtraceback() is called to
        display a traceback.  All exceptions are caught except
        SystemExit, which is reraised.

        A note about KeyboardInterrupt: this exception may occur
        elsewhere in this code, and may not always be caught.  The
        caller should be prepared to deal with it.

        """
89
        try:
90
            exec(code, self.locals)
91 92 93 94 95
        except SystemExit:
            raise
        except:
            self.showtraceback()

96
    def showsyntaxerror(self, filename=None):
97 98 99 100
        """Display the syntax error that just occurred.

        This doesn't display a stack trace because there isn't one.

101 102 103 104
        If a filename is given, it is stuffed in the exception instead
        of what was there before (because Python's parser always uses
        "<string>" when reading from a string).

105 106 107
        The output is written by self.write(), below.

        """
108
        type, value, tb = sys.exc_info()
109 110
        sys.last_type = type
        sys.last_value = value
111
        sys.last_traceback = tb
112 113
        if filename and type is SyntaxError:
            # Work hard to stuff the correct filename in the exception
114
            try:
115 116
                msg, (dummy_filename, lineno, offset, line) = value.args
            except ValueError:
117 118 119 120
                # Not the format we expect; leave it alone
                pass
            else:
                # Stuff in the right filename
121
                value = SyntaxError(msg, (filename, lineno, offset, line))
122
                sys.last_value = value
123 124 125 126 127 128 129
        if sys.excepthook is sys.__excepthook__:
            lines = traceback.format_exception_only(type, value)
            self.write(''.join(lines))
        else:
            # If someone has set sys.excepthook, we let that take precedence
            # over self.write
            sys.excepthook(type, value, tb)
130 131 132 133 134 135 136 137 138 139 140

    def showtraceback(self):
        """Display the exception that just occurred.

        We remove the first stack item because it is our own code.

        The output is written by self.write(), below.

        """
        try:
            type, value, tb = sys.exc_info()
141 142 143
            sys.last_type = type
            sys.last_value = value
            sys.last_traceback = tb
144
            tblist = traceback.extract_tb(tb)
145
            del tblist[:1]
146 147 148 149
            lines = traceback.format_list(tblist)
            if lines:
                lines.insert(0, "Traceback (most recent call last):\n")
            lines.extend(traceback.format_exception_only(type, value))
150 151
        finally:
            tblist = tb = None
152 153 154 155 156 157
        if sys.excepthook is sys.__excepthook__:
            self.write(''.join(lines))
        else:
            # If someone has set sys.excepthook, we let that take precedence
            # over self.write
            sys.excepthook(type, value, tb)
158 159 160 161 162 163 164 165 166 167

    def write(self, data):
        """Write a string.

        The base implementation writes to sys.stderr; a subclass may
        replace this with a different implementation.

        """
        sys.stderr.write(data)

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197

class InteractiveConsole(InteractiveInterpreter):
    """Closely emulate the behavior of the interactive Python interpreter.

    This class builds on InteractiveInterpreter and adds prompting
    using the familiar sys.ps1 and sys.ps2, and input buffering.

    """

    def __init__(self, locals=None, filename="<console>"):
        """Constructor.

        The optional locals argument will be passed to the
        InteractiveInterpreter base class.

        The optional filename argument should specify the (file)name
        of the input stream; it will show up in tracebacks.

        """
        InteractiveInterpreter.__init__(self, locals)
        self.filename = filename
        self.resetbuffer()

    def resetbuffer(self):
        """Reset the input buffer."""
        self.buffer = []

    def interact(self, banner=None):
        """Closely emulate the interactive Python console.

198
        The optional banner argument specifies the banner to print
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
        before the first interaction; by default it prints a banner
        similar to the one printed by the real Python interpreter,
        followed by the current class name in parentheses (so as not
        to confuse this with the real interpreter -- since it's so
        close!).

        """
        try:
            sys.ps1
        except AttributeError:
            sys.ps1 = ">>> "
        try:
            sys.ps2
        except AttributeError:
            sys.ps2 = "... "
214
        cprt = 'Type "help", "copyright", "credits" or "license" for more information.'
215 216
        if banner is None:
            self.write("Python %s on %s\n%s\n(%s)\n" %
217
                       (sys.version, sys.platform, cprt,
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
                        self.__class__.__name__))
        else:
            self.write("%s\n" % str(banner))
        more = 0
        while 1:
            try:
                if more:
                    prompt = sys.ps2
                else:
                    prompt = sys.ps1
                try:
                    line = self.raw_input(prompt)
                except EOFError:
                    self.write("\n")
                    break
                else:
                    more = self.push(line)
            except KeyboardInterrupt:
                self.write("\nKeyboardInterrupt\n")
                self.resetbuffer()
                more = 0

    def push(self, line):
        """Push a line to the interpreter.

        The line should not have a trailing newline; it may have
        internal newlines.  The line is appended to a buffer and the
        interpreter's runsource() method is called with the
        concatenated contents of the buffer as source.  If this
        indicates that the command was executed or invalid, the buffer
        is reset; otherwise, the command is incomplete, and the buffer
        is left as it was after the line was appended.  The return
        value is 1 if more input is required, 0 if the line was dealt
        with in some way (this is the same as runsource()).

        """
        self.buffer.append(line)
255
        source = "\n".join(self.buffer)
256 257 258 259 260
        more = self.runsource(source, self.filename)
        if not more:
            self.resetbuffer()
        return more

261 262 263 264 265 266
    def raw_input(self, prompt=""):
        """Write a prompt and read a line.

        The returned line does not include the trailing newline.
        When the user enters the EOF key sequence, EOFError is raised.

267 268 269
        The base implementation uses the built-in function
        input(); a subclass may replace this with a different
        implementation.
270 271

        """
272
        return input(prompt)
273

274 275


276
def interact(banner=None, readfunc=None, local=None):
277 278 279
    """Closely emulate the interactive Python interpreter.

    This is a backwards compatible interface to the InteractiveConsole
280 281
    class.  When readfunc is not specified, it attempts to import the
    readline module to enable GNU readline if it is available.
282 283 284 285 286

    Arguments (all optional, all default to None):

    banner -- passed to InteractiveConsole.interact()
    readfunc -- if not None, replaces InteractiveConsole.raw_input()
287
    local -- passed to InteractiveInterpreter.__init__()
288 289

    """
290
    console = InteractiveConsole(local)
291 292
    if readfunc is not None:
        console.raw_input = readfunc
293 294 295
    else:
        try:
            import readline
296
        except ImportError:
297
            pass
298
    console.interact(banner)
299 300


Benjamin Peterson's avatar
Benjamin Peterson committed
301 302
if __name__ == "__main__":
    interact()