feat: Create notebook copies

frontend/src/components/modal/ImperativeModal.tsx

@@ -99,6 +99,8 @@ export function useImperativeModal() {
       title: React.ReactNode;
       description?: React.ReactNode;
       defaultValue?: string;
+      spellCheck?: boolean;
+      confirmText?: string;
       onConfirm: (value: string) => void;
     }) => {
       context.setModal(
@@ -124,6 +126,7 @@ export function useImperativeModal() {
                   {opts.description}
                 </AlertDialogDescription>
                 <Input
+                  spellCheck={opts.spellCheck}
                   defaultValue={opts.defaultValue}
                   className="my-4 h-8"
                   name="prompt"
@@ -136,7 +139,7 @@ export function useImperativeModal() {
                 <AlertDialogCancel onClick={closeModal}>
                   Cancel
                 </AlertDialogCancel>
-                <Button type="submit">Ok</Button>
+                <Button type="submit">{opts.confirmText ?? "Ok"}</Button>
               </AlertDialogFooter>
             </form>
           </AlertDialogContent>

frontend/src/components/pages/home-page.tsx

@@ -5,6 +5,7 @@ import {
   getRunningNotebooks,
   shutdownSession,
   openTutorial,
+  sendCopy,
 } from "@/core/network/requests";
 import { combineAsyncData, useAsyncData } from "@/hooks/useAsyncData";
 import type React from "react";
@@ -19,6 +20,7 @@ import {
   ChevronRightIcon,
   ChevronsDownUpIcon,
   ClockIcon,
+  Copy,
   DatabaseIcon,
   ExternalLinkIcon,
   FileIcon,
@@ -73,7 +75,7 @@ import {
 } from "../home/state";
 import { Maps } from "@/utils/maps";
 import { Input } from "../ui/input";
-import { Paths } from "@/utils/paths";
+import { PathBuilder, Paths } from "@/utils/paths";
 import {
   DropdownMenu,
   DropdownMenuTrigger,
@@ -441,9 +443,8 @@ const MarimoFileComponent = ({
       </div>
       <div className="flex flex-col gap-1 items-end">
         <div className="flex gap-3 items-center">
-          <div>
-            <SessionShutdownButton filePath={file.path} />
-          </div>
+          <CopyNotebookButton filePath={file.path} />
+          <SessionShutdownButton filePath={file.path} />
           {openNewTab && (
             <ExternalLinkIcon
               size={20}
@@ -516,6 +517,46 @@ const SessionShutdownButton: React.FC<{ filePath: string }> = ({
   );
 };
 
+const CopyNotebookButton: React.FC<{ filePath: string }> = ({ filePath }) => {
+  const { openPrompt, closeModal } = useImperativeModal();
+  return (
+    <Tooltip content="Copy">
+      <Button
+        size={"icon"}
+        variant="outline"
+        className="opacity-0 group-hover:opacity-100 hover:bg-accent text-primary border-primary hover:border-primary hover:text-primary bg-background hover:bg-[var(--blue-1)]"
+        onClick={(e) => {
+          e.stopPropagation();
+          e.preventDefault();
+          const pathBuilder = new PathBuilder("/");
+          openPrompt({
+            title: "Copy notebook",
+            description: "Enter a new filename for the notebook copy.",
+            defaultValue: `_${Paths.basename(filePath)}`,
+            confirmText: "Copy notebook",
+            spellCheck: false,
+            onConfirm: (destination: string) => {
+              sendCopy({
+                source: filePath,
+                destination: pathBuilder.join(
+                  Paths.dirname(filePath),
+                  destination,
+                ),
+              });
+              closeModal();
+              toast({
+                description: "Notebook has been copied.",
+              });
+            },
+          });
+        }}
+      >
+        <Copy size={14} />
+      </Button>
+    </Tooltip>
+  );
+};
+
 const CreateNewNotebook: React.FC = () => {
   const sessionId = generateSessionId();
   const initializationId = `__new__${sessionId}`;

frontend/src/core/islands/bridge.ts

@@ -125,6 +125,7 @@ export class IslandsPyodideBridge implements RunRequests, EditRequests {
   getUsageStats = throwNotImplemented;
   sendRename = throwNotImplemented;
   sendSave = throwNotImplemented;
+  sendCopy = throwNotImplemented;
   sendRunScratchpad = throwNotImplemented;
   sendStdin = throwNotImplemented;
   sendInterrupt = throwNotImplemented;

frontend/src/core/network/requests-network.ts

@@ -40,6 +40,14 @@ export function createNetworkRequests(): EditRequests & RunRequests {
         })
         .then(handleResponseReturnNull);
     },
+    sendCopy: (request) => {
+      return marimoClient
+        .POST("/api/kernel/copy", {
+          body: request,
+          parseAs: "text",
+        })
+        .then(handleResponseReturnNull);
+    },
     sendFormat: (request) => {
       return marimoClient
         .POST("/api/kernel/format", {

frontend/src/core/network/requests-static.ts

@@ -37,6 +37,7 @@ export function createStaticRequests(): EditRequests & RunRequests {
     sendRunScratchpad: throwNotInEditMode,
     sendRename: throwNotInEditMode,
     sendSave: throwNotInEditMode,
+    sendCopy: throwNotInEditMode,
     sendInterrupt: throwNotInEditMode,
     sendShutdown: throwNotInEditMode,
     sendFormat: throwNotInEditMode,

frontend/src/core/network/requests-toasting.ts

@@ -18,6 +18,7 @@ export function createErrorToastingRequests(
     sendRunScratchpad: "Failed to run scratchpad",
     sendRename: "Failed to rename",
     sendSave: "Failed to save",
+    sendCopy: "Failed to copy",
     sendInterrupt: "Failed to interrupt",
     sendShutdown: "Failed to shutdown",
     sendFormat: "Failed to format",

frontend/src/core/network/requests.ts

@@ -31,6 +31,7 @@ export const {
   sendRestart,
   syncCellIds,
   sendSave,
+  sendCopy,
   sendStdin,
   sendFormat,
   sendInterrupt,

frontend/src/core/network/types.ts

@@ -56,6 +56,7 @@ export type RunScratchpadRequest = schemas["RunScratchpadRequest"];
 export type SaveAppConfigurationRequest =
   schemas["SaveAppConfigurationRequest"];
 export type SaveNotebookRequest = schemas["SaveNotebookRequest"];
+export type CopyNotebookRequest = schemas["CopyNotebookRequest"];
 export type SaveUserConfigurationRequest =
   schemas["SaveUserConfigurationRequest"];
 export interface SetCellConfigRequest {
@@ -95,6 +96,7 @@ export interface RunRequests {
 export interface EditRequests {
   sendRename: (request: RenameFileRequest) => Promise<null>;
   sendSave: (request: SaveNotebookRequest) => Promise<null>;
+  sendCopy: (request: CopyNotebookRequest) => Promise<null>;
   sendStdin: (request: StdinRequest) => Promise<null>;
   sendRun: (request: RunRequest) => Promise<null>;
   sendRunScratchpad: (request: RunScratchpadRequest) => Promise<null>;

frontend/src/core/wasm/bridge.ts

@@ -187,6 +187,11 @@ export class PyodideBridge implements RunRequests, EditRequests {
     return null;
   };
 
+  sendCopy: EditRequests["sendCopy"] = async () => {
+    // TODO: Implement copy with pyodide!
+    return null;
+  };
+
   sendStdin: EditRequests["sendStdin"] = async (request) => {
     await this.rpc.proxy.request.bridge({
       functionName: "put_input",

frontend/src/core/wasm/worker/types.ts

@@ -2,6 +2,7 @@
 import type { PyodideInterface } from "pyodide";
 import type {
   CodeCompletionRequest,
+  CopyNotebookRequest,
   ExportAsHTMLRequest,
   FileCreateRequest,
   FileCreateResponse,
@@ -66,6 +67,7 @@ export interface RawBridge {
   read_snippets(): Promise<Snippets>;
   format(request: FormatRequest): Promise<FormatResponse>;
   save(request: SaveNotebookRequest): Promise<string>;
+  copy(request: CopyNotebookRequest): Promise<string>;
   save_app_config(request: SaveAppConfigurationRequest): Promise<string>;
   save_user_config(request: SaveUserConfigurationRequest): Promise<null>;
   rename_file(request: string): Promise<string>;

marimo/_cli/development/commands.py

@@ -149,6 +149,7 @@ def _generate_schema() -> dict[str, Any]:
         models.RunScratchpadRequest,
         models.SaveAppConfigurationRequest,
         models.SaveNotebookRequest,
+        models.CopyNotebookRequest,
         models.SaveUserConfigurationRequest,
         models.StdinRequest,
         models.SuccessResponse,

marimo/_server/api/endpoints/files.py

@@ -15,6 +15,7 @@
 from marimo._server.api.utils import parse_request
 from marimo._server.models.models import (
     BaseResponse,
+    CopyNotebookRequest,
     OpenFileRequest,
     ReadCodeResponse,
     RenameFileRequest,
@@ -182,6 +183,34 @@ async def save(
     return PlainTextResponse(content=contents)
 
 
+@router.post("/copy")
+@requires("edit")
+async def copy(
+    *,
+    request: Request,
+) -> PlainTextResponse:
+    """
+    requestBody:
+        content:
+            application/json:
+                schema:
+                    $ref: "#/components/schemas/CopyNotebookRequest"
+    responses:
+        200:
+            description: Copy notebook
+            content:
+                text/plain:
+                    schema:
+                        type: string
+    """
+    app_state = AppState(request)
+    body = await parse_request(request, cls=CopyNotebookRequest)
+    session = app_state.require_current_session()
+    contents = session.app_file_manager.copy(body)
+
+    return PlainTextResponse(content=contents)
+
+
 @router.post("/save_app_config")
 @requires("edit")
 async def save_app_config(

marimo/_server/file_manager.py

@@ -2,6 +2,7 @@
 from __future__ import annotations
 
 import os
+import shutil
 from typing import Any, Dict, Optional
 
 from marimo import _loggers
@@ -15,7 +16,10 @@
     save_layout_config,
 )
 from marimo._server.api.status import HTTPException, HTTPStatus
-from marimo._server.models.models import SaveNotebookRequest
+from marimo._server.models.models import (
+    CopyNotebookRequest,
+    SaveNotebookRequest,
+)
 from marimo._server.utils import canonicalize_filename
 
 LOGGER = _loggers.marimo_logger()
@@ -261,6 +265,11 @@ def save(self, request: SaveNotebookRequest) -> str:
             persist=request.persist,
         )
 
+    def copy(self, request: CopyNotebookRequest) -> str:
+        source, destination = request.source, request.destination
+        shutil.copy(source, destination)
+        return os.path.basename(destination)
+
     def to_code(self) -> str:
         """Read the contents of the unsaved file."""
         contents = codegen.generate_filecontents(

marimo/_server/models/models.py

@@ -132,6 +132,24 @@ def __post_init__(self) -> None:
         ), "Mismatched cell_ids and configs"
 
 
+@dataclass
+class CopyNotebookRequest:
+    # path to app
+    source: str
+    destination: str
+
+    # Validate filenames are valid, and destination path does not already exist
+    def __post_init__(self) -> None:
+        assert self.source is not None
+        assert self.destination is not None
+        assert os.path.exists(
+            self.source
+        ), f"File {self.source} does not exist"
+        assert not os.path.exists(
+            self.destination
+        ), f"File {self.destination} already exists"
+
+
 @dataclass
 class SaveAppConfigurationRequest:
     # partial app config

openapi/api.yaml

@@ -2241,6 +2241,20 @@ paths:
               schema:
                 type: string
           description: Save the current app
+  /api/kernel/copy:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CopyNotebookRequest'
+      responses:
+        200:
+          content:
+            text/plain:
+              schema:
+                type: string
+          description: Copy notebook
   /api/kernel/save_app_config:
     post:
       requestBody:

openapi/src/api.ts

@@ -1233,6 +1233,45 @@ export interface paths {
     patch?: never;
     trace?: never;
   };
+  "/api/kernel/copy": {
+    parameters: {
+      query?: never;
+      header?: never;
+      path?: never;
+      cookie?: never;
+    };
+    get?: never;
+    put?: never;
+    post: {
+      parameters: {
+        query?: never;
+        header?: never;
+        path?: never;
+        cookie?: never;
+      };
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["CopyNotebookRequest"];
+        };
+      };
+      responses: {
+        /** @description Save the app as a new file */
+        200: {
+          headers: {
+            [name: string]: unknown;
+          };
+          content: {
+            "text/plain": string;
+          };
+        };
+      };
+    };
+    delete?: never;
+    options?: never;
+    head?: never;
+    patch?: never;
+    trace?: never;
+  };
   "/api/kernel/save_app_config": {
     parameters: {
       query?: never;
@@ -2367,6 +2406,10 @@ export interface components {
       names: string[];
       persist: boolean;
     };
+    CopyNotebookRequest: {
+      source: string;
+      destination: string;
+    }
     SaveUserConfigurationRequest: {
       config: components["schemas"]["MarimoConfig"];
     };