Fix the pydantic model for RemoteData (aiidateam#6845)

The `__qb_fields__` has been removed and a `orm_to_model` function has
been added that correctly returns the `remote_path`. Tests have been
added to `test_models.py`.

Author: agoscinski

src/aiida/orm/nodes/data/remote/base.py

@@ -13,10 +13,10 @@
 import logging
 import os
 from pathlib import Path
+from typing import Union
 
 from aiida.common.pydantic import MetadataField
 from aiida.orm import AuthInfo
-from aiida.orm.fields import add_field
 from aiida.transports import Transport
 
 from ..data import Data
@@ -33,25 +33,23 @@ class RemoteData(Data):
     """
 
     KEY_EXTRA_CLEANED = 'cleaned'
-    __qb_fields__ = [
-        add_field(
-            'remote_path',
-            dtype=str,
-        ),
-    ]
 
     class Model(Data.Model):
-        remote_path: str = MetadataField(description='Filepath on the remote computer.')
+        remote_path: Union[str, None] = MetadataField(
+            title='Remote path',
+            description='Filepath on the remote computer.',
+            orm_to_model=lambda node, _: node.get_remote_path(),
+        )
 
-    def __init__(self, remote_path=None, **kwargs):
+    def __init__(self, remote_path: Union[str, None] = None, **kwargs):
         super().__init__(**kwargs)
         if remote_path is not None:
             self.set_remote_path(remote_path)
 
     def get_remote_path(self) -> str:
         return self.base.attributes.get('remote_path')
 
-    def set_remote_path(self, val):
+    def set_remote_path(self, val: str):
         self.base.attributes.set('remote_path', val)
 
     @property
@@ -233,7 +231,7 @@ def get_size_on_disk(
 
         with authinfo.get_transport() as transport:
             if not transport.path_exists(str(full_path)):
-                exc_message = f'The required remote path {full_path} on Computer <{computer_label}> ' 'does not exist.'
+                exc_message = f'The required remote path {full_path} on Computer <{computer_label}> does not exist.'
                 raise FileNotFoundError(exc_message)
 
             if method not in ('du', 'stat'):

tests/orm/models/test_models.py

@@ -21,6 +21,7 @@
     Int,
     JsonableData,
     List,
+    RemoteData,
     SinglefileData,
     Str,
     StructureData,
@@ -48,6 +49,7 @@
     SinglefileData,
     Str,
     StructureData,
+    RemoteData,
 )
 
 
@@ -134,6 +136,8 @@ def required_arguments(request, default_user, aiida_localhost, tmp_path):
         return Str, {'value': 'string'}
     if request.param is StructureData:
         return StructureData, {'cell': [[1, 0, 0], [0, 1, 0], [0, 0, 1]]}
+    if request.param is RemoteData:
+        return RemoteData, {'remote_path': '/some/path', 'computer': aiida_localhost}
 
     raise NotImplementedError()
 

tests/orm/test_fields/fields_aiida.data.core.remote.RemoteData.yml

@@ -10,7 +10,7 @@ mtime: QbNumericField('mtime', dtype=typing.Optional[datetime.datetime], is_attr
 node_type: QbStrField('node_type', dtype=typing.Optional[str], is_attribute=False)
 pk: QbNumericField('pk', dtype=typing.Optional[int], is_attribute=False)
 process_type: QbStrField('process_type', dtype=typing.Optional[str], is_attribute=False)
-remote_path: QbStrField('remote_path', dtype=<class 'str'>, is_attribute=True)
+remote_path: QbStrField('remote_path', dtype=typing.Optional[str], is_attribute=True)
 repository_content: QbDictField('repository_content', dtype=typing.Optional[dict[str,
   bytes]], is_attribute=False)
 repository_metadata: QbDictField('repository_metadata', dtype=typing.Optional[typing.Dict[str,