Skip to main content

ptpython: a better Python REPL

Build Status

Latest Version

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…

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

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

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:

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

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

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.

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

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.

Configurating

It is possible to create a ~/.ptpython/config.py file to customize the configuration.

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

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)

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

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.

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

Have a look at the alternatives.

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.

Metadata

Release files for ptpython 0.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ptpython 0.18
File Size Uploaded Provenance Actions
ptpython-0.18.tar.gz 29.4 kB Without provenance Details for ptpython-0.18.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for ptpython 0.18
File Interpreter ABI Platform Actions
ptpython-0.18-py3-none-any.whl Python 3 none any Details for ptpython-0.18-py3-none-any.whl
ptpython-0.18-py2-none-any.whl Python 2 none any Details for ptpython-0.18-py2-none-any.whl

Total release size: 104.1 kB

Release files / ptpython-0.18.tar.gz

Download URL ptpython-0.18.tar.gz
Size 29.4 kB
Tags Source
SHA-256 checksum
How to use checksums
be231639bd0dba13c1dc34af1728111bd8a2bf2b25bb18b3b58ad7a28432668d
BLAKE2b-256 checksum
How to use checksums
5d04228ce294521665d51e9f60c827d766059805ede63c265d7e4bead39a6081
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ptpython-0.18-py3-none-any.whl

Download URL ptpython-0.18-py3-none-any.whl
Size 37.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
26f6aee356f4a47835f5f11cde4e92edd89df953892b37c6fd672bd6ee5abd91
BLAKE2b-256 checksum
How to use checksums
e054acf2ca0acb902e61312acdbd4dfc9f0e1e9fa6ffdf2615c3ff53f7080ac0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / ptpython-0.18-py2-none-any.whl

Download URL ptpython-0.18-py2-none-any.whl
Size 37.3 kB
Tags Python 2
SHA-256 checksum
How to use checksums
7dabe6aaa9b7e3e53b023871dac0491c7a60953bbd90783bca58ae96092d1b5a
BLAKE2b-256 checksum
How to use checksums
9adc20ecdc3872e85c47bd1f6b9eb614da0e9765dc7d0a25ed111964d85255f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for ptpython 0.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.18 This release

3 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page