Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Post History

81%
+7 −0
Q&A Can you have syntax highlighting for streaming text in Python?

The answer is "it depends". It depends on the language, how much buffering you're willing to allow, how much you're willing to accept some approximate/incorrect syntax highlighting, and whether you...

posted 4mo ago by Derek Elkins‭

Answer
#1: Initial revision by user avatar Derek Elkins‭ · 2024-07-10T00:04:37Z (4 months ago)
The answer is "it depends". It depends on the language, how much buffering you're willing to allow, how much you're willing to accept some approximate/incorrect syntax highlighting, and whether you'd accept control codes that correct the syntax highlighting after the fact.

If your bar for syntax highlighting was simply that language keywords, operators, and other "punctuation" are highlighted, then almost all programming languages allow this with only a small amount of buffering needed. Some amount of buffering is needed because I can't tell if "i" is part of the keyword "if" until I see the next two characters.

On the other hand, if you wanted to highlight unmatched brackets, then you may not be able to correctly highlight an opening bracket at the beginning of the file until the very end of the file.

This is an issue in most languages for many non-trivial uses of syntax highlighting. Specifically, this is an issue with markdown if you'd like to, for example, use bold text for text wrapped in **s.

As the highlighting of this paragraph indicates, whether the text following ** is made bold depends on whether there is a following ** among other rules. I didn't do any escaping in this case.

Ultimately, the only (non-trivial) solution in general is for the streaming syntax highlighting to make a guess and sometimes be wrong. If allowed, it might be possible to use control codes to edit the previously displayed output when the syntax highlighter has enough context to realize it made a mistake.

[`bat`](https://github.com/sharkdp/bat), for example, just assumes `**` starts a bold span and makes the following text bold even when this is incorrect.