Add suffix _to_toml to public serialization functions

Author: homeworkprod

CHANGELOG.md

@@ -10,6 +10,8 @@
 
 - Implemented serialization of series.
 
+- Added suffix `_to_toml` to public serialization functions.
+
 - Renamed model `Links` to `PartyLinks`.
 
 - Updated pytest to v9.0.2 (from v8.3.5).

README.md

@@ -42,7 +42,7 @@ To serialize a party with only the required attributes to TOML:
 from datetime import date
 
 from lanpartydb.models import Party
-from lanpartydb.serialization import serialize_party
+from lanpartydb.serialization import serialize_party_to_toml
 
 party = Party(
     slug='megalan-2023',
@@ -51,7 +51,7 @@ party = Party(
     end_on=date(2023, 11, 19),
 )
 
-toml = serialize_party(party)
+toml = serialize_party_to_toml(party)
 
 print(toml)
 ```
@@ -64,7 +64,7 @@ from decimal import Decimal
 from pathlib import Path
 
 from lanpartydb.models import Location, Party, PartyLinks, Resource
-from lanpartydb.serialization import serialize_party
+from lanpartydb.serialization import serialize_party_to_toml
 
 party = Party(
     slug='superlan-2024',
@@ -93,7 +93,7 @@ party = Party(
     ),
 )
 
-toml = serialize_party(party)
+toml = serialize_party_to_toml(party)
 
 path = Path('./superlan-2024.toml')
 path.write_text(toml)

src/lanpartydb/serialization.py

@@ -18,7 +18,7 @@
 # series
 
 
-def serialize_series_list(series_list: list[Series]) -> str:
+def serialize_series_list_to_toml(series_list: list[Series]) -> str:
     """Serialize list of series to TOML document."""
     aot = tomlkit.aot()
 
@@ -32,7 +32,7 @@ def serialize_series_list(series_list: list[Series]) -> str:
     return _write_toml(doc)
 
 
-def serialize_series(series: Series) -> str:
+def serialize_series_to_toml(series: Series) -> str:
     """Serialize series to TOML document."""
     series_dict = _series_to_sparse_dict(series)
 
@@ -48,7 +48,7 @@ def _series_to_sparse_dict(series: Series) -> dict[str, Any]:
 # party
 
 
-def serialize_party(party: Party) -> str:
+def serialize_party_to_toml(party: Party) -> str:
     """Serialize party to TOML document."""
     party_dict = _party_to_sparse_dict(party)
 

tests/serialization/test_serialize_party.py

@@ -10,7 +10,7 @@
 import pytest
 
 from lanpartydb.models import Location, Party, PartyLinks, Resource
-from lanpartydb.serialization import serialize_party
+from lanpartydb.serialization import serialize_party_to_toml
 
 
 @pytest.mark.parametrize(
@@ -82,5 +82,5 @@
         ),
     ],
 )
-def test_serialize_party(party: Party, expected: str):
-    assert serialize_party(party) == expected
+def test_serialize_party_to_toml(party: Party, expected: str):
+    assert serialize_party_to_toml(party) == expected

tests/serialization/test_serialize_series.py

@@ -8,10 +8,13 @@
 import pytest
 
 from lanpartydb.models import Series
-from lanpartydb.serialization import serialize_series, serialize_series_list
+from lanpartydb.serialization import (
+    serialize_series_to_toml,
+    serialize_series_list_to_toml,
+)
 
 
-def test_serialize_series_list():
+def test_serialize_series_list_to_toml():
     series_list = [
         Series(
             slug='gammalan',
@@ -27,7 +30,7 @@ def test_serialize_series_list():
         ),
     ]
 
-    assert serialize_series_list(series_list) == dedent("""\
+    assert serialize_series_list_to_toml(series_list) == dedent("""\
             [[series]]
             slug = "gammalan"
             name = "GammaLAN"
@@ -73,5 +76,5 @@ def test_serialize_series_list():
         ),
     ],
 )
-def test_serialize_series(series: Series, expected: str):
-    assert serialize_series(series) == expected
+def test_serialize_series_to_toml(series: Series, expected: str):
+    assert serialize_series_to_toml(series) == expected