modules: use bot.say()'s trailing parameter
#1995
Merged
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
We have very reliable message truncation now, so it's silly to only add definitions to the output if the length is less than 150 characters. Seems like 300 is a more reasonable threshold for stopping, since the amount of usable space in a line tends to be closer to 450.
The new parameter doesn't really help with overly long submission titles since those appear near the beginning of the output line, but it does simplify truncating comment previews & subreddit descriptions.
This plugin was a bit more complicated to switch over, since the old order of operations placed the post caption in the middle when parsing Instagram's full-fat JSON data. Moving the caption handling to the end (and tweaking it a bit to make better use of Python language features) makes it possible to let Sopel handle truncating the caption itself, using the new `bot.say()` param. oEmbed handling only pulls the author's name and post title, and it's unlikely to run into over-length issues, but adding `trailing` to it anyway for safety doesn't cost anything.
Exirel
approved these changes
Nov 30, 2020
Honestly it feels really good to remove that awful `while` loop with its embedded magic numbers. I still don't even know what `18` was for.
We sacrifice the ability to know for sure if another Sopel bot's wiki output was what triggered this call, but gain the ability to include more of the article text (and test out a hack of the `trailing` param that will be useful for other plugins with truncatable content that's not at the very end of the message). Replaced the `msg_url == trigger` check with a heuristic: Assume that the triggering user was a Sopel bot if the trigger started with `[wikipedia] ` and ended with ` | <our wiki page URL>`. Obviously it won't be a super effective check if two different versions of Sopel with different Wikipedia output meet, but the old check would also break in that case. The change seems worthwhile.
dgw
force-pushed
the
modules-use-bot.say-trailing
branch
from
eef2637
to
54aa021
Compare
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.
Description
This updates every core plugin I could find with an existing handler for "too long" output (
instagram,reddit,tld,wiktionary, &wikipedia) to usebot.say()'s newtrailingparameter from #1958.Two things that might be worth amending, if others think my thought process or assumptions were wrong:
instagram: I rearranged the output to put the caption (most likely to be over-length) at the end. A subsequent commit to this branch (towikipedia) showed a neat hack that would allow leaving the caption where it was, in the middle of the line, but it seems to make the most sense at the end anyway.reddit: I did not change submission output to usetrailing, because:Checklist
make qa(runsmake qualityandmake test)