Syntax highlighting for prompt_toolkit and HTML with pyparsing.
Project description
Syntax highlighting with pyparsing, supporting both HTML output and prompt_toolkit–style terminal output. The PPHighlighter class can also be used as a lexer for syntax highlighting as you type in prompt_toolkit. It is compatible with existing Pygments styles.
Read the documentation on readthedocs.
Requirements
Python 3.5+
prompt_toolkit 2.0+
Installation
pip3 install -U pyparsing-highlighting
Or, after cloning the repository on GitHub:
python3 setup.py install
Examples
The following code demonstrates the use of PPHighlighter:
from pp_highlighting import PPHighlighter
from prompt_toolkit.styles import Style
import pyparsing as pp
from pyparsing import pyparsing_common as ppc
def parser_factory(styler):
a = styler('class:int', ppc.integer)
return pp.delimitedList(a)
pph = PPHighlighter(parser_factory)
style = Style([('int', '#528f50')])
pph.print('1, 2, 3', style=style)
This prints out the following to the terminal:
The following code generates HTML:
pph.highlight_html('1, 2, 3')
The output is:
<span class="highlight"><span class="int">1</span>, <span class="int">2</span>, <span class="int">3</span></span>
There is also a lower-level API—pph.highlight('1, 2, 3')
returns the following:
FormattedText([('class:int', '1'), ('', ', '), ('class:int', '2'), ('', ', '), ('class:int', '3')])
A FormattedText instance can be passed to prompt_toolkit.print_formatted_text(), along with a Style mapping the class names to colors, for display on the terminal.
PPHighlighter can also be passed to a prompt_toolkit.PromptSession as the lexer argument, which will perform syntax highlighting as you type. For an example of this, see examples/calc.py and examples/repl.py.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pyparsing-highlighting-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3795630a795d93a94af847f240a95845a6d3a4c138dcdb1d9dec50d06a872cd6 |
|
MD5 | 5deb269cc05ae5013e675019e33f7ac0 |
|
BLAKE2b-256 | 3cd2aab8444cf63640b39f3d51f8b56cf8c91a8799a8a62f6d5535769ac300ce |
Hashes for pyparsing_highlighting-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89ab31e98c8c5bb057f50bea32245db0a9482d19c991f9e2a6aaae68c46130db |
|
MD5 | ee4de24b50f867b8d681bdff55ab7563 |
|
BLAKE2b-256 | 5d94055faa314ab37db4c21b0e721133e7d78d5b39554c74812376f7404819e5 |