Refactor Speakers dataclass and client to use similar hook setup

Author: RutgerRauws

notubiz/api/_hooks_registry.py

@@ -1,10 +1,12 @@
 from notubiz.api.dataclasses import Event, event_hook
 from notubiz.api.dataclasses import Meeting, meeting_hook
 from notubiz.api.dataclasses import AgendaItem, agenda_item_hook
-#from notubiz.api.dataclasses import Speakers, speakers_nook
+from notubiz.api.dataclasses import Speakers, Speaker, speakers_hook, speaker_hook
 
 Hooks = {
     Event: event_hook,
     Meeting: meeting_hook,
-    AgendaItem: agenda_item_hook
+    AgendaItem: agenda_item_hook,
+    Speakers: speakers_hook,
+    Speaker: speaker_hook
 }

notubiz/api/clients/speakers_client.py

@@ -1,5 +1,6 @@
 from notubiz.api_client import ApiClient
 from notubiz.api.dataclasses import Speakers
+from notubiz.api._converter import get_converter
 
 class SpeakersClient:
     api_client : ApiClient
@@ -9,4 +10,4 @@ def __init__(self, api_client : ApiClient):
 
     def get(self) -> Speakers:
         json_object = self.api_client.get("speakers")
-        return Speakers.from_json(json_object)
+        return get_converter().structure(json_object, Speakers)

notubiz/api/dataclasses/__init__.py

@@ -3,4 +3,4 @@
 from notubiz.api.dataclasses.assembly import Assembly
 from notubiz.api.dataclasses.document import Document
 from notubiz.api.dataclasses.agenda_item import AgendaItem, agenda_item_hook
-from notubiz.api.dataclasses.speakers import Speaker, Speakers # TODO: refactor with speaker_hook
+from notubiz.api.dataclasses.speakers import Speakers, Speaker, speakers_hook, speaker_hook

notubiz/api/dataclasses/speakers.py

@@ -1,17 +1,19 @@
-from attrs import define
-import cattrs
-from cattrs import transform_error
-from cattrs.gen import make_dict_unstructure_fn, make_dict_structure_fn, override
+from attrs import define, field
+from cattr import Converter
+from datetime import datetime
+
+from notubiz.api._helpers import parse_date
 
 @define
 class SpeakerAttributes:
     id: int
     person_id: int
     active: int
-    last_modified: str
+    last_modified: datetime
 
 @define
 class Speaker:
+    # Auto-filled
     photo: str
     party: str
     email: str
@@ -21,11 +23,25 @@ class Speaker:
     sex: str
     function: str
     url: str
-    attributes: SpeakerAttributes
+
+    # Manually filled
+    attributes: SpeakerAttributes = field(init=False)
 
     def full_name(self):
         return self.firstname + " " + self.lastname
 
+def speaker_hook(data: dict[str, any], cls: type) -> Speaker:
+    # Auto-fill fields
+    converter = Converter()    
+    converter.register_structure_hook(datetime, lambda date_string, _: parse_date(date_string))
+    
+    speaker = converter.structure(data, cls)
+
+    # Manually add some fields
+    speaker.attributes = converter.structure(data.get("@attributes", {}), SpeakerAttributes)
+
+    return speaker
+
 @define
 class Speakers:
     speakers: list[Speaker]
@@ -45,24 +61,12 @@ def find_by_person_id(self, person_id : int):
 
         return None
 
-    @staticmethod
-    def from_json(json_object : any) -> 'Speakers':
-        c = cattrs.Converter()
-
-        unst_hook = make_dict_unstructure_fn(Speakers, c, speakers=override(rename="speaker"))
-        st_hook = make_dict_structure_fn(Speakers, c, speakers=override(rename="speaker"))
-        c.register_unstructure_hook(Speakers, unst_hook)
-        c.register_structure_hook(Speakers, st_hook)
+def speakers_hook(data: dict[str, any], cls: type) -> Speakers:
+    speakers_json_arary = data["speakers"]["speaker"]
 
-        unst_hook = make_dict_unstructure_fn(Speaker, c, attributes=override(rename="@attributes"))
-        st_hook = make_dict_structure_fn(Speaker, c, attributes=override(rename="@attributes"))
-        c.register_unstructure_hook(Speaker, unst_hook)
-        c.register_structure_hook(Speaker, st_hook)
+    c = Converter()
+    c.register_structure_hook(Speaker, speaker_hook)
 
-        try:
-            speakers = c.structure(json_object["speakers"], Speakers)
-        except Exception as exc:
-            print("\n".join(transform_error(exc)))
-            quit()
+    speakers = [c.structure(speaker_json, Speaker) for speaker_json in speakers_json_arary]
 
-        return speakers
+    return Speakers(speakers)

test/test_speakers.py

@@ -3,17 +3,18 @@
 
 import pytest
 from test.helpers import read_json
+from notubiz.api._converter import get_converter
 
 @pytest.fixture(scope="session")
 def input_json():
     return read_json("./test/data/speakers.json")
 
 @pytest.fixture(scope="session")
-def input_speakers():
-    return Speakers.from_json(read_json("./test/data/speakers.json"))
+def input_speakers(input_json):
+    return get_converter().structure(input_json, Speakers)
 
 def test_deserialization(input_json):
-    speakers = Speakers.from_json(input_json).speakers
+    speakers = get_converter().structure(input_json, Speakers).speakers
 
     # Let's not test the entire attrs/cattrs package. 
     # The serialization did not throw an exception if we reach these lines