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

adds deprecation warnings to DataService

Browse Source
This commit is contained in:
Mose Müller 2023-11-06 09:54:33 +01:00
parent e4796102be
commit 08512e945b
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/pydase/data_service/data_service.py
View File

@ -1,4 +1,5 @@
import logging import logging
import warnings
from enum import Enum from enum import Enum
from typing import Any, Optional, get_type_hints from typing import Any, Optional, get_type_hints
@ -53,7 +54,14 @@ class DataService(rpyc.Service, AbstractDataService):
filename = kwargs.pop("filename", None) filename = kwargs.pop("filename", None)
if filename is not None: if filename is not None:
warnings.warn(
"The 'filename' argument is deprecated and will be removed in a future version. "
"Please pass the 'filename' argument to `pydase.Server`.",
DeprecationWarning,
stacklevel=2,
)
self._filename = filename self._filename = filename
self._callback_manager.register_callbacks() self._callback_manager.register_callbacks()
self.__check_instance_classes() self.__check_instance_classes()
self._initialised = True self._initialised = True
@ -133,11 +141,29 @@ class DataService(rpyc.Service, AbstractDataService):
""" """
Serialize the DataService instance and write it to a JSON file. Serialize the DataService instance and write it to a JSON file.
This method is deprecated and will be removed in a future version.
Service persistence is handled by `pydase.Server` now, instead.
""" """
warnings.warn(
"'write_to_file' is deprecated and will be removed in a future version. "
"Service persistence is handled by `pydase.Server` now, instead.",
DeprecationWarning,
stacklevel=2,
)
if hasattr(self, "_state_manager"): if hasattr(self, "_state_manager"):
getattr(self, "_state_manager").save_state() getattr(self, "_state_manager").save_state()
def load_DataService_from_JSON(self, json_dict: dict[str, Any]) -> None: def load_DataService_from_JSON(self, json_dict: dict[str, Any]) -> None:
warnings.warn(
"'load_DataService_from_JSON' is deprecated and will be removed in a "
"future version. "
"Service persistence is handled by `pydase.Server` now, instead.",
DeprecationWarning,
stacklevel=2,
)
# Traverse the serialized representation and set the attributes of the class # Traverse the serialized representation and set the attributes of the class
serialized_class = self.serialize() serialized_class = self.serialize()
for path in generate_paths_from_DataService_dict(json_dict): for path in generate_paths_from_DataService_dict(json_dict):