prompt-toolkit / ptpython

prompt-toolkit

A better Python REPL

3.8K Stars 215 Forks Last release: Not found BSD 3-Clause "New" or "Revised" License 375 Commits 19 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Readme

ptpython

Name: ptpython
Brand: ptpython
SKU: //prompt-toolkit/ptpython
Rating: 4.308666666666666 (3778 reviews)

A better Python REPL

pip install ptpython

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/example1.png

Ptpython is an advanced Python REPL. It should work on all Python versions from 2.6 up to 3.7 and work cross platform (Linux, BSD, OS X and Windows).

Note: this version of ptpython requires at least Python 3.6. Install ptpython 2.0.5 for older Python versions.

Installation

Install it using pip:

pip install ptpython

Start it by typing

ptpython

Features

Syntax highlighting.
Multiline editing (the up arrow works).
Autocompletion.
Mouse support. [1]
Support for color schemes.
Support for
```
bracketed paste 
```
_ [2].
Both Vi and Emacs key bindings.
Support for double width (Chinese) characters.
... and many other things.

[1] Disabled by default. (Enable in the menu.)

[2] If the terminal supports it (most terminals do), this allows pasting without going into paste mode. It will keep the indentation.

pt_repr: A nicer repr with colors

When classes implement a

__pt_repr__

method, this will be used instead of

__repr__

for printing. Any

prompt_toolkit "formatted text"

_ can be returned from here. In order to avoid writing a

__repr__

as well, the

ptpython.utils.ptrepr_to_repr

decorator can be applied. For instance:

.. code:: python

from ptpython.utils import ptrepr_to_repr
from prompt_toolkit.formatted_text import HTML

@ptrepr_to_repr
class MyClass:
    def __pt_repr__(self):
        return HTML('Hello world!')

More screenshots

The configuration menu:

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ptpython-menu.png

The history page and its help:

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ptpython-history-help.png

Autocompletion:

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/file-completion.png

Embedding the REPL

Embedding the REPL in any Python application is easy:

.. code:: python

from ptpython.repl import embed
embed(globals(), locals())

You can make ptpython your default Python REPL by creating a

PYTHONSTARTUP file

_ containing code like this:

.. code:: python

import sys try: from ptpython.repl import embed except ImportError: print("ptpython is not available: falling back to standard prompt") else: sys.exit(embed(globals(), locals()))

Multiline editing

Multi-line editing mode will automatically turn on when you press enter after a colon.

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.)

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/multiline.png

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.

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/validation.png

Additional 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 or

(major V) in Vi navigation mode.

Configuration

It is possible to create a

$XDG_CONFIG_HOME/ptpython/config.py

file to customize the configuration.

Have a look at this example to see what is possible:

config.py

IPython support

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

)

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/ipython.png

This is also available for embedding:

.. code:: python

from ptpython.ipython.repl import embed
embed(globals(), locals())

Django support

django-extensions

_ has a

shell_plus

management command. When

ptpython

has been installed, it will by default use

ptpython

ptipython

PDB

There is an experimental PDB replacement:

ptpdb

Windows support

prompt_toolkit

and

ptpython

works better on Linux and OS X than on Windows. Some things might not work, but it is usable:

.. image :: https://github.com/jonathanslenders/ptpython/raw/master/docs/images/windows.png

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

```
BPython 
```
_
```
IPython 
```
_

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 maybe 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.

.. |Build Status| image:: https://api.travis-ci.org/prompt-toolkit/ptpython.svg?branch=master :target: https://travis-ci.org/prompt-toolkit/ptpython#

.. |License| image:: https://img.shields.io/github/license/prompt-toolkit/ptpython.svg :target: https://github.com/prompt-toolkit/ptpython/blob/master/LICENSE

.. |PyPI| image:: https://pypip.in/version/ptpython/badge.svg :target: https://pypi.python.org/pypi/ptpython/ :alt: Latest Version

ptpython

by prompt-toolkit

No Items, yet!

ptpython