Skip to content

Commit 96a22fa

Browse files
committed
Add suffix _from_toml to public deserialization functions which accept string parameter
1 parent 34ea012 commit 96a22fa

4 files changed

Lines changed: 13 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010

1111
- Implemented serialization of series.
1212

13+
- Added suffix `_from_toml` to public deserialization functions with string
14+
input argument.
15+
1316
- Added suffix `_to_toml` to public serialization functions.
1417

1518
- Renamed model `Links` to `PartyLinks`.

src/lanpartydb/deserialization.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
def deserialize_series_list_from_toml_file(filename: Path) -> list[Series]:
2323
"""Deserialize list of series from a TOML file."""
2424
toml = filename.read_text()
25-
return deserialize_series_list(toml)
25+
return deserialize_series_list_from_toml(toml)
2626

2727

28-
def deserialize_series_list(toml: str) -> list[Series]:
28+
def deserialize_series_list_from_toml(toml: str) -> list[Series]:
2929
"""Deserialize list of series from a TOML document."""
3030
data = _load_toml(toml)
3131
return _deserialize_series_list_from_dict(data)
@@ -42,10 +42,10 @@ def _deserialize_series_list_from_dict(data: dict[str, Any]) -> list[Series]:
4242
def deserialize_party_from_toml_file(filename: Path) -> Party:
4343
"""Deserialize party from a TOML file."""
4444
toml = filename.read_text()
45-
return deserialize_party(toml)
45+
return deserialize_party_from_toml(toml)
4646

4747

48-
def deserialize_party(toml: str) -> Party:
48+
def deserialize_party_from_toml(toml: str) -> Party:
4949
"""Deserialize party from a TOML document."""
5050
data = _load_toml(toml)
5151
return _deserialize_party_from_dict(data)

tests/deserialization/test_deserialize_party.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
import pytest
1010

11-
from lanpartydb.deserialization import deserialize_party
11+
from lanpartydb.deserialization import deserialize_party_from_toml
1212
from lanpartydb.models import Location, Party, PartyLinks, Resource
1313

1414

@@ -88,5 +88,5 @@
8888
),
8989
],
9090
)
91-
def test_deserialize_party(toml: str, expected: Party):
92-
assert deserialize_party(toml) == expected
91+
def test_deserialize_party_from_toml(toml: str, expected: Party):
92+
assert deserialize_party_from_toml(toml) == expected

tests/deserialization/test_deserialize_series_list.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
import pytest
77

8-
from lanpartydb.deserialization import deserialize_series_list
8+
from lanpartydb.deserialization import deserialize_series_list_from_toml
99
from lanpartydb.models import Series
1010

1111

@@ -62,5 +62,5 @@
6262
),
6363
],
6464
)
65-
def test_deserialize_series_list(toml: str, expected: list[Series]):
66-
assert deserialize_series_list(toml) == expected
65+
def test_deserialize_series_list_from_toml(toml: str, expected: list[Series]):
66+
assert deserialize_series_list_from_toml(toml) == expected

0 commit comments

Comments
 (0)