feat(vtk): enable custom VTK build

pyproject.toml

@@ -2,15 +2,11 @@
 name = "trame-vtk"
 version = "2.8.17"
 description = "VTK widgets for trame"
-authors = [
-    {name = "Kitware Inc."},
-]
-dependencies = [
-    "trame-client>=3.4,<4",
-]
+authors = [{ name = "Kitware Inc." }]
+dependencies = ["trame-client>=3.4,<4"]
 requires-python = ">=3.9"
 readme = "README.rst"
-license = {text = "BSD License"}
+license = { text = "BSD License" }
 keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -24,14 +20,7 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-dev = [
-    "pre-commit",
-    "ruff",
-    "pytest",
-    "pytest-asyncio",
-    "coverage",
-    "nox",
-]
+dev = ["pre-commit", "ruff", "pytest", "pytest-asyncio", "coverage", "nox"]
 
 [build-system]
 requires = ["hatchling"]
@@ -40,21 +29,16 @@ build-backend = "hatchling.build"
 
 [tool.hatch.build]
 include = [
-  "/src/**/*.py",
-  "/src/**/*.html",
-  "/src/trame_vtk/modules/common/serve/**",
+    "/src/**/*.py",
+    "/src/**/*.html",
+    "/src/trame_vtk/modules/common/serve/**",
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = [
-    "src/trame_vtk",
-    "src/trame",
-]
+packages = ["src/trame_vtk", "src/trame"]
 
 [tool.semantic_release]
-version_toml = [
-    "pyproject.toml:project.version",
-]
+version_toml = ["pyproject.toml:project.version"]
 build_command = """
   python -m venv .venv
   source .venv/bin/activate
@@ -73,7 +57,7 @@ target-version = "py39"
 
 [tool.ruff.lint]
 select = ["E", "W", "F"]
-ignore = []
+ignore = ["E402"]
 fixable = ["ALL"]
 unfixable = []
 
@@ -93,4 +77,4 @@ docstring-code-line-length = "dynamic"
 max-line-length = 120
 
 [lint.pydocstyle]
-convention = "google"
+convention = "google"

src/trame_vtk/modules/vtk/__init__.py

@@ -1,18 +1,21 @@
 import warnings
+import importlib
+import os
+import sys
 
 from .core import HybridView
 from .serializers import mesh as vtk_mesh
 
 try:
-    import vtkmodules  # noqa
-
+    vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+    sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
     HAS_VTK = True
 except ImportError:
     warnings.warn("VTK is not installed.")
     HAS_VTK = False
 
 try:
-    from vtkmodules.vtkWebCore import vtkWebApplication
+    from vtk_module.vtkWebCore import vtkWebApplication
 
     HAS_VTK_WEB = True
 except ImportError:

src/trame_vtk/modules/vtk/protocols/mouse_handler.py

@@ -1,6 +1,12 @@
 import math
+import os
+import importlib
+import sys
 
-from vtkmodules.vtkWebCore import vtkWebInteractionEvent
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+
+from vtk_module.vtkWebCore import vtkWebInteractionEvent
 
 from wslink import register as export_rpc
 

src/trame_vtk/modules/vtk/serializers/data.py

@@ -1,7 +1,14 @@
 import logging
 
-from vtkmodules.vtkFiltersGeometry import vtkCompositeDataGeometryFilter
-from vtkmodules.vtkFiltersGeometry import vtkDataSetSurfaceFilter
+import os
+import importlib
+import sys
+
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+
+from vtk_module.vtkFiltersGeometry import vtkCompositeDataGeometryFilter
+from vtk_module.vtkFiltersGeometry import vtkDataSetSurfaceFilter
 
 from .helpers import extract_required_fields, get_array_description
 from .registry import class_name

src/trame_vtk/modules/vtk/serializers/lookup_tables.py

@@ -1,4 +1,11 @@
-from vtkmodules.vtkRenderingCore import vtkColorTransferFunction
+import os
+import importlib
+import sys
+
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+
+from vtk_module.vtkRenderingCore import vtkColorTransferFunction
 
 from .helpers import data_table_to_list, linspace
 from .registry import class_name

src/trame_vtk/modules/vtk/serializers/mappers.py

@@ -1,6 +1,11 @@
 import logging
+import os
+import importlib
+import sys
 
-from vtkmodules.vtkFiltersGeometry import vtkDataSetSurfaceFilter
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+from vtk_module.vtkFiltersGeometry import vtkDataSetSurfaceFilter
 
 from .registry import class_name
 from .serialize import serialize

src/trame_vtk/modules/vtk/serializers/mesh.py

@@ -1,9 +1,15 @@
 import base64
 
 import numpy as np
+import os
+import importlib
+import sys
 
-from vtkmodules.util.numpy_support import vtk_to_numpy
-from vtkmodules.vtkFiltersGeometry import vtkDataSetSurfaceFilter
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+
+from vtk_module.util.numpy_support import vtk_to_numpy
+from vtk_module.vtkFiltersGeometry import vtkDataSetSurfaceFilter
 
 
 def mesh(dataset, field_to_keep=None, point_arrays=None, cell_arrays=None):

src/trame_vtk/modules/vtk/widget.py

@@ -1,12 +1,18 @@
 from typing import Type, Callable, Dict, Optional
 from functools import partialmethod
+import os
+import importlib
+import sys
 
-from vtkmodules.vtkInteractionWidgets import (
+vtk_module_name = os.environ.get("VTK_MODULE_NAME", "vtkmodules")
+sys.modules["vtk_module"] = importlib.import_module(vtk_module_name)
+
+from vtk_module.vtkInteractionWidgets import (
     vtkAbstractWidget,
     vtkWidgetRepresentation,
 )
 
-from vtkmodules.vtkCommonCore import vtkCommand
+from vtk_module.vtkCommonCore import vtkCommand
 
 EventCallback = Callable[[vtkCommand.EventIds, Optional["VtkWidget"]], None]