CLN: Collect deprecations in same function #589
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
| ) | ||
|
|
||
| if self.grid_model: | ||
| warn( | ||
| "The 'grid_model' key has currently no function. It will be evaluated " | ||
| "for removal in fmu-dataio version 2.", | ||
| PendingDeprecationWarning, | ||
| UserWarning, |
There was a problem hiding this comment.
Do we know that UserWarning is visible to the user...? Ref discussions
There was a problem hiding this comment.
After chatting with chatGPT 😄 I believe it will
Yes, if you have a warnings.warn("message", UserWarning) call in the init method of your class, and a user imports your class into their Python script and creates an instance of the class, they will see the warning when they run the script, unless they have specifically configured the warnings system to suppress it.
There was a problem hiding this comment.
OK :) We can also confirm once this is deployed to RMS, I guess
perolavsvendsen
approved these changes
Apr 10, 2024
tnatt
added a commit
to tnatt/fmu-dataio
that referenced
this pull request
Apr 10, 2024
tnatt
added a commit
to tnatt/fmu-dataio
that referenced
this pull request
Apr 10, 2024
tnatt
added a commit
to tnatt/fmu-dataio
that referenced
this pull request
Apr 10, 2024
tnatt
added a commit
to tnatt/fmu-dataio
that referenced
this pull request
Apr 10, 2024
tnatt
added a commit
to tnatt/fmu-dataio
that referenced
this pull request
Apr 10, 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.
PR to move deprecations present in ExportData init to the
_show_deprecations_or_notimplementedfunction.Also changed two
PendingDeprecationWarningstoUserWarningsFutureWarningbut since the features already are deprecated and the argument has no effect, it felt more natural to give aUserWarning