From 7619fc3dd2ee6f347f4ae48ab4996cba5cd82baf Mon Sep 17 00:00:00 2001
From: Zhaoyilunnn <dilved1014@gmail.com>
Date: Sat, 29 Jun 2024 11:46:43 +0800
Subject: [PATCH] refactor(User): make account info configurable

---
 quafu/users/userapi.py                   | 66 +++++++++++++++++++-----
 tests/quafu/algorithms/estimator_test.py |  2 +-
 2 files changed, 55 insertions(+), 13 deletions(-)

diff --git a/quafu/users/userapi.py b/quafu/users/userapi.py
index 7aa29f7..afec3ce 100644
--- a/quafu/users/userapi.py
+++ b/quafu/users/userapi.py
@@ -12,7 +12,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import json
 import os
+import warnings
 from typing import Optional
 
 from ..exceptions import APITokenNotFound, UserError, validate_server_resp
@@ -27,6 +29,7 @@ class User(object):
     exec_api = "qbackend/scq_kit/"
     exec_async_api = "qbackend/scq_kit_asyc/"
     exec_recall_api = "qbackend/scq_task_recall/"
+    backend_type = "quafu"
 
     def __init__(
         self, api_token: Optional[str] = None, token_dir: Optional[str] = None
@@ -45,12 +48,25 @@ def __init__(
             self.token_dir = token_dir
 
         if api_token is None:
-            self._api_token = self._load_account_token()
+            self._api_token = self._load_account()
         else:
             self._api_token = api_token
 
         self.priority = 2
 
+    @classmethod
+    def list_configurable_attributes(cls):
+        """Return all attributes that are configuratble in configuration file"""
+        # get all configurable attributes
+        attributes = [
+            attr
+            for attr in list(cls.__dict__.keys())
+            if not attr.startswith("__")
+            and not callable(getattr(cls, attr))
+            and not isinstance(getattr(cls, attr), property)
+        ]
+        return attributes
+
     @property
     def api_token(self):
         if self._api_token is None:
@@ -62,7 +78,7 @@ def api_token(self):
 
     def save_apitoken(self, apitoken=None):
         """
-        Save api-token associate your Quafu account.
+        Save the api-token of your Quafu account.
         """
         if apitoken is not None:
             import warnings
@@ -75,25 +91,51 @@ def save_apitoken(self, apitoken=None):
             self._api_token = apitoken
 
         file_dir = self.token_dir
-        if not os.path.exists(file_dir):
-            os.mkdir(file_dir)
-        with open(file_dir + "api", "w") as f:
-            f.write(self.api_token + "\n")
-            f.write(self.url)
+        file_path = os.path.join(file_dir, "api")
+
+        data = None
+        if os.path.exists(file_path):
+            # if the configuration file exists
+            # only update api token
+            with open(file_path, "r") as f:
+                data = json.load(f)
+            data["token"] = self.api_token
+        else:
+            # if the configuration file does not exist
+            # set default configuration for api_token and url
+            data = {"token": self.api_token, "url": self.url}
+            if not os.path.exists(file_dir):
+                os.mkdir(file_dir)
 
-    def _load_account_token(self):
+        with open(file_path, "w") as f:
+            json.dump(data, f)
+
+    def _load_account(self):
         """
         Load Quafu account, only api at present.
 
         TODO: expand to load more user information
         """
-        file_dir = self.token_dir + "api"
+        file_dir = os.path.join(self.token_dir, "api")
+        attr_names = self.__class__.list_configurable_attributes()
+
         if not os.path.exists(file_dir):
             raise UserError("Please first save api token using `User.save_apitoken()`")
         with open(file_dir, "r") as f:
-            items = f.readlines()
-            token = items[0].strip()
-            self.__class__.url = items[1].strip()
+            try:
+                data = json.load(f)
+                token = data["token"]
+                for attr_name in attr_names:
+                    if attr_name in data:
+                        setattr(self.__class__, attr_name, data[attr_name])
+            except json.JSONDecodeError:
+                warnings.warn(
+                    "Deprecated config file format, suggest to fix this warning by running save_apitoken() again"
+                )
+                f.seek(0)
+                items = f.readlines()
+                token = items[0].strip()
+                self.__class__.url = items[1].strip()
         return token
 
     def _get_backends_info(self):
diff --git a/tests/quafu/algorithms/estimator_test.py b/tests/quafu/algorithms/estimator_test.py
index 6e9eeb5..c642515 100644
--- a/tests/quafu/algorithms/estimator_test.py
+++ b/tests/quafu/algorithms/estimator_test.py
@@ -57,7 +57,7 @@ def build_circuit(self):
         )
         return circ, test_ising
 
-    @patch("quafu.users.userapi.User._load_account_token", autospec=True)
+    @patch("quafu.users.userapi.User._load_account", autospec=True)
     @patch("quafu.users.userapi.User.get_available_backends", autospec=True)
     @patch("quafu.tasks.tasks.Task.send", autospec=True)
     def test_run(self, mock_send, mock_backends, mock_load_account):