Implement series serialization

Author: homeworkprod

CHANGELOG.md

@@ -3,6 +3,8 @@
 
 ## 0.11.0 (unreleased)
 
+- Implemented serialization of series.
+
 - Renamed model `Links` to `PartyLinks`.
 
 - Updated pytest to v9.0.2 (from v8.3.5).

src/lanpartydb/writing.py

@@ -11,10 +11,40 @@
 import dataclasses
 from typing import Any
 
-from lanpartydb.models import Party
+from lanpartydb.models import Party, Series
 import tomlkit
 
 
+# series
+
+
+def serialize_series_list(series_list: list[Series]) -> str:
+    """Serialize list of series to TOML document."""
+    aot = tomlkit.aot()
+
+    for series in series_list:
+        series_dict = _series_to_sparse_dict(series)
+        aot.append(tomlkit.item(series_dict))
+
+    doc = tomlkit.document()
+    doc.append('series', aot)
+
+    return _write_toml(doc)
+
+
+def serialize_series(series: Series) -> str:
+    """Serialize series to TOML document."""
+    series_dict = _series_to_sparse_dict(series)
+
+    return _write_toml(series_dict)
+
+
+def _series_to_sparse_dict(series: Series) -> dict[str, Any]:
+    data = dataclasses.asdict(series)
+    _remove_default_values(data)
+    return data
+
+
 # party
 
 
@@ -50,9 +80,11 @@ def _write_toml(d: dict[str, Any]) -> str:
 
 
 def _remove_default_values(d: dict[str, Any]) -> dict[str, Any]:
-    """Remove `None` and `False`, values from first level of dictionary."""
+    """Remove `None`, `False`, and `[]` values from first level of
+    dictionary.
+    """
     for k, v in list(d.items()):
-        if (v is None) or (v is False):
+        if (v is None) or (v is False) or (v == []):
             del d[k]
         elif isinstance(v, dict):
             _remove_default_values(v)

tests/writing/test_serialize_series.py

@@ -0,0 +1,77 @@
+"""
+:Copyright: 2024-2025 Jochen Kupperschmidt
+:License: MIT
+"""
+
+from textwrap import dedent
+
+import pytest
+
+from lanpartydb.models import Series
+from lanpartydb.writing import serialize_series, serialize_series_list
+
+
+def test_serialize_series_list():
+    series_list = [
+        Series(
+            slug='gammalan',
+            name='GammaLAN',
+            alternative_names=[],
+            country_codes=['ca', 'us'],
+        ),
+        Series(
+            slug='deltalan',
+            name='DeltaLAN',
+            alternative_names=['Δ LAN', 'Δέλτα LAN'],
+            country_codes=['au'],
+        ),
+    ]
+
+    assert serialize_series_list(series_list) == dedent("""\
+            [[series]]
+            slug = "gammalan"
+            name = "GammaLAN"
+            country_codes = ["ca", "us"]
+
+            [[series]]
+            slug = "deltalan"
+            name = "DeltaLAN"
+            alternative_names = ["Δ LAN", "Δέλτα LAN"]
+            country_codes = ["au"]
+            """)
+
+
+@pytest.mark.parametrize(
+    ('series', 'expected'),
+    [
+        (
+            Series(
+                slug='gammalan',
+                name='GammaLAN',
+                alternative_names=[],
+                country_codes=['ca', 'us'],
+            ),
+            dedent("""\
+            slug = "gammalan"
+            name = "GammaLAN"
+            country_codes = ["ca", "us"]
+            """),
+        ),
+        (
+            Series(
+                slug='deltalan',
+                name='DeltaLAN',
+                alternative_names=['Δ LAN', 'Δέλτα LAN'],
+                country_codes=['au'],
+            ),
+            dedent("""\
+            slug = "deltalan"
+            name = "DeltaLAN"
+            alternative_names = ["Δ LAN", "Δέλτα LAN"]
+            country_codes = ["au"]
+            """),
+        ),
+    ],
+)
+def test_serialize_series(series: Series, expected: str):
+    assert serialize_series(series) == expected