ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-22 01:00:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: updating docstrings

Browse Source
This commit is contained in:
Mose Müller 2023-11-06 15:08:11 +01:00
parent f88493d97c
commit 2b304cba03
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/pydase/data_service/state_manager.py
View File

@ -77,11 +77,10 @@ class StateManager:
def save_state(self) -> None: def save_state(self) -> None:
""" """
Serialize the DataService instance and write it to a JSON file. Saves the DataService's current state to a JSON file defined by `self.filename`.
Logs an error if `self.filename` is not set.
Args:
filename (str): The name of the file to write to.
""" """
if self.filename is not None: if self.filename is not None:
with open(self.filename, "w") as f: with open(self.filename, "w") as f:
json.dump(self.cache, f, indent=4) json.dump(self.cache, f, indent=4)
@ -92,6 +91,11 @@ class StateManager:
) )
def load_state(self) -> None: def load_state(self) -> None:
"""
Loads the DataService's state from a JSON file defined by `self.filename`.
Updates the service's attributes, respecting type and read-only constraints.
"""
# Traverse the serialized representation and set the attributes of the class # Traverse the serialized representation and set the attributes of the class
json_dict = self._get_state_dict_from_JSON_file() json_dict = self._get_state_dict_from_JSON_file()
if json_dict == {}: if json_dict == {}: