bot, loader, plugin, rules: add NOTICE message to rate limits

[Exirel]

Description

Fix #830 by adding an optional message and three new decorators for specific rate limit messages (user, channel, and server).

Checklist

• I have read CONTRIBUTING.md
• I can and do license this contribution under the EFLv2
• No issues are reported by make qa (runs make quality and make test)
• I have tested the functionality of the things this change touches

[dgw]

I haven't dived into the tests yet (there are a lot of them), but there might be enough to discuss already without them.

[dgw]

Yes, I realize some of this could fall in "future PR" territory. One of us can make a tracking issue(s) once we agree on what's out of scope.

[Exirel]

I've modified func.rate into func.user_rate (and many little changes like that).

Also now there are conflicts... I didn't look at them yet.

[dgw]

Merge conflicts are from a bit of CTCP stuff and some type-hint tweaks, AFAICT. Shouldn't be a huge deal to fix up. What's important is, this looks ready to merge so our brave master testers can try to break it in prod. 😁

[dgw]

Hmm, I'm tempted to dismiss my approving review because 1) this isn't squashed/rebased and 2) there actually are unresolved conversations about placeholders and docs. @Exirel take another look this weekend? I don't know when your work trip is done.

Edit, from IRC: 16:15:43 <+Exirel> dgw: I'm too busy up until next week at least.

[Exirel]

1. this isn't squashed/rebased

This part: done. I didn't add anything yet, because I think it would be better for you if you wanted to check the diff between what you approved so far, and what will come next (docstrings, placeholders, etc.).

[Exirel]

Since there's already some support for placeholders, what do you think of adding one for the time remaining until the rate limit expires? It's the main reason that I wished for this feature to be built in, all those years ago.

Regardless of the above, these placeholders don't appear to be documented anywhere.

I'm about to push a commit with just nick for user and global rate limits, nick and channel for channel rate limit.

For other placeholders, I need to think a bit more about it: can we assume the time left will be in seconds, and the rate limit in seconds as well? Like, if the rate limit is something like 60s/3600s, should we be smart about it? Should we provide a human readable version of that? (Using cool functions from tools.time for example?)

This leads me to think that, maybe, I could just commit what I have, and consider this PR "done": anyone could jump into the code and add the new placeholders as they wanted, with a separate/dedicated conversation about it, without all the other diff around.

[dgw]

Looks like a small bit of collateral damage from the rebase happened; see line note.

We can certainly defer adding more kinds of placeholder for a later PR, but I really would like this patch to document the ones that it does add. 🙂

[Exirel]

We can certainly defer adding more kinds of placeholder for a later PR, but I really would like this patch to document the ones that it does add. slightly_smiling_face

I added the proper docstrings, and this little "see also" section in the doc:

[Exirel]

Squashed & rebased, as per @dgw's validation on IRC.

[dgw]

I should probably test this one last time on a real bot before merging, but that doesn't mean I can't approve it first.