dialoghelper 0.0.13__tar.gz → 0.0.15__tar.gz

{dialoghelper-0.0.13/dialoghelper.egg-info → dialoghelper-0.0.15}/PKG-INFO

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

dialoghelper-0.0.15/dialoghelper/__init__.py

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

{dialoghelper-0.0.13 → dialoghelper-0.0.15}/dialoghelper/core.py

@@ -57,8 +57,8 @@ def find_msgs(
     msg_type:str=None, # optional limit by message type ('code', 'note', or 'prompt')
     limit:int=None, # Optionally limit number of returned items
     include_output:bool=True # Include output in returned dict?
-):
-    "Find messages in current specific dialog that contain the given information. To refer to a message found later, use its `sid` field (which is the pk)."
+)->list[dict]:
+    "Find `list[dict]` of messages in current specific dialog that contain the given information. To refer to a message found later, use its `sid` field (which is the pk)."
     did = find_dialog_id()
     db = get_db()
     res = db.t.message('did=? AND content LIKE ? ORDER BY mid', [did, f'%{pattern}%'], limit=limit)
@@ -73,7 +73,7 @@ def find_msg_id():
     return find_var('__msg_id')
 
 # %% ../nbs/00_core.ipynb
-def read_msg_ids():
+def read_msg_ids()->list[str]:
     "Get all ids in current dialog."
     did = find_dialog_id()
     db = get_db()
@@ -89,7 +89,7 @@ def msg_idx():
 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."
+    "Get the `Message` object indexed in the current dialog."
     ids,idx = msg_idx()
     if relative:
         idx = idx+n
@@ -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 @@ 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
@@ -144,7 +152,7 @@ def _add_msg_unsafe(
 ):
     """Add/update a message to the queue to show after code execution completes, and optionally run it. Be sure to pass a `sid` (stable id) not a `mid` (which is used only for sorting, and can change).
     *WARNING*--This can execute arbitrary code, so check carefully what you run!--*WARNING"""
-    add_msg(content=content, run=run, **kwargs)
+    return add_msg(content=content, run=run, **kwargs)
 
 # %% ../nbs/00_core.ipynb
 def _umsg(
@@ -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):

{dialoghelper-0.0.13 → dialoghelper-0.0.15/dialoghelper.egg-info}/PKG-INFO

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

{dialoghelper-0.0.13 → dialoghelper-0.0.15}/settings.ini

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

dialoghelper-0.0.13/dialoghelper/__init__.py

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