ptpython 0.8

Python REPL build on top of prompt_toolkit

ptpython is an advanced Python REPL built on top of the prompt_toolkit library.

It works best on all Posix systems like Linux, BSD and OS X. But it should work as well on Windows. It works on all Python versions from 2.6 up to 3.4.

Installation

To install ptpython, type:

pip install ptpython

The REPL

Run ptpython to get an interactive Python prompt with syntax highlighting, code completion, etc…

By default, you will have Emacs key bindings, but if you prefer Vi bindings (like in the above screenshot) then run ptpython --vi.

If you want to embed the REPL inside your application at one point, do:

from ptpython.repl import embed
embed(globals(), locals(), vi_mode=False, history_filename=None)

Autocompletion

Tab and shift+tab complete the input. In Vi-mode, you can also use Ctrl+N and Ctrl+P.

There is even completion on file names inside strings:

Multiline editing

Usually, multi-line editing mode will automatically turn on when you press enter after a colon, however you can always turn it on by pressing F7.

To execute the input in multi-line mode, you can either press Alt+Enter, or Esc followed by Enter. (If you want the first to work in the OS X terminal, you have to check the “Use option as meta key” checkbox in your terminal settings. For iTerm2, you have to check “Left option acts as +Esc” in the options.)

Syntax validation

Before execution, ptpython will see whether the input is syntactically correct Python code. If not, it will show a warning, and move the cursor to the error.

Tab pages

Suppose that you were editing a long multiline Python command, but suddenly you want to test something else in between in the same shell and go back. We have tab pages for this. Each tab has its own input buffer, but they are all evaluated in the same environment (sharing locals/globals).

The shortcuts:

Create a new tab page	Control-T
Close current tab page	Control-D
Navigate to next tab	Control-Arrow-right (Or in Vi-mode: ‘gt’)
Navigate to previous tab	Control-Arrow-left (Or in Vi-mode: ‘gT’)

Other features

Running system commands: Press Meta-! in Emacs mode or just ! in Vi navigation mode to see the “Shell command” prompt. There you can enter system commands without leaving the REPL.

Selecting text: Press Control+Space in Emacs mode on V (major V) in Vi navigation mode.

You love IPython?

Run ptipython (prompt_toolkit - IPython), to get a nice interactive shell with all the power that IPython has to offer, like magic functions and shell integration. Make sure that IPython has been installed. (pip install ipython)

You are using Django?

django-extensions has a shell_plus management command. When ptpython has been installed, it will by default use ptpython or ptipython.

PDB

There is an experimental PDB replacement: ptpdb.

About Windows support

prompt_toolkit works still a little better on systems like Linux and OS X than on Windows, but it certainly is usable. One thing that still needs attention is the colorscheme. Windows terminals don’t support all colors, so we have to create another colorscheme for Windows.

FAQ

Q

The Ctrl-S forward search doesn’t work and freezes my terminal.

A

Try to run stty -ixon in your terminal to disable flow control.

Q

The Meta-key doesn’t work.

A

For some terminals you have to enable the Alt-key to act as meta key, but you can also type Escape before any key instead.

Alternatives

Have a look at the alternatives.

• BPython

If you find another alternative, you can create an issue and we’ll list it here. If you find a nice feature somewhere that is missing in ptpython, also create a GitHub issue and mabye we’ll implement it.

Special thanks to

• Pygments: Syntax highlighter.

• Jedi: Autocompletion library.

• Docopt: Command-line interface description language.

• wcwidth: Determine columns needed for a wide characters.

• prompt_toolkit for the interface.