dialoghelper 0.0.4__tar.gz → 0.0.6__tar.gz

{dialoghelper-0.0.4/dialoghelper.egg-info → dialoghelper-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dialoghelper
-Version: 0.0.4
+Version: 0.0.6
 Summary: Helper functions for solveit dialogs
 Home-page: https://github.com/AnswerDotAI/dialoghelper
 Author: Jeremy Howard

dialoghelper-0.0.6/dialoghelper/__init__.py

@@ -0,0 +1,2 @@
+__version__ = "0.0.6"
+from .core import *

{dialoghelper-0.0.4 → dialoghelper-0.0.6}/dialoghelper/core.py

@@ -2,10 +2,11 @@
 
 # %% auto 0
 __all__ = ['get_db', 'find_var', 'find_dialog_id', 'find_msgs', 'find_msg_id', 'read_msg_ids', 'msg_idx', 'read_msg', 'add_msg',
-           'update_msg', 'add_html', 'load_gist', 'gist_file', 'import_string', 'import_gist']
+           'update_msg', 'add_html', 'load_gist', 'gist_file', 'import_string', 'import_gist', 'asdict']
 
 # %% ../nbs/00_core.ipynb
 import inspect, json, importlib, linecache
+from typing import Dict
 from tempfile import TemporaryDirectory
 from ipykernel_helper import *
 
@@ -13,6 +14,10 @@ from fastcore.utils import *
 from fastcore.meta import delegates
 from ghapi.all import *
 from fastlite import *
+from fastcore.xtras import asdict
+
+# %% ../nbs/00_core.ipynb
+_all_ = ["asdict"]
 
 # %% ../nbs/00_core.ipynb
 def get_db(ns:dict=None):
@@ -45,10 +50,11 @@ def find_msgs(
     pattern: str, # Text to search for
     limit:int=10 # Limit number of returned items
 ):
-    "Find messages in a specific dialog that contain the given pattern."
+    "Find messages in a specific dialog that contain the given pattern. To refer to a message found later, use its `sid` field."
     did = find_dialog_id()
     db = get_db()
-    return db.t.message('did=? AND content LIKE ?', [did, f'%{pattern}%'], limit=limit)
+    res = db.t.message('did=? AND content LIKE ? ORDER BY mid', [did, f'%{pattern}%'], limit=limit)
+    return [asdict(o) for o in res]
 
 # %% ../nbs/00_core.ipynb
 def find_msg_id():
@@ -60,7 +66,7 @@ def read_msg_ids():
     "Get all ids in current dialog."
     did = find_dialog_id()
     db = get_db()
-    return [o.sid for o in db.t.message('did=?', [did], select='sid', order_by='id')]
+    return [o.sid for o in db.t.message('did=?', [did], select='sid', order_by='mid')]
 
 # %% ../nbs/00_core.ipynb
 def msg_idx():
@@ -98,25 +104,35 @@ def _msg(
 # %% ../nbs/00_core.ipynb
 @delegates(_msg)
 def add_msg(
-    content:str, # message that we are updating or adding before/after
+    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'
-    msg_id:str=None, # id of message that placement is relative to (if None, uses current message)
+    sid:str=None, # sid of message that placement is relative to (if None, uses current message)
     **kwargs # additional Message fields such as skipped i/o_collapsed, etc, passed through to the server
 ):
-    "Add/update a message to the queue to show after code execution completes."
+    "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)."
     assert msg_type in ('note', 'code', 'prompt'), "msg_type must be 'code', 'note', or 'prompt'."
-    run_cmd('add_msg', content=content, msg_type=msg_type, output=output, placement=placement, msg_id=msg_id, **kwargs)
-
-# %% ../nbs/00_core.ipynb
-def update_msg(msg: dict):
-    "Update an existing message in the dialog."
-    if not isinstance(msg, dict): msg = asdict(msg)
-    exclude = {'id', 'content', 'msg_type', 'output'} # explicit args
-    kw = {k: v for k, v in msg.items() if k not in exclude}
-    add_msg(content=msg['content'], msg_type=msg['msg_type'], output=msg['output'],
-            placement='update', msg_id=msg['id'], **kw)
+    assert msg_type not in ('note') or not output, "'note' messages cannot have an output."
+    run_cmd('add_msg', content=content, msg_type=msg_type, output=output, placement=placement, sid=sid, **kwargs)
+
+# %% ../nbs/00_core.ipynb
+@delegates(add_msg)
+def update_msg(
+    msg:Optional[Dict]=None, # Dictionary of field keys/values to update
+    sid:str=None, # sid of message that placement is relative to (if None, uses current message)
+    content:str=None, # content of the message (i.e the message prompt, code, or note text)
+    **kwargs):
+    "Update an existing message. Provide either `msg` OR field key/values to update. Use `content` param to update contents. Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change)."
+    if content: kwargs['content']=content
+    assert bool(msg)^bool(kwargs), "Provide *either* msg, for kwargs, not both"
+    if msg and 'sid' in msg: target_id = msg['sid']
+    elif sid: target_id = sid
+    else: raise TypeError("update_msg needs either a dict message or `sid=...`")
+    old = asdict(get_db().t.message[target_id])
+    kw = old | (msg or {}) | kwargs
+    kw.pop('did', None)
+    return add_msg(placement='update', **kw)
 
 # %% ../nbs/00_core.ipynb
 def add_html(

{dialoghelper-0.0.4 → dialoghelper-0.0.6/dialoghelper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dialoghelper
-Version: 0.0.4
+Version: 0.0.6
 Summary: Helper functions for solveit dialogs
 Home-page: https://github.com/AnswerDotAI/dialoghelper
 Author: Jeremy Howard

{dialoghelper-0.0.4 → dialoghelper-0.0.6}/settings.ini

@@ -1,7 +1,7 @@
 [DEFAULT]
 repo = dialoghelper
 lib_name = dialoghelper
-version = 0.0.4
+version = 0.0.6
 min_python = 3.9
 license = apache2
 black_formatting = False

dialoghelper-0.0.4/dialoghelper/__init__.py

@@ -1,2 +0,0 @@
-__version__ = "0.0.4"
-from .core import *