Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ORM: Fix deprecation warning being shown for new code types #6407

Merged
merged 1 commit into from
May 21, 2024
Merged

ORM: Fix deprecation warning being shown for new code types #6407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/aiida/orm/nodes/data/code/installed.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
class InstalledCode(Code):
"""Data plugin representing an executable code on a remote computer."""

_EMIT_CODE_DEPRECATION_WARNING: bool = False
_KEY_ATTRIBUTE_FILEPATH_EXECUTABLE: str = 'filepath_executable'

class Model(AbstractCode.Model):
Expand Down
18 changes: 11 additions & 7 deletions src/aiida/orm/nodes/data/code/legacy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,17 @@ class Code(AbstractCode):
def __init__(self, remote_computer_exec=None, local_executable=None, input_plugin_name=None, files=None, **kwargs):
super().__init__(**kwargs)

warn_deprecation(
'The `Code` class is deprecated. To create an instance, use the '
'`aiida.orm.nodes.data.code.installed.InstalledCode` or `aiida.orm.nodes.data.code.portable.PortableCode` '
'for a "remote" or "local" code, respectively. If you are using this class to compare type, e.g. in '
'`isinstance`, use `aiida.orm.nodes.data.code.abstract.AbstractCode`.',
version=3,
)
# The ``_EMIT_CODE_DEPRECATION_WARNING`` attribute is set in subclasses to avoid the deprecation message below
# is also shown when they are instantiated, since they are not deprecated.
if getattr(self, '_EMIT_CODE_DEPRECATION_WARNING', True):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

warn_deprecation(
'The `Code` class is deprecated. To create an instance, use the '
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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. 🤷

'`aiida.orm.nodes.data.code.installed.InstalledCode` or '
'`aiida.orm.nodes.data.code.portable.PortableCode` for a "remote" or "local" code, respectively. If '
'you are using this class to compare type, e.g. in '
'`isinstance`, use `aiida.orm.nodes.data.code.abstract.AbstractCode`.',
version=3,
)

if remote_computer_exec and local_executable:
raise ValueError('cannot set `remote_computer_exec` and `local_executable` at the same time')
Expand Down
1 change: 1 addition & 0 deletions src/aiida/orm/nodes/data/code/portable.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@
class PortableCode(Code):
"""Data plugin representing an executable code stored in AiiDA's storage."""

_EMIT_CODE_DEPRECATION_WARNING: bool = False
_KEY_ATTRIBUTE_FILEPATH_EXECUTABLE: str = 'filepath_executable'

class Model(AbstractCode.Model):
Expand Down
Loading