privileges, plugin, tools.target, docs: channel privileges as IntFlag #2540
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
Exirel
approved these changes
Nov 1, 2023
SnoopJ
approved these changes
Nov 2, 2023
I figure getting "rewrite sopel/privileges.py (97%)" is the most justified I'll ever be in my life for adding a copyright comment. :D
The history and brief overview of how IRC privileges work is not part of the module/class documentation. It's more appropriate to explain in the doc page about privileges as a general concept.
Super-duper deemphasized that privileges are integer values. Removed the actual values from code examples, to show logic only. Condensed admonitions about nonstandard privilege levels/modes into a single location, with cross-references.
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
Rather than have someone open an issue, I decided to Just Do It. I realized that the time to change how these constants are defined/accessed is now, as they've been moved to a new location but the new location hasn't appeared in a release yet. After we release 8.0, it would be that much more painful to change this a second time.
I'm open to bikeshedding on the class name here. If nothing else, maybe it should be plural to match
sopel.formatting.colors. I'm keeping in mind the fact that we keep thinking about better access controls on bot functions, and other stuff that might also logically have constants living insopel.privileges.AccessLevelis perhaps not the most future-proof choice for avoiding ambiguity. Other ideas included just plainLevel,Channel,ChannelPrivilege,ChanPriv, and a few more I forgot.If we do this, the type annotation changes in
pluginwill resolve #2538. Decorators that take this type will link to it in their function signatures' type annotations:Checklist
make qa(runsmake lintandmake test)Notes
Honestly,
privileges.Channelmade the most sense to me as far as a future collection of different kinds of privileges went. Having two different types namedChannel—here, and intools.target—sounds like a terrible idea in the long term, though.tools.target.Channeleven has logic to manipulate the hypotheticalprivileges.Channeltype. Getting into "wait, which kind ofChannelis this?" sounded very not-fun.