ivoryos 1.0.1__py3-none-any.whl → 1.0.4__py3-none-any.whl

ivoryos/routes/database/templates/database/{experiment_database.html → scripts_database.html}

@@ -35,19 +35,19 @@
             </tr>
         </thead>
         <tbody>
-            {% for workflow in workflows %}
+            {% for script in scripts %}
                 <tr>
-                    <td><a href="{{ url_for('database.edit_workflow', workflow_name=workflow.name) }}">{{ workflow.name }}</a></td>
-                    <td>{{ workflow.deck }}</td>
-                    <td>{{ workflow.status }}</td>
-                    <td>{{ workflow.time_created }}</td>
-                    <td>{{ workflow.last_modified }}</td>
-                    <td>{{ workflow.author }}</td>
+                    <td><a href="{{ url_for('database.edit_workflow', script_name=script.name) }}">{{ script.name }}</a></td>
+                    <td>{{ script.deck }}</td>
+                    <td>{{ script.status }}</td>
+                    <td>{{ script.time_created }}</td>
+                    <td>{{ script.last_modified }}</td>
+                    <td>{{ script.author }}</td>
 {#                    <td>{{ workflow.registered }}</td>#}
                     <td>
                         {#not workflow.status == "finalized" or#}
-                        {% if session['user'] == 'admin' or session['user'] == workflow.author %}
-                            <a href="{{ url_for('database.delete_workflow', workflow_name=workflow.name) }}">delete</a>
+                        {% if session['user'] == 'admin' or session['user'] == script.author %}
+                            <a href="{{ url_for('database.delete_workflow', script_name=script.name) }}">delete</a>
                         {% else %}
                             <a class="disabled-link">delete</a>
                         {% endif %}
@@ -57,18 +57,27 @@
         </tbody>
     </table>
 
-{#    paging#}
+    {#    paging#}
     <div class="pagination justify-content-center">
-        <div class="page-item {{ 'disabled' if not workflows.has_prev else '' }}">
-            <a class="page-link" href="{{ url_for('database.load_from_database', page=workflows.prev_num) }}">Previous</a>
+        <div class="page-item {{ 'disabled' if not scripts.has_prev else '' }}">
+            <a class="page-link" href="{{ url_for('database.load_from_database', page=scripts.prev_num) }}">Previous</a>
         </div>
-        {% for num in workflows.iter_pages() %}
-            <div class="page-item">
-                <a class="page-link {{ 'active' if num == workflows.page else '' }}" href="{{ url_for('database.load_from_database', page=num) }}">{{ num }}</a>
-            </div>
+
+        {% for num in scripts.iter_pages() %}
+            {% if num %}
+                <div class="page-item {{ 'active' if num == scripts.page else '' }}">
+                    <a class="page-link" href="{{ url_for('database.load_from_database', page=num) }}">{{ num }}</a>
+                </div>
+            {% else %}
+                <div class="page-item disabled">
+                    <span class="page-link">…</span>
+                </div>
+            {% endif %}
         {% endfor %}
-        <div class="page-item {{ 'disabled' if not workflows.has_next else '' }}">
-            <a class="page-link" href="{{ url_for('database.load_from_database', page=workflows.next_num) }}">Next</a>
+
+        <div class="page-item {{ 'disabled' if not scripts.has_next else '' }}">
+            <a class="page-link" href="{{ url_for('database.load_from_database', page=scripts.next_num) }}">Next</a>
         </div>
     </div>
+
 {% endblock %}

ivoryos/routes/database/templates/database/{workflow_run_database.html → workflow_database.html}

@@ -2,11 +2,24 @@
 
 {% block title %}IvoryOS | Design Database{% endblock %}
 {% block body %}
+    <div class="div">
+        <form id="search" style="display: inline-block;float: right;" action="{{url_for('database.list_workflows',deck_name=deck_name)}}" method="GET">
+            <div class="input-group">
+                <div class="form-outline">
+                    <input type="search" name="keyword" id="keyword" class="form-control" placeholder="Search workflows...">
+                </div>
+                <button type="submit" class="btn btn-primary">
+                    <i class="bi bi-search"></i>
+                </button>
+            </div>
+        </form>
+    </div>
 
-        <table class="table table-hover" id="workflowResultLibrary">
+    <table class="table table-hover" id="workflowResultLibrary">
         <thead>
             <tr>
                 <th scope="col">Workflow name</th>
+                <th scope="col">Workflow ID</th>
                 <th scope="col">Start time</th>
                 <th scope="col">End time</th>
                 <th scope="col">Data</th>
@@ -16,6 +29,7 @@
             {% for workflow in workflows %}
                 <tr>
                     <td><a href="{{ url_for('database.get_workflow_steps', workflow_id=workflow.id) }}">{{ workflow.name }}</a></td>
+                    <td>{{ workflow.id }}</td>
                     <td>{{ workflow.start_time.strftime("%Y-%m-%d %H:%M:%S") if workflow.start_time else '' }}</td>
                     <td>{{ workflow.end_time.strftime("%Y-%m-%d %H:%M:%S") if workflow.end_time else '' }}</td>
 
@@ -36,16 +50,24 @@
         </tbody>
     </table>
 
-{#    paging#}
+    {#    paging#}
     <div class="pagination justify-content-center">
         <div class="page-item {{ 'disabled' if not workflows.has_prev else '' }}">
             <a class="page-link" href="{{ url_for('database.list_workflows', page=workflows.prev_num) }}">Previous</a>
         </div>
+
         {% for num in workflows.iter_pages() %}
-            <div class="page-item">
-                <a class="page-link {{ 'active' if num == workflows.page else '' }}" href="{{ url_for('database.list_workflows', page=num) }}">{{ num }}</a>
-            </div>
+            {% if num %}
+                <div class="page-item {{ 'active' if num == workflows.page else '' }}">
+                    <a class="page-link" href="{{ url_for('database.list_workflows', page=num) }}">{{ num }}</a>
+                </div>
+            {% else %}
+                <div class="page-item disabled">
+                    <span class="page-link">…</span>
+                </div>
+            {% endif %}
         {% endfor %}
+
         <div class="page-item {{ 'disabled' if not workflows.has_next else '' }}">
             <a class="page-link" href="{{ url_for('database.list_workflows', page=workflows.next_num) }}">Next</a>
         </div>

ivoryos/routes/design/design.py

@@ -3,6 +3,7 @@ import json
 import os
 import pickle
 import sys
+import time
 
 from flask import Blueprint, redirect, url_for, flash, jsonify, send_file, request, render_template, session, \
     current_app, g
@@ -11,7 +12,6 @@ from flask_socketio import SocketIO
 from werkzeug.utils import secure_filename
 
 from ivoryos.utils import utils
-from ivoryos.utils.client_proxy import create_function, export_to_python
 from ivoryos.utils.global_config import GlobalConfig
 from ivoryos.utils.form import create_builtin_form, create_action_button, format_name, create_form_from_pseudo, \
     create_form_from_action, create_all_builtin_forms
@@ -74,8 +74,8 @@ def handle_abort_action():
         socketio.emit('log', {'message': message})
 
 
-@design.route("/experiment/build/", methods=['GET', 'POST'])
-@design.route("/experiment/build/<instrument>/", methods=['GET', 'POST'])
+@design.route("/design/script/", methods=['GET', 'POST'])
+@design.route("/design/script/<instrument>/", methods=['GET', 'POST'])
 @login_required
 def experiment_builder(instrument=None):
     """
@@ -86,7 +86,7 @@ def experiment_builder(instrument=None):
     This route allows users to build and edit experiment workflows. Users can interact with available instruments,
     define variables, and manage experiment scripts.
 
-    .. http:get:: /experiment/build
+    .. http:get:: /design/script
 
     Load the experiment builder interface.
 
@@ -94,7 +94,7 @@ def experiment_builder(instrument=None):
     :type instrument: str
     :status 200: Experiment builder loaded successfully.
 
-    .. http:post:: /experiment/build
+    .. http:post:: /design/script
 
     Submit form data to add or modify actions in the experiment script.
 
@@ -120,7 +120,7 @@ def experiment_builder(instrument=None):
     if deck and script.deck is None:
         script.deck = os.path.splitext(os.path.basename(deck.__file__))[
             0] if deck.__name__ == "__main__" else deck.__name__
-    script.sort_actions()
+    # script.sort_actions()
 
     pseudo_deck_name = session.get('pseudo_deck', '')
     pseudo_deck_path = os.path.join(current_app.config["DUMMY_DECK"], pseudo_deck_name)
@@ -202,11 +202,11 @@ def experiment_builder(instrument=None):
                 logic_type = kwargs.pop('builtin_name')
                 if 'variable' in kwargs:
                     try:
-                        script.add_variable(**kwargs, insert_position=insert_position)
+                        script.add_variable(insert_position=insert_position, **kwargs)
                     except ValueError:
                         flash("Invalid variable type")
                 else:
-                    script.add_logic_action(logic_type=logic_type, **kwargs, insert_position=insert_position)
+                    script.add_logic_action(logic_type=logic_type, insert_position=insert_position, **kwargs)
             else:
                 flash(form.errors)
         elif request.method == 'POST' and "workflow_name" in request.form:
@@ -240,6 +240,10 @@ def experiment_builder(instrument=None):
                 forms = create_form_from_pseudo(functions, autofill=autofill, script=script)
 
     utils.post_script_file(script)
+
+    exec_string = script.python_script if script.python_script else script.compile(current_app.config['SCRIPT_FOLDER'])
+    session['python_code'] = exec_string
+
     design_buttons = create_action_button(script)
     return render_template('experiment_builder.html', off_line=off_line, instrument=instrument, history=deck_list,
                            script=script, defined_variables=deck_variables,
@@ -248,17 +252,17 @@ def experiment_builder(instrument=None):
                            use_llm=enable_llm)
 
 
-@design.route("/generate_code", methods=['POST'])
+@design.route("/design/generate_code", methods=['POST'])
 @login_required
 def generate_code():
     """
     .. :quickref: Text to Code; Generate code from user input and update the design canvas.
 
-    .. http:post:: /generate_code
+    .. http:post:: /design/generate_code
 
     :form prompt: user's prompt
     :status 200: and then redirects to :http:get:`/experiment/build`
-    :status 400: failed to initialize the AI agent redirects to :http:get:`/experiment/build`
+    :status 400: failed to initialize the AI agent redirects to :http:get:`/design/script`
 
     """
     agent = global_config.agent
@@ -296,24 +300,25 @@ def generate_code():
     return redirect(url_for("design.experiment_builder", instrument=instrument, use_llm=True))
 
 
-@design.route("/experiment", methods=['GET', 'POST'])
+@design.route("/design/campaign", methods=['GET', 'POST'])
 @login_required
 def experiment_run():
     """
     .. :quickref: Workflow Execution; Execute/iterate the workflow
 
-    .. http:get:: /experiment
+    .. http:get:: /design/campaign
 
     Compile the workflow and load the experiment execution interface.
 
-    .. http:post:: /experiment
+    .. http:post:: /design/campaign
 
     Start workflow execution
 
     """
     deck = global_config.deck
     script = utils.get_script_file()
-    script.sort_actions()
+
+    # script.sort_actions() # handled in update list
     off_line = current_app.config["OFF_LINE"]
     deck_list = utils.import_history(os.path.join(current_app.config["OUTPUT_FOLDER"], 'deck_history.txt'))
     # if not off_line and deck is None:
@@ -328,7 +333,7 @@ def experiment_run():
         # todo
         exec_string = script.python_script if script.python_script else script.compile(current_app.config['SCRIPT_FOLDER'])
         # exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
-
+        # print(exec_string)
     except Exception as e:
         flash(e.__str__())
         # handle api request
@@ -345,12 +350,13 @@ def experiment_run():
     if filename:
         # config_preview = list(csv.DictReader(open(os.path.join(current_app.config['CSV_FOLDER'], filename))))
         config = list(csv.DictReader(open(os.path.join(current_app.config['CSV_FOLDER'], filename))))
-        config_preview = config[1:6]
+        config_preview = config[1:]
         arg_type = config.pop(0)  # first entry is types
     try:
         for key, func_str in exec_string.items():
             exec(func_str)
         line_collection = script.convert_to_lines(exec_string)
+
     except Exception:
         flash(f"Please check {key} syntax!!")
         return redirect(url_for("design.experiment_builder"))
@@ -408,6 +414,9 @@ def experiment_run():
             else:
                 flash(e)
     if request.accept_mimetypes.best_match(['application/json', 'text/html']) == 'application/json':
+        # wait to get a workflow ID
+        while not global_config.runner_status:
+            time.sleep(1)
         return jsonify({"status": "task started", "task_id": global_config.runner_status.get("id")})
     else:
         return render_template('experiment_run.html', script=script.script_dict, filename=filename,
@@ -418,15 +427,15 @@ def experiment_run():
                            history=deck_list, pause_status=runner.pause_status())
 
 
-@design.route("/toggle_script_type/<stype>")
+@design.route("/design/script/toggle/<stype>")
 @login_required
 def toggle_script_type(stype=None):
     """
     .. :quickref: Workflow Design; toggle the experimental phase for design canvas.
 
-    .. http:get:: /toggle_script_type
+    .. http:get:: /design/script/toggle/<stype>
 
-    :status 200: and then redirects to :http:get:`/experiment/build`
+    :status 200: and then redirects to :http:get:`/design/script`
 
     """
     script = utils.get_script_file()
@@ -435,27 +444,37 @@ def toggle_script_type(stype=None):
     return redirect(url_for('design.experiment_builder'))
 
 
-@design.route("/updateList", methods=['GET', 'POST'])
+@design.route("/updateList", methods=['POST'])
 @login_required
 def update_list():
     order = request.form['order']
     script = utils.get_script_file()
     script.currently_editing_order = order.split(",", len(script.currently_editing_script))
+    script.sort_actions()
+    exec_string = script.compile(current_app.config['SCRIPT_FOLDER'])
     utils.post_script_file(script)
-    return jsonify('Successfully Updated')
+    session['python_code'] = exec_string
+
+    return jsonify({'success': True})
+
+
+@design.route("/toggle_show_code", methods=["POST"])
+def toggle_show_code():
+    session["show_code"] = not session.get("show_code", False)
+    return redirect(request.referrer or url_for("design.experiment_builder"))
 
 
 # --------------------handle all the import/export and download/upload--------------------------
-@design.route("/clear")
+@design.route("/design/clear")
 @login_required
 def clear():
     """
     .. :quickref: Workflow Design; clear the design canvas.
 
-    .. http:get:: /clear
+    .. http:get:: /design/clear
 
     :form prompt: user's prompt
-    :status 200: clear canvas and then redirects to :http:get:`/experiment/build`
+    :status 200: clear canvas and then redirects to :http:get:`/design/script`
     """
     deck = global_config.deck
     pseudo_name = session.get("pseudo_deck", "")
@@ -471,16 +490,16 @@ def clear():
     return redirect(url_for("design.experiment_builder"))
 
 
-@design.route("/import_pseudo", methods=['POST'])
+@design.route("/design/import/pseudo", methods=['POST'])
 @login_required
 def import_pseudo():
     """
     .. :quickref: Workflow Design; Import pseudo deck from deck history
 
-    .. http:post:: /import_pseudo
+    .. http:post:: /design/import/pseudo
 
     :form pkl_name: pseudo deck name
-    :status 302: load pseudo deck and then redirects to :http:get:`/experiment/build`
+    :status 302: load pseudo deck and then redirects to :http:get:`/design/script`
     """
     pkl_name = request.form.get('pkl_name')
     script = utils.get_script_file()
@@ -494,16 +513,16 @@ def import_pseudo():
     return redirect(url_for("design.experiment_builder"))
 
 
-@design.route('/uploads', methods=['POST'])
+@design.route('/design/uploads', methods=['POST'])
 @login_required
 def upload():
     """
     .. :quickref: Workflow Execution; upload a workflow config file (.CSV)
 
-    .. http:post:: /uploads
+    .. http:post:: /design/uploads
 
     :form file: workflow CSV config file
-    :status 302: save csv file and then redirects to :http:get:`/experiment`
+    :status 302: save csv file and then redirects to :http:get:`/design/campaign`
     """
     if request.method == "POST":
         f = request.files['file']
@@ -519,14 +538,20 @@ def upload():
             return redirect(url_for("design.experiment_run"))
 
 
-@design.route('/download_results/<filename>')
+@design.route('/design/workflow/download/<filename>')
 @login_required
 def download_results(filename):
+    """
+    .. :quickref: Workflow Design; download a workflow data file
+
+    .. http:get:: /design/workflow/download/<filename>
+
+    """
     filepath = os.path.join(current_app.config["DATA_FOLDER"], filename)
     return send_file(os.path.abspath(filepath), as_attachment=True)
 
 
-@design.route('/load_json', methods=['POST'])
+@design.route('/design/load_json', methods=['POST'])
 @login_required
 def load_json():
     """
@@ -535,7 +560,7 @@ def load_json():
     .. http:post:: /load_json
 
     :form file: workflow design JSON file
-    :status 302: load pseudo deck and then redirects to :http:get:`/experiment/build`
+    :status 302: load pseudo deck and then redirects to :http:get:`/design/script`
     """
     if request.method == "POST":
         f = request.files['file']
@@ -549,9 +574,15 @@ def load_json():
     return redirect(url_for("design.experiment_builder"))
 
 
-@design.route('/download/<filetype>')
+@design.route('/design/script/download/<filetype>')
 @login_required
 def download(filetype):
+    """
+    .. :quickref: Workflow Design Ext; download a workflow design file
+
+    .. http:get:: /design/script/download/<filetype>
+
+    """
     script = utils.get_script_file()
     run_name = script.name if script.name else "untitled"
     if filetype == "configure":
@@ -569,40 +600,28 @@ def download(filetype):
             outfile.write(json_object)
     elif filetype == "python":
         filepath = os.path.join(current_app.config["SCRIPT_FOLDER"], f"{run_name}.py")
-    elif filetype == "proxy":
-        snapshot = global_config.deck_snapshot.copy()
-        class_definitions = {}
-        # Iterate through each instrument in the snapshot
-        for instrument_key, instrument_data in snapshot.items():
-            # Iterate through each function associated with the current instrument
-            for function_key, function_data in instrument_data.items():
-                # Convert the function signature to a string representation
-                function_data['signature'] = str(function_data['signature'])
-            class_name = instrument_key.split('.')[-1]  # Extracting the class name from the path
-            class_definitions[class_name.capitalize()] = create_function(request.url_root, class_name, instrument_data)
-        # Export the generated class definitions to a .py script
-        export_to_python(class_definitions, current_app.config["OUTPUT_FOLDER"])
-        filepath = os.path.join(current_app.config["OUTPUT_FOLDER"], "generated_proxy.py")
+    else:
+        return "Unsupported file type", 400
     return send_file(os.path.abspath(filepath), as_attachment=True)
 
 
-@design.route("/edit/<uuid>", methods=['GET', 'POST'])
+@design.route("/design/step/edit/<uuid>", methods=['GET', 'POST'])
 @login_required
 def edit_action(uuid: str):
     """
     .. :quickref: Workflow Design; edit parameters of an action step on canvas
 
-    .. http:get:: /edit
+    .. http:get:: /design/step/edit/<uuid>
 
     Load parameter form of an action step
 
-    .. http:post:: /edit
+    .. http:post:: /design/step/edit/<uuid>
 
     :param uuid: The step's uuid
     :type uuid: str
 
     :form dynamic form: workflow step dynamic inputs
-    :status 302: save changes and then redirects to :http:get:`/experiment/build`
+    :status 302: save changes and then redirects to :http:get:`/design/script`
     """
     script = utils.get_script_file()
     action = script.find_by_uuid(uuid)
@@ -625,18 +644,18 @@ def edit_action(uuid: str):
     return redirect(url_for('design.experiment_builder'))
 
 
-@design.route("/delete/<id>")
+@design.route("/design/step/delete/<id>")
 @login_required
 def delete_action(id: int):
     """
     .. :quickref: Workflow Design; delete an action step on canvas
 
-    .. http:get:: /delete
+    .. http:get:: /design/step/delete/<id>
 
     :param id: The step number id
     :type id: int
 
-    :status 302: save changes and then redirects to :http:get:`/experiment/build`
+    :status 302: save changes and then redirects to :http:get:`/design/script`
     """
     back = request.referrer
     script = utils.get_script_file()
@@ -645,18 +664,18 @@ def delete_action(id: int):
     return redirect(back)
 
 
-@design.route("/duplicate/<id>")
+@design.route("/design/step/duplicate/<id>")
 @login_required
 def duplicate_action(id: int):
     """
     .. :quickref: Workflow Design; duplicate an action step on canvas
 
-    .. http:get:: /duplicate
+    .. http:get:: /design/step/duplicate/<id>
 
     :param id: The step number id
     :type id: int
 
-    :status 302: save changes and then redirects to :http:get:`/experiment/build`
+    :status 302: save changes and then redirects to :http:get:`/design/script`
     """
     back = request.referrer
     script = utils.get_script_file()
@@ -667,8 +686,15 @@ def duplicate_action(id: int):
 
 # ---- HTTP API Endpoints ----
 
-@design.route("/api/status", methods=["GET"])
+@design.route("/api/runner/status", methods=["GET"])
 def runner_status():
+    """
+    .. :quickref: Workflow Design; get the execution status
+
+    .. http:get:: /api/runner/status
+
+    :status 200: status
+    """
     runner_busy = global_config.runner_lock.locked()
     status = {"busy": runner_busy}
     task_status = global_config.runner_status
@@ -692,39 +718,69 @@ def runner_status():
 
 
 
-@design.route("/api/abort_pending", methods=["POST"])
+@design.route("/api/runner/abort_pending", methods=["POST"])
 def api_abort_pending():
+    """
+    .. :quickref: Workflow Design; abort pending action(s) during execution
+
+    .. http:get:: /api/runner/abort_pending
+
+    :status 200: {"status": "ok"}
+    """
     abort_pending()
     return jsonify({"status": "ok"}), 200
 
-@design.route("/api/abort_current", methods=["POST"])
+@design.route("/api/runner/abort_current", methods=["POST"])
 def api_abort_current():
+    """
+    .. :quickref: Workflow Design; abort right after current action during execution
+
+    .. http:get:: /api/runner/abort_current
+
+    :status 200: {"status": "ok"}
+    """
     abort_current()
     return jsonify({"status": "ok"}), 200
 
-@design.route("/api/pause", methods=["POST"])
+@design.route("/api/runner/pause", methods=["POST"])
 def api_pause():
+    """
+    .. :quickref: Workflow Design; pause during execution
+
+    .. http:get:: /api/runner/pause
+
+    :status 200: {"status": "ok"}
+    """
     msg = pause()
     return jsonify({"status": "ok", "pause_status": msg}), 200
 
-@design.route("/api/retry", methods=["POST"])
+@design.route("/api/runner/retry", methods=["POST"])
 def api_retry():
+    """
+    .. :quickref: Workflow Design; retry when error occur during execution
+
+    .. http:get:: /api/runner/retry
+
+    :status 200: {"status": "ok"}
+    """
     retry()
     return jsonify({"status": "ok, retrying failed step"}), 200
 
 
-@design.route("/api/get_script", methods=["GET", "POST"])
-def get_script():
-    script = utils.get_script_file()
-    script.sort_actions()
-    script_collection = script.compile()
-    if request.method == "POST":
-        # create a brand-new script
-        deck = global_config.deck
-        deck_name = os.path.splitext(os.path.basename(deck.__file__))[0] if deck.__name__ == "__main__" else deck.__name__
-        script = Script(author=session.get('user'), deck=deck_name)
-        script_collection = request.get_json()
-        script.python_script = script_collection
-        utils.post_script_file(script)
-        return jsonify({"status": "ok"}), 200
-    return jsonify(script_collection), 200
+@design.route("/api/design/submit", methods=["POST"])
+def submit_script():
+    """
+    .. :quickref: Workflow Design; submit script
+
+    .. http:get:: /api/design/submit
+
+    :status 200: {"status": "ok"}
+    """
+    deck = global_config.deck
+    deck_name = os.path.splitext(os.path.basename(deck.__file__))[0] if deck.__name__ == "__main__" else deck.__name__
+    script = Script(author=session.get('user'), deck=deck_name)
+    script_collection = request.get_json()
+    script.python_script = script_collection
+    # todo check script format
+    utils.post_script_file(script)
+    return jsonify({"status": "ok"}), 200