ivoryos 1.0.9__py3-none-any.whl → 1.2.0__py3-none-any.whl

ivoryos/routes/control/control_new_device.py

@@ -0,0 +1,142 @@
+import os
+from flask import Blueprint, request, current_app, send_file, flash, redirect, url_for, session, render_template
+from flask_login import login_required
+
+from ivoryos.utils import utils
+from ivoryos.routes.control.utils import find_instrument_by_name
+from ivoryos.utils.global_config import GlobalConfig
+
+global_config = GlobalConfig()
+
+control_temp = Blueprint('temp', __name__)
+
+@control_temp.route("/new/module", methods=['POST'])
+def import_api():
+    """
+    .. :quickref: Advanced Features; Manually import API module(s)
+
+    importing other Python modules
+
+    .. http:post:: /instruments/new/module
+
+    :form filepath: API (Python class) module filepath
+
+    import the module and redirect to :http:get:`/ivoryos/instruments/new/`
+
+    """
+    filepath = request.form.get('filepath')
+    # filepath.replace('\\', '/')
+    name = os.path.split(filepath)[-1].split('.')[0]
+    try:
+        spec = utils.importlib.util.spec_from_file_location(name, filepath)
+        module = utils.importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        classes = utils.inspect.getmembers(module, utils.inspect.isclass)
+        if len(classes) == 0:
+            flash("Invalid import: no class found in the path")
+            return redirect(url_for("control.controllers_home"))
+        for i in classes:
+            globals()[i[0]] = i[1]
+            global_config.api_variables.add(i[0])
+    # should handle path error and file type error
+    except Exception as e:
+        flash(e.__str__())
+    return redirect(url_for("control.temp.new_controller"))
+
+
+
+@control_temp.route("/new/deck-python", methods=['POST'])
+def import_deck():
+    """
+    .. :quickref: Advanced Features; Manually import a deck
+
+    .. http:post:: /instruments/new/deck-python
+
+    :form filepath: deck module filepath
+
+    import the module and redirect to the previous page
+
+    """
+    script = utils.get_script_file()
+    filepath = request.form.get('filepath')
+    session['dismiss'] = request.form.get('dismiss')
+    update = request.form.get('update')
+    back = request.referrer
+    if session['dismiss']:
+        return redirect(back)
+    name = os.path.split(filepath)[-1].split('.')[0]
+    try:
+        module = utils.import_module_by_filepath(filepath=filepath, name=name)
+        utils.save_to_history(filepath, current_app.config["DECK_HISTORY"])
+        module_sigs = utils.create_deck_snapshot(module, save=update, output_path=current_app.config["DUMMY_DECK"])
+        if not len(module_sigs) > 0:
+            flash("Invalid hardware deck, connect instruments in deck script", "error")
+            return redirect(url_for("control.deck_controllers"))
+        global_config.deck = module
+        global_config.deck_snapshot = module_sigs
+
+        if script.deck is None:
+            script.deck = module.__name__
+    # file path error exception
+    except Exception as e:
+        flash(e.__str__())
+    return redirect(back)
+
+
+@control_temp.route("/new/", strict_slashes=False)
+@control_temp.route("/new/<string:instrument>", methods=['GET', 'POST'])
+@login_required
+def new_controller(instrument:str=None):
+    """
+    .. :quickref: Advanced Features; connect to a new device
+
+    interface for connecting a new <instrument>
+
+    .. http:get:: /instruments/new/
+
+    :param instrument: instrument name
+    :type instrument: str
+
+    .. http:post:: /instruments/new/
+
+    :form device_name: module instance name (e.g. my_instance = MyClass())
+    :form kwargs: dynamic module initialization kwargs fields
+
+    """
+    device = None
+    args = None
+    if instrument:
+
+        device = globals()[instrument]
+        args = utils.inspect.signature(device.__init__)
+
+        if request.method == 'POST':
+            device_name = request.form.get("device_name", "")
+            if device_name and device_name in globals():
+                flash("Device name is defined. Try another name, or leave it as blank to auto-configure")
+                # return render_template('controllers_new.html', instrument=instrument,
+                #                        api_variables=global_config.api_variables,
+                #                        device=device, args=args, defined_variables=global_config.defined_variables)
+            if device_name == "":
+                device_name = device.__name__.lower() + "_"
+                num = 1
+                while device_name + str(num) in global_config.defined_variables:
+                    num += 1
+                device_name = device_name + str(num)
+            kwargs = request.form.to_dict()
+            kwargs.pop("device_name")
+            for i in kwargs:
+                if kwargs[i] in global_config.defined_variables:
+                    kwargs[i] = global_config.defined_variables[kwargs[i]]
+            try:
+                utils.convert_config_type(kwargs, device.__init__.__annotations__, is_class=True)
+            except Exception as e:
+                flash(e)
+            try:
+                global_config.defined_variables[device_name] = device(**kwargs)
+                # global_config.defined_variables.add(device_name)
+                return redirect(url_for('control.deck_controllers'))
+            except Exception as e:
+                flash(e)
+    return render_template('controllers_new.html', instrument=instrument, api_variables=global_config.api_variables,
+                           device=device, args=args, defined_variables=global_config.defined_variables)

ivoryos/routes/control/templates/controllers.html

@@ -0,0 +1,166 @@
+{% extends 'base.html' %}
+{% block title %}IvoryOS | Controllers {% endblock %}
+
+{% block body %}
+<div id="overlay" class="overlay">
+    <div>
+        <h3 id="overlay-text"></h3>
+        <div class="spinner-border" role="status"></div>
+    </div>
+</div>
+<div class="container-fluid">
+  <div class="row">
+    <!-- Sidebar: Instruments -->
+    <nav class="col-md-3 col-lg-2 d-md-block bg-light sidebar py-3" style="height: 100vh; overflow-y: auto; position: sticky; top: 0;">
+      <div class="sidebar-sticky">
+        <!-- Deck Instruments -->
+        <div class="mb-4">
+          <div class="list-group">
+            {% for inst in defined_variables %}
+              <a class="list-group-item list-group-item-action d-flex align-items-center {% if instrument == inst %}active bg-primary text-white border-0{% else %}bg-light{% endif %}"
+                 href="{{ url_for('control.deck_controllers') }}?instrument={{ inst }}"
+                 style="border-radius: 0.5rem; margin-bottom: 0.5rem; transition: background 0.2s;">
+                <span class="flex-grow-1">{{ inst | format_name }}</span>
+                {% if instrument == inst %}
+                  <span class="ms-auto">&gt;</span>
+                {% endif %}
+              </a>
+            {% endfor %}
+          </div>
+        </div>
+
+
+
+        <!-- Temp Instruments -->
+        {% if temp_variables %}
+          <div class="mb-4">
+            <h6 class="fw-bold text-secondary mb-2" style="letter-spacing: 1px;">Temp Instruments</h6>
+            <div class="list-group">
+              {% for inst in temp_variables %}
+                <a class="list-group-item list-group-item-action d-flex align-items-center {% if instrument == inst %}active bg-warning text-dark border-0{% else %}bg-light{% endif %}"
+                   href="{{ url_for('control.deck_controllers') }}?instrument={{ inst }}"
+                   style="border-radius: 0.5rem; margin-bottom: 0.5rem; transition: background 0.2s;">
+                  <span class="flex-grow-1">{{ inst | format_name }}</span>
+                  {% if instrument == inst %}
+                    <span class="ms-auto">&gt;</span>
+                  {% endif %}
+                </a>
+              {% endfor %}
+            </div>
+          </div>
+        {% endif %}
+        <!-- Action Buttons -->
+        <div class="mb-4">
+          <a href="{{ url_for('control.file.download_proxy', filetype='proxy') }}" class="btn btn-outline-primary w-100 mb-2">
+            Download proxy
+          </a>
+          <a href="{{ url_for('control.temp.new_controller') }}" class="btn btn-outline-success w-100">
+            New connection
+          </a>
+        </div>
+      </div>
+    </nav>
+
+    <!-- Main: Method Cards -->
+    <main class="col-md-9 ms-sm-auto col-lg-10 px-md-4" style="height: 100vh; overflow-y: auto;">
+      {% if instrument%}
+{#        <h2 class="text-secondary">{{ instrument }} controller</h2>#}
+        <div class="grid-container" id="sortable-grid" style="display: grid; grid-template-columns: repeat(auto-fit, minmax(350px, 1fr)); gap: 1rem; width: 100%;">
+          {% set hidden = session.get('hidden_functions', {}) %}
+          {% set hidden_instrument = hidden.get(instrument, []) %}
+          {% for function, form in forms.items() %}
+            {% if function not in hidden_instrument %}
+              <div class="card" id="{{function}}" style="margin: 0;">
+                <div class="bg-white rounded shadow-sm h-100">
+                  <i class="bi bi-info-circle ms-2" data-bs-toggle="tooltip" data-bs-placement="top" title='{{ form.hidden_name.description or "Docstring is not available" }}' ></i>
+                    <a href="{{ url_for('control.hide_function', instrument=instrument, function=function) }}"
+                       data-method="patch" data-payload='{"hidden":true}' class="toggle-visibility">
+                       <i style="float: right;" class="bi bi-eye-slash-fill text-muted" title="Hide function"></i>
+                    </a>
+                    <div class="form-control" style="border: none">
+                        <form role="form" method='POST' name="{{function}}" id="{{function}}" action="{{ url_for('control.deck_controllers') }}?instrument={{ instrument }}">
+                      <div class="form-group">
+                        {{ form.hidden_tag() }}
+                        {% for field in form %}
+                          {% if field.type not in ['CSRFTokenField', 'HiddenField'] %}
+                            <div class="input-group mb-3">
+                              <label class="input-group-text">{{ field.label.text | format_name }}</label>
+                              {% if field.type == "SubmitField" %}
+                                {{ field(class="btn btn-dark") }}
+                              {% elif field.type == "BooleanField" %}
+                                {{ field(class="form-check-input") }}
+                              {% else %}
+                                {{ field(class="form-control") }}
+                              {% endif %}
+                            </div>
+                          {% endif %}
+                        {% endfor %}
+                      </div>
+                      <div class="input-group mb-3">
+                        <button type="submit" name="{{ function }}" id="{{ function }}" class="form-control" style="background-color: #a5cece;">
+                            {{ function | format_name }}
+                        </button>
+                      </div>
+                    </form>
+                  </div>
+                </div>
+              </div>
+            {% endif %}
+          {% endfor %}
+        </div>
+        <!-- Hidden functions accordion -->
+        <div class="accordion accordion-flush" id="accordionActions" >
+          <div class="accordion-item">
+            <h4 class="accordion-header">
+              <button class="accordion-button collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#hidden">
+                Hidden functions
+              </button>
+            </h4>
+          </div>
+          <div id="hidden" class="accordion-collapse collapse" data-bs-parent="#accordionActions">
+            <div class="accordion-body">
+              {% for function in hidden_instrument %}
+                <div>
+                  {{ function }}
+                    <a href="{{ url_for('control.hide_function', instrument=instrument, function=function) }}"
+                       data-method="patch" data-payload='{"hidden":false}' class="toggle-visibility">
+                       <i class="bi bi-eye-fill text-success" title="Show function"></i>
+                    </a>
+                </div>
+              {% endfor %}
+            </div>
+          </div>
+        </div>
+        <script>
+
+            document.querySelectorAll('.toggle-visibility').forEach(el => {
+              el.addEventListener('click', e => {
+                e.preventDefault();
+                const url = el.getAttribute('href');
+                const payload = JSON.parse(el.getAttribute('data-payload') || '{}');
+                fetch(url, {
+                  method: 'PATCH',
+                  headers: {
+                    'Content-Type': 'application/json'
+                  },
+                  body: JSON.stringify(payload)
+                }).then(response => {
+                  if (response.ok) {
+                    location.reload(); // or update the DOM directly
+                  }
+                });
+              });
+            });
+
+          const saveOrderUrl = `{{ url_for('control.save_order', instrument=instrument) }}`;
+          const buttonIds = {{ session['card_order'][instrument] | tojson }};
+        </script>
+        <script src="{{ url_for('static', filename='js/sortable_card.js') }}"></script>
+        <script src="{{ url_for('static', filename='js/overlay.js') }}"></script>
+      {% else %}
+        <div class="alert alert-info mt-4">Select an instrument to view its methods.</div>
+      {% endif %}
+    </main>
+  </div>
+</div>
+{% endblock %}

ivoryos/routes/control/templates/controllers_new.html

@@ -0,0 +1,112 @@
+{% extends 'base.html' %}
+     {% block title %}IvoryOS | New devices{% endblock %}
+
+     {% block body %}
+     <div class="row">
+         <!-- Available Python API -->
+         <div class="col-xl-4 col-lg-4 col-md-6 mb-4">
+             <div class="card shadow-sm mb-4">
+                 <div class="card-header">
+                     <h5 class="mb-0">Available Python API</h5>
+                 </div>
+                 <div class="card-body">
+                     {% for instrument in api_variables %}
+                         <div class="card mb-2">
+                             <div class="card-body p-2">
+                                 <a href="{{ url_for('control.temp.new_controller', instrument=instrument) }}" class="text-dark stretched-link">{{ instrument }}</a>
+                             </div>
+                         </div>
+                     {% endfor %}
+                     <div class="card mt-3">
+                         <div class="card-body p-2">
+                             <a data-bs-toggle="modal" href="#importAPI" class="stretched-link">
+                                 <i class="bi bi-folder-plus"></i> Import API
+                             </a>
+                         </div>
+                     </div>
+                 </div>
+             </div>
+         </div>
+
+         <!-- Connecting Device -->
+         <div class="col-xl-5 col-lg-5 col-md-6 mb-4">
+             {% if device %}
+{#                 {{ device }}#}
+             <div class="card shadow-sm mb-4">
+                 <div class="card-header">
+                     <h5 class="mb-0">Connecting</h5>
+                 </div>
+                 <div class="card-body">
+                     <form role="form" method="POST" name="init" action="{{ url_for('control.temp.new_controller', instrument=instrument) }}">
+                         <div class="mb-3">
+                             <label class="form-label" for="device_name">Name this device</label>
+                             <input class="form-control" type="text" id="device_name" name="device_name" aria-describedby="nameHelpBlock" placeholder="e.g. {{device.__name__}}_1">
+                             <div id="nameHelpBlock" class="form-text">
+                                 Name your instrument, avoid names that are defined on the right
+                             </div>
+                         </div>
+                         {% for arg in device.__init__.__annotations__ %}
+                             {% if not arg == "return" %}
+                                 <div class="mb-3">
+                                     <label class="form-label" for="{{arg}}">{{arg}}</label>
+                                     <input class="form-control" type="text" id="{{arg}}" name="{{arg}}"
+                                         placeholder="{{device.__init__.__annotations__[arg].__name__}}"
+                                         value="{{args.parameters[arg].default if not args.parameters[arg].default.__name__ == '_empty' else ''}}">
+                                     {% if device.__init__.__annotations__[arg].__module__ is not in ["builtins", "typing"] %}
+                                         <a role="button" href="{{ url_for('control.temp.new_controller', instrument=device.__init__.__annotations__[arg].__name__) }}" class="btn btn-secondary btn-sm mt-2">Initialize {{device.__init__.__annotations__[arg].__name__}} first</a>
+                                     {% endif %}
+                                 </div>
+                             {% endif %}
+                         {% endfor %}
+                         <button type="submit" class="btn btn-dark">Connect</button>
+                     </form>
+                 </div>
+             </div>
+             {% endif %}
+         </div>
+
+         <!-- Defined Instruments -->
+         <div class="col-xl-3 col-lg-3 col-md-6 mb-4">
+             <div class="card shadow-sm mb-4">
+                 <div class="card-header">
+                     <h5 class="mb-0">Defined Instruments</h5>
+                 </div>
+                 <div class="card-body">
+                     {% if defined_variables %}
+                         <ul class="list-group">
+                             {% for instrument in defined_variables %}
+                                 <li class="list-group-item">{{ instrument }}</li>
+                             {% endfor %}
+                         </ul>
+                     {% else %}
+                         <span class="text-muted">No instruments defined.</span>
+                     {% endif %}
+                 </div>
+             </div>
+         </div>
+     </div>
+
+     <!-- Import API Modal -->
+     <div class="modal fade" id="importAPI" tabindex="-1" aria-labelledby="importModal" aria-hidden="true">
+         <div class="modal-dialog">
+             <div class="modal-content">
+                 <div class="modal-header">
+                     <h1 class="modal-title fs-5" id="importModal">Import API by file path</h1>
+                     <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
+                 </div>
+                 <form method="POST" action="{{ url_for('control.temp.import_api') }}" enctype="multipart/form-data">
+                     <div class="modal-body">
+                         <div class="mb-3">
+                             <label class="form-label" for="filepath">File Path:</label>
+                             <input type="text" class="form-control" name="filepath" id="filepath">
+                         </div>
+                     </div>
+                     <div class="modal-footer">
+                         <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
+                         <button type="submit" class="btn btn-primary">Save</button>
+                     </div>
+                 </form>
+             </div>
+         </div>
+     </div>
+     {% endblock %}

ivoryos/routes/control/utils.py

@@ -0,0 +1,38 @@
+from flask import session
+
+from ivoryos.utils.global_config import GlobalConfig
+
+
+global_config = GlobalConfig()
+
+
+def find_instrument_by_name(name: str):
+    """
+    find instrument class object by instance name
+    """
+    if name.startswith("deck"):
+        name = name.replace("deck.", "")
+        return getattr(global_config.deck, name)
+    elif name in global_config.defined_variables:
+        return global_config.defined_variables[name]
+    elif name in globals():
+        return globals()[name]
+
+
+def get_session_by_instrument(session_name, instrument):
+    """get data from session by instrument"""
+    session_object = session.get(session_name, {})
+    functions = session_object.get(instrument, [])
+    return functions
+
+
+def post_session_by_instrument(session_name, instrument, data):
+    """
+    save new data to session by instrument
+    :param session_name: "card_order" or "hidden_functions"
+    :param instrument: function name of class object
+    :param data: order list or hidden function list
+    """
+    session_object = session.get(session_name, {})
+    session_object[instrument] = data
+    session[session_name] = session_object

ivoryos/routes/data/data.py

@@ -0,0 +1,129 @@
+import os
+
+from flask import Blueprint, redirect, url_for, request, render_template, current_app, jsonify, send_file
+from flask_login import login_required
+
+from ivoryos.utils.db_models import db, WorkflowRun, WorkflowStep
+
+data = Blueprint('data', __name__, template_folder='templates')
+
+
+
+@data.route('/executions/records')
+def list_workflows():
+    """
+    .. :quickref: Workflow Execution Database; list all workflow execution records
+
+    list all workflow execution records
+
+    .. http:get:: /executions/records
+
+    """
+    query = WorkflowRun.query.order_by(WorkflowRun.id.desc())
+    search_term = request.args.get("keyword", None)
+    if search_term:
+        query = query.filter(WorkflowRun.name.like(f'%{search_term}%'))
+    page = request.args.get('page', default=1, type=int)
+    per_page = 10
+
+    workflows = query.paginate(page=page, per_page=per_page, error_out=False)
+    if request.accept_mimetypes.best_match(['application/json', 'text/html']) == 'application/json':
+        workflows = query.all()
+        workflow_data = {w.id:{"workflow_name":w.name, "start_time":w.start_time} for w in workflows}
+        return jsonify({
+            "workflow_data": workflow_data,
+        })
+    else:
+        return render_template('workflow_database.html', workflows=workflows)
+
+
+@data.get("/executions/records/<int:workflow_id>")
+def workflow_logs(workflow_id:int):
+    """
+    .. :quickref: Workflow Data Database; get workflow data, steps, and logs
+
+    get workflow data logs by workflow id
+
+    .. http:get:: /executions/<int:workflow_id>
+
+    :param workflow_id: workflow id
+    :type workflow_id: int
+    """
+
+    if request.method == 'GET':
+        workflow = db.session.get(WorkflowRun, workflow_id)
+        steps = WorkflowStep.query.filter_by(workflow_id=workflow_id).order_by(WorkflowStep.start_time).all()
+
+        # Use full objects for template rendering
+        grouped = {
+            "prep": [],
+            "script": {},
+            "cleanup": [],
+        }
+
+        # Use dicts for JSON response
+        grouped_json = {
+            "prep": [],
+            "script": {},
+            "cleanup": [],
+        }
+
+        for step in steps:
+            step_dict = step.as_dict()
+
+            if step.phase == "prep":
+                grouped["prep"].append(step)
+                grouped_json["prep"].append(step_dict)
+
+            elif step.phase == "script":
+                grouped["script"].setdefault(step.repeat_index, []).append(step)
+                grouped_json["script"].setdefault(step.repeat_index, []).append(step_dict)
+
+            elif step.phase == "cleanup" or step.method_name == "stop":
+                grouped["cleanup"].append(step)
+                grouped_json["cleanup"].append(step_dict)
+
+        if request.accept_mimetypes.best_match(['application/json', 'text/html']) == 'application/json':
+            return jsonify({
+                "workflow_info": workflow.as_dict(),
+                "steps": grouped_json,
+            })
+        else:
+            return render_template("workflow_view.html", workflow=workflow, grouped=grouped)
+
+
+@data.delete("/executions/records/<int:workflow_id>")
+@login_required
+def delete_workflow_record(workflow_id: int):
+    """
+    .. :quickref: Workflow Data Database; delete a workflow execution record
+
+    delete a workflow execution record by workflow id
+
+    .. http:delete:: /executions/records/<int:workflow_id>
+
+    :param workflow_id: workflow id
+    :type workflow_id: int
+    :status 200: return success message
+    """
+    run = WorkflowRun.query.get(workflow_id)
+    db.session.delete(run)
+    db.session.commit()
+    return jsonify(success=True)
+
+
+@data.route('/files/execution-data/<string:filename>')
+def download_results(filename:str):
+    """
+    .. :quickref: Workflow data; download a workflow data file (.CSV)
+
+    .. http:get:: /files/execution-data/<string:filename>
+
+    :param filename: workflow data filename
+    :type filename: str
+
+    # :status 302: load pseudo deck and then redirects to :http:get:`/ivoryos/executions`
+    """
+
+    filepath = os.path.join(current_app.config["DATA_FOLDER"], filename)
+    return send_file(os.path.abspath(filepath), as_attachment=True)

ivoryos/routes/data/templates/components/step_card.html

@@ -0,0 +1,13 @@
+<div class="card mb-2 {{ 'border-danger text-danger bg-light' if step.run_error else 'border-secondary' }}">
+  <div class="card-body p-2">
+    <strong>{{ step.method_name | format_name }}</strong>
+    <small class="text-muted">
+      <i class="fas fa-play-circle me-1"></i> Start: {{ step.start_time.strftime('%H:%M:%S') if step.start_time else 'N/A' }}
+      <i class="fas fa-stop-circle ms-2 me-1"></i> End: {{ step.end_time.strftime('%H:%M:%S') if step.end_time else 'N/A' }}
+      <!-- {% if step.run_error %}
+        <i class="fas fa-stop-circle ms-2 me-1"></i> Error: {{ step.run_error if step.run_error else 'N/A' }}
+      {% endif %} -->
+    </small>
+    <!-- <small>Error: {{ step.run_error }}</small> -->
+  </div>
+</div>