Merge pull request #20 from Josverl/Josverl/issue17

Allow mounting a local folder during cell magic

Author: Josverl

src/micropython_magic/mpr.py

@@ -20,7 +20,12 @@
 
 
 class MPRemote2:
-    def __init__(self, shell: InteractiveShell, port: str = "auto", resume: bool = True,):
+    def __init__(
+        self,
+        shell: InteractiveShell,
+        port: str = "auto",
+        resume: bool = True,
+    ):
         self.shell: InteractiveShell = shell
         self.port: str = port  # by default connect to the first device
         self.resume = resume  # by default resume the device to maintain state
@@ -53,7 +58,9 @@ def run_cmd(
             else:
                 log.warning(f"cmd is not a string: {cmd}")
         log.debug(cmd)
-        return ipython_run(cmd, stream_out=stream_out, shell=shell, timeout=timeout or self.timeout, follow=follow)
+        return ipython_run(
+            cmd, stream_out=stream_out, shell=shell, timeout=timeout or self.timeout, follow=follow
+        )
 
         # output = self.shell.getoutput(cmd, split=True)
         # assert isinstance(output, SList)
@@ -75,23 +82,62 @@ def select_device(self, port: Optional[str], verify: bool = False):
             output = e
         return output
 
-    def run_cell(self, cell: str, *, timeout: Union[int, float] = TIMEOUT, follow: bool = True):
+    def run_cell(
+        self,
+        cell: str,
+        *,
+        timeout: Union[int, float] = TIMEOUT,
+        follow: bool = True,
+        mount: Optional[str] = None,
+    ):
         """run a codeblock on the device and return the output"""
-        #     # TODO: if the cell is small enough, concat the cell with \n and use exec instead of copy
-        #     # - may need escaping quotes and newlines
-        # copy the cell to a file on the device
-        self.cell_to_mcu_file(cell, "__magic.py")
-        # run the transferred cell/file
-        result = self.run_mcu_file("__magic.py", stream_out=True, timeout=timeout, follow=follow)
-        return result # ?
-
-    def run_mcu_file(self, filename: str, stream_out: bool = True, timeout: Union[int, float] = 0, follow: bool = True):
-        exec_cmd = f"exec \"exec( open('{filename}').read() , globals() )\""
+        """copy cell to a file and run it on the MCU"""
+        with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as f:
+            f.write(
+                "# Jupyter cell\n"
+            )  # add a line to replace the cell magic to keep the line numbers aligned
+            f.write(cell)
+            f.close()
+            # copy the file to the device
+            run_cmd = f"run {f.name}"
+            if mount:
+                # prefix the run command with a mount command
+                run_cmd = f'mount "{Path(mount).as_posix()}" ' + run_cmd
+
+            # TODO: detect / retry / report errors copying the file
+            result = self.run_cmd(
+                run_cmd,
+                stream_out=True,
+                timeout=timeout,
+                follow=follow,
+            )
+            # log.info(_)
+            # log.info(f.name, "copied to device")
+            Path(f.name).unlink()
+        return result
+
+    def run_mcu_file(
+        self,
+        filename: str,
+        *,
+        stream_out: bool = True,
+        timeout: Union[int, float] = 0,
+        follow: bool = True,
+        mount: Optional[str] = None,
+    ):
+        """run a file on the device and return the output"""
+        exec_cmd = ""
+        if mount:
+            exec_cmd = f'mount "{mount}" '
+        exec_cmd += f"exec \"exec( open('{filename}').read() , globals() )\""
         return self.run_cmd(exec_cmd, stream_out=stream_out, timeout=timeout, follow=follow)
 
-    def cell_to_mcu_file(self, cell, filename):
+    def copy_cell_to_mcu(self, cell, *, filename: str):
+        """copy cell to a file to the MCU"""
         with tempfile.NamedTemporaryFile(mode="w", suffix=".py", delete=False) as f:
-            f.write("# Jupyter cell\n")  # add a line to replace the cell magic to keep the line numbers aligned
+            f.write(
+                "# Jupyter cell\n"
+            )  # add a line to replace the cell magic to keep the line numbers aligned
             f.write(cell)
             f.close()
             # copy the file to the device

src/micropython_magic/octarine.py

@@ -88,7 +88,7 @@ class MpyMagics(Magics):
     """A class to define the magic functions for Micropython."""
 
     # The default timeout
-    timeout = Float_(TIMEOUT).tag(config=True)
+    timeout = Float_(TIMEOUT).tag(config=True)  # type: ignore
 
     def __init__(self, shell: InteractiveShell):
         # first call the parent constructor
@@ -116,6 +116,13 @@ def MCU(self) -> MPRemote2:
     @cell_magic("mpy")
     @magic_arguments("%micropython")  # add additional % to display two %% in help
     #
+    @argument_group("Mount")
+    @argument(
+        "--mount",
+        type=str,
+        help="Host folder to mount on the MCU",
+        metavar="A/FOLDER",
+    )
     @argument_group("Code execution")
     @argument(
         "--writefile",
@@ -183,7 +190,7 @@ def micropython(self, line: str, cell: str = ""):
             log.debug(f"{args.writefile=}")
             if args.new:
                 log.warning(f"{args.new=} not implemented")
-            self.MCU.cell_to_mcu_file(cell, args.writefile)
+            self.MCU.copy_cell_to_mcu(cell,filename= args.writefile)
             return
 
         if args.readfile:
@@ -201,7 +208,9 @@ def micropython(self, line: str, cell: str = ""):
 
         if not cell:
             raise UsageError("Please specify some MicroPython code to execute")
-        output = self.MCU.run_cell(cell, timeout=args.timeout, follow=args.follow)
+        output = self.MCU.run_cell(
+            cell, timeout=args.timeout, follow=args.follow, mount=args.mount
+        )
         # return PrettyOutput(output)
 
     # -------------------------------------------------------------------------
@@ -223,7 +232,6 @@ def micropython(self, line: str, cell: str = ""):
     @argument("--hard-reset", action="store_true", help="reset device.")
     @argument("--info", action="store_true", help="get boardinfo from device")
     @argument("--bootloader", action="store_true", help="make the device enter its bootloader")
-
     @output_can_be_silenced
     def mpy_line(self, line: str):
         """