dialoghelper 0.0.5__tar.gz → 0.0.6__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dialoghelper
-Version: 0.0.5
+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.5 → dialoghelper-0.0.6}/dialoghelper/core.py

@@ -50,7 +50,7 @@ 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()
     res = db.t.message('did=? AND content LIKE ? ORDER BY mid', [did, f'%{pattern}%'], limit=limit)
@@ -108,10 +108,10 @@ def add_msg(
     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, # 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'."
     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)
@@ -120,10 +120,10 @@ def add_msg(
 @delegates(add_msg)
 def update_msg(
     msg:Optional[Dict]=None, # Dictionary of field keys/values to update
-    sid: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)
     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."
+    "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']

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

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

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

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

dialoghelper-0.0.5/dialoghelper/__init__.py

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