New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
More privatization, and some error helpers #2976
More privatization, and some error helpers #2976
Conversation
After some feedback from various cog creators in the discord server, there should be a few more things exposed in this PR prior to it being merged. Will be adding those soon |
This now has all the changes planned for this PR. Some of the attributes related to help formatting should also be exposed, but this should be done with the design concerns of #2981 in mind, likely as part of those changes. |
This makes a lot more things private. Continued from #2967, fixes #2984 Adds public methods for various things. Below is a brief summary of things available elsewhere, though this particular set of changes may warrant a detailed section in the release notes. - bot.db.locale -> redbot.core.i18n.get_locale - Note: This one already existed. - bot.db.help -> redbot.core.commands.help.HelpSettings - bot db whitelist/blaclist? -> bot.allowed_by_whitelist_blacklist - This has also been made a single cannonical function for this purpose including check usage - bot color? -> bot.get_embed_color/bot.get_embed_colour - bot.id.api_tokens? -> - bot.get_shared_api_tokens - bot.set_shared_api_tokens - bot.remove_shared_api_tokens -bot.db.prefix -> bot.get_valid_prefixes - (Note: This is a wrapper around bot.get_prefix) Other changes include - removing `bot.counter` as it was never used anywhere - Adding properties with helpful error messages for moved and renamed things - making bot.uptime a property with an error on set - adding a migration to the bot config for shared_api_tokens
…n in dev if you cant manage it
Everything appears to work but I didn't do extensive edge case testing nor do I understand the internals to see any implications of these changes. I've included some recommendations for some changes to docstrings and other UX.
EDIT: Nvm, I just saw #3019 |
Type
Description of the changes
This makes a lot more things private. Continued from #2967, fixes #2984
Adds public methods for various things.
Below is a brief summary of things available elsewhere, though this
particular set of changes may warrant a detailed section in the release notes.
bot.db.locale -> redbot.core.i18n.get_locale
bot.db.help -> redbot.core.commands.help.HelpSettings
bot db whitelist/blacklist? -> bot.allowed_by_whitelist_blacklist
bot color? -> bot.get_embed_color/bot.get_embed_colour
bot.id.api_tokens? ->
-bot.db.prefix -> bot.get_valid_prefixes
Other changes include
bot.counter
as it was never used anywhere