docs: add advanced tip about scheduling function calls #2617
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
We learned why replicating the API of another library sucks back when `sopel.web` contained wrappers for various tools from `requests`, and we don't want to do it again. Setting up a scheduler for one's plugin doesn't take a lot of work. It's not ideal for multiple plugins to all have their own `interval` checks for whether there are any pending tasks to run, but we can drop this new section from the docs if we find a decent compromise.
This appears to have been fixed as part of the big rule-system rewrite
back in 7.1. The rule system now also considers the *start* time of the
callable's most recent run in the given context, if it hasn't finished
running since the last time it was started.
I also tested this with a very basic plugin:
import sched
import time
from sopel import plugin
s = sched.scheduler(time.time, time.sleep)
@plugin.rate(60)
@plugin.command('testrate')
def rate_limited(bot, trigger):
s.enter(30, 2, bot.say, argument=('hi',))
s.run()
Despite trying to run `.testrate` three times in a few seconds, as a non
admin user, the bot only said "hi" once.
dgw
added
Low Priority
Documentation
Housekeeping
Exirel
approved these changes
Sep 2, 2024
|
Ramping up to 8.0.1 soon, don't see why this should be held back for 8.1. |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
How to do this was discussed fairly well in #1222 a while ago, and I just cribbed an example from there.
I also found an apparently obsolete note about using
schedwith@plugin.rateand friends while poking around the topic of scheduled callables, because I tested what it said and found that the caveat no longer applies (see #825).Checklist
make qa(runsmake lintandmake test)Notes
Along the way I also briefly considered giving the
botascheduleinstance that it provides to plugins, but I'm not ready to commit to that kind of API addition yet. Putting this into the tips & tricks section is better than pointing to a random issue comment on the occasions when "how do I schedule a function at a specific time?" comes up, and it doesn't preclude API additions at a later time if we come up with a sane decorator interface for it.