add get_job, pause_job and resume_job methods plus minor adjustments #852
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
Hi! As discussed in the last dev meeting, I propose adding some methods to the
WhiteRabbit
class to finalize the excellent work by @jacopopalumbo01 and provide a complete and useful API wrapping APScheduler features. The added methods are:get_job
: Returns a dictionary of a single scheduled job.pause_job
: Temporarily pauses a scheduled job.resume_job
: Resumes a paused job.Additionally, I have made some minor adjustments for type hinting and corrected comment typos. I have replaced every
id
reference withjob_id
to avoid shadowing built-in names. However, if we consider this a breaking change, we can restoreid
.Regarding other features, I think we are covering most use cases, but APScheduler also provides for a concatenation of triggers, which could be really interesting in situations where triggers are complex:
Currently we need to access the inner scheduler to achieve something like that, it would be nice to provide a simple API also in the WhiteRabbit class.
Related to issue #839
Type of change
Checklist: