dialoghelper 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

dialoghelper/__init__.py

@@ -1,2 +1,2 @@
-__version__ = "0.0.1"
+__version__ = "0.0.3"
 from .core import *

dialoghelper/_modidx.py

@@ -5,7 +5,8 @@ d = { 'settings': { 'branch': 'main',
                 'doc_host': 'https://AnswerDotAI.github.io',
                 'git_url': 'https://github.com/AnswerDotAI/dialoghelper',
                 'lib_path': 'dialoghelper'},
-  'syms': { 'dialoghelper.core': { 'dialoghelper.core.add_msg': ('core.html#add_msg', 'dialoghelper/core.py'),
+  'syms': { 'dialoghelper.core': { 'dialoghelper.core.add_html': ('core.html#add_html', 'dialoghelper/core.py'),
+                                   'dialoghelper.core.add_msg': ('core.html#add_msg', 'dialoghelper/core.py'),
                                    'dialoghelper.core.find_dialog_id': ('core.html#find_dialog_id', 'dialoghelper/core.py'),
                                    'dialoghelper.core.find_msg_id': ('core.html#find_msg_id', 'dialoghelper/core.py'),
                                    'dialoghelper.core.find_msgs': ('core.html#find_msgs', 'dialoghelper/core.py'),

dialoghelper/core.py

@@ -2,7 +2,7 @@
 
 # %% 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', 'load_gist', 'gist_file', 'import_string', 'import_gist']
+           'update_msg', 'add_html', 'load_gist', 'gist_file', 'import_string', 'import_gist']
 
 # %% ../nbs/00_core.ipynb
 import inspect, json, importlib, linecache
@@ -14,15 +14,18 @@ from ghapi.all import *
 from fastlite import *
 
 # %% ../nbs/00_core.ipynb
-def get_db():
-    if os.environ.get('IN_SOLVEIT', False): dataparent,nm = Path('/app'),'data.db'
+def get_db(ns:dict=None):
+    app_path = Path('/app') if Path('/.dockerenv').exists() else Path('.')
+    if os.environ.get('IN_SOLVEIT', False): dataparent,nm = app_path, 'data.db'
     else: dataparent,nm = Path('..'),'dev_data.db'
     db = database(dataparent/'data'/nm)
-    all_dcs(db)
+    dcs = [o for o in all_dcs(db) if o.__name__[0]!='_']
+    if ns:
+        for o in dcs: ns[o.__name__]=o
     return db
 
 # %% ../nbs/00_core.ipynb
-def find_var(var: str):
+def find_var(var:str):
     "Search for var in all frames of the call stack"
     frame = inspect.currentframe()
     while frame:
@@ -37,9 +40,13 @@ def find_dialog_id():
     return find_var('__dialog_id')
 
 # %% ../nbs/00_core.ipynb
-def find_msgs(pattern: str, limit=10):
+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."
     did = find_dialog_id()
+    db = get_db()
     return db.t.message('did=? AND content LIKE ?', [did, f'%{pattern}%'], limit=limit)
 
 # %% ../nbs/00_core.ipynb
@@ -51,6 +58,7 @@ def find_msg_id():
 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')]
 
 # %% ../nbs/00_core.ipynb
@@ -60,8 +68,8 @@ def msg_idx():
     return ids,ids.index(find_msg_id())
 
 # %% ../nbs/00_core.ipynb
-def read_msg(n: int=-1,     # Message index (if relative, +ve is downwards)
-             relative=True  # Is `n` relative to current message (True) or absolute (False)?
+def read_msg(n:int=-1,     # Message index (if relative, +ve is downwards)
+             relative:bool=True  # Is `n` relative to current message (True) or absolute (False)?
     ):
     "Get the message indexed in the current dialog."
     ids,idx = msg_idx()
@@ -69,6 +77,7 @@ def read_msg(n: int=-1,     # Message index (if relative, +ve is downwards)
         idx = idx+n
         if not 0<=idx<len(ids): return None
     else: idx = n
+    db = get_db()
     return db.t.message.fetchone('sid=?', [ids[idx]])
 
 # %% ../nbs/00_core.ipynb
@@ -77,35 +86,49 @@ def add_msg(
     msg_type: str='note', # message type, can be 'code', 'note', or 'prompt'
     output='', # for prompts/code, initial output
     placement='add_after', # can be 'add_after', 'add_before', 'update', 'at_start', 'at_end'
-    msg_id=None
+    msg_id:str=None, # id of message that placement is relative to (if None, uses current message)
+    **kw # 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."
     assert msg_type in ('note', 'code', 'prompt'), "msg_type must be 'code', 'note', or 'prompt'."
-    kwargs = dict(content=content, msg_type=msg_type, output=output, placement=placement)
-    if msg_id: kwargs['msg_id']=msg_id
-    run_cmd('add_msg', **kwargs)
+#     kwargs = {'msg_id':msg_id} if msg_id else {}
+    run_cmd('add_msg', content=content, msg_type=msg_type, output=output, placement=placement, msg_id=msg_id, **kw)
 
 # %% ../nbs/00_core.ipynb
-def update_msg(msg):
+def update_msg(msg: dict):
     "Update an existing message in the dialog."
-    add_msg(content=msg.content, msg_type=msg.msg_type, output=msg.output, placement='update', msg_id=msg.id)
+    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)
 
 # %% ../nbs/00_core.ipynb
-def load_gist(gist_id):
-    "Get the first file from a gist"
+def add_html(
+    html:str, # HTML to add to the DOM
+):
+    "Dynamically add HTML to the current web page. Supports HTMX attrs too."
+    run_cmd('add_ft', html=html)
+
+# %% ../nbs/00_core.ipynb
+def load_gist(gist_id:str):
+    "Retrieve a gist"
     api = GhApi()
     if '/' in gist_id: *_,user,gist_id = gist_id.split('/')
     else: user = None
     return api.gists.get(gist_id, user=user)
 
 # %% ../nbs/00_core.ipynb
-def gist_file(gist_id):
+def gist_file(gist_id:str):
     "Get the first file from a gist"
     gist = load_gist(gist_id)
     return first(gist.files.values())
 
 # %% ../nbs/00_core.ipynb
-def import_string(code, name):
+def import_string(
+    code:str, # Code to import as a module
+    name:str  # Name of module to create
+):
     with TemporaryDirectory() as tmpdir:
         path = Path(tmpdir) / f"{name}.py"
         path.write_text(code)
@@ -118,7 +141,11 @@ def import_string(code, name):
         return module
 
 # %% ../nbs/00_core.ipynb
-def import_gist(gist_id, mod_name=None, add_global=True):
+def import_gist(
+    gist_id:str, # user/id or just id of gist to import as a module
+    mod_name:str=None, # module name to create (taken from gist filename if not passed)
+    add_global:bool=True # add module to caller's globals?
+):
     "Import gist directly from string without saving to disk"
     fil = gist_file(gist_id)
     mod_name = mod_name or Path(fil['filename']).stem

{dialoghelper-0.0.1.dist-info → dialoghelper-0.0.3.dist-info}/METADATA

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

dialoghelper-0.0.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+dialoghelper/__init__.py,sha256=DyjzzgRJvp3QnEDlrwpSgOvDRy9Thxh14LVq-rV7GgI,42
+dialoghelper/_modidx.py,sha256=1PHT0r4S123iToeVNakiU2Yr2Y-53RX4cZyIxV3RbKQ,2033
+dialoghelper/core.py,sha256=-JuWSExqKql2Wtgf9xpEn9jDbwvpR0dwB-gbUCvromw,5832
+dialoghelper-0.0.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dialoghelper-0.0.3.dist-info/METADATA,sha256=3BjM2WdNrBNx8lQgURp-buL1uGmlXblSP-fBtuFeOvU,2557
+dialoghelper-0.0.3.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
+dialoghelper-0.0.3.dist-info/entry_points.txt,sha256=wvDeX-XTS_XVjWiiPQe6yVfmyNwy9eCr36ewp9baFIg,46
+dialoghelper-0.0.3.dist-info/top_level.txt,sha256=VXLlkgltFs_q-XB9imt2G64I_-MPm1RnxlpvUWPuLKM,13
+dialoghelper-0.0.3.dist-info/RECORD,,

dialoghelper-0.0.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-dialoghelper/__init__.py,sha256=XoppFCWM_8XsGAbynKKKg7C3Mca0Kzf_ueJ_7U-l9SE,42
-dialoghelper/_modidx.py,sha256=PYuQKjuQ7Xtn6uhXCn0NxhfKNqzABE2m3wSpyt4pGYI,1920
-dialoghelper/core.py,sha256=qXF8TeRvvL9aFdrQzAsSdULikTW__pu_L8ysBCqp25s,4672
-dialoghelper-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dialoghelper-0.0.1.dist-info/METADATA,sha256=99dHvGz7e8tkw1Bb1E7jb9UuKWxnoiDqeX0IAE7Kx7g,2557
-dialoghelper-0.0.1.dist-info/WHEEL,sha256=ck4Vq1_RXyvS4Jt6SI0Vz6fyVs4GWg7AINwpsaGEgPE,91
-dialoghelper-0.0.1.dist-info/entry_points.txt,sha256=wvDeX-XTS_XVjWiiPQe6yVfmyNwy9eCr36ewp9baFIg,46
-dialoghelper-0.0.1.dist-info/top_level.txt,sha256=VXLlkgltFs_q-XB9imt2G64I_-MPm1RnxlpvUWPuLKM,13
-dialoghelper-0.0.1.dist-info/RECORD,,