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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d06b324858fb216c96ca997a7df9c44b6fe00bebde495fb6f8f63c37be0e562f |
|
MD5 | 72b43876151815fc5867b8a039053c74 |
|
BLAKE2b-256 | 646812ede0d66c4b607108e26e2adc4a0c60e6dec1fae928e5950b6c95597f2a |
Hashes for pyparsing_highlighting-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 20d3816993c99dcb6437c73731db43556fc7b2c929aee144eea24914ae094524 |
|
MD5 | 98b9e4d6f0cd4ae6d9a67524c5eb9137 |
|
BLAKE2b-256 | 9aa6a1a96bad431446cb224c60036e7ab4929be9a5166f7eea27a556f2d26567 |