update plugin setting

Author: wj-Mcat

src/wechaty/plugin.py

@@ -75,6 +75,7 @@
     error
 )
 from wechaty.types import EndPoint
+from wechaty.utils import HookDict
 
 from .config import config
 
@@ -396,9 +397,11 @@ def __init__(self, options: Optional[WechatyPluginOptions] = None):
         self.options = options
         self._default_logger: Optional[Logger] = None
         self._cache_dir: Optional[str] = None
-
         self.setting_file: str = os.path.join(self.cache_dir, 'setting.json')
 
+        if not os.path.exists(self.setting_file):
+            self.setting = {}   # type: ignore
+
     def metadata(self) -> NavMetadata:
         """get the default nav metadata
 
@@ -414,18 +417,27 @@ def metadata(self) -> NavMetadata:
         )
 
     @property
-    def setting(self) -> dict:
+    def setting(self) -> HookDict[str, Any]:
         """get the setting of a plugin"""
         with open(self.setting_file, 'r', encoding='utf-8') as f:
             setting = json.load(f)
-        return setting
 
-    @setting.setter
-    def setting(self, value: dict) -> None:
+        def set_item_hooks(_: str, __: Any, value: dict) -> None:
+            """hook set_item event, and save the setting"""
+            self._save_setting(value)
+
+        return HookDict(setting, set_item_hooks=set_item_hooks)
+
+    def _save_setting(self, value: dict) -> None:
         """update the plugin setting"""
         with open(self.setting_file, 'w', encoding='utf-8') as f:
             json.dump(value, f, ensure_ascii=True)
 
+    @setting.setter     # type: ignore
+    def setting(self, value: dict) -> None:
+        """update the plugin setting"""
+        self._save_setting(value)
+
     def get_ui_dir(self) -> Optional[str]:
         """get the ui asset dir
         """
@@ -658,7 +670,7 @@ async def update_plugin_setting() -> Response:
                 return error(f'plugin<{name}> not exist ...')
 
             plugin: WechatyPlugin = self._plugins[name]
-            plugin.setting = data['setting']
+            plugin.setting = data['setting']    # type: ignore
             return success(None)
 
         @app.route("/js/<string:name>", methods=['GET'])

src/wechaty/utils/__init__.py

@@ -2,11 +2,13 @@
 from .qr_code import qr_terminal
 from .type_check import default_str
 from .date_util import timestamp_to_date
+from .data_util import HookDict
 # from .type_check import type_check
 
 __all__ = [
     'qr_terminal',
     'default_str',
-    'timestamp_to_date'
+    'timestamp_to_date',
+    'HookDict'
     # 'type_check'
 ]

src/wechaty/utils/data_util.py

@@ -0,0 +1,73 @@
+"""
+Python Wechaty - https://github.com/wechaty/python-wechaty
+
+Authors:    Huan LI (李卓桓) <https://github.com/huan>
+            Jingjing WU (吴京京) <https://github.com/wj-Mcat>
+
+2020-now @ Copyright Wechaty
+
+Licensed under the Apache License, Version 2.0 (the 'License');
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an 'AS IS' BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+from __future__ import annotations
+
+from typing import (
+    Callable,
+    Any,
+    Dict,
+    Iterable,
+    Iterator,
+    Optional,
+    Type,
+    TypeVar,
+    MutableMapping,
+    Generic
+)
+
+_KT = TypeVar("_KT")
+_VT = TypeVar("_VT")
+
+
+class HookDict(MutableMapping[_KT, _VT], Generic[_KT, _VT]):
+    """add hooks to the dict data
+    """
+    def __init__(
+        self,
+        data: Dict[_KT, _VT],
+        set_item_hooks: Optional[Callable[[_KT, _VT, Dict[_KT, _VT]], None]] = None,
+        default_type: Type = int,
+    ):
+        self._dict_data = data
+        self._set_item_hooks = set_item_hooks
+        self.default_type = default_type
+
+    def __setitem__(self, key: _KT, value: Any) -> None:
+        """triggered by `data[key] = value`"""
+        self._dict_data[key] = value
+        if self._set_item_hooks is not None:
+            self._set_item_hooks(key, value, self._dict_data)
+
+    def __getitem__(self, __k: _KT) -> _VT:
+        """get item data"""
+        return self._dict_data.get(__k, self.default_type())
+    
+    def __delitem__(self, __v: _KT) -> None:
+        """del item by key"""
+        del self._dict_data[__v]
+    
+    def __iter__(self) -> Iterator[_KT]:
+        """get the iterable data of data"""
+        return iter(self._dict_data)
+    
+    def __len__(self) -> int:
+        """get the length of dict data"""
+        return len(self._dict_data)

tests/plugin_test.py

@@ -0,0 +1,21 @@
+"""unittest for plugin"""
+import json
+import os
+import tempfile
+from wechaty.plugin import WechatyPlugin
+
+
+def test_setting():
+    with tempfile.TemporaryDirectory() as cache_dir:
+        os.environ['CACHE_DIR'] = cache_dir
+        plugin = WechatyPlugin()
+        
+        plugin.setting['unk'] = 11
+
+        # load the setting file
+        assert os.path.exists(plugin.setting_file)
+
+        with open(plugin.setting_file, 'r', encoding='utf-8') as f:
+            data = json.load(f)
+
+        assert data['unk'] == 11

tests/utils_test.py

@@ -3,6 +3,7 @@
 from wechaty.utils.async_helper import gather_with_concurrency
 from wechaty.utils.link import fetch_github_user_avatar_url, get_url_metadata
 from wechaty.utils.async_helper import SingleIdContainer
+from wechaty.utils.data_util import HookDict
 
 
 async def number_task(num: int):
@@ -39,4 +40,20 @@ def test_single_id_container():
     for index in range(SingleIdContainer.instance().max_size):
         assert not SingleIdContainer.instance().exist(index)
 
-    assert len(SingleIdContainer.instance().ids) == 0
+    assert len(SingleIdContainer.instance().ids) == 0
+
+
+def test_hook_dict():
+    
+    def change_value(key: str, _: int, data: HookDict):
+        data[key] += 10
+    
+    data = HookDict({}, default_type=int, set_item_hooks=change_value)
+
+    assert data['unk-key'] == 0
+    
+    data['1'] = 1
+    assert data['1'] == 11
+
+    data['1'] = 20
+    assert data['1'] == 30