fix(icij-common): serialize registered name

Author: ClemDoum

icij-common/icij_common/registrable.py

@@ -136,11 +136,7 @@ def list_available(cls) -> list[str]:
     @classmethod
     @property
     def registered_name(cls) -> str:
-        for (
-            names
-        ) in (
-            RegistrableMixin._registered_names.values()
-        ):  # pylint: disable=protected-access
+        for names in RegistrableMixin._registered_names.values():  # pylint: disable=protected-access
             name = names.get(cls)
             if name is not None:
                 return name
@@ -169,6 +165,20 @@ def deserialize_with_registry_key(
             return handler(value)
         return handler(value)
 
+    @model_serializer(mode="wrap")
+    def serialize_with_registry_key(
+        self,
+        handler: SerializerFunctionWrapHandler,
+        info: SerializationInfo,  # pylint: disable=unused-argument
+    ) -> dict:
+        data = handler(self)
+        registry_key = self.__class__.registry_key.default
+        registry_value = getattr(self, registry_key)
+        if isinstance(registry_value, FieldInfo):
+            registry_value = registry_value.default
+        data[registry_key] = registry_value
+        return data
+
 
 class RegistrableSettings(RegistrableConfig, BaseSettings):
     model_config = merge_configs(

icij-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "icij-common"
-version = "0.8.0"
+version = "0.8.1"
 description = "Common utils for ICIJ libs"
 authors = [
     { name = "Clément Doumouro", email = "cdoumouro@icij.org" },

icij-common/tests/test_registerable.py

@@ -134,3 +134,26 @@ def _from_config(cls, config: RegistrableConfig, **extras) -> Registered:
     assert isinstance(instance, Registered)
 
     assert instance.some_attr == "some_value"
+
+
+def test_serialize_with_registry_key() -> None:
+    # Given
+
+    class _MockedBaseClassConfig(RegistrableConfig):
+        registry_key: ClassVar[str] = Field(frozen=True, default="some_key")
+
+    class _MockConfig(_MockedBaseClassConfig):
+        some_key: ClassVar[str] = Field(frozen=True, default="registered")
+        some_attr: str
+
+    instance_config = _MockConfig(some_attr="some_value")
+
+    # When
+    serialized = instance_config.model_dump_json(indent=2)
+
+    # Then
+    expected = """{
+  "some_attr": "some_value",
+  "some_key": "registered"
+}"""
+    assert serialized == expected