choose: safely handle formatted options #1965
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
This is for plugin convenience, as otherwise they'd all need to build their own lists of constants from the formatting module. Providing a constant also lets plugins adapt automatically when Sopel adds support for new formatting characters.
dgw
added
the
Bugfix
|
Wow, I really whiffed that. Was so focused on making sure my new tests behaved that I neglected the existing ones. |
dgw
force-pushed
the
choose-preserve-formatting
branch
from
da02739
to
967f747
Compare
Python's built-in `strip()` method for strings considers some control codes used for IRC formatting to be "whitespace" and removes them if they appear at the beginning or end of the string. While the built-in method does take an optional argument listing what characters to strip, there's no good way to generate our own list to pass in. One can look up the category of a Unicode character, but there's no way to get a list of all characters in a category. So instead, we have a custom function, which also handles adding the "formatting reset" character if the text contains any formatting. (My original idea was to write a "parser" of sorts that would insert the appropriate control code to "close" unmatched formatting, but then I remembered that the "reset" 0x0F exists and it was Good Enough™.) Future revisions could gain a little more efficiency on the wire by only adding the reset character if the text contains an unmatched formatting code (but that quickly devolves into diminishing returns, so it's likely not worth doing unless someone gets *really* bored).
dgw
force-pushed
the
choose-preserve-formatting
branch
from
967f747
to
078c4ac
Compare
|
Should be all fixed, or at least the full |
Exirel
reviewed
Oct 19, 2020
Exirel
approved these changes
Oct 19, 2020
Co-authored-by: Exirel <florian.strzelecki@gmail.com>
|
I'm going to stop messing with this now. 23 passing + 8 xfail test cases is enough for this one silly little function. 😛 |
dgw
force-pushed
the
choose-preserve-formatting
branch
from
0c763cf
to
c89fa55
Compare
Because Python doesn't have a static type system.
dgw
force-pushed
the
choose-preserve-formatting
branch
from
c89fa55
to
582baad
Compare
Yeah, that didn't happen. But I'm really done now. CI passed on all versions this time! |
Exirel
approved these changes
Oct 23, 2020
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
Briefly, this resolves #1877. No longer will unterminated formatting, or leading/trailing formatting characters, cause formatting issues in the
.choosecommand's output.The custom "strip"/"cleanup" function that makes it all possible comes replete with
162023 passing cases and 8 expect-fail cases for future enhancements—though I'm sure there are weird cases I haven't covered with the existing test params. Suggestions welcome, and/or we can just see what breaks once this hits the wild.Checklist
make qa(runsmake qualityandmake test)