Add deprecation warnings to results classes and methods #15323
Merged
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
CodSpeed Performance ReportMerging #15323 will not alter performanceComparing Summary
|
desertaxle
commented
Sep 11, 2024
Comment on lines
+759
to
765
| @deprecated.deprecated_callable( | ||
| start_date="Sep 2024", | ||
| end_date="Nov 2024", | ||
| help="Use `create_result_record` instead.", | ||
| ) | ||
| @sync_compatible | ||
| async def create_result( |
There was a problem hiding this comment.
Deprecation warning for create_reuslt
desertaxle
commented
Sep 11, 2024
Comment on lines
+1106
to
1109
| @deprecated.deprecated_class( | ||
| start_date="Sep 2024", end_date="Nov 2024", help="Use `ResultRecord` instead." | ||
| ) | ||
| class PersistedResult(BaseResult): |
There was a problem hiding this comment.
Deprecation warning for PersistedResult
desertaxle
commented
Sep 11, 2024
Comment on lines
+1053
to
1057
| @deprecated.deprecated_class( | ||
| start_date="Sep 2024", end_date="Nov 2024", help="Use `ResultRecord` instead." | ||
| ) | ||
| @register_base_type | ||
| class BaseResult(BaseModel, abc.ABC, Generic[R]): |
There was a problem hiding this comment.
Deprecation warning for BaseResult
desertaxle
commented
Sep 11, 2024
Comment on lines
+15
to
+36
| def should_reraise_warning(warning): | ||
| """ | ||
| Determine if a deprecation warning should be reraised based on the date. | ||
|
|
||
| Deprecation warnings that have passed the date threshold should be reraised to | ||
| ensure the deprecated code paths are removed. | ||
| """ | ||
| message = str(warning.message) | ||
| try: | ||
| # Extract the date from the new message format | ||
| date_str = message.split("not be available in new releases after ")[1].strip( | ||
| "." | ||
| ) | ||
| # Parse the date | ||
| deprecation_date = datetime.strptime(date_str, "%b %Y").date().replace(day=1) | ||
|
|
||
| # Check if the current date is after the start of the month following the deprecation date | ||
| current_date = datetime.now().date().replace(day=1) | ||
| return current_date > deprecation_date | ||
| except Exception: | ||
| # Reraise in cases of failure | ||
| return True |
There was a problem hiding this comment.
I added this check to know when the deprecated code is ready to be removed. As a result, code path that raise deprecation warnings in tests will need to use the ignore_prefect_deprecation_warnings fixture directly.
desertaxle
added
the
development
cicdw
approved these changes
Sep 11, 2024
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.
This PR adds deprecation warning to following because they have been superseded by new results mechanics:
ResultStore.create_resultBaseResultPersistedResultThis PR also updates our testing logic to fail whenever a
PrefectDeprecationWarningis raised. A fixtureignore_prefect_deprecation_warningscan suppress failures until the deprecation period has passed. Once the deprecation period has passed, the warnings will cause test failures again, prompting us to remove the deprecated code.Related to #15208
Checklist
<link to issue>"mint.json.