fixes #18

Author: jph00

dialoghelper/core.py

@@ -107,6 +107,8 @@ def del_msg(
 
 # %% ../nbs/00_core.ipynb
 def _msg(
+    msg_type: str='note', # Message type, can be 'code', 'note', or 'prompt'
+    output:str='', # For prompts/code, initial output
     time_run: str | None = '', # When was message executed
     is_exported: int | None = 0, # Export message to a module?
     skipped: int | None = 0, # Hide message from prompt?
@@ -122,17 +124,23 @@ def _msg(
 @delegates(_msg)
 def add_msg(
     content:str, # Content of the message (i.e the message prompt, code, or note text)
-    msg_type: str='note', # Message type, can be 'code', 'note', or 'prompt'
-    output:str='', # For prompts/code, initial output
     placement:str='add_after', # Can be 'add_after', 'add_before', 'update', 'at_start', 'at_end'
     sid:str=None, # sid (stable id -- pk) of message that placement is relative to (if None, uses current message)
     **kwargs
 ):
-    "Add/update a message to the queue to show after code execution completes. Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change)."
-    if msg_type not in ('note', 'code', 'prompt'): return "msg_type must be 'code', 'note', or 'prompt'."
-    if msg_type=='note' and output: return "note messages cannot have an output."
+    """Add/update a message to the queue to show after code execution completes.
+    Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change).
+    Sets msg_type to 'note' by default if not update placement."""
+    if 'msg_type' not in kwargs and placement!='update': kwargs['msg_type']='note'
+    mt = kwargs.get('msg_type',None)
+    ot = kwargs.get('output',None)
+    if mt and mt not in ('note', 'code', 'prompt'): return "msg_type must be 'code', 'note', or 'prompt'."
+    if mt=='note' and ot: return "note messages cannot have an output."
+    if mt=='code':
+        try: json.loads(ot or '[]')
+        except: return "Code output must be valid json"
     if not sid: sid = find_msg_id()
-    data = dict(content=content, msg_type=msg_type, output=output, placement=placement, sid=sid, **kwargs)
+    data = dict(content=content, placement=placement, sid=sid, **kwargs)
     return xpost('http://localhost:5001/add_relative_', data=data).text
 
 # %% ../nbs/00_core.ipynb
@@ -174,7 +182,7 @@ def update_msg(
     sid = kw.pop('sid', sid)
     if not sid: raise TypeError("update_msg needs either a dict message or `sid=...`")
     kw.pop('did', None)
-    add_msg(content, placement='update', sid=sid, **kw)
+    return add_msg(content, placement='update', sid=sid, **kw)
 
 # %% ../nbs/00_core.ipynb
 def load_gist(gist_id:str):

nbs/00_core.ipynb

@@ -411,6 +411,8 @@
    "source": [
     "#| export\n",
     "def _msg(\n",
+    "    msg_type: str='note', # Message type, can be 'code', 'note', or 'prompt'\n",
+    "    output:str='', # For prompts/code, initial output\n",
     "    time_run: str | None = '', # When was message executed\n",
     "    is_exported: int | None = 0, # Export message to a module?\n",
     "    skipped: int | None = 0, # Hide message from prompt?\n",
@@ -433,17 +435,23 @@
     "@delegates(_msg)\n",
     "def add_msg(\n",
     "    content:str, # Content of the message (i.e the message prompt, code, or note text)\n",
-    "    msg_type: str='note', # Message type, can be 'code', 'note', or 'prompt'\n",
-    "    output:str='', # For prompts/code, initial output\n",
     "    placement:str='add_after', # Can be 'add_after', 'add_before', 'update', 'at_start', 'at_end'\n",
     "    sid:str=None, # sid (stable id -- pk) of message that placement is relative to (if None, uses current message)\n",
     "    **kwargs\n",
     "):\n",
-    "    \"Add/update a message to the queue to show after code execution completes. Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change).\"\n",
-    "    if msg_type not in ('note', 'code', 'prompt'): return \"msg_type must be 'code', 'note', or 'prompt'.\"\n",
-    "    if msg_type=='note' and output: return \"note messages cannot have an output.\"\n",
+    "    \"\"\"Add/update a message to the queue to show after code execution completes.\n",
+    "    Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change).\n",
+    "    Sets msg_type to 'note' by default if not update placement.\"\"\"\n",
+    "    if 'msg_type' not in kwargs and placement!='update': kwargs['msg_type']='note'\n",
+    "    mt = kwargs.get('msg_type',None)\n",
+    "    ot = kwargs.get('output',None)\n",
+    "    if mt and mt not in ('note', 'code', 'prompt'): return \"msg_type must be 'code', 'note', or 'prompt'.\"\n",
+    "    if mt=='note' and ot: return \"note messages cannot have an output.\"\n",
+    "    if mt=='code':\n",
+    "        try: json.loads(ot or '[]')\n",
+    "        except: return \"Code output must be valid json\"\n",
     "    if not sid: sid = find_msg_id()\n",
-    "    data = dict(content=content, msg_type=msg_type, output=output, placement=placement, sid=sid, **kwargs)\n",
+    "    data = dict(content=content, placement=placement, sid=sid, **kwargs)\n",
     "    return xpost('http://localhost:5001/add_relative_', data=data).text"
    ]
   },
@@ -506,7 +514,14 @@
     "    sid = kw.pop('sid', sid)\n",
     "    if not sid: raise TypeError(\"update_msg needs either a dict message or `sid=...`\")\n",
     "    kw.pop('did', None)\n",
-    "    add_msg(content, placement='update', sid=sid, **kw)"
+    "    return add_msg(content, placement='update', sid=sid, **kw)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Gists"
    ]
   },
   {