Skip to content
Library for building powerful interactive command line applications in Python
Python
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs spellfix functiom -> function May 6, 2020
examples Added comment regarding the origin of the fancy-zsh-prompt theme. Apr 10, 2020
prompt_toolkit A few pyflakes fixes: added several imports to __all__. May 26, 2020
tests test_completion: drop residual use of six Mar 11, 2020
tools Added debug_win_input tool for testing win32 console input. Mar 4, 2020
.codecov.yml Prevent Codecov from commenting on pull requests Dec 20, 2018
.gitignore Ignore pipenv and pytest files. Jul 11, 2018
.travis.yml Stop ignoring 'Name already defined' errors in Mypy. Feb 18, 2020
AUTHORS.rst AUTHORS.rst file added. Sep 29, 2014
CHANGELOG Release 3.0.5 Mar 26, 2020
LICENSE Initial commit (Squash of about 68 commits between Jan 25, 2014 and A… Aug 30, 2014
MANIFEST.in Add tests to code bundle Nov 10, 2015
PROJECTS.rst Add pydoro to PROJECTS.rst Jun 19, 2019
README.rst Remove unicode_literals import from examples, README and tests (not n… Jan 21, 2020
appveyor.yml Add an AppVeyor setup. Jul 11, 2018
mypy.ini Fixed several type annotations. Feb 18, 2020
pyproject.toml Applied Black code style. Nov 28, 2019
setup.cfg Ignore certain formatting parameters in flake8 (for Black compatibili… Nov 28, 2019
setup.py Added Python 3.8 to classifiers in setup.py. May 14, 2020
tox.ini Reorganize tests to be collected by py.test May 25, 2016

README.rst

Python Prompt Toolkit

Build Status AppVeyor Latest Version RTD License Codecov

https://github.com/prompt-toolkit/python-prompt-toolkit/raw/master/docs/images/logo_400px.png

prompt_toolkit is a library for building powerful interactive command line applications in Python.

Read the documentation on readthedocs.

NOTICE: prompt_toolkit 3.0

Please notice that this branch is the prompt_toolkit 3.0 branch. For most users, it should be compatible with prompt_toolkit 2.0, but it requires at least Python 3.6. On the plus side, prompt_toolkit 3.0 is completely type annotated and uses asyncio natively.

Gallery

ptpython is an interactive Python Shell, build on top of prompt_toolkit.

https://github.com/prompt-toolkit/python-prompt-toolkit/raw/master/docs/images/ptpython.png

More examples

prompt_toolkit features

prompt_toolkit could be a replacement for GNU readline, but it can be much more than that.

Some features:

  • Pure Python.
  • Syntax highlighting of the input while typing. (For instance, with a Pygments lexer.)
  • Multi-line input editing.
  • Advanced code completion.
  • Both Emacs and Vi key bindings. (Similar to readline.)
  • Even some advanced Vi functionality, like named registers and digraphs.
  • Reverse and forward incremental search.
  • Works well with Unicode double width characters. (Chinese input.)
  • Selecting text for copy/paste. (Both Emacs and Vi style.)
  • Support for bracketed paste.
  • Mouse support for cursor positioning and scrolling.
  • Auto suggestions. (Like fish shell.)
  • Multiple input buffers.
  • No global state.
  • Lightweight, the only dependencies are Pygments, six and wcwidth.
  • Runs on Linux, OS X, FreeBSD, OpenBSD and Windows systems.
  • And much more...

Feel free to create tickets for bugs and feature requests, and create pull requests if you have nice patches that you would like to share with others.

Installation

pip install prompt_toolkit

For Conda, do:

conda install -c https://conda.anaconda.org/conda-forge prompt_toolkit

About Windows support

prompt_toolkit is cross platform, and everything that you build on top should run fine on both Unix and Windows systems. Windows support is best on recent Windows 10 builds, for which the command line window supports vt100 escape sequences. (If not supported, we fall back to using Win32 APIs for color and cursor movements).

It's worth noting that the implementation is a "best effort of what is possible". Both Unix and Windows terminals have their limitations. But in general, the Unix experience will still be a little better.

For Windows, it's recommended to use either cmder or conemu.

Getting started

The most simple example of the library would look like this:

from prompt_toolkit import prompt

if __name__ == '__main__':
    answer = prompt('Give me some input: ')
    print('You said: %s' % answer)

For more complex examples, have a look in the examples directory. All examples are chosen to demonstrate only one thing. Also, don't be afraid to look at the source code. The implementation of the prompt function could be a good start.

Philosophy

The source code of prompt_toolkit should be readable, concise and efficient. We prefer short functions focusing each on one task and for which the input and output types are clearly specified. We mostly prefer composition over inheritance, because inheritance can result in too much functionality in the same object. We prefer immutable objects where possible (objects don't change after initialization). Reusability is important. We absolutely refrain from having a changing global state, it should be possible to have multiple independent instances of the same code in the same process. The architecture should be layered: the lower levels operate on primitive operations and data structures giving -- when correctly combined -- all the possible flexibility; while at the higher level, there should be a simpler API, ready-to-use and sufficient for most use cases. Thinking about algorithms and efficiency is important, but avoid premature optimization.

Projects using prompt_toolkit

Special thanks to

  • Pygments: Syntax highlighter.
  • wcwidth: Determine columns needed for a wide characters.
You can’t perform that action at this time.