ptpython: Advanced Python REPL

3.0.32 · active · verified Sat Apr 11

ptpython is an advanced, cross-platform Python REPL (Read-Eval-Print Loop) built on top of the prompt_toolkit library. It provides features like syntax highlighting, autocompletion, multiline editing, mouse support, and customizable key bindings (Emacs and Vi modes). Currently at version 3.0.32, it sees fairly frequent updates, often with several patch releases per month.

Warnings

breaking Python 3.7 support was dropped in version 3.0.30. Users on Python 3.7 or older must use an earlier ptpython version (e.g., ptpython 2.0.5 for Python < 3.6, or a 2.x version for Python 3.7).
Fix: Upgrade to Python 3.8 or newer, or pin ptpython to <3.0.30.
gotcha When embedding the REPL using `ptpython.repl.embed()`, configuration files (e.g., `~/.config/ptpython/config.py`) are ignored by default. This can lead to unexpected behavior if you rely on custom settings.
Fix: Explicitly load your configuration using `from ptpython.repl import run_config; run_config(repl, config_path)` within your `configure` callback passed to `embed()`.
breaking Since version 3.0.24, the `--asyncio` flag is explicitly required to activate the asyncio REPL when running `ptpython` from the command line. Previously, asyncio mode might have been implicitly active under certain conditions.
Fix: Ensure you explicitly pass `--asyncio` when you intend to use the asyncio-enabled REPL for top-level await or other async features.
gotcha Version 3.0.28 introduced a custom `exit` function that can be called without parentheses (i.e., just `exit`) to return from the REPL when embedded. While convenient, users accustomed to always calling `exit()` might find this behavior unexpected.
Fix: Be aware that both `exit` and `exit()` will work to leave the embedded REPL.
gotcha In version 3.0.32, the default code theme ('default-ansi') switched to using ANSI colors instead of RGB. This can alter the appearance of syntax highlighting depending on your terminal emulator's color configuration, potentially affecting contrast.
Fix: If the default theme's colors are unsatisfactory, you can configure a custom color scheme in your `config.py` file or select a different theme if available.

Install

pip install ptpython Install ptpython
pip install ptpython[ptipython] Install with IPython support

Imports

embed
```
from ptpython.repl import embed
```
Used to embed the ptpython REPL directly into a Python application or script. It's common to pass `globals()` and `locals()` to make current scope variables available.
run_config
```
from ptpython.repl import run_config
```
Used to explicitly load a configuration file when embedding the REPL, as configuration files are otherwise ignored in embedded mode.

Quickstart

To start a `ptpython` shell, simply run `ptpython` in your terminal. To embed it in a Python script for debugging or interactive sessions, use `ptpython.repl.embed()`. You should pass `globals()` and `locals()` to `embed()` to make the current scope available inside the REPL.

import os
from ptpython.repl import embed

def main():
    print("Entering embedded ptpython REPL...")
    my_variable = "Hello from host script"
    # Pass globals() and locals() to make variables accessible in the REPL
    embed(globals(), locals())
    print("Exited embedded ptpython REPL.")

if __name__ == "__main__":
    # Or simply run from command line:
    # $ ptpython
    main()

view raw JSON →