dialoghelper 0.0.14__py3-none-any.whl → 0.0.16__py3-none-any.whl

dialoghelper/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.0.14"
+__version__ = "0.0.16"
 from .core import *

dialoghelper/_modidx.py

@@ -8,6 +8,7 @@ d = { 'settings': { 'branch': 'main',
   'syms': { 'dialoghelper.core': { 'dialoghelper.core._add_msg_unsafe': ('core.html#_add_msg_unsafe', 'dialoghelper/core.py'),
                                    'dialoghelper.core._msg': ('core.html#_msg', 'dialoghelper/core.py'),
                                    'dialoghelper.core._umsg': ('core.html#_umsg', 'dialoghelper/core.py'),
+                                   'dialoghelper.core.add_html': ('core.html#add_html', 'dialoghelper/core.py'),
                                    'dialoghelper.core.add_msg': ('core.html#add_msg', 'dialoghelper/core.py'),
                                    'dialoghelper.core.del_msg': ('core.html#del_msg', 'dialoghelper/core.py'),
                                    'dialoghelper.core.export_dialog': ('core.html#export_dialog', 'dialoghelper/core.py'),

dialoghelper/core.py

@@ -2,8 +2,8 @@
 
 # %% auto 0
 __all__ = ['Placements', 'empty', 'get_db', 'find_var', 'find_dialog_id', 'find_msgs', 'find_msg_id', 'read_msg_ids', 'msg_idx',
-           'read_msg', 'del_msg', 'add_msg', 'update_msg', 'load_gist', 'gist_file', 'import_string', 'is_usable_tool',
-           'mk_toollist', 'import_gist', 'export_dialog', 'import_dialog', 'tool_info', 'asdict']
+           'read_msg', 'add_html', 'del_msg', 'add_msg', 'update_msg', 'load_gist', 'gist_file', 'import_string',
+           'is_usable_tool', 'mk_toollist', 'import_gist', 'export_dialog', 'import_dialog', 'tool_info', 'asdict']
 
 # %% ../nbs/00_core.ipynb
 import json, importlib, linecache
@@ -11,6 +11,7 @@ from typing import Dict
 from tempfile import TemporaryDirectory
 from ipykernel_helper import *
 from dataclasses import dataclass
+from fastcore.xml import to_xml
 
 from fastcore.utils import *
 from fastcore.meta import delegates
@@ -98,6 +99,14 @@ def read_msg(n:int=-1,     # Message index (if relative, +ve is downwards)
     db = get_db()
     return db.t.message.selectone('sid=?', [ids[idx]])
 
+# %% ../nbs/00_core.ipynb
+def add_html(
+    content:str, # The HTML to send to the client (generally should include hx-swap-oob)
+):
+    "Send HTML to the browser to be swapped into the DOM"
+    res = to_xml(content)
+    xpost('http://localhost:5001/add_html_', data=dict(content=res))
+
 # %% ../nbs/00_core.ipynb
 def del_msg(
     sid:str=None, # sid (stable id -- pk) of message that placement is relative to (if None, uses current message)
@@ -107,6 +116,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 +133,23 @@ Placements = str_enum('Placements', 'add_after', 'add_before', 'update', 'at_sta
 @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 +191,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):
@@ -272,6 +289,7 @@ def import_dialog(fname, add_header=True):
 def tool_info():
     cts='''Tools available from `dialoghelper`:
 
+- &`add_html`: Send HTML to the browser to be swapped into the DOM using hx-swap-oob.
 - &`find_dialog_id`: Get the current dialog id.
 - &`find_msg_id`: Get the current message id.
 - &`find_msgs`: Find messages in current specific dialog that contain the given information.

{dialoghelper-0.0.14.dist-info → dialoghelper-0.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dialoghelper
-Version: 0.0.14
+Version: 0.0.16
 Summary: Helper functions for solveit dialogs
 Home-page: https://github.com/AnswerDotAI/dialoghelper
 Author: Jeremy Howard
@@ -18,7 +18,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore
+Requires-Dist: fastcore>=1.8.5
 Requires-Dist: fastlite
 Requires-Dist: ghapi
 Requires-Dist: ipykernel-helper

dialoghelper-0.0.16.dist-info/RECORD

@@ -0,0 +1,10 @@
+dialoghelper/__init__.py,sha256=EQiWUFoxrXghvJr_OC_Aq6XIWVNNQBYYPEmM1kQG0w8,43
+dialoghelper/_modidx.py,sha256=il4I8H0rrleInprpaXaQ3Lyy4_C1ipPVQvaZ8WopN7I,3126
+dialoghelper/core.py,sha256=2RhFkbnxUkMep4Imf_Qe3zEDxmd3QJk2uc0PZgmddzQ,12978
+dialoghelper/db_dc.py,sha256=ieSie_K1HHXACEJVZ0rMkD_uo42GgmMqqKDYrodjhtM,2297
+dialoghelper-0.0.16.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dialoghelper-0.0.16.dist-info/METADATA,sha256=L2Uiv1P4Z5fSDltxetRrzvzThTuet-y9QKC4t2_Oh4E,2565
+dialoghelper-0.0.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dialoghelper-0.0.16.dist-info/entry_points.txt,sha256=wvDeX-XTS_XVjWiiPQe6yVfmyNwy9eCr36ewp9baFIg,46
+dialoghelper-0.0.16.dist-info/top_level.txt,sha256=VXLlkgltFs_q-XB9imt2G64I_-MPm1RnxlpvUWPuLKM,13
+dialoghelper-0.0.16.dist-info/RECORD,,

dialoghelper-0.0.14.dist-info/RECORD

@@ -1,10 +0,0 @@
-dialoghelper/__init__.py,sha256=z-0Rh9e-quhc6YCgBCQPxO9WBChy0UBbaCcAmIPEqfE,43
-dialoghelper/_modidx.py,sha256=BmhVoIv53snN6JQm_EzJp-bu793QuY7EZg2hKaq5_7E,3013
-dialoghelper/core.py,sha256=suW06DOaGDxVH5cgxbue1Yj9HOJjj1m_fA0zSSR-Ecg,12260
-dialoghelper/db_dc.py,sha256=ieSie_K1HHXACEJVZ0rMkD_uo42GgmMqqKDYrodjhtM,2297
-dialoghelper-0.0.14.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dialoghelper-0.0.14.dist-info/METADATA,sha256=EMdtA7E4bTfJiNRxabpas8Z1RX0GkyGhJw5fMyaT9tA,2558
-dialoghelper-0.0.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dialoghelper-0.0.14.dist-info/entry_points.txt,sha256=wvDeX-XTS_XVjWiiPQe6yVfmyNwy9eCr36ewp9baFIg,46
-dialoghelper-0.0.14.dist-info/top_level.txt,sha256=VXLlkgltFs_q-XB9imt2G64I_-MPm1RnxlpvUWPuLKM,13
-dialoghelper-0.0.14.dist-info/RECORD,,