feat: add download and download_file methods (#5)

Author: JakubAndrysek

src/wokwi_client/client.py

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: MIT
 
+import base64
 from pathlib import Path
 from typing import Any, Optional, Union
 
@@ -14,7 +15,7 @@
 from .constants import DEFAULT_WS_URL
 from .control import set_control
 from .event_queue import EventQueue
-from .file_ops import upload, upload_file
+from .file_ops import download, upload, upload_file
 from .pins import pin_listen, pin_read
 from .protocol_types import EventMessage, ResponseMessage
 from .serial import monitor_lines, write_serial
@@ -91,6 +92,34 @@ async def upload_file(
         """
         return await upload_file(self._transport, filename, local_path)
 
+    async def download(self, name: str) -> bytes:
+        """
+        Download a file from the simulator.
+
+        Args:
+            name: The name of the file to download.
+
+        Returns:
+            The downloaded file content as bytes.
+        """
+        result = await download(self._transport, name)
+        return base64.b64decode(result["result"]["binary"])
+
+    async def download_file(self, name: str, local_path: Optional[Path] = None) -> None:
+        """
+        Download a file from the simulator and save it to a local path.
+
+        Args:
+            name: The name of the file to download.
+            local_path: The local path to save the downloaded file. If not provided, uses the name as the path.
+        """
+        if local_path is None:
+            local_path = Path(name)
+
+        result = await self.download(name)
+        with open(local_path, "wb") as f:
+            f.write(result)
+
     async def start_simulation(
         self,
         firmware: str,

src/wokwi_client/file_ops.py

@@ -22,3 +22,7 @@ async def upload_file(
 async def upload(transport: Transport, name: str, content: bytes) -> ResponseMessage:
     params = UploadParams(name=name, binary=base64.b64encode(content).decode())
     return await transport.request("file:upload", params.model_dump())
+
+
+async def download(transport: Transport, name: str) -> ResponseMessage:
+    return await transport.request("file:download", {"name": name})