ivoryos 1.3.3__py3-none-any.whl → 1.3.5__py3-none-any.whl

ivoryos/__init__.py

@@ -1,8 +1,8 @@
-from ivoryos.server import run
+from ivoryos.server import run, global_config
 from ivoryos.optimizer.registry import OPTIMIZER_REGISTRY
 from ivoryos.version import __version__ as ivoryos_version
 from ivoryos.utils.decorators import block, BUILDING_BLOCKS
-from ivoryos.app import app
+from ivoryos.app import app, create_app, socketio, db
 
 __all__ = [
     "block",
@@ -11,4 +11,8 @@ __all__ = [
     "run",
     "app",
     "ivoryos_version",
+    "create_app",
+    "socketio",
+    "global_config",
+    "db"
 ]

ivoryos/app.py

@@ -41,7 +41,8 @@ def reset_old_schema(engine, db_dir):
     old_workflow_run = 'workflow_runs' in tables
     old_workflow_step = 'workflow_steps' in tables
 
-    if not has_workflow_phase:
+    # v1.3.4 only delete and backup when there is runs but no phases
+    if not has_workflow_phase and old_workflow_run:
         print("⚠️ Old workflow database detected! All previous workflows have been reset to support the new schema.")
         # Backup old DB
         db_path = os.path.join(db_dir, "ivoryos.db")

ivoryos/routes/control/control.py

@@ -23,7 +23,7 @@ control.register_blueprint(control_temp)
 @control.route("/", strict_slashes=False, methods=["GET", "POST"])
 @control.route("/<string:instrument>", strict_slashes=False, methods=["GET", "POST"])
 @login_required
-def deck_controllers(instrument: str = None):
+async def deck_controllers(instrument: str = None):
     """
     .. :quickref: Direct Control; device (instruments) and methods
 
@@ -82,7 +82,7 @@ def deck_controllers(instrument: str = None):
 
         wait = str(payload.get("hidden_wait", "true")).lower() == "true"
 
-        output = runner.run_single_step(
+        output = await runner.run_single_step(
             component=instrument, method=method_name, kwargs=kwargs, wait=wait,
             current_app=current_app._get_current_object()
         )

ivoryos/routes/design/design.py

@@ -87,8 +87,11 @@ def experiment_builder():
 
     # edit_action_info = session.get("edit_action")
 
-
-    exec_string = script.python_script if script.python_script else script.compile(current_app.config['SCRIPT_FOLDER'])
+    try:
+        exec_string = script.python_script if script.python_script else script.compile(current_app.config['SCRIPT_FOLDER'])
+    except Exception as e:
+        exec_string = {}
+        flash(f"Error in Python script: {e}")
     session['python_code'] = exec_string
 
     design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
@@ -316,6 +319,7 @@ def methods_handler(instrument: str = ''):
     msg = ""
     request.form
     if "hidden_name" in request.form:
+        deck_snapshot = global_config.deck_snapshot
         method_name = request.form.get("hidden_name", None)
         form = forms.get(method_name) if forms else None
         insert_position = request.form.get("drop_target_id", None)
@@ -334,7 +338,9 @@ def methods_handler(instrument: str = ''):
                 action = {"instrument": instrument, "action": function_name,
                           "args": kwargs,
                           "return": save_data,
-                          'arg_types': primitive_arg_types}
+                          'arg_types': primitive_arg_types,
+                          "coroutine": deck_snapshot[instrument][function_name].get("coroutine", False) if deck_snapshot else False,
+                          }
                 script.add_action(action=action, insert_position=insert_position)
             else:
                 msg = [f"{field}: {', '.join(messages)}" for field, messages in form.errors.items()]

ivoryos/routes/design/design_step.py

@@ -47,6 +47,7 @@ def save_step(uuid: int):
     """
     script = utils.get_script_file()
     action = script.find_by_uuid(uuid)
+    warning = None
     if action is not None:
         forms = create_form_from_action(action, script=script)
         kwargs = {field.name: field.data for field in forms if field.name != 'csrf_token'}
@@ -55,14 +56,19 @@ def save_step(uuid: int):
             kwargs = script.validate_variables(kwargs)
             script.update_by_uuid(uuid=uuid, args=kwargs, output=save_as)
         else:
-            flash(forms.errors)
+            warning = f"Compilation failed: {str(forms.errors)}"
     utils.post_script_file(script)
-    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    try:
+        exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    except Exception as e:
+        exec_string = {}
+        warning = f"Compilation failed: {str(e)}"
     session['python_code'] = exec_string
     design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
     return render_template("components/canvas_main.html",
-                               script=script,
-                               buttons_dict=design_buttons)
+                           script=script,
+                           buttons_dict=design_buttons,
+                           warning=warning)
 
 @steps.delete("/draft/steps/<int:uuid>")
 def delete_step(uuid: int):
@@ -82,12 +88,17 @@ def delete_step(uuid: int):
     if request.method == 'DELETE':
         script.delete_action(uuid)
     utils.post_script_file(script)
-    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    warning = None
+    try:
+        exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    except Exception as e:
+        exec_string = {}
+        warning = f"Compilation failed: {str(e)}"
     session['python_code'] = exec_string
     design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
     return render_template("components/canvas_main.html",
                                script=script,
-                               buttons_dict=design_buttons)
+                               buttons_dict=design_buttons, warning=warning)
 
 
 @steps.route("/draft/steps/<int:uuid>/duplicate", methods=["POST"], strict_slashes=False,)
@@ -107,13 +118,18 @@ def duplicate_action(uuid: int):
     script = utils.get_script_file()
     script.duplicate_action(uuid)
     utils.post_script_file(script)
-    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    warning = None
+    try:
+        exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    except Exception as e:
+        exec_string = {}
+        warning = f"Compilation failed: {str(e)}"
     session['python_code'] = exec_string
     design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
 
     return render_template("components/canvas_main.html",
                          script=script,
-                         buttons_dict=design_buttons)
+                         buttons_dict=design_buttons, warning=warning)
 
 
 @steps.route("/draft/steps/order", methods=['POST'])
@@ -133,13 +149,18 @@ def update_list():
     script = utils.get_script_file()
     script.currently_editing_order = order.split(",", len(script.currently_editing_script))
     script.sort_actions()
+    warning = None
 
     utils.post_script_file(script)
-    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    try:
+        exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
+    except Exception as e:
+        exec_string = {}
+        warning = f"Compilation failed: {str(e)}"
     session['python_code'] = exec_string
 
     # Return the updated canvas HTML instead of JSON
     design_buttons = {stype: create_action_button(script, stype) for stype in script.stypes}
     return render_template("components/canvas_main.html",
                            script=script,
-                           buttons_dict=design_buttons)
+                           buttons_dict=design_buttons, warning=warning)

ivoryos/routes/design/templates/components/canvas_main.html

@@ -31,4 +31,9 @@
 </div>
 <div class="python-code-wrapper" id="python-code-wrapper">
     {% include 'components/python_code_overlay.html' %}
-</div>
+</div>
+
+
+{% if warning %}
+<div id="warning" style="display:none;">{{ warning }}</div>
+{% endif %}

ivoryos/server.py

@@ -49,6 +49,7 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
         enable_design: bool = True,
         blueprint_plugins: Union[list, Blueprint] = [],
         exclude_names: list = [],
+        notification_handler=None,
         ):
     """
     Start ivoryOS app server.
@@ -65,6 +66,7 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
     :param enable_design: enable design canvas, database and workflow execution
     :param blueprint_plugins: Union[list[Blueprint], Blueprint] custom Blueprint pages
     :param exclude_names: list[str] module names to exclude from parsing
+    :param notification_handler: notification handler function
     """
     app = create_app(config_class=config or get_config())  # Create app instance using factory function
 
@@ -113,11 +115,33 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
                                        output_path=app.config["OUTPUT_FOLDER"] if module is not None else None)
     else:
         app.config["ENABLE_LLM"] = False
-    if logger and type(logger) is str:
-        utils.start_logger(socketio, log_filename=logger_path, logger_name=logger)
-    elif type(logger) is list:
-        for log in logger:
-            utils.start_logger(socketio, log_filename=logger_path, logger_name=log)
+
+
+    # --- Logger registration ---
+    if logger:
+        if isinstance(logger, str):
+            logger = [logger]  # convert single logger to list
+        elif not isinstance(logger, list):
+            raise TypeError("logger must be a string or a list of strings.")
+
+        for log_name in logger:
+            utils.start_logger(socketio, log_filename=logger_path, logger_name=log_name)
+
+    # --- Notification handler registration ---
+    if notification_handler:
+
+        # make it a list if a single function is passed
+        if callable(notification_handler):
+            notification_handler = [notification_handler]
+
+        if not isinstance(notification_handler, list):
+            raise ValueError("notification_handlers must be a callable or a list of callables.")
+
+        # validate all items are callable
+        for handler in notification_handler:
+            if not callable(handler):
+                raise TypeError(f"Handler {handler} is not callable.")
+            global_config.register_notification(handler)
 
     # TODO in case Python 3.12 or higher doesn't log URL
     # if sys.version_info >= (3, 12):
@@ -129,23 +153,6 @@ def run(module=None, host="0.0.0.0", port=None, debug=None, llm_server=None, mod
     # return app
 
 
-# def load_installed_plugins(app, socketio):
-#     """
-#     Dynamically load installed plugins and attach Flask-SocketIO.
-#     """
-#     plugin_names = []
-#     for entry_point in entry_points().get("ivoryos.plugins", []):
-#         plugin = entry_point.load()
-#
-#         # If the plugin has an `init_socketio()` function, pass socketio
-#         if hasattr(plugin, 'init_socketio'):
-#             plugin.init_socketio(socketio)
-#
-#         plugin_names.append(entry_point.name)
-#         app.register_blueprint(getattr(plugin, entry_point.name), url_prefix=f"{url_prefix}/{entry_point.name}")
-#
-#     return plugin_names
-
 
 def load_plugins(blueprints: Union[list, Blueprint], app, socketio):
     """

ivoryos/static/js/action_handlers.js

@@ -103,6 +103,12 @@ function submitEditForm(event) {
                 document.getElementById('instrument-panel').innerHTML = previousHtmlState;
                 previousHtmlState = null;  // Clear the stored state
             }
+            const parser = new DOMParser();
+            const doc = parser.parseFromString(html, 'text/html');
+            const warningDiv = doc.querySelector('#warning');
+            if (warningDiv && warningDiv.textContent.trim()) {
+                alert(warningDiv.textContent.trim()); // or use a nicer toast
+            }
         }
     })
     .catch(error => {
@@ -149,6 +155,13 @@ function duplicateAction(uuid) {
     .then(response => response.text())
     .then(html => {
         updateActionCanvas(html);
+
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(html, 'text/html');
+        const warningDiv = doc.querySelector('#warning');
+        if (warningDiv && warningDiv.textContent.trim()) {
+            alert(warningDiv.textContent.trim()); // or use a nicer toast
+        }
     })
     .catch(error => console.error('Error:', error));
 }
@@ -202,6 +215,13 @@ function deleteAction(uuid) {
     .then(html => {
         // Find the first list element's content and replace it
         updateActionCanvas(html);
+        // Optionally, check if a warning element exists
+        const parser = new DOMParser();
+        const doc = parser.parseFromString(html, 'text/html');
+        const warningDiv = doc.querySelector('#warning');
+        if (warningDiv && warningDiv.textContent.trim()) {
+            alert(warningDiv.textContent.trim()); // or use a nicer toast
+        }
     })
     .catch(error => console.error('Error:', error));
 }

ivoryos/utils/db_models.py

@@ -434,14 +434,21 @@ class Script(db.Model):
         :return: A dict containing script types as keys and lists of function body lines as values.
         """
         line_collection = {}
+
         for stype, func_str in exec_str_collection.items():
             if func_str:
                 module = ast.parse(func_str)
-                func_def = next(node for node in module.body if isinstance(node, ast.FunctionDef))
 
-                # Extract function body as source lines
-                line_collection[stype] = [ast_unparse(node) for node in func_def.body if not isinstance(node, ast.Return)]
-                # print(line_collection[stype])
+                # Find the first function (regular or async)
+                func_def = next(
+                    node for node in module.body
+                    if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))
+                )
+
+                # Extract function body as source lines, skipping 'return' nodes
+                line_collection[stype] = [
+                    ast_unparse(node) for node in func_def.body if not isinstance(node, ast.Return)
+                ]
         return line_collection
 
     def compile(self, script_path=None):
@@ -459,7 +466,8 @@ class Script(db.Model):
 
         for i in self.stypes:
             if self.script_dict[i]:
-                func_str = self._generate_function_header(run_name, i) + self._generate_function_body(i)
+                is_async = any(a.get("coroutine", False) for a in self.script_dict[i])
+                func_str = self._generate_function_header(run_name, i, is_async) + self._generate_function_body(i)
                 exec_str_collection[i] = func_str
         if script_path:
             self._write_to_file(script_path, run_name, exec_str_collection)
@@ -477,7 +485,7 @@ class Script(db.Model):
             name += '_'
         return name
 
-    def _generate_function_header(self, run_name, stype):
+    def _generate_function_header(self, run_name, stype, is_async):
         """
         Generate the function header.
         """
@@ -487,7 +495,8 @@ class Script(db.Model):
                      config_type.items()]
 
         script_type = f"_{stype}" if stype != "script" else ""
-        function_header = f"def {run_name}{script_type}("
+        async_str = "async " if is_async else ""
+        function_header = f"{async_str}def {run_name}{script_type}("
 
         if stype == "script":
             function_header += ", ".join(configure)
@@ -540,7 +549,8 @@ class Script(db.Model):
         # elif instrument == 'registered_workflows':
         #     return inspect.getsource(my_function)
         else:
-            return self._process_instrument_action(indent_unit, instrument, action_name, args, save_data)
+            is_async = action.get("coroutine", False)
+            return self._process_instrument_action(indent_unit, instrument, action_name, args, save_data, is_async)
 
     def _process_args(self, args):
         """
@@ -600,10 +610,12 @@ class Script(db.Model):
             indent_unit -= 1
         return exec_string, indent_unit
 
-    def _process_instrument_action(self, indent_unit, instrument, action, args, save_data):
+    def _process_instrument_action(self, indent_unit, instrument, action, args, save_data, is_async=False):
         """
         Process actions related to instruments.
         """
+        async_str = "await " if is_async else ""
+
         function_call = f"{instrument}.{action}"
         if instrument.startswith("blocks"):
             self.blocks_included = True
@@ -611,11 +623,11 @@ class Script(db.Model):
 
         if isinstance(args, dict) and args != {}:
             args_str = self._process_dict_args(args)
-            single_line = f"{function_call}(**{args_str})"
+            single_line = f"{async_str}{function_call}(**{args_str})"
         elif isinstance(args, str):
             single_line = f"{function_call} = {args}"
         else:
-            single_line = f"{function_call}()"
+            single_line = f"{async_str}{function_call}()"
 
         if save_data:
             save_data += " = "

ivoryos/utils/global_config.py

@@ -17,6 +17,8 @@ class GlobalConfig:
             cls._instance._runner_lock = threading.Lock()
             cls._instance._runner_status = None
             cls._instance._optimizers = {}
+            cls._instance._notification_handlers = []
+
         return cls._instance
 
     @property
@@ -28,6 +30,15 @@ class GlobalConfig:
         if self._deck is None:
             self._deck = value
 
+    def register_notification(self, handler):
+        if not callable(handler):
+            raise ValueError("Handler must be callable")
+        self._notification_handlers.append(handler)
+
+    @property
+    def notification_handlers(self):
+        return self._notification_handlers
+
     @property
     def building_blocks(self):
         return self._building_blocks

ivoryos/utils/py_to_json.py

@@ -55,6 +55,10 @@ def convert_to_cards(source_code: str):
         )
 
     class CardVisitor(ast.NodeVisitor):
+        def __init__(self):
+            self.defined_types = {}  # <-- always exists
+
+
         def visit_FunctionDef(self, node):
             self.defined_types = {
                 arg.arg: ast.unparse(arg.annotation) if arg.annotation else "float"
@@ -142,14 +146,20 @@ def convert_to_cards(source_code: str):
                     "return": "",
                     "uuid": generate_uuid()
                 })
+            elif isinstance(node.value, ast.Await):
+                self.handle_call(node.value.value, ret_var=node.targets[0].id, awaited=True)
+
             elif isinstance(node.value, ast.Call):
                 self.handle_call(node.value, ret_var=node.targets[0].id)
 
         def visit_Expr(self, node):
-            if isinstance(node.value, ast.Call):
+            if isinstance(node.value, ast.Await):
+                # node.value is ast.Await
+                self.handle_call(node.value.value, awaited=True)
+            elif isinstance(node.value, ast.Call):
                 self.handle_call(node.value)
 
-        def handle_call(self, node, ret_var=""):
+        def handle_call(self, node, ret_var="", awaited=False):
             func_parts = []
             f = node.func
             while isinstance(f, ast.Attribute):
@@ -229,7 +239,7 @@ def convert_to_cards(source_code: str):
                         else infer_type(value)
                     )
 
-            add_card({
+            card = {
                 "action": action,
                 "arg_types": arg_types,
                 "args": args,
@@ -237,7 +247,12 @@ def convert_to_cards(source_code: str):
                 "instrument": instrument,
                 "return": ret_var,
                 "uuid": generate_uuid()
-            })
+            }
+
+            if awaited:
+                card["coroutine"] = True  # mark as coroutine if awaited
+
+            add_card(card)
 
     CardVisitor().visit(tree)
     return cards

ivoryos/utils/script_runner.py

@@ -1,4 +1,5 @@
 import ast
+import asyncio
 import os
 import csv
 import threading
@@ -19,6 +20,14 @@ class HumanInterventionRequired(Exception):
     pass
 
 def pause(reason="Human intervention required"):
+    handlers = global_config.notification_handlers
+    if handlers:
+        for handler in handlers:
+            try:
+                handler(reason)
+            except Exception as e:
+                print(f"[notify] handler {handler} failed: {e}")
+    # raise error to pause workflow in gui
     raise HumanInterventionRequired(reason)
 
 class ScriptRunner:
@@ -161,7 +170,7 @@ class ScriptRunner:
                 start_time=datetime.now(),
             )
             db.session.add(step)
-            db.session.commit()
+            db.session.flush()
 
             logger.info(f"Executing: {line}")
             socketio.emit('execution', {'section': f"{section_name}-{index}"})
@@ -174,7 +183,26 @@ class ScriptRunner:
                     duration = float(duration_str)
                     self.safe_sleep(duration)
                 else:
-                    exec(line, exec_globals, exec_locals)
+                    if "await " in line:
+                        async_code = f"async def __async_exec_wrapper():\n"
+                        # indent all code lines by 4 spaces
+                        async_code += "\n".join("    " + line for line in line.splitlines())
+                        async_code += f"\n    return locals()"
+                        exec(async_code, exec_globals, exec_locals)
+                        func = exec_locals.get("__async_exec_wrapper") or exec_globals.get("__async_exec_wrapper")
+                        # Capture the return value from asyncio.run
+                        result_locals = asyncio.run(func())
+
+                        # Update exec_locals with the returned locals
+                        exec_locals.update(result_locals)
+
+
+                    else:
+                        print("just exec synchronously")
+                        exec(line, exec_globals, exec_locals)
+                        exec_globals.update(exec_locals)
+                        # return locals_dict
+                    # exec(line, exec_globals, exec_locals)
                 # step.run_error = False
 
             except HumanInterventionRequired as e:
@@ -190,6 +218,7 @@ class ScriptRunner:
 
                 step.run_error = True
                 self.toggle_pause()
+            exec_locals.pop("__async_exec_wrapper", None)
             step.end_time = datetime.now()
             step.output = exec_locals
             db.session.commit()
@@ -219,7 +248,7 @@ class ScriptRunner:
                               repeat_mode=repeat_mode
                               )
             db.session.add(run)
-            db.session.commit()
+            db.session.flush()
             run_id = run.id  # Save the ID
             try:
 
@@ -241,7 +270,7 @@ class ScriptRunner:
                 self._run_actions(script, section_name="cleanup", logger=logger, socketio=socketio,run_id=run_id)
                 # Reset the running flag when done
                 # Save results if necessary
-                if not script.python_script and output_list:
+                if not script.python_script and return_list:
                     filename = self._save_results(run_name, arg_type, return_list, output_list, logger, output_path)
                 self._emit_progress(socketio, 100)
 
@@ -277,7 +306,7 @@ class ScriptRunner:
             start_time=datetime.now()
         )
         db.session.add(phase)
-        db.session.commit()
+        db.session.flush()
         phase_id = phase.id
 
         step_outputs = self.exec_steps(script, section_name, logger, socketio, phase_id=phase_id)
@@ -317,7 +346,7 @@ class ScriptRunner:
                     start_time=datetime.now()
                 )
                 db.session.add(phase)
-                db.session.commit()
+                db.session.flush()
 
                 phase_id = phase.id
                 output = self.exec_steps(script, "script", logger, socketio, phase_id, **kwargs)
@@ -371,7 +400,7 @@ class ScriptRunner:
                 start_time=datetime.now()
             )
             db.session.add(phase)
-            db.session.commit()
+            db.session.flush()
             phase_id = phase.id
 
             logger.info(f'Executing {run_name} experiment: {i_progress + 1}/{int(repeat_count)}')

ivoryos/utils/task_runner.py

@@ -1,3 +1,5 @@
+import inspect
+import asyncio
 import threading
 import time
 from datetime import datetime
@@ -19,8 +21,7 @@ class TaskRunner:
         self.globals_dict = globals_dict
         self.lock = global_config.runner_lock
 
-
-    def run_single_step(self, component, method, kwargs, wait=True, current_app=None):
+    async def run_single_step(self, component, method, kwargs, wait=True, current_app=None):
         global deck
         if deck is None:
             deck = global_config.deck
@@ -29,18 +30,18 @@ class TaskRunner:
         if not self.lock.acquire(blocking=False):
             current_status = global_config.runner_status
             current_status["status"] = "busy"
+            current_status["output"] = "busy"
             return current_status
 
-
         if wait:
-            output = self._run_single_step(component, method, kwargs, current_app)
+            output = await self._run_single_step(component, method, kwargs, current_app)
         else:
-            print("running with thread")
-            thread = threading.Thread(
-                target=self._run_single_step, args=(component, method, kwargs, current_app)
-            )
-            thread.start()
-            time.sleep(0.1)
+            # Create background task properly
+            async def background_runner():
+                await self._run_single_step(component, method, kwargs, current_app)
+
+            asyncio.create_task(background_runner())
+            await asyncio.sleep(0.1)  # Change time.sleep to await asyncio.sleep
             output = {"status": "task started", "task_id": global_config.runner_status.get("id")}
 
         return output
@@ -59,22 +60,32 @@ class TaskRunner:
             function_executable = getattr(instrument, method)
         return function_executable
 
-    def _run_single_step(self, component, method, kwargs, current_app=None):
+    async def _run_single_step(self, component, method, kwargs, current_app=None):
         try:
             function_executable = self._get_executable(component, deck, method)
             method_name = f"{component}.{method}"
         except Exception as e:
             self.lock.release()
-            return {"status": "error", "msg": e.__str__()}
+            return {"status": "error", "msg": str(e)}
 
-        # with self.lock:
+        # Flask context is NOT async → just use normal "with"
         with current_app.app_context():
-            step = SingleStep(method_name=method_name, kwargs=kwargs, run_error=None, start_time=datetime.now())
+            step = SingleStep(
+                method_name=method_name,
+                kwargs=kwargs,
+                run_error=None,
+                start_time=datetime.now()
+            )
             db.session.add(step)
-            db.session.commit()
-            global_config.runner_status = {"id":step.id, "type": "task"}
+            db.session.flush()
+            global_config.runner_status = {"id": step.id, "type": "task"}
+
             try:
-                output = function_executable(**kwargs)
+                if inspect.iscoroutinefunction(function_executable):
+                    output = await function_executable(**kwargs)
+                else:
+                    output = function_executable(**kwargs)
+
                 step.output = output
                 step.end_time = datetime.now()
                 success = True
@@ -86,4 +97,5 @@ class TaskRunner:
             finally:
                 db.session.commit()
                 self.lock.release()
-            return dict(success=success, output=output)
+
+            return dict(success=success, output=output)

ivoryos/utils/utils.py

@@ -105,7 +105,8 @@ def _inspect_class(class_object=None, debug=False):
             try:
                 annotation = inspect.signature(method)
                 docstring = inspect.getdoc(method)
-                functions[function] = dict(signature=annotation, docstring=docstring)
+                coroutine = inspect.iscoroutinefunction(method)
+                functions[function] = dict(signature=annotation, docstring=docstring, coroutine=coroutine,)
 
             except Exception:
                 pass
@@ -141,6 +142,7 @@ def _get_type_from_parameters(arg, parameters):
 def _convert_by_str(args, arg_types):
     """
     Converts a value to type through eval(f'{type}("{args}")')
+    v1.3.4 TODO try str lastly, otherwise it's always converted to str
     """
     if type(arg_types) is not list:
         arg_types = [arg_types]

ivoryos/version.py

@@ -1 +1 @@
-__version__ = "1.3.3"
+__version__ = "1.3.5"

{ivoryos-1.3.3.dist-info → ivoryos-1.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ivoryos
-Version: 1.3.3
+Version: 1.3.5
 Summary: an open-source Python package enabling Self-Driving Labs (SDLs) interoperability
 Author-email: Ivory Zhang <ivoryzhang@chem.ubc.ca>
 License: MIT
@@ -17,9 +17,19 @@ Requires-Dist: Flask-WTF
 Requires-Dist: SQLAlchemy-Utils
 Requires-Dist: python-dotenv
 Requires-Dist: astor; python_version < "3.9"
+Provides-Extra: optimizer-ax
+Requires-Dist: ax-platform; extra == "optimizer-ax"
+Provides-Extra: optimizer-baybe
+Requires-Dist: baybe; extra == "optimizer-baybe"
 Provides-Extra: optimizer
 Requires-Dist: ax-platform; extra == "optimizer"
 Requires-Dist: baybe; extra == "optimizer"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-rtd-theme; extra == "doc"
+Requires-Dist: sphinxcontrib-httpdomain; extra == "doc"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
 Dynamic: license-file
 
 [![Documentation Status](https://readthedocs.org/projects/ivoryos/badge/?version=latest)](https://ivoryos.readthedocs.io/en/latest/?badge=latest)
@@ -28,7 +38,8 @@ Dynamic: license-file
 [![YouTube](https://img.shields.io/badge/YouTube-tutorial-red?logo=youtube)](https://youtu.be/dFfJv9I2-1g)
 [![YouTube](https://img.shields.io/badge/YouTube-demo-red?logo=youtube)](https://youtu.be/flr5ydiE96s)
 [![Published](https://img.shields.io/badge/Nature_Comm.-paper-blue)](https://www.nature.com/articles/s41467-025-60514-w)
-[![Discord](https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2)](https://discord.gg/AX5P9EdGVX)
+
+[//]: # ([![Discord]&#40;https://img.shields.io/discord/1313641159356059770?label=Discord&logo=discord&color=5865F2&#41;]&#40;https://discord.gg/AX5P9EdGVX&#41;)
 
 ![](https://gitlab.com/heingroup/ivoryos/raw/main/docs/source/_static/ivoryos.png)
 # ivoryOS: interoperable Web UI for self-driving laboratories (SDLs)
@@ -101,11 +112,14 @@ pip install -e .
 ## Quick start
 In your SDL script, 
 ```python
+my_robot = Robot()
+
 import ivoryos
 
 ivoryos.run(__name__)
 ```
-Login: Create an account (local DB, bcrypt password)
+You can now access the web UI at http://127.0.0.1:8000,
+create an account, login, and start designing workflows!
 
 ----
 ## Features
@@ -127,6 +141,28 @@ Add single or multiple loggers:
 ivoryos.run(__name__, logger="logger name")
 ivoryos.run(__name__, logger=["logger 1", "logger 2"])
 ```
+### Human-in-the-loop
+Add single or multiple notification handlers for `pause` feature in flow control:
+```python
+
+def slack_bot(msg: str = "Hi"):
+    """
+    a function that can be used as a notification handler function("msg")
+    :param msg: message to send
+    """
+    from slack_sdk import WebClient
+
+    slack_token = "your slack token"
+    client = WebClient(token=slack_token)
+
+    my_user_id = "your user id"  # replace with your actual Slack user ID
+
+    client.chat_postMessage(channel=my_user_id, text=msg)
+
+import ivoryos
+ivoryos.run(__name__, notification_handler=slack_bot)
+```
+
 ### Directory Structure
 
 Created automatically on first run:
@@ -152,11 +188,10 @@ ivoryos.run(__name__)
 
 ## Roadmap
 
-- [x] Allow plugin pages ✅  
-- [x] pause, resume, abort current and pending workflows ✅
 - [ ] dropdown input 
 - [ ] snapshot version control
 - [ ] optimizer-agnostic
+- [ ] prefect compatibility
 - [ ] check batch-config file compatibility
 
 ---
@@ -198,4 +233,4 @@ For an additional perspective related to the development of the tool, please see
 ```
 ---
 ## Acknowledgements
-Authors acknowledge Telescope Innovations Corp., Hein Lab members for their valuable suggestions and contributions.
+Authors acknowledge Telescope Innovations Corp., UBC Hein Lab, and Acceleration Consortium members for their valuable suggestions and contributions.

{ivoryos-1.3.3.dist-info → ivoryos-1.3.5.dist-info}/RECORD

@@ -1,9 +1,9 @@
-ivoryos/__init__.py,sha256=Or4kPfDSQA5WYrQdnBlWl_dA4wwjhEqNkuE5XPX3bqI,358
-ivoryos/app.py,sha256=fuHVjJcJVc0i3Qe5aOOVQCe1Vetc4zTa4S1Z_xCjBZs,4749
+ivoryos/__init__.py,sha256=gEvBO2y5TRq06Itjjej3iAcq73UsihqKPWcb2HykPwM,463
+ivoryos/app.py,sha256=G6kzEOVzCduj7Fc2r1rMbMFHgDzZQV0lC20Oxps7RSM,4839
 ivoryos/config.py,sha256=y3RxNjiIola9tK7jg-mHM8EzLMwiLwOzoisXkDvj0gA,2174
-ivoryos/server.py,sha256=K0_Ioui0uKshKl5fxGB_1wJD4OckXyR9DdOfCIhvkfE,6742
+ivoryos/server.py,sha256=5tXrgG16lm6Fl-Q-ZHxiGQQoyZQFxRhdDf6idNYqhNg,6985
 ivoryos/socket_handlers.py,sha256=VWVWiIdm4jYAutwGu6R0t1nK5MuMyOCL0xAnFn06jWQ,1302
-ivoryos/version.py,sha256=Vi6om3KImlKsS_Wg5CjUgYffoi2zx7T-SRPnnGL0G7M,22
+ivoryos/version.py,sha256=tdqvkGH0OryRjjXzO3HS5DyYol-VTO9fC8m43nB2PgI,22
 ivoryos/optimizer/ax_optimizer.py,sha256=PoSu8hrDFFpqyhRBnaSMswIUsDfEX6sPWt8NEZ_sobs,7112
 ivoryos/optimizer/base_optimizer.py,sha256=JTbUharZKn0t8_BDbAFuwZIbT1VOnX1Xuog1pJuU8hY,1992
 ivoryos/optimizer/baybe_optimizer.py,sha256=EdrrRiYO-IOx610cPXiQhH4qG8knUP0uiZ0YoyaGIU8,7954
@@ -15,7 +15,7 @@ ivoryos/routes/auth/auth.py,sha256=D-sPEaUsc8vefly36h74rgU-ILulf7hiK6xc5sBEl58,3
 ivoryos/routes/auth/templates/login.html,sha256=WSRrKbdM_oobqSXFRTo-j9UlOgp6sYzS9tm7TqqPULI,1207
 ivoryos/routes/auth/templates/signup.html,sha256=b5LTXtpfTSkSS7X8u1ldwQbbgEFTk6UNMAediA5BwBY,1465
 ivoryos/routes/control/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ivoryos/routes/control/control.py,sha256=rYXMHIfX17tFBgIZoXxKfDSoeZaRdCd621twh0V4DgQ,6430
+ivoryos/routes/control/control.py,sha256=0g23PoPPoTeMD7Szm3UAW10sEMLpSD-iTfASAZE4iIE,6442
 ivoryos/routes/control/control_file.py,sha256=3fQ9R8EcdqKs_hABn2EqRAB1xC2DHAT_q_pwsMIDDQI,864
 ivoryos/routes/control/control_new_device.py,sha256=mfJKg5JAOagIpUKbp2b5nRwvd2V3bzT3M0zIhIsEaFM,5456
 ivoryos/routes/control/utils.py,sha256=XlhhqAtOj7n3XfHPDxJ8TvCV2K2I2IixB0CBkl1QeQc,1242
@@ -27,9 +27,9 @@ ivoryos/routes/data/templates/workflow_database.html,sha256=ofvHcovpwmJXo1SFiSrL
 ivoryos/routes/data/templates/workflow_view.html,sha256=Ti17kzlPlYTmzx5MkdsPlXJ1_k6QgMYQBM6FHjG50go,12491
 ivoryos/routes/data/templates/components/step_card.html,sha256=XWsr7qxAY76RCuQHETubWjWBlPgs2HkviH4ju6qfBKo,1923
 ivoryos/routes/design/__init__.py,sha256=zS3HXKaw0ALL5n6t_W1rUz5Uj5_tTQ-Y1VMXyzewvR0,113
-ivoryos/routes/design/design.py,sha256=h55RZ_SDbkmA647GmkD-Sc2_en5vyBK8foE-arrPEdk,18244
+ivoryos/routes/design/design.py,sha256=8xWsJxs-jg3r1yszzvHWK0mccYoYlgzhO_dTV7aEA_w,18567
 ivoryos/routes/design/design_file.py,sha256=MVIc5uGSaGxZhs86hfPjX2n0iy1OcXeLq7b9Ucdg4VQ,2115
-ivoryos/routes/design/design_step.py,sha256=zW6kOhX-zJbtX1x5NaVPm79HZjKBzAWevmqJ2Y3qqpg,5218
+ivoryos/routes/design/design_step.py,sha256=maDaR-CFK6UY_ajbQeYJ_onwYW0e9nMD-HgrhsSU6JY,5874
 ivoryos/routes/design/templates/experiment_builder.html,sha256=hh-d2tOc_40gww5WfUYIf8sM3qBaALZnR8Sx7Ja4tpU,1623
 ivoryos/routes/design/templates/components/action_form.html,sha256=kXJOrJLbFsMHHWVSuMQHpt1xFrUMnwgzTG8e6Qfn0Cg,3042
 ivoryos/routes/design/templates/components/actions_panel.html,sha256=jHTR58saTUIZInBdC-vLc1ZTbStLiULeWbupjB4hQzo,977
@@ -37,7 +37,7 @@ ivoryos/routes/design/templates/components/autofill_toggle.html,sha256=CRVQUHoQT
 ivoryos/routes/design/templates/components/canvas.html,sha256=bKLCJaG1B36Yy9Vsnz4P5qiX4BPdfaGe9JeQQzu9rsI,268
 ivoryos/routes/design/templates/components/canvas_footer.html,sha256=5VRRacMZbzx0hUej0NPP-PmXM_AtUqduHzDS7a60cQY,435
 ivoryos/routes/design/templates/components/canvas_header.html,sha256=7iIzLDGHX7MnmBbf98nWtLDprbeIgoNV4dJUO1zE4Tc,3598
-ivoryos/routes/design/templates/components/canvas_main.html,sha256=9inYO700zRa09lfQI2NY4FJGGeTh-9rvX4ltjj0LK3k,1432
+ivoryos/routes/design/templates/components/canvas_main.html,sha256=nLEtp3U2YtfJwob1kR8ua8-UVdu9hwc6z1L5UMNVz8c,1524
 ivoryos/routes/design/templates/components/deck_selector.html,sha256=ryTRpljYezo0AzGLCJu_qOMokjjnft3GIxddmNGtBA0,657
 ivoryos/routes/design/templates/components/edit_action_form.html,sha256=Dz7FnnOK4PYptAHNy9_WFCU1RZTSV61-1lNHHOSRJNs,1876
 ivoryos/routes/design/templates/components/instruments_panel.html,sha256=tRKd-wOqKjaMJCLuGgRmHtxIgSjklhBkuX8arm5aTCU,4268
@@ -74,7 +74,7 @@ ivoryos/static/logo.webp,sha256=lXgfQR-4mHTH83k7VV9iB54-oC2ipe6uZvbwdOnLETc,1497
 ivoryos/static/style.css,sha256=zQVx35A5g6JMJ-K84-6fSKtzXGjp_p5ZVG6KLHPM2IE,4021
 ivoryos/static/gui_annotation/Slide1.png,sha256=Lm4gdOkUF5HIUFaB94tl6koQVkzpitKj43GXV_XYMMc,121727
 ivoryos/static/gui_annotation/Slide2.PNG,sha256=z3wQ9oVgg4JTWVLQGKK_KhtepRHUYP1e05XUWGT2A0I,118761
-ivoryos/static/js/action_handlers.js,sha256=UJHKFhYRNQRBo0AHLCIxhWxt8OSgYeyLynzPIPNhbeY,5125
+ivoryos/static/js/action_handlers.js,sha256=DnNYV5mITADKp14I6NaByNRzHco0dDPP2fuSM43x2hY,6119
 ivoryos/static/js/db_delete.js,sha256=l67fqUaN_FVDaL7v91Hd7LyRbxnqXx9nyjF34-7aewY,561
 ivoryos/static/js/overlay.js,sha256=dPxop19es0E0ZUSY3d_4exIk7CJuQEnlW5uTt5fZfzI,483
 ivoryos/static/js/script_metadata.js,sha256=m8VYZ8OGT2oTx1kXMXq60bKQI9WCbJNkzcFDzLvRuGc,1188
@@ -86,18 +86,18 @@ ivoryos/templates/base.html,sha256=cl5w6E8yskbUzdiJFal6fZjnPuFNKEzc7BrrbRd6bMI,8
 ivoryos/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 ivoryos/utils/bo_campaign.py,sha256=Fil-zT7JexL_p9XqyWByjAk42XB1R9XUKN8CdV5bi6c,9714
 ivoryos/utils/client_proxy.py,sha256=74G3HAuq50iEHkSvlMZFmQaukm613FbRgOdzO_T3dMg,10191
-ivoryos/utils/db_models.py,sha256=TaRA65Zmj2lIqQk5sDoQzP_od6QnPUYJgvDAV9LkqYM,31074
+ivoryos/utils/db_models.py,sha256=i1fLiWFnese2xqAfWipN9eUDHeuy6eIYE9_cY6YZ6NU,31553
 ivoryos/utils/decorators.py,sha256=p1Bdl3dCeaHNv6-cCCUOZMiFu9kRaqqQnkFJUkzPoJE,991
 ivoryos/utils/form.py,sha256=Ej9tx06KZZ5fPQm1ho1byotNocF3u24aatc2ZyI0rK4,22301
-ivoryos/utils/global_config.py,sha256=D6oz5dttyaP24jbqnw1sR64moSb-7jJkSpRuufdA_TI,2747
+ivoryos/utils/global_config.py,sha256=leYoEXvAS0AH4xQpYsqu4HI9CJ9-wiLM-pIh_bEG4Ak,3087
 ivoryos/utils/llm_agent.py,sha256=-lVCkjPlpLues9sNTmaT7bT4sdhWvV2DiojNwzB2Lcw,6422
-ivoryos/utils/py_to_json.py,sha256=pd-tkbe6CwZxrB2rkozx3_R6D_KIuKkyJNRqAcjNt1g,9204
-ivoryos/utils/script_runner.py,sha256=I_ghDVT7_O9RQ30J0rC3guaAM76-sin6OJc50uB1u8Q,19362
+ivoryos/utils/py_to_json.py,sha256=ZtejHgwdEAUCVVMYeVNR8G7ceLINue294q6WpiJ6jn0,9734
+ivoryos/utils/script_runner.py,sha256=qozSrlpnsk5rZzui8WT59cMaw41ZfsYKvofAXdDiC5A,20747
 ivoryos/utils/serilize.py,sha256=lkBhkz8r2bLmz2_xOb0c4ptSSOqjIu6krj5YYK4Nvj8,6784
-ivoryos/utils/task_runner.py,sha256=bfG6GubdlzgD8rBwzD00aGB5LDFmb9hLFJIOMH8hVv4,3248
-ivoryos/utils/utils.py,sha256=09VPNRaIoA-mp1TXLGC3BwM2tDaAJ36csvNtW19KsU0,14792
-ivoryos-1.3.3.dist-info/licenses/LICENSE,sha256=p2c8S8i-8YqMpZCJnadLz1-ofxnRMILzz6NCMIypRag,1084
-ivoryos-1.3.3.dist-info/METADATA,sha256=6Rf7TJmuO7qOUFGP413fCcg4xmdCF_oZ48Np7j7wYlY,7351
-ivoryos-1.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-ivoryos-1.3.3.dist-info/top_level.txt,sha256=FRIWWdiEvRKqw-XfF_UK3XV0CrnNb6EmVbEgjaVazRM,8
-ivoryos-1.3.3.dist-info/RECORD,,
+ivoryos/utils/task_runner.py,sha256=xiMzK8gQ0mHsg0A1Ah8fmXe3azpaJh4hJiQJLHA11ZQ,3682
+ivoryos/utils/utils.py,sha256=dIc4BO55eS3lCA0nhbIncS5d7sLaKZy5hJS1I_Sm45o,14949
+ivoryos-1.3.5.dist-info/licenses/LICENSE,sha256=p2c8S8i-8YqMpZCJnadLz1-ofxnRMILzz6NCMIypRag,1084
+ivoryos-1.3.5.dist-info/METADATA,sha256=z3rNHhq2GaCBN6bWwi6JtUXn8fWzkigMR-_PuKHgFtc,8403
+ivoryos-1.3.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+ivoryos-1.3.5.dist-info/top_level.txt,sha256=FRIWWdiEvRKqw-XfF_UK3XV0CrnNb6EmVbEgjaVazRM,8
+ivoryos-1.3.5.dist-info/RECORD,,