ivoryos 0.1.9__py3-none-any.whl → 0.1.12__py3-none-any.whl

ivoryos/routes/database/database.py

@@ -1,114 +1,188 @@
-from flask import Blueprint, redirect, url_for, flash, request, render_template, session, current_app
-from flask_login import login_required
-
-from ivoryos.utils.db_models import Script, db
-from ivoryos.utils.utils import get_script_file, post_script_file
-
-database = Blueprint('database', __name__, template_folder='templates/database')
-
-
-
-@database.route("/edit_workflow/<workflow_name>")
-@login_required
-def edit_workflow(workflow_name):
-    row = Script.query.get(workflow_name)
-    script = Script(**row.as_dict())
-    post_script_file(script)
-    pseudo_name = session.get("pseudo_deck", "")
-    off_line = current_app.config["OFF_LINE"]
-    if off_line and pseudo_name and not script.deck == pseudo_name:
-        flash(f"Choose the deck with name {script.deck}")
-    return redirect(url_for('design.experiment_builder'))
-
-
-@database.route("/delete_workflow/<workflow_name>")
-@login_required
-def delete_workflow(workflow_name):
-    Script.query.filter(Script.name == workflow_name).delete()
-    db.session.commit()
-    return redirect(url_for('database.load_from_database'))
-
-
-@database.route("/publish")
-@login_required
-def publish():
-    script = get_script_file()
-    if not script.name or not script.deck:
-        flash("Deck cannot be empty, try to re-submit deck configuration on the left panel")
-    row = Script.query.get(script.name)
-    if row and row.status == "finalized":
-        flash("This is a protected script, use save as to rename.")
-    elif row and not session['user'] == row.author:
-        flash("You are not the author, use save as to rename.")
-    else:
-        db.session.merge(script)
-        db.session.commit()
-        flash("Saved!")
-    return redirect(url_for('design.experiment_builder'))
-
-
-@database.route("/finalize")
-@login_required
-def finalize():
-    script = get_script_file()
-    script.finalize()
-    if script.name:
-        db.session.merge(script)
-        db.session.commit()
-    post_script_file(script)
-    return redirect(url_for('design.experiment_builder'))
-
-
-@database.route("/database/", methods=['GET', 'POST'])
-@database.route("/database/<deck_name>", methods=['GET', 'POST'])
-@login_required
-def load_from_database(deck_name=None):
-    session.pop('edit_action', None)  # reset cache
-    query = Script.query
-    search_term = request.args.get("keyword", None)
-    if search_term:
-        query = query.filter(Script.name.like(f'%{search_term}%'))
-    if deck_name is None:
-        temp = Script.query.with_entities(Script.deck).distinct().all()
-        deck_list = [i[0] for i in temp]
-    else:
-        query = query.filter(Script.deck == deck_name)
-        deck_list = ["ALL"]
-    page = request.args.get('page', default=1, type=int)
-    per_page = 10
-
-    workflows = query.paginate(page=page, per_page=per_page, error_out=False)
-    return render_template("experiment_database.html", workflows=workflows, deck_list=deck_list, deck_name=deck_name)
-
-
-@database.route("/edit_run_name", methods=['GET', 'POST'])
-@login_required
-def edit_run_name():
-    if request.method == "POST":
-        run_name = request.form.get("run_name")
-        exist_script = Script.query.get(run_name)
-        if not exist_script:
-            script = get_script_file()
-            script.save_as(run_name)
-            post_script_file(script)
-        else:
-            flash("Script name is already exist in database")
-        return redirect(url_for("design.experiment_builder"))
-
-
-@database.route("/save_as", methods=['GET', 'POST'])
-@login_required
-def save_as():
-    # script = get_script_file()
-    if request.method == "POST":
-        run_name = request.form.get("run_name")
-        exist_script = Script.query.get(run_name)
-        if not exist_script:
-            script = get_script_file()
-            script.save_as(run_name)
-            script.author = session.get('user')
-            post_script_file(script)
-            publish()
-        else:
-            flash("Script name is already exist in database")
-        return redirect(url_for("design.experiment_builder"))
+from flask import Blueprint, redirect, url_for, flash, request, render_template, session, current_app
+from flask_login import login_required
+
+from ivoryos.utils.db_models import Script, db
+from ivoryos.utils.utils import get_script_file, post_script_file
+
+database = Blueprint('database', __name__, template_folder='templates/database')
+
+
+
+@database.route("/edit_workflow/<workflow_name>")
+@login_required
+def edit_workflow(workflow_name):
+    """
+    .. :quickref: Database; load workflow to canvas
+
+    load the selected workflow to the design canvas
+
+    .. http:get:: /edit_workflow/<workflow_name>
+
+    :param workflow_name: workflow name
+    :type workflow_name: str
+    :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
+    """
+    row = Script.query.get(workflow_name)
+    script = Script(**row.as_dict())
+    post_script_file(script)
+    pseudo_name = session.get("pseudo_deck", "")
+    off_line = current_app.config["OFF_LINE"]
+    if off_line and pseudo_name and not script.deck == pseudo_name:
+        flash(f"Choose the deck with name {script.deck}")
+    return redirect(url_for('design.experiment_builder'))
+
+
+@database.route("/delete_workflow/<workflow_name>")
+@login_required
+def delete_workflow(workflow_name: str):
+    """
+    .. :quickref: Database; delete workflow
+
+    delete workflow from database
+
+    .. http:get:: /delete_workflow/<workflow_name>
+
+    :param workflow_name: workflow name
+    :type workflow_name: str
+    :status 302: redirect to :http:get:`/ivoryos/database/`
+
+    """
+    Script.query.filter(Script.name == workflow_name).delete()
+    db.session.commit()
+    return redirect(url_for('database.load_from_database'))
+
+
+@database.route("/publish")
+@login_required
+def publish():
+    """
+    .. :quickref: Database; save workflow to database
+
+    save workflow to database
+
+    .. http:get:: /publish
+
+    :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
+    """
+    script = get_script_file()
+    if not script.name or not script.deck:
+        flash("Deck cannot be empty, try to re-submit deck configuration on the left panel")
+    row = Script.query.get(script.name)
+    if row and row.status == "finalized":
+        flash("This is a protected script, use save as to rename.")
+    elif row and not session['user'] == row.author:
+        flash("You are not the author, use save as to rename.")
+    else:
+        db.session.merge(script)
+        db.session.commit()
+        flash("Saved!")
+    return redirect(url_for('design.experiment_builder'))
+
+
+@database.route("/finalize")
+@login_required
+def finalize():
+    """
+    .. :quickref: Database; finalize the workflow
+
+    [protected workflow] prevent saving edited workflow to the same workflow name
+
+    .. http:get:: /finalize
+
+    :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
+
+    """
+    script = get_script_file()
+    script.finalize()
+    if script.name:
+        db.session.merge(script)
+        db.session.commit()
+    post_script_file(script)
+    return redirect(url_for('design.experiment_builder'))
+
+
+@database.route("/database/")
+@database.route("/database/<deck_name>")
+@login_required
+def load_from_database(deck_name=None):
+    """
+    .. :quickref: Database; database page
+
+    backend control through http requests
+
+    .. http:get:: /database/<deck_name>
+
+    :param deck_name: filter for deck name
+    :type deck_name: str
+
+    """
+    session.pop('edit_action', None)  # reset cache
+    query = Script.query
+    search_term = request.args.get("keyword", None)
+    if search_term:
+        query = query.filter(Script.name.like(f'%{search_term}%'))
+    if deck_name is None:
+        temp = Script.query.with_entities(Script.deck).distinct().all()
+        deck_list = [i[0] for i in temp]
+    else:
+        query = query.filter(Script.deck == deck_name)
+        deck_list = ["ALL"]
+    page = request.args.get('page', default=1, type=int)
+    per_page = 10
+
+    workflows = query.paginate(page=page, per_page=per_page, error_out=False)
+    return render_template("experiment_database.html", workflows=workflows, deck_list=deck_list, deck_name=deck_name)
+
+
+@database.route("/edit_run_name", methods=['POST'])
+@login_required
+def edit_run_name():
+    """
+    .. :quickref: Database; edit workflow name
+
+    edit the name of the current workflow, won't save to the database
+
+    .. http:post:: /edit_run_name
+
+    : form run_name: new workflow name
+    :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
+
+    """
+    if request.method == "POST":
+        run_name = request.form.get("run_name")
+        exist_script = Script.query.get(run_name)
+        if not exist_script:
+            script = get_script_file()
+            script.save_as(run_name)
+            post_script_file(script)
+        else:
+            flash("Script name is already exist in database")
+        return redirect(url_for("design.experiment_builder"))
+
+
+@database.route("/save_as", methods=['POST'])
+@login_required
+def save_as():
+    """
+    .. :quickref: Database; save the run name as
+
+    save the workflow name as
+
+    .. http:post:: /save_as
+
+    : form run_name: new workflow name
+    :status 302: redirect to :http:get:`/ivoryos/experiment/build/`
+
+    """
+    if request.method == "POST":
+        run_name = request.form.get("run_name")
+        exist_script = Script.query.get(run_name)
+        if not exist_script:
+            script = get_script_file()
+            script.save_as(run_name)
+            script.author = session.get('user')
+            post_script_file(script)
+            publish()
+        else:
+            flash("Script name is already exist in database")
+        return redirect(url_for("design.experiment_builder"))

ivoryos/routes/database/templates/database/experiment_database.html

@@ -1,72 +1,72 @@
-{% extends 'base.html' %}
-
-{% block title %}IvoryOS | Design Database{% endblock %}
-{% block body %}
-    <div class="database-filter">
-        {% for deck_name in deck_list %}
-            {% if deck_name == "ALL" %}<a class="btn btn-secondary" href="{{url_for('database.load_from_database')}}">Back</a>
-            {% else %}<a class="btn btn-secondary" href="{{url_for('database.load_from_database',deck_name=deck_name)}}">{{deck_name}}</a>
-            {% endif %}
-        {% endfor %}
-
-        <form id="search" style="display: inline-block;float: right;" action="{{url_for('database.load_from_database',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="workflowLibrary">
-        <thead>
-            <tr>
-                <th scope="col">Workflow name</th>
-                <th scope="col">Deck </th>
-                <th scope="col">Current status</th>
-                <th scope="col">Time created</th>
-                <th scope="col">Last modified</th>
-                <th scope="col">Author</th>
-                <th scope="col"></th>
-            </tr>
-        </thead>
-        <tbody>
-            {% for workflow in workflows %}
-                <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>
-                        {#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>
-                        {% else %}
-                            <a class="disabled-link" href="{{ url_for('database.delete_workflow', workflow_name=workflow.name) }}">delete</a>
-                        {% endif %}
-                    <td>
-                </tr>
-            {% endfor %}
-        </tbody>
-    </table>
-
-{#    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>
-        {% 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>
-        {% 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>
-    </div>
-{% endblock %}
+{% extends 'base.html' %}
+
+{% block title %}IvoryOS | Design Database{% endblock %}
+{% block body %}
+    <div class="database-filter">
+        {% for deck_name in deck_list %}
+            {% if deck_name == "ALL" %}<a class="btn btn-secondary" href="{{url_for('database.load_from_database')}}">Back</a>
+            {% else %}<a class="btn btn-secondary" href="{{url_for('database.load_from_database',deck_name=deck_name)}}">{{deck_name}}</a>
+            {% endif %}
+        {% endfor %}
+
+        <form id="search" style="display: inline-block;float: right;" action="{{url_for('database.load_from_database',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="workflowLibrary">
+        <thead>
+            <tr>
+                <th scope="col">Workflow name</th>
+                <th scope="col">Deck </th>
+                <th scope="col">Current status</th>
+                <th scope="col">Time created</th>
+                <th scope="col">Last modified</th>
+                <th scope="col">Author</th>
+                <th scope="col"></th>
+            </tr>
+        </thead>
+        <tbody>
+            {% for workflow in workflows %}
+                <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>
+                        {#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>
+                        {% else %}
+                            <a class="disabled-link" href="{{ url_for('database.delete_workflow', workflow_name=workflow.name) }}">delete</a>
+                        {% endif %}
+                    <td>
+                </tr>
+            {% endfor %}
+        </tbody>
+    </table>
+
+{#    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>
+        {% 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>
+        {% 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>
+    </div>
+{% endblock %}