Rename reading subpackage to deserialization

Author: homeworkprod

CHANGELOG.md

@@ -3,6 +3,9 @@
 
 ## 0.11.0 (unreleased)
 
+- Renamed `reading` subpackage to `deserialization`, and adjusted function
+  names.
+
 - Renamed `writing` subpackage to `serialization`.
 
 - Implemented serialization of series.

src/lanpartydb/reading.py src/lanpartydb/deserialization.pysrc/lanpartydb/reading.py renamed to src/lanpartydb/deserialization.py

@@ -1,8 +1,8 @@
 """
-lanpartydb.reading
-~~~~~~~~~~~~~~~~~~
+lanpartydb.deserialization
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Data reading
+TOML deserialization to objects
 
 :Copyright: 2024-2025 Jochen Kupperschmidt
 :License: MIT
@@ -19,40 +19,40 @@
 # series
 
 
-def read_series_list_from_toml_file(filename: Path) -> list[Series]:
-    """Read list of series from a TOML file."""
+def deserialize_series_list_from_toml_file(filename: Path) -> list[Series]:
+    """Deserialize list of series from a TOML file."""
     toml = filename.read_text()
-    return read_series_list_from_toml(toml)
+    return deserialize_series_list(toml)
 
 
-def read_series_list_from_toml(toml: str) -> list[Series]:
-    """Read list of series from a TOML document."""
+def deserialize_series_list(toml: str) -> list[Series]:
+    """Deserialize list of series from a TOML document."""
     data = _load_toml(toml)
-    return _read_series_list_from_dict(data)
+    return _deserialize_series_list_from_dict(data)
 
 
-def _read_series_list_from_dict(data: dict[str, Any]) -> list[Series]:
-    """Read list of series from a dictionary."""
+def _deserialize_series_list_from_dict(data: dict[str, Any]) -> list[Series]:
+    """Build list of series from a dictionary."""
     return [Series(**item) for item in data.get('series', [])]
 
 
 # party
 
 
-def read_party_from_toml_file(filename: Path) -> Party:
-    """Read party from a TOML file."""
+def deserialize_party_from_toml_file(filename: Path) -> Party:
+    """Deserialize party from a TOML file."""
     toml = filename.read_text()
-    return read_party_from_toml(toml)
+    return deserialize_party(toml)
 
 
-def read_party_from_toml(toml: str) -> Party:
-    """Read party from a TOML document."""
+def deserialize_party(toml: str) -> Party:
+    """Deserialize party from a TOML document."""
     data = _load_toml(toml)
-    return _read_party_from_dict(data)
+    return _deserialize_party_from_dict(data)
 
 
-def _read_party_from_dict(party_dict: dict[str, Any]) -> Party:
-    """Read party from a dictionary."""
+def _deserialize_party_from_dict(party_dict: dict[str, Any]) -> Party:
+    """Build party from a dictionary."""
     location_dict = party_dict.pop('location', None)
     if location_dict:
         party_dict['location'] = Location(**location_dict)

…sts/reading/test_read_party_from_toml.py …eserialization/test_deserialize_party.pytests/reading/test_read_party_from_toml.py renamed to tests/deserialization/test_deserialize_party.py tests/reading/test_read_party_from_toml.py renamed to tests/deserialization/test_deserialize_party.py

@@ -8,8 +8,8 @@
 
 import pytest
 
+from lanpartydb.deserialization import deserialize_party
 from lanpartydb.models import Location, Party, PartyLinks, Resource
-from lanpartydb.reading import read_party_from_toml
 
 
 @pytest.mark.parametrize(
@@ -88,5 +88,5 @@
         ),
     ],
 )
-def test_read_party_from_toml(toml: str, expected: Party):
-    assert read_party_from_toml(toml) == expected
+def test_deserialize_party(toml: str, expected: Party):
+    assert deserialize_party(toml) == expected

…ading/test_read_series_list_from_toml.py …lization/test_deserialize_series_list.pytests/reading/test_read_series_list_from_toml.py renamed to tests/deserialization/test_deserialize_series_list.py tests/reading/test_read_series_list_from_toml.py renamed to tests/deserialization/test_deserialize_series_list.py

@@ -5,8 +5,8 @@
 
 import pytest
 
+from lanpartydb.deserialization import deserialize_series_list
 from lanpartydb.models import Series
-from lanpartydb.reading import read_series_list_from_toml
 
 
 @pytest.mark.parametrize(
@@ -62,5 +62,5 @@
         ),
     ],
 )
-def test_read_series_list_from_toml(toml: str, expected: list[Series]):
-    assert read_series_list_from_toml(toml) == expected
+def test_deserialize_series_list(toml: str, expected: list[Series]):
+    assert deserialize_series_list(toml) == expected