version 0.2.11

Author: VigneshVSV

CHANGELOG.md

@@ -25,6 +25,10 @@ This release will contain a lot of new features and improvements so that a versi
 Not finalised:
 - cookie auth & its specification in TD (cookie auth branch)
 
+## [v0.2.11] - 2025-04-25
+
+- new feature - support for JSON files as backup for property values (use with `db_commit`, `db_persist` and `db_init`). Compatible only with JSON serializable properties. 
+
 ## [v0.2.10] - 2025-04-05
 
 - bug fixes to support `class_member` properties to work with `fget`, `fset` and `fdel` methods. While using custom `fget`, `fset` and `fdel` methods for `class_member`s,

examples

@@ -1 +1 @@
-__version__ = "0.2.10"
+__version__ = "0.2.11"

hololinked/__init__.py

@@ -1,7 +1,7 @@
 import os
 import threading
-from .serializers import JSONSerializer
 from typing import Any, Dict, List, Optional, Union
+from .serializers import JSONSerializer
 from .property import Property
 from ..param import Parameterized
 

hololinked/server/json_storage.py

@@ -1,7 +1,6 @@
 import typing, inspect
 from dataclasses import dataclass, field
 
-from hololinked.server.eventloop import EventLoop
 
 
 from .constants import JSON, JSONSerializable
@@ -12,6 +11,7 @@
 from .property import Property
 from .thing import Thing
 from .state_machine import StateMachine
+from .eventloop import EventLoop
 
 
 

hololinked/server/td.py

@@ -16,7 +16,7 @@
 from .exceptions import BreakInnerLoop
 from .action import action
 from .dataklasses import HTTPResource, ZMQResource, build_our_temp_TD, get_organised_resources
-from .utils import get_default_logger, getattr_without_descriptor_read
+from .utils import get_a_filename_from_instance, get_default_logger, getattr_without_descriptor_read
 from .property import Property, ClassProperties
 from .properties import String, ClassSelector, Selector, TypedKeyMappingsConstrainedDict
 from .zmq_message_brokers import RPCServer, ServerTypes, EventPublisher
@@ -210,7 +210,7 @@ class attribute, see docs.
         # choose storage type, if use_json_file is True - use JSON storage, else - use database
         if kwargs.get('use_json_file',
                       self.__class__.use_json_file if hasattr(self.__class__, 'use_json_file') else False):
-            self._prepare_json_storage(filename=kwargs.get('json_filename', f"{self._prepare_json_filename()}"))
+            self._prepare_json_storage(filename=kwargs.get('json_filename', f"{get_a_filename_from_instance(self, 'json')}"))
         else:
             self._prepare_DB(kwargs.get('use_default_db', False), kwargs.get('db_config_file', None))
 
@@ -277,23 +277,10 @@ def _prepare_DB(self, default_db : bool = False, config_file : str = None):
 
     def _prepare_json_storage(self, filename: str = None):
         if not filename:
-            filename = f"{self._prepare_json_filename()}"
+            filename = f"{get_a_filename_from_instance(self, 'json')}"
         self.db_engine = ThingJsonStorage(filename=filename, instance=self)
 
-    def _prepare_json_filename(self):
-        class_name = self.__class__.__name__
-
-        # Remove invalid characters from the instance name
-        safe_instance_name = re.sub(r'[<>:"/\\|?*\x00-\x1F]+', '_', self.instance_name)
-        # Collapse consecutive underscores into one
-        safe_instance_name = re.sub(r'_+', '_', safe_instance_name)
-        # Remove leading and trailing underscores
-        safe_instance_name = safe_instance_name.strip('_')
-
-        filename = f"{class_name}-{safe_instance_name or '_'}.json"
-        return filename
-
-
+ 
     @object_info.getter
     def _get_object_info(self):
         if not hasattr(self, '_object_info'):

hololinked/server/thing.py

@@ -224,6 +224,20 @@ def issubklass(obj, cls):
             return False
     except TypeError:
         return False
+    
+
+def get_a_filename_from_instance(thing: type, extension: str = 'json') -> str:
+    class_name = thing.__class__.__name__
+
+    # Remove invalid characters from the instance name
+    safe_instance_name = re.sub(r'[<>:"/\\|?*\x00-\x1F]+', '_', thing.instance_name)
+    # Collapse consecutive underscores into one
+    safe_instance_name = re.sub(r'_+', '_', safe_instance_name)
+    # Remove leading and trailing underscores
+    safe_instance_name = safe_instance_name.strip('_')
+
+    filename = f"{class_name}-{safe_instance_name or '_'}.{extension}"
+    return filename
 
 
 __all__ = [

hololinked/server/utils.py

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name="hololinked",
-    version="0.2.10",
+    version="0.2.11",
     author="Vignesh Vaidyanathan",
     author_email="[email protected]",
     description="A ZMQ-based Object Oriented RPC tool-kit for instrument control/data acquisition or controlling generic python objects.",