Make untranslated a positional-only argument in Translator().
#6643
Conversation
This file contains hidden or 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
github-actions
bot
added
the
Category: Core - i18n
This commit changes the signature of
`redbot.core.i18n.Translator.__call__()` from `self, untranslated: str`
to `self, untranslated: str, /`, making `untranslated` a positional-only
argument.
This works around an issue in `redgettext`, where using `_("text")`
works fine, but `_(untranslated="text")` causes `untranslated=` to be
detected as an unexpected token. Considering this function is a
single-argument function, and nothing would be gained from using the
keyword argument, I believe marking it as positional-only is the correct
solution, rather than making a change in `redgettext`. This is
technically a breaking change though.
This also has the small but notable side effect of removing
`untranslated=` from calls in editors that show inline keyword
arguments, such as basedpyright's
`basedpyright.analysis.inlayHints.callArgumentNames` VSCode setting, or
similar settings in other extensions. This cuts down on wasted space in
the editor without disabling an otherwise useful feature.
See the related discussion in
[`#coding`](https://discord.com/channels/133049272517001216/160386989819035648/1453030635756191866).
cswimr
force-pushed
the
translator-kwarg
branch
from
0ec54b4 to
a0a70e3
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 of the changes
This PR changes the signature of
redbot.core.i18n.Translator.__call__()fromself, untranslated: strtoself, untranslated: str, /, makinguntranslateda positional-only argument.This works around an issue in
redgettext, where using_("text")works fine, but_(untranslated="text")causesuntranslated=to be detected as an unexpected token. Considering this function is a single-argument function, and nothing would be gained from using the keyword argument, I believe marking it as positional-only is the correct solution, rather than making a change inredgettext. This is technically a breaking change though.This also has the small but notable side effect of removing
untranslated=from calls in editors that show inline keyword arguments, such as basedpyright'sbasedpyright.analysis.inlayHints.callArgumentNamesVSCode setting, or similar settings in other extensions. This cuts down on wasted space in the editor without disabling an otherwise useful feature.See the related discussion in
#coding.Have the changes in this PR been tested?
Yes