feat: Add plotly-express JsPlugin implementation and registration

plugins/plotly-express/setup.cfg

@@ -3,7 +3,7 @@ name = deephaven-plugin-plotly-express
 description = Deephaven Chart Plugin
 long_description = file: README.md
 long_description_content_type = text/markdown
-version = attr:deephaven.plot.express.__version__
+version = 0.2.0.dev1
 url = https://github.com/deephaven/deephaven-plugins
 project_urls =
     Source Code = https://github.com/deephaven/deephaven-plugins
@@ -34,4 +34,4 @@ where=src
 
 [options.entry_points]
 deephaven.plugin =
-    registration_cls = deephaven.plot.express:ChartRegistration
+    registration_cls = deephaven.plot.express:ExpressRegistration

plugins/plotly-express/setup.py

@@ -2,7 +2,6 @@
 from setuptools import setup
 import os
 import subprocess
-import json
 
 # npm pack in js directory
 
@@ -18,11 +17,13 @@
     os.makedirs(dest_dir, exist_ok=True)
 
     # pack and unpack into the js plotly-express directory
-    subprocess.run(["npm", "pack", "--pack-destination", project], cwd=js_dir)
+    subprocess.run(
+        ["npm", "pack", "--pack-destination", project], cwd=js_dir, check=True
+    )
     # it is assumed that there is only one tarball in the directory
     files = os.listdir(dest_dir)
     for file in files:
-        subprocess.run(["tar", "-xzf", file], cwd=dest_dir)
+        subprocess.run(["tar", "-xzf", file], cwd=dest_dir, check=True)
         os.remove(os.path.join(dest_dir, file))
 
     # move the contents of the package directory to the plotly-express directory

plugins/plotly-express/src/deephaven/plot/express/__init__.py

@@ -7,6 +7,7 @@
 
 from .communication.DeephavenFigureConnection import DeephavenFigureConnection
 from .deephaven_figure import DeephavenFigure
+from .js import create_js_plugin
 
 from .plots import (
     area,
@@ -44,7 +45,6 @@
 
 from .data import data_generators
 
-__version__ = "0.2.0dev1"
 
 NAME = "deephaven.plot.express.DeephavenFigure"
 
@@ -103,20 +103,21 @@ def create_client_connection(
         return figure_connection
 
 
-class ChartRegistration(Registration):
+class ExpressRegistration(Registration):
     """
-    Register the DeephavenFigureType
+    Register the DeephavenFigureType and ExpressJsPlugin
 
     """
 
     @classmethod
     def register_into(cls, callback: Callback) -> None:
         """
-        Register the DeephavenFigureType
+        Register the DeephavenFigureType and ExpressJsPlugin
 
         Args:
           callback: Registration.Callback:
             A function to call after registration
 
         """
         callback.register(DeephavenFigureType)
+        callback.register(create_js_plugin())

plugins/plotly-express/src/deephaven/plot/express/js/__init__.py

@@ -0,0 +1,76 @@
+import typing
+import pathlib
+
+import importlib.metadata
+import importlib.resources
+import json
+import sys
+from typing import Callable
+
+from deephaven.plugin.js import JsPlugin
+
+
+class ExpressJsPlugin(JsPlugin):
+    def __init__(
+        self,
+        name: str,
+        version: str,
+        main: str,
+        root_provider: Callable[[], typing.Generator[pathlib.Path, None, None]],
+    ) -> None:
+        self._name = name
+        self._version = version
+        self._main = main
+        self._root_provider = root_provider
+
+    @property
+    def name(self) -> str:
+        return self._name
+
+    @property
+    def version(self) -> str:
+        return self._version
+
+    @property
+    def main(self) -> str:
+        return self._main
+
+    def distribution_path(self) -> typing.Generator[pathlib.Path, None, None]:
+        # TODO: Finalize JsPlugin
+        # https://github.com/deephaven/deephaven-plugin/issues/15
+        return self._root_provider()
+
+
+def _create_from_npm_package_json(
+    root_provider: Callable[[], typing.Generator[pathlib.Path, None, None]]
+) -> JsPlugin:
+    with root_provider() as root, (root / "package.json").open("rb") as f:
+        package_json = json.load(f)
+    return ExpressJsPlugin(
+        package_json["name"],
+        package_json["version"],
+        package_json["main"],
+        root_provider,
+    )
+
+
+def _production_root() -> typing.Generator[pathlib.Path, None, None]:
+    # TODO: Js content should be in same package directory
+    # https://github.com/deephaven/deephaven-plugins/issues/139
+    if sys.version_info < (3, 9):
+        return importlib.resources.path("js", "plotly-express")
+    else:
+        return importlib.resources.as_file(
+            importlib.resources.files("js").joinpath("plotly-express")
+        )
+
+
+def _development_root() -> typing.Generator[pathlib.Path, None, None]:
+    raise NotImplementedError("TODO")
+
+
+def create_js_plugin() -> JsPlugin:
+    # TODO: Include developer instructions for installing in editable mode
+    # https://github.com/deephaven/deephaven-plugins/issues/93
+    # TBD what editable mode looks like for JsPlugin
+    return _create_from_npm_package_json(_production_root)