Package: ptpython
A better Python REPLpip install ptpythonPtpython is an advanced Python REPL. It should work on all
Python versions from 2.6 up to 3.9 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.InstallationInstall it using pip:pip install ptpythonStart it by typingptpython.FeaturesSyntax highlighting.Multiline editing (the up arrow works).Autocompletion.Mouse support. [1]Support for color schemes.Support forbracketed 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.Command Line OptionsThe help menu shows basic command-line options.$ ptpython --help
usage: ptpython [-h] [--vi] [-i] [--light-bg] [--dark-bg] [--config-file CONFIG_FILE]
                [--history-file HISTORY_FILE] [-V]
                [args ...]

ptpython: Interactive Python shell.

positional arguments:
  args                  Script and arguments

optional arguments:
  -h, --help            show this help message and exit
  --vi                  Enable Vi key bindings
  -i, --interactive     Start interactive shell after executing this file.
  --asyncio             Run an asyncio event loop to support top-level "await".
  --light-bg            Run on a light background (use dark colors for text).
  --dark-bg             Run on a dark background (use light colors for text).
  --config-file CONFIG_FILE
                        Location of configuration file.
  --history-file HISTORY_FILE
                        Location of history file.
  -V, --version         show program's version number and exit

environment variables:
  PTPYTHON_CONFIG_HOME: a configuration directory to use
  PYTHONSTARTUP: file executed on interactive startup (no default)__pt_repr__: A nicer repr with colorsWhen classes implement a__pt_repr__method, this will be used instead of__repr__for printing. Anyprompt_toolkit “formatted text”can be returned from here. In order to avoid writing a__repr__as well,
theptpython.utils.ptrepr_to_reprdecorator can be applied. For instance:fromptpython.utilsimportptrepr_to_reprfromprompt_toolkit.formatted_textimportHTML@ptrepr_to_reprclassMyClass:def__pt_repr__(self):returnHTML('<yellow>Hello world!</yellow>')More screenshotsThe configuration menu:The history page and its help:Autocompletion:Embedding the REPLEmbedding the REPL in any Python application is easy:fromptpython.replimportembedembed(globals(),locals())You can make ptpython your default Python REPL by creating aPYTHONSTARTUP filecontaining code
like this:importsystry:fromptpython.replimportembedexceptImportError:print("ptpython is not available: falling back to standard prompt")else:sys.exit(embed(globals(),locals()))Note config file support currently only works when invokingptpythondirectly.
That it, the config file will be ignored when embedding ptpython in an application.Multiline editingMulti-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 pressAlt+Enter, orEscfollowed byEnter. (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 validationBefore execution,ptpythonwill see whether the input is syntactically
correct Python code. If not, it will show a warning, and move the cursor to the
error.Asyncio REPL and top level awaitIn order to get top-levelawaitsupport, start ptpython as follows:ptpython --asyncioThis will spawn an asyncio event loop and embed the async REPL in the event
loop. After this, top-level await will work and statements likeawait asyncio.sleep(10)will execute.Additional featuresRunning system commands: PressMeta-!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: PressControl+Spacein Emacs mode orV(major V) in Vi
navigation mode.ConfigurationIt is possible to create aconfig.pyfile to customize configuration.
ptpython will look in an appropriate platform-specific directory viaappdirs
<https://pypi.org/project/appdirs/>. See theappdirsdocumentation for the
precise location for your platform. APTPYTHON_CONFIG_HOMEenvironment
variable, if set, can also be used to explicitly override where configuration
is looked for.Have a look at this example to see what is possible:config.pyNote config file support currently only works when invokingptpythondirectly.
That it, the config file will be ignored when embedding ptpython in an application.IPython supportRunptipython(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)This is also available for embedding:fromptpython.ipythonimportembedembed(globals(),locals())Django supportdjango-extensionshas ashell_plusmanagement command. Whenptpythonhas been installed,
it will by default useptpythonorptipython.PDBThere is an experimental PDB replacement:ptpdb.Windows supportprompt_toolkitandptpythonworks better on Linux and OS X than on
Windows. Some things might not work, but it is usable:FAQQ: TheCtrl-Sforward search doesn’t work and freezes my terminal.A: Try to runstty-ixonin your terminal to disable flow control.Q: TheMeta-key doesn’t work.A: For some terminals you have to enable the Alt-key to act as meta key, but you
can also typeEscapebefore any key instead.AlternativesBPythonIPythonIf 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 inptpython,
also create a GitHub issue and maybe we’ll implement it.Special thanks toPygments: Syntax highlighter.Jedi: Autocompletion library.wcwidth: Determine columns needed for a wide characters.prompt_toolkitfor the interface.