Make it possible to serialize models

src/aiochris/link/linked.py

@@ -82,14 +82,35 @@ def mark_to_check(mcs, method: Callable, link_name: str) -> None:
         setattr(method, mcs.__DECORATED_METHOD_MARK, link_name)
 
 
-@serde.deserialize
+_S = TypeVar("_S")
+
+
+def _deserialize_noop_hack(s: _S) -> _S:
+    setattr(s, "_AIOCHRIS_LINKED_DESERIALIZED", True)
+    return s
+
+
+def _skip_hacked(s: any) -> bool:
+    if getattr(s, "_AIOCHRIS_LINKED_DESERIALIZED"):
+        return False
+    return True
+
+
+@serde.serde
 @dataclasses.dataclass(frozen=True)
 class Linked(abc.ABC, metaclass=LinkedMeta):
     """
     A `Linked` is an object which can make HTTP requests to links from an API.
     """
 
-    s: aiohttp.ClientSession = serde.field(deserializer=lambda s: s)
+    # The functions `_deserialize_noop_hack` and `_skip_hacked`  are used with `serde.field`
+    # so that `s` is included in deserialization, but excluded when serialized.
+    s: aiohttp.ClientSession = serde.field(
+        deserializer=_deserialize_noop_hack,
+        serializer=lambda s: s,
+        skip_if=_skip_hacked,
+    )
+
     max_search_requests: int
     """
     Maximum number of requests to make for pagination.
@@ -103,7 +124,7 @@ def _has_link(cls, name: str) -> bool: ...
     def _get_link(self, name: str) -> yarl.URL: ...
 
 
-@serde.deserialize
+@serde.serde
 @dataclasses.dataclass(frozen=True)
 class LinkedModel(Linked, abc.ABC):
     """

src/aiochris/models/collection_links.py

@@ -1,15 +1,15 @@
 import dataclasses
 import functools
+from collections.abc import Iterator
 from dataclasses import dataclass
 from typing import Optional
-from collections.abc import Iterator
 
-from serde import deserialize
+from serde import serde
 
 from aiochris.types import ApiUrl, UserUrl, AdminUrl
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class AbstractCollectionLinks:
     @classmethod
@@ -33,7 +33,7 @@ def _dict(self) -> dict[str, str]:
         return dataclasses.asdict(self)
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class AnonymousCollectionLinks(AbstractCollectionLinks):
     chrisinstance: ApiUrl
@@ -52,7 +52,7 @@ class AnonymousCollectionLinks(AbstractCollectionLinks):
     pipeline_instances: Optional[ApiUrl]  # removed in CUBE version 6
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class CollectionLinks(AnonymousCollectionLinks):
     user: UserUrl
@@ -70,13 +70,13 @@ def useruploadedfiles(self) -> ApiUrl:
         return self.userfiles
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class AdminCollectionLinks(CollectionLinks):
     admin: AdminUrl
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class AdminApiCollectionLinks(AbstractCollectionLinks):
     compute_resources: ApiUrl

src/aiochris/models/data.py

@@ -9,14 +9,14 @@
 import datetime
 from typing import Optional
 
-from serde import deserialize
+from serde import serde
 
 from aiochris.link.linked import LinkedModel
 from aiochris.enums import PluginType, Status
 from aiochris.types import *
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class UserData:
     """A *CUBE* user."""
@@ -28,7 +28,7 @@ class UserData:
 
 
 # TODO It'd be better to use inheritance instead of optionals
-@deserialize
+@serde
 @dataclass(frozen=True)
 class PluginInstanceData(LinkedModel):
     """
@@ -90,7 +90,7 @@ class PluginInstanceData(LinkedModel):
     """
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class FeedData(LinkedModel):
     url: FeedUrl
@@ -116,7 +116,7 @@ class FeedData(LinkedModel):
     plugin_instances: PluginInstancesUrl
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class FeedNoteData(LinkedModel):
     url: FeedUrl

src/aiochris/models/logged_in.py

@@ -6,27 +6,27 @@
 
 import asyncio
 import time
+from collections.abc import Sequence
 from dataclasses import dataclass
 from typing import Optional
-from collections.abc import Sequence
 
-from serde import deserialize
+from serde import serde
 
+from aiochris.enums import PluginType, Status
 from aiochris.link import http
 from aiochris.link.linked import LinkedModel
 from aiochris.models.data import PluginInstanceData, FeedData, UserData, FeedNoteData
-from aiochris.enums import PluginType, Status
 from aiochris.models.public import PublicPlugin
 from aiochris.types import *
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class User(UserData, LinkedModel):
     pass  # TODO change_email, change_password
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class File(LinkedModel):
     """
@@ -59,7 +59,7 @@ def parent(self) -> str:
     # TODO download methods
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class PACSFile(File):
     """
@@ -86,7 +86,7 @@ class PACSFile(File):
     pacs_identifier: str
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class PluginInstance(PluginInstanceData):
     @http.get("feed")
@@ -158,7 +158,7 @@ async def wait(
         return (time.monotonic_ns() - start) / 1e9, cur
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class FeedNote(FeedNoteData):
     @http.get("feed")
@@ -174,7 +174,7 @@ async def set(
         ...
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class Feed(FeedData):
     """
@@ -201,7 +201,7 @@ async def set(
     async def get_note(self) -> FeedNote: ...
 
 
-@deserialize
+@serde
 @dataclass(frozen=True)
 class Plugin(PublicPlugin):
     """

src/aiochris/models/public.py

@@ -7,7 +7,6 @@
 from typing import Optional, Literal, TextIO
 
 import serde
-from serde import deserialize
 
 from aiochris.enums import PluginType
 from aiochris.link import http
@@ -16,7 +15,7 @@
 from aiochris.util.search import Search
 
 
-@deserialize
+@serde.serde
 @dataclass(frozen=True)
 class ComputeResource:
     url: ApiUrl
@@ -30,7 +29,7 @@ class ComputeResource:
     max_job_exec_seconds: int
 
 
-@deserialize
+@serde.serde
 @dataclass(frozen=True)
 class PluginParameter(LinkedModel):
     """
@@ -51,7 +50,7 @@ class PluginParameter(LinkedModel):
     plugin: PluginUrl
 
 
-@deserialize
+@serde.serde
 @dataclass(frozen=True)
 class PublicPlugin(LinkedModel):
     """

src/aiochris/util/search.py

@@ -1,5 +1,6 @@
 import copy
 import logging
+from collections.abc import AsyncIterable, AsyncIterator, AsyncGenerator
 from dataclasses import dataclass
 from typing import (
     Optional,
@@ -8,25 +9,24 @@
     Any,
     Generic,
 )
-from collections.abc import AsyncIterable, AsyncIterator, AsyncGenerator
 
 import yarl
-from serde import deserialize
+from serde import serde
 from serde.json import from_json
 
-from aiochris.link.linked import deserialize_linked, Linked
 from aiochris.errors import (
     BaseClientError,
     raise_for_status,
     NonsenseResponseError,
 )
+from aiochris.link.linked import deserialize_linked, Linked
 
 logger = logging.getLogger(__name__)
 
 T = TypeVar("T")
 
 
-@deserialize
+@serde
 class _Paginated:
     """
     Response from a paginated endpoint.

tests/test_client.py

@@ -4,6 +4,7 @@
 from typing import Callable, Awaitable
 
 import pytest
+import serde
 from aiohttp.client_exceptions import ClientConnectorError
 
 import tests.examples.plugin_description as example_descriptions
@@ -143,6 +144,15 @@ async def test_added_plugin(
     assert plinst.compute_resource_name == new_compute_resource.name
 
 
+async def test_serialize(dircopy_instance: PluginInstance):
+    """
+    Make sure it's possible to use `serde.to_dict` on models.
+    """
+    serialized = serde.to_dict(dircopy_instance)
+    assert not hasattr(serialized, "s")
+    assert serialized["id"] == dircopy_instance.id
+
+
 async def test_add_plugin_compute_resources_serialization(
     new_compute_resource: ComputeResource,
 ):