Rich text support in console output #359
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Code is adapted from GPL3-licensed muv by @seonon https://github.com/seonon/muv
Code is adapted from GPL3-licensed muv by @seonon https://github.com/seonon/muv
see: https://www.flake8rules.com/rules/W503.html for justification
Fixes issue ihabunek#255
Title is now a positional parameter. Also added some error handling in the command processing for looking up list IDs per @ihabunek 's suggestions
Also don't check if account is found, that function alredy raises a ConsoleError.
Top level widgets are separated by blank lines, but The final blank line of the status is omitted. This exactly matches existing status rendering in master, for statuses that contain only the currently supported tags
No longer specifying color "white" when it's more correct to omit the color and just specify an attribute like underline, bold, etc.
If the class name appears in the constants.py PALETTE entry, it is honored. Otherwise, the class is ignored and the tag is handled as a generic tag of that type. This allows hashtag anchors to be highlighted, and URL anchors to be styled differently regardless of the strange class markup that Akkoma adds to URL anchors
Uses the Hyperlink widget along with TextEmbed widget
We see this problem with statuses from Pixelfed servers. Per the Mastodon API spec, the content tag is supposed to be HTML, but Pixelfed sends statuses that often start as plain text. They may include embedded anchor tags etc. within the text. This confuses BeautifulSoup HTML parsers and results in bad rendering artifacts. This workaround detects the above condition and attempts to fix it by surrounding the status in <p></p>. This converts it to nominally valid HTML (at least, parseable by BeautifulSoup.)
Also, hashtags are created as OCS-8 hyperlinks, so they are directly clickable in terminals that support OCS-8
Also, now renders HTML in Account overlay page
Also, removed Python 3.6 tests as urwidgets is Python 3.7+
Also converted polls.py to use HTML rendering
This introduces a dependency on html2text. The library works well for our limited use cases, but has not been updated since 2020.
This allows us to pass existing test_console.py tests
This introduces a dependency on html2text. The library works well for our limited use cases, but has not been updated since 2020.
Pleroma, Akkoma, and other servers do not follow the Mastodon spec for the 'uri' attribute which specifies that it contains the domain name of the instance. Instead, they return a complete URI. As a workaround, we now detect this situation and parse out the domain from the URI when necessary. This fixes issue ihabunek#347. Thanks to @laleanor for their patch and @rjp for ideas on how to make it work with GotoSocial and other servers
Previously this only worked for anchor tags with nested spans. Now it works for anchor tags with or without nested spans.
danschwarz
force-pushed
the
console-output-enh
branch
from
bc8bce5
to
18ef70c
Compare
I've fixed the one HTML2Text issue (design choice) that stopped long URLs from being properly wrapped at the proper width. This is only in my fork of the project for the foreseeable future as upstream is dormant. The issue with spaces being added in front of underlined text appears to be a deliberate choice (there's a comment stating that in the code). So just something to live with if we go with this library. |
|
This is going to need to get squashed before commit, I'm sure. Too much going on here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is cumulative with PR #356 . It adds the ability to output rich text as Markdown on the console (i.e., in
toot timelineoutput) and also output rich text as Markdown to the clipboard with theCop[y]command.It uses the html2text library to convert HTML to Markdown text.
Why Markdown format? Because there doesn't seem to be a html2ansi library available anywhere. Also, ANSI escape sequences aren't a clipboard-friendly format if we want to copy richtext status messages to the clipboard using OSC 52.
Why this library? Because I couldn't find anything better in a prebuilt library. I'm not interested in writing all the code to do text formatting, wrapping, etc. when all that has been done here.
Output of ordinary status messages without HTML passes the console_test.py test suite. I have added an additional test of a status message with all the new HTML tags to be supported in Mastodon 4.2.
That said, html2text is not great! It has some formatting bugs and open PRs piling up since 2022. The last update in Github was February 2022. You can see in the example below, lines with emphasized, bold, and combined styles have extra spaces in them. I have a fork of the project where I've applied all the relevant PRs and it fixes some of the formatting bugs, but not all. (The output you see below uses the release version of html2text, not my fork).
Open to suggestions about how to proceed with this.