ORM: Fix deprecation warning being shown for new code types #6407
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
|
This seems to do the trick. Credits to @giovannipizzi I remember him mentioning an approach like this somewhere sometime ago. |
danielhollas
approved these changes
May 21, 2024
| '`isinstance`, use `aiida.orm.nodes.data.code.abstract.AbstractCode`.', | ||
| version=3, | ||
| ) | ||
| if getattr(self, '_EMIT_CODE_DEPRECATION_WARNING', True): |
There was a problem hiding this comment.
Just for my own understanding; why do we need to use getattr instead accessing via self directly?
Ah, took me a while to understand, this is evil. :D The trick is that this attribute is only defined in child classes, right? Maybe a comment explaining this trick is warranted here.
| ) | ||
| if getattr(self, '_EMIT_CODE_DEPRECATION_WARNING', True): | ||
| warn_deprecation( | ||
| 'The `Code` class is deprecated. To create an instance, use the ' |
There was a problem hiding this comment.
This warning might be a bit confusing if it's printed when user tries to create Code via CLI. At the same time the text is already long. 🤷
The `InstalledCode` and `PortableCode` have been introduced already some time ago as the refactored version of the legacy `Code` class. The latter has been deprecated for that reason, but for backwards compatibility reasons, the new implementations still need to keep the legacy class as a base class. Unfortunately, this meant that the deprecation warning was also shown when users instantiated an instance of the new classes, which would be confusing. The deprecation warning had already been moved from module level to the constructor of the `Code` class to prevent it from showing merely upon import of the `aiida.orm` package. As a final work around, the new classes define the `_EMIT_CODE_DEPRECATION_WARNING` class attribute which is checked in the `Code` constructor such that when set, the deprecation warning is skipped.
sphuber
force-pushed
the
fix/code-deprecation-warning
branch
from
2ced904 to
aaaba67
Compare
mikibonacci
pushed a commit
to mikibonacci/aiida-core
that referenced
this pull request
Sep 3, 2024
…m#6407) The `InstalledCode` and `PortableCode` have been introduced already some time ago as the refactored version of the legacy `Code` class. The latter has been deprecated for that reason, but for backwards compatibility reasons, the new implementations still need to keep the legacy class as a base class. Unfortunately, this meant that the deprecation warning was also shown when users instantiated an instance of the new classes, which would be confusing. The deprecation warning had already been moved from module level to the constructor of the `Code` class to prevent it from showing merely upon import of the `aiida.orm` package. As a final work around, the new classes define the `_EMIT_CODE_DEPRECATION_WARNING` class attribute which is checked in the `Code` constructor such that when set, the deprecation warning is skipped.
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.
The
InstalledCodeandPortableCodehave been introduced already some time ago as the refactored version of the legacyCodeclass. The latter has been deprecated for that reason, but for backwards compatibility reasons, the new implementations still need to keep the legacy class as a base class. Unfortunately, this meant that the deprecation warning was also shown when users instantiated an instance of the new classes, which would be confusing.The deprecation warning had already been moved from module level to the constructor of the
Codeclass to prevent it from showing merely upon import of theaiida.ormpackage. As a final work around, the new classes define the_EMIT_CODE_DEPRECATION_WARNINGclass attribute which is checked in theCodeconstructor such that when set, the deprecation warning is skipped.