pydoc > code

man perldoc info pydoc3 ri search

📘 NAME

code - Utilities needed to emulate Python's interactive interpreter.

🚀 Quick Reference

Use Case	Command	Description
🖥 Start interactive console	interact(banner=None, readfunc=None, local=None, exitmsg=None)	Closely emulate the interactive Python interpreter with optional banner and exit message
🔍 Compile a command string	compile_command(source, filename='<input>', symbol='single')	Compile source and determine if complete, incomplete, or error; returns code object, None, or raises SyntaxError
🛠 Create InteractiveConsole	InteractiveConsole(locals=None, filename='<console>')	Class that builds on InteractiveInterpreter with prompting and input buffering
📦 Create InteractiveInterpreter	InteractiveInterpreter(locals=None)	Base class for parsing and interpreter state, no input buffering or prompting
📝 Push a line to interpreter	console.push(line)	Append line to buffer and run; returns 1 if more input needed, 0 if complete

📚 MODULE REFERENCE

https://docs.python.org/3.10/library/code.html

The following documentation is automatically generated from the Python source files. It may be incomplete, incorrect or include features that are considered implementation detail and may vary between Python implementations. When in doubt, consult the module reference at the location listed above.

🏛️ CLASSES

builtins.object
    InteractiveInterpreter
        InteractiveConsole

🧩 class InteractiveConsole

InteractiveConsole(locals=None, filename='<console>') — 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.

Method resolution order: InteractiveConsole, InteractiveInterpreter, builtins.object

🔧 Methods defined here

• __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.
• interact(self, banner=None, exitmsg=None) — Closely emulate the interactive Python console. The optional banner argument specifies the banner to print 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!). The optional exitmsg argument specifies the exit message printed when exiting. Pass the empty string to suppress printing an exit message. If exitmsg is not given or None, a default message is printed.
• 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()).
• 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. The base implementation uses the built-in function input(); a subclass may replace this with a different implementation.
• resetbuffer(self) — Reset the input buffer.

⬅️ Methods inherited from InteractiveInterpreter

• 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.
• runsource(self, source, filename='<input>', symbol='single') — Compile and run some source in the interpreter. Arguments are as for compile_command(). One of several things can happen: 1) The input is incorrect; compile_command() raised an exception (SyntaxError or OverflowError). A syntax traceback will be printed by calling the showsyntaxerror() method. 2) The input is incomplete, and more input is required; compile_command() returned None. Nothing happens. 3) The input is complete; compile_command() returned a code object. The code is executed by calling self.runcode() (which also handles run-time exceptions, except for SystemExit). The return value is True in case 2, False in the other cases (unless 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.
• showsyntaxerror(self, filename=None) — Display the syntax error that just occurred. This doesn't display a stack trace because there isn't one. 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). The output is written by self.write(), below.
• 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.
• write(self, data) — Write a string. The base implementation writes to sys.stderr; a subclass may replace this with a different implementation.

📦 Data descriptors inherited from InteractiveInterpreter

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🧩 class InteractiveInterpreter

InteractiveInterpreter(locals=None) — 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).

🔧 Methods defined here

• __init__(self, locals=None) — Constructor. 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.
• runcode(self, code) — (same as above)
• runsource(self, source, filename='<input>', symbol='single') — (same as above)
• showsyntaxerror(self, filename=None) — (same as above)
• showtraceback(self) — (same as above)
• write(self, data) — (same as above)

📦 Data descriptors defined here

• __dict__ — dictionary for instance variables (if defined)
• __weakref__ — list of weak references to the object (if defined)

🔧 FUNCTIONS

🔧 compile_command

compile_command(source, filename='<input>', symbol='single') — Compile a command and determine whether it is incomplete.

Arguments:

• source — the source string; may contain \n characters
• filename — optional filename from which source was read; default "<input>"
• symbol — optional grammar start symbol; "single" (default), "exec" or "eval"

Return value / exceptions raised:

• 📄 Return a code object if the command is complete and valid
• 🔄 Return None if the command is incomplete
• ⚠️ Raise SyntaxError, ValueError or OverflowError if the command is a syntax error (OverflowError and ValueError can be produced by malformed literals).

🔧 interact

interact(banner=None, readfunc=None, local=None, exitmsg=None) — Closely emulate the interactive Python interpreter. This is a backwards compatible interface to the InteractiveConsole class. When readfunc is not specified, it attempts to import the readline module to enable GNU readline if it is available.

Arguments (all optional, all default to None):

• banner — passed to InteractiveConsole.interact()
• readfunc — if not None, replaces InteractiveConsole.raw_input()
• local — passed to InteractiveInterpreter.__init__()
• exitmsg — passed to InteractiveConsole.interact()

📊 DATA

__all__ = ['InteractiveInterpreter', 'InteractiveConsole', 'interact',...]

📁 FILE

/usr/lib/python3.10/code.py

📘 NAME 🚀 Quick Reference 📚 MODULE REFERENCE 🏛️ CLASSES 🔧 FUNCTIONS 📊 DATA 📁 FILE