add pypop-gui cli launcher

Author: ptooley

pypop/cli.py

@@ -5,8 +5,19 @@
 """CLI Analysis scripts"""
 
 from os import getcwd
-from os.path import expanduser, join as path_join, normpath
+from os.path import (
+    exists as path_exists,
+    expanduser,
+    isabs,
+    join as path_join,
+    normpath,
+    realpath,
+    relpath,
+)
+from pkg_resources import resource_filename
 from shutil import copytree, Error as shutil_error
+from webbrowser import open_new_tab
+import sys
 
 from matplotlib import use
 
@@ -17,10 +28,31 @@
 from pypop.dimemas import dimemas_idealise
 from pypop.config import set_dimemas_path, set_paramedir_path, set_tmpdir_path
 from pypop.examples import examples_directory
+from pypop.server import get_notebook_server_instance, construct_nb_url
 
 from argparse import ArgumentParser
 from tqdm import tqdm
 
+import nbformat
+
+latest_nbformat = getattr(nbformat, "v{}".format(nbformat.current_nbformat))
+new_nb = latest_nbformat.new_notebook
+code_cell = latest_nbformat.new_code_cell
+md_cell = latest_nbformat.new_markdown_cell
+
+GUI_MSG = """
+        PyPOP GUI Ready:
+        If the gui does not open automatically, please go to the following url
+        in your web browser:
+
+        {}
+"""
+
+OWN_SERVER_MSG = """
+        A new notebook server was started for this PyPOP session.  When you are finished,
+        press CTRL-C in this window to shut down the server.
+"""
+
 
 def _dimemas_idealise_parse_args():
 
@@ -327,3 +359,127 @@ def copy_examples():
     except shutil_error as err:
         print("Copy failed: {}".format(str(err)))
         return -1
+
+
+def _gui_launcher_parse_args():
+
+    # make an argument parser
+    parser = ArgumentParser(description="Launch the PyPOP GUI and Notebook server")
+
+    # First define collection of traces
+    parser.add_argument(
+        "nb_path",
+        type=str,
+        nargs="?",
+        metavar="NB_PATH",
+        help="GUI Notebook name/path default is $PWD/pypop_gui.ipynb",
+    )
+    parser.add_argument(
+        "-n",
+        "--notebookdir",
+        type=str,
+        metavar="NB_DIR",
+        help="Notebook server root directory (default is $PWD or inferred from "
+        "NB_PATH), ignored if an existing server is used",
+    )
+    parser.add_argument(
+        "-f",
+        "--force-overwrite",
+        action="store_true",
+        help="Overwrite existing file when creating GUI notebook.",
+    )
+
+    return parser.parse_args()
+
+
+def _gui_exit(msg, own_server):
+    print(msg, file=sys.stderr)
+    if own_server:
+        own_server.kill()
+    sys.exit(-1)
+
+
+def pypop_gui():
+    """Entrypoint for launching Jupyter Notebook GUI
+    """
+
+    config = _gui_launcher_parse_args()
+
+    notebookdir = getcwd()
+    nb_name = "pypop_gui.ipynb"
+    if config.notebookdir:
+        notebookdir = realpath(notebookdir)
+
+    nb_path = realpath(path_join(notebookdir, nb_name))
+    if config.nb_path:
+        if isabs(config.nb_path):
+            if relpath(realpath(config.nb_path), notebookdir):
+                gui_exit(
+                    "Requested gui notebook file path is not in the notebook server "
+                    "directory ({}).".format(config.nb_path, notebookdir),
+                    None,
+                )
+            nb_path = os.realpath(config.nb_path)
+        else:
+            nb_name = os.realpath(join(notebookdir, config.nb_path))
+
+    server_info, own_server = get_notebook_server_instance()
+
+    real_nbdir = realpath(server_info["notebook_dir"])
+    if relpath(nb_path, real_nbdir).startswith(".."):
+        _gui_exit(
+            "Requested gui notebook file path {} is not in the root of the "
+            "notebook server ({}). You may need to specify a different working "
+            "directory, change the server config, or allow PyPOP to start its own "
+            "server.".format(nb_path, real_nbdir),
+            own_server,
+        )
+
+    if not path_exists(nb_path) or config.force_overwrite:
+        try:
+            write_gui_nb(nb_path)
+        except:
+            _gui_exit("Failed to create gui notebook", own_server)
+
+    nb_url = construct_nb_url(server_info, nb_path)
+
+    open_new_tab(nb_url)
+
+    print(GUI_MSG.format(nb_url))
+
+    if own_server:
+        print(OWN_SERVER_MSG)
+        try:
+            own_server.wait()
+        except KeyboardInterrupt:
+            own_server.terminate()
+
+
+def hidden_code_cell(*args, **kwargs):
+
+    hidden_cell = {"hide_input": True}
+
+    if "metadata" in kwargs:
+        kwargs["metadata"].update(hidden_cell)
+    else:
+        kwargs["metadata"] = hidden_cell
+
+    return code_cell(*args, **kwargs)
+
+
+def write_gui_nb(gui_nb_path):
+
+    gui_nb = new_nb(metadata={})
+
+    gui_code = """\
+from pypop.notebook_interface import MetricsWizard
+from pypop.metrics import MPI_OpenMP_Metrics
+gui = MetricsWizard(MPI_OpenMP_Metrics)
+display(gui)\
+    """
+    gui_cells = [(gui_code, hidden_code_cell)]
+
+    for cell_text, cell_ctr in gui_cells:
+        gui_nb.cells.append(cell_ctr(cell_text))
+
+    nbformat.write(gui_nb, gui_nb_path)

pypop/server.py

@@ -0,0 +1,86 @@
+#!/usr/bin/enb python3
+
+"""A minimal interface for managing IPython servers
+"""
+
+import os
+import subprocess
+from time import sleep
+
+from notebook.notebookapp import list_running_servers
+
+
+def get_cache_pid():
+
+    try:
+        with open(os.path.expanduser("~/.cache/pypopserver.pid")) as fh:
+            pid = int(fh.readline().strip())
+            return pid
+    except (FileNotFoundError, ValueError):
+        return None
+
+
+def get_notebook_server_instance(try_use_existing=False):
+    """Create a notebook server instance to use. Optionally attempting to re-use existing
+    instances.
+    """
+
+    pid = get_cache_pid()
+
+    servers = list_running_servers()
+
+    # If we already have a server, use that
+    for server in servers:
+        if server["pid"] == pid:
+            return (server, None)
+
+    # Otherwise, if we are allowed, try to piggyback on another session
+    if try_use_existing and servers:
+        return (servers[0], None)
+
+    # Fine, I'll make my own server, with blackjack, and userhooks!
+    try:
+        server_process = subprocess.Popen(["jupyter", "notebook", "--no-browser"])
+    except OSError as err:
+        raise RuntimeError("Failed to start server: {}".format(err))
+    print("Started Jupyter Notebook server pid {}".format(server_process.pid))
+    # wait for 1 second for server to come up
+    sleep(1)
+
+    server = None
+    for retry in range(5):
+        try:
+            server = {s["pid"]: s for s in list_running_servers()}[server_process.pid]
+            break
+        except KeyError:
+            # Sleep for increasing times to give server a chance to come up
+            sleep(5)
+
+    if server:
+        return (server, server_process)
+
+    # Don't leave orphans!
+    server_process.kill()
+    raise RuntimeError("Failed to acquire server instance after 25s")
+
+
+def construct_nb_url(server_info, nb_path):
+
+    nb_dir = server_info["notebook_dir"]
+
+    if os.path.isabs(nb_dir):
+        nb_relpath = os.path.relpath(nb_path, nb_dir)
+        if nb_relpath.startswith(".."):
+            raise ValueError(
+                "Requested notebook file path is not in the notebook server "
+                "directory ({}).".format(nb_path, nb_dir)
+            )
+    else:
+        nb_relpath = nb_path.lstrip(".").lstrip("/")
+
+    if server_info["token"]:
+        return "{}notebooks/{}?token={}".format(
+            server_info["url"], nb_relpath, server_info["token"]
+        )
+    else:
+        return "{}notebooks/{}".format(server_info["url"], nb_relpath)

setup.py

@@ -36,6 +36,7 @@
             "pypop-preprocess = pypop.cli:preprocess_traces",
             "pypop-idealise-prv = pypop.cli:dimemas_idealise_cli",
             "pypop-copy-examples = pypop.cli:copy_examples",
+            "pypop-gui = pypop.cli:pypop_gui",
         ]
     },
 )