feat: add stub generic (de)serializer classes

python/ngen_init_config/src/ngen/init_config/__init__.py

@@ -8,13 +8,15 @@
     YamlDeserializer,
     TomlDeserializer,
     JsonDeserializer,
+    GenericDeserializer,
 )
 from .serializer import (
     IniSerializer,
     NamelistSerializer,
     YamlSerializer,
     TomlSerializer,
     JsonSerializer,
+    GenericSerializer,
 )
 
 from .serializer_deserializer import (
@@ -23,4 +25,5 @@
     YamlSerializerDeserializer,
     TomlSerializerDeserializer,
     JsonSerializerDeserializer,
+    GenericSerializerDeserializer,
 )

python/ngen_init_config/src/ngen/init_config/deserializer.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from abc import ABC, abstractmethod
+
 from .core import Base
 from .utils import merge_class_attr
 from ._deserializers import (
@@ -105,3 +107,21 @@ def from_json(cls, p: Path) -> Self:
     @classmethod
     def from_json_str(cls, s: str) -> Self:
         return cls.parse_raw(s)
+
+
+class GenericDeserializer(Base, ABC):
+    """
+    Stub for deserializing from a generic format.
+    Subclasses must implement the `from_file` and `from_str` abstract class methods.
+    See `ngen.init_config.core.Base` and `pydantic`'s documentation for configuration options.
+    """
+
+    @classmethod
+    @abstractmethod
+    def from_file(cls, p: Path, *_) -> Self:
+        ...
+
+    @classmethod
+    @abstractmethod
+    def from_str(cls, s: str, *_) -> Self:
+        ...

python/ngen_init_config/src/ngen/init_config/serializer.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import os
+from abc import ABC, abstractmethod
 
 from . import core, format_serializers, utils
 from typing import TYPE_CHECKING
@@ -146,3 +147,19 @@ def to_json_str(self, *, indent: int = 0) -> str:
         options = {} if not indent else {"indent": indent}
         # remove trailing eol
         return self.json(by_alias=True, **options).rstrip()
+
+
+class GenericSerializer(core.Base, ABC):
+    """
+    Stub for serializing a generic format.
+    Subclasses must implement the `to_file` and `to_str` abstract class methods.
+    See `ngen.init_config.core.Base` and `pydantic`'s documentation for configuration options.
+    """
+
+    @abstractmethod
+    def to_file(self, p: pathlib.Path, *_) -> None:
+        ...
+
+    @abstractmethod
+    def to_str(self, *_) -> str:
+        ...

python/ngen_init_config/src/ngen/init_config/serializer_deserializer.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+from abc import ABC
+
 from . import serializer as ser
 from . import deserializer as de
 
@@ -70,3 +72,13 @@ class JsonSerializerDeserializer(ser.JsonSerializer, de.JsonDeserializer):
     """
 
     ...
+
+
+class GenericSerializerDeserializer(ser.GenericSerializer, de.GenericDeserializer, ABC):
+    """
+    Stub for deserializing from and serializing to a generic format.
+    Subclasses must implement the `to_file`, `to_str`, `from_file`, and `from_str` abstract methods.
+    See `ngen.init_config.core.Base` and `pydantic`'s documentation for configuration options.
+    """
+
+    ...