Update Job.get_status and Job.restore to consistently return JobStatus Enum #2039
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2039 +/- ##
==========================================
+ Coverage 93.61% 93.76% +0.14%
==========================================
Files 28 29 +1
Lines 3758 3863 +105
==========================================
+ Hits 3518 3622 +104
- Misses 240 241 +1 ☔ View full report in Codecov by Sentry. |
selwin
reviewed
Feb 13, 2024
rq/job.py
Outdated
| return None | ||
|
|
||
| def get_status(self, refresh: bool = True) -> JobStatus: | ||
| def get_status(self, refresh: bool = True) -> Optional[JobStatus]: |
There was a problem hiding this comment.
I think get_status() should always returns something. If the job hash in Redis has no status, raise an exception.
There was a problem hiding this comment.
Thank you for the note. I updated it to raise an exception if there's no status in Redis. I added a status=JobStatus.QUEUED to a few Job.create calls in other tests so that they wouldn't fail as a result. I don't think this changed the purpose or accuracy of those tests.
selwin
reviewed
Mar 4, 2024
| status = self.connection.hget(self.key, 'status') | ||
| self._status = as_text(status) if status else None | ||
| if not status: | ||
| raise InvalidJobOperation(f"Failed to retrieve status for job: {self.id}") |
There was a problem hiding this comment.
Mind updating the test to test this code path so it can pass Codecov's test?
|
Thanks! |
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Nov 8, 2024
…alidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]>
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Nov 8, 2024
* feat: test for Python 3.12 * feat: packages for Python 3.12 * fix: called_once_with should be assert_called_once_with Signed-off-by: F.N. Claessen <[email protected]> * fix: don't assert assert_method Signed-off-by: F.N. Claessen <[email protected]> * docs: changelog entry Signed-off-by: F.N. Claessen <[email protected]> * docs: add Python 3.12 classifier in setup.py Signed-off-by: F.N. Claessen <[email protected]> * fix: getting the status of a not yet queued job now results in an InvalidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]> --------- Signed-off-by: F.N. Claessen <[email protected]>
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Nov 8, 2024
* feat: test for Python 3.12 * feat: packages for Python 3.12 * fix: called_once_with should be assert_called_once_with Signed-off-by: F.N. Claessen <[email protected]> * fix: don't assert assert_method Signed-off-by: F.N. Claessen <[email protected]> * docs: changelog entry Signed-off-by: F.N. Claessen <[email protected]> * docs: add Python 3.12 classifier in setup.py Signed-off-by: F.N. Claessen <[email protected]> * fix: getting the status of a not yet queued job now results in an InvalidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]> --------- Signed-off-by: F.N. Claessen <[email protected]> (cherry picked from commit faf7f55) Signed-off-by: F.N. Claessen <[email protected]>
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Nov 17, 2024
…alidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]>
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Nov 17, 2024
… in MW (#1234) * feat: `flexmeasures add sensor` no longer requires setting a capacity in MW Signed-off-by: F.N. Claessen <[email protected]> * docs: changelog entry Signed-off-by: F.N. Claessen <[email protected]> * docs: CLI changelog entry Signed-off-by: F.N. Claessen <[email protected]> * fix: getting the status of a not yet queued job now results in an InvalidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]> * docs: explain abbreviation used in changelog Signed-off-by: F.N. Claessen <[email protected]> * docs: fix typo Signed-off-by: F.N. Claessen <[email protected]> * docs: format CLI option and correct nomenclature (a flag is a boolean option, which this isn't) Signed-off-by: F.N. Claessen <[email protected]> --------- Signed-off-by: F.N. Claessen <[email protected]>
This was referenced Nov 22, 2024
Flix6x
added a commit
to FlexMeasures/flexmeasures
that referenced
this pull request
Jan 17, 2025
… in MW (#1234) * feat: `flexmeasures add sensor` no longer requires setting a capacity in MW Signed-off-by: F.N. Claessen <[email protected]> * docs: changelog entry Signed-off-by: F.N. Claessen <[email protected]> * docs: CLI changelog entry Signed-off-by: F.N. Claessen <[email protected]> * fix: getting the status of a not yet queued job now results in an InvalidJobOperation; see rq/rq#2039 Signed-off-by: F.N. Claessen <[email protected]> * docs: explain abbreviation used in changelog Signed-off-by: F.N. Claessen <[email protected]> * docs: fix typo Signed-off-by: F.N. Claessen <[email protected]> * docs: format CLI option and correct nomenclature (a flag is a boolean option, which this isn't) Signed-off-by: F.N. Claessen <[email protected]> --------- Signed-off-by: F.N. Claessen <[email protected]> (cherry picked from commit 772f73e)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I wrote up what I found in issue #2038, so I though I should create a PR with my suggested fixes.