Merge pull request #131 from NickCrews/account-json

feat: adjust the ser/deser logic of AppleAccount

Author: malmeloo

examples/_login.py

@@ -1,8 +1,5 @@
 # ruff: noqa: ASYNC230
 
-import json
-from pathlib import Path
-
 from findmy.reports import (
     AppleAccount,
     AsyncAppleAccount,
@@ -71,33 +68,25 @@ async def _login_async(account: AsyncAppleAccount) -> None:
 
 def get_account_sync(anisette: BaseAnisetteProvider) -> AppleAccount:
     """Tries to restore a saved Apple account, or prompts the user for login otherwise. (sync)"""
-    acc = AppleAccount(anisette)
-
-    # Save / restore account logic
-    acc_store = Path("account.json")
+    acc = AppleAccount(anisette=anisette)
+    acc_store = "account.json"
     try:
-        with acc_store.open() as f:
-            acc.restore(json.load(f))
+        acc.from_json(acc_store)
     except FileNotFoundError:
         _login_sync(acc)
-        with acc_store.open("w+") as f:
-            json.dump(acc.export(), f)
+        acc.to_json(acc_store)
 
     return acc
 
 
 async def get_account_async(anisette: BaseAnisetteProvider) -> AsyncAppleAccount:
     """Tries to restore a saved Apple account, or prompts the user for login otherwise. (async)"""
-    acc = AsyncAppleAccount(anisette)
-
-    # Save / restore account logic
-    acc_store = Path("account.json")
+    acc = AsyncAppleAccount(anisette=anisette)
+    acc_store = "account.json"
     try:
-        with acc_store.open() as f:
-            acc.restore(json.load(f))
+        acc.from_json(acc_store)
     except FileNotFoundError:
         await _login_async(acc)
-        with acc_store.open("w+") as f:
-            json.dump(acc.export(), f)
+        acc.to_json(acc_store)
 
     return acc

findmy/reports/account.py

@@ -11,6 +11,7 @@
 from abc import ABC, abstractmethod
 from datetime import datetime, timedelta, timezone
 from functools import wraps
+from pathlib import Path
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -48,7 +49,7 @@
 )
 
 if TYPE_CHECKING:
-    from collections.abc import Sequence
+    from collections.abc import Mapping, Sequence
 
     from findmy.accessory import RollingKeyPairSource
     from findmy.keys import HasHashedPublicKey
@@ -151,24 +152,29 @@ def last_name(self) -> str | None:
         raise NotImplementedError
 
     @abstractmethod
-    def export(self) -> dict:
+    def to_json(self, path: str | Path | None = None) -> dict:
         """
-        Export a representation of the current state of the account as a dictionary.
+        Export the current state of the account as a JSON-serializable dictionary.
+
+        If `path` is provided, the output will also be written to that file.
 
         The output of this method is guaranteed to be JSON-serializable, and passing
-        the return value of this function as an argument to `BaseAppleAccount.restore`
+        the return value of this function as an argument to `BaseAppleAccount.from_json`
         will always result in an exact copy of the internal state as it was when exported.
 
         This method is especially useful to avoid having to keep going through the login flow.
         """
         raise NotImplementedError
 
     @abstractmethod
-    def restore(self, data: dict) -> None:
+    def from_json(self, json_: str | Path | Mapping, /) -> None:
         """
-        Restore a previous export of the internal state of the account.
+        Restore the state from a previous `BaseAppleAccount.to_json` export.
+
+        If given a str or Path, it must point to a json file from `BaseAppleAccount.to_json`.
+        Otherwise it should be the Mapping itself.
 
-        See `BaseAppleAccount.export` for more information.
+        See `BaseAppleAccount.to_json` for more information.
         """
         raise NotImplementedError
 
@@ -363,6 +369,7 @@ class AsyncAppleAccount(BaseAppleAccount):
 
     def __init__(
         self,
+        *,
         anisette: BaseAnisetteProvider,
         user_id: str | None = None,
         device_id: str | None = None,
@@ -447,9 +454,8 @@ def last_name(self) -> str | None:
         return self._account_info["last_name"] if self._account_info else None
 
     @override
-    def export(self) -> dict:
-        """See `BaseAppleAccount.export`."""
-        return {
+    def to_json(self, path: str | Path | None = None) -> dict:
+        result = {
             "ids": {"uid": self._uid, "devid": self._devid},
             "account": {
                 "username": self._username,
@@ -461,10 +467,13 @@ def export(self) -> dict:
                 "data": self._login_state_data,
             },
         }
+        if path is not None:
+            Path(path).write_text(json.dumps(result, indent=4))
+        return result
 
     @override
-    def restore(self, data: dict) -> None:
-        """See `BaseAppleAccount.restore`."""
+    def from_json(self, json_: str | Path | Mapping, /) -> None:
+        data = json.loads(Path(json_).read_text()) if isinstance(json_, (str, Path)) else json_
         try:
             self._uid = data["ids"]["uid"]
             self._devid = data["ids"]["devid"]
@@ -972,12 +981,13 @@ class AppleAccount(BaseAppleAccount):
 
     def __init__(
         self,
+        *,
         anisette: BaseAnisetteProvider,
         user_id: str | None = None,
         device_id: str | None = None,
     ) -> None:
         """See `AsyncAppleAccount.__init__`."""
-        self._asyncacc = AsyncAppleAccount(anisette, user_id, device_id)
+        self._asyncacc = AsyncAppleAccount(anisette=anisette, user_id=user_id, device_id=device_id)
 
         try:
             self._evt_loop = asyncio.get_running_loop()
@@ -1017,14 +1027,12 @@ def last_name(self) -> str | None:
         return self._asyncacc.last_name
 
     @override
-    def export(self) -> dict:
-        """See `AsyncAppleAccount.export`."""
-        return self._asyncacc.export()
+    def to_json(self, path: str | Path | None = None) -> dict:
+        return self._asyncacc.to_json(path)
 
     @override
-    def restore(self, data: dict) -> None:
-        """See `AsyncAppleAccount.restore`."""
-        return self._asyncacc.restore(data)
+    def from_json(self, json_: str | Path | Mapping, /) -> None:
+        return self._asyncacc.from_json(json_)
 
     @override
     def login(self, username: str, password: str) -> LoginState: