ci: use pyproject and ruff

jourdain · jourdain · commit 290cd3e1afcf · 2025-01-07T11:32:27.000-07:00
diff --git a/.github/workflows/test_and_release.yml b/.github/workflows/test_and_release.yml
@@ -93,10 +93,17 @@ jobs:
     needs: [pre-commit, pytest]
     runs-on: ubuntu-latest
     if: github.event_name == 'push'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/trame
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+      contents: write # IMPORTANT: mandatory for making GitHub Releases
+
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -105,8 +112,11 @@ jobs:
           bash .fetch_externals.sh
 
       - name: Python Semantic Release
-        uses: relekang/python-semantic-release@v7.34.6
+        id: release
+        uses: relekang/python-semantic-release@v9.15.2
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          repository_username: __token__
-          repository_password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Publish package distributions to PyPI
+        if: steps.release.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,17 +1,11 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
-    hooks:
-      - id: black
-        entry: black --check
-
   - repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
     hooks:
       - id: codespell
-        args: ['--ignore-words=.ignore-words.txt']
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.8.4
     hooks:
-      - id: flake8
+      - id: ruff
+      - id: ruff-format
diff --git a/examples/pyvista/ambient.py b/examples/pyvista/ambient.py
@@ -2,7 +2,7 @@
 
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
-from trame.widgets import html, vuetify
+from trame.widgets import vuetify
 from trame.widgets.vtk import VtkLocalView, VtkRemoteView
 
 import pyvista as pv
diff --git a/examples/pyvista/export_scene.py b/examples/pyvista/export_scene.py
@@ -1,6 +1,7 @@
 """Export scene for offline rendering.
 https://kitware.github.io/vtk-js/examples/OfflineLocalView.html
 """
+
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
 from trame.widgets import vuetify
diff --git a/examples/pyvista/grid.py b/examples/pyvista/grid.py
@@ -1,6 +1,6 @@
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
-from trame.widgets import grid, vuetify
+from trame.widgets import grid
 
 server = get_server()
 state = server.state
diff --git a/examples/pyvista/lighting.py b/examples/pyvista/lighting.py
@@ -2,7 +2,7 @@
 
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
-from trame.widgets import html, vuetify
+from trame.widgets import vuetify
 from trame.widgets.vtk import VtkLocalView, VtkRemoteView
 
 import pyvista as pv
diff --git a/examples/pyvista/picking.py b/examples/pyvista/picking.py
@@ -1,4 +1,3 @@
-import numpy as np
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
 from trame.widgets import vuetify
@@ -43,8 +42,7 @@ def toggle_edges():
 
 
 @ctrl.set("on_selection_change")
-def on_box_selection(event):
-    ...
+def on_box_selection(event): ...
 
 
 @state.change("selection_mode")
diff --git a/examples/pyvista/scalar_range.py b/examples/pyvista/scalar_range.py
@@ -4,7 +4,6 @@
 from trame.widgets import vuetify
 
 import pyvista as pv
-from pyvista import examples
 from pyvista.trame.ui import plotter_ui
 
 # -----------------------------------------------------------------------------
diff --git a/examples/pyvista/toggle_edge_lighting.py b/examples/pyvista/toggle_edge_lighting.py
@@ -1,6 +1,5 @@
 """Validate Int64 usage with VTK.js."""
 
-import numpy as np
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
 from trame.widgets import vuetify
diff --git a/examples/pyvista/toggle_edges_many_actors.py b/examples/pyvista/toggle_edges_many_actors.py
@@ -1,7 +1,7 @@
 # for remote view
 from trame.app import get_server
 from trame.ui.vuetify import SinglePageLayout
-from trame.widgets import html, vtk as vtk_widgets, vuetify
+from trame.widgets import vtk as vtk_widgets, vuetify
 from vtkmodules.vtkFiltersSources import vtkConeSource
 from vtkmodules.vtkInteractionStyle import vtkInteractorStyleSwitch  # noqa
 from vtkmodules.vtkRenderingCore import (
diff --git a/examples/validation/BigIntCoords.py b/examples/validation/BigIntCoords.py
@@ -4,7 +4,6 @@
 from trame.ui.html import DivLayout
 from trame.widgets import vtk
 
-from vtkmodules.vtkFiltersSources import vtkConeSource
 from vtkmodules.vtkIOXML import vtkXMLRectilinearGridReader
 from vtkmodules.vtkRenderingCore import (
     vtkActor,
diff --git a/examples/validation/CaptureImageLocal.py b/examples/validation/CaptureImageLocal.py
@@ -94,8 +94,10 @@ def save_image_on_server(screenshot_file):
         ):
             view = vtk_widgets.VtkLocalView(
                 renderWindow,
-                on_image_capture="utils.download('local.png', $event)",  # For client side handling
-                # on_image_capture=(save_image_on_server, "[new File([$event], 'screenshot.png')]"), # For server side handling
+                # For client side handling
+                on_image_capture="utils.download('local.png', $event)",
+                # For server side handling
+                # on_image_capture=(save_image_on_server, "[new File([$event], 'screenshot.png')]"),
             )
             ctrl.view_update = view.update
             ctrl.view_reset_camera = view.reset_camera
diff --git a/examples/validation/PickingLocalView.py b/examples/validation/PickingLocalView.py
@@ -6,7 +6,6 @@
 from vtkmodules.vtkRenderingCore import (
     vtkRenderer,
     vtkRenderWindow,
-    vtkRenderWindowInteractor,
     vtkPolyDataMapper,
     vtkActor,
 )
diff --git a/examples/validation/PyVistaVolumeRendering.py b/examples/validation/PyVistaVolumeRendering.py
@@ -1,4 +1,5 @@
 """Validate volume rendering with VTK.js."""
+
 import os
 import sys
 import pyvista as pv
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,87 @@
+[project]
+name = "trame-vtk"
+version = "3.8.13"
+description = "VTK widgets for trame"
+authors = [
+    {name = "Kitware Inc."},
+]
+dependencies = [
+    "trame-client>=3.4,<4",
+]
+requires-python = ">=3.9"
+readme = "README.rst"
+license = {text = "BSD License"}
+keywords = ["Python", "Interactive", "Web", "Application", "Framework"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pre-commit",
+    "ruff",
+    "pytest",
+]
+
+[build-system]
+requires = ['setuptools', 'wheel']
+build-backend = 'setuptools.build_meta'
+
+[tool.setuptools.packages.find]
+where = ["."]
+
+[tool.setuptools.package-data]
+trame_vtk = [
+    "**/modules/common/serve/*.js",
+]
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+build_command = """
+  python -m venv .venv
+  source .venv/bin/activate
+  pip install -U pip build
+  python -m build .
+"""
+
+[semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+
+[tool.ruff]
+line-length = 88
+indent-width = 4
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "W", "F"]
+ignore = []
+fixable = ["ALL"]
+unfixable = []
+
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+docstring-code-format = true
+
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 120
+
+[lint.pydocstyle]
+convention = "google"
diff --git a/setup.cfg b/setup.cfg
diff --git a/setup.py b/setup.py
diff --git a/trame/modules/paraview.py b/trame/modules/paraview.py
@@ -1 +1 @@
-from trame_vtk.modules.common import *
+from trame_vtk.modules.common import *  # noqa: F403
diff --git a/trame/modules/vtk.py b/trame/modules/vtk.py
@@ -1 +1 @@
-from trame_vtk.modules.common import *
+from trame_vtk.modules.common import *  # noqa: F403
diff --git a/trame/widgets/paraview.py b/trame/widgets/paraview.py
@@ -1,4 +1,4 @@
-from trame_vtk.widgets.vtk import *
+from trame_vtk.widgets.vtk import *  # noqa: F403
 
 
 def initialize(server):
diff --git a/trame/widgets/vtk.py b/trame/widgets/vtk.py
@@ -1,4 +1,4 @@
-from trame_vtk.widgets.vtk import *
+from trame_vtk.widgets.vtk import *  # noqa: F403
 
 
 def initialize(server):
diff --git a/trame_vtk/modules/paraview/protocols/local_rendering.py b/trame_vtk/modules/paraview/protocols/local_rendering.py
@@ -47,9 +47,13 @@ def push_geometry(new_subscription=False):
             return state_to_return
 
         if real_view_id not in self.tracking_views:
-            observer_callback = lambda *args, **kwargs: self.publish(
-                "viewport.geometry.view.subscription", push_geometry()
-            )
+
+            def observer_callback(*_, **__):
+                return self.publish(
+                    "viewport.geometry.view.subscription",
+                    push_geometry(),
+                )
+
             tag = self.app.AddObserver("UpdateEvent", observer_callback)
             self.tracking_views[real_view_id] = {"tags": [tag], "observerCount": 1}
         else:
@@ -92,7 +96,7 @@ def get_view_state(
         new_subscription=False,
         widgets=None,
         orientation_axis=0,
-        **kwargs
+        **kwargs,
     ):
         s_view = self.get_view(view_id)
         if not s_view:
diff --git a/trame_vtk/modules/paraview/protocols/publish_image_delivery.py b/trame_vtk/modules/paraview/protocols/publish_image_delivery.py
@@ -342,13 +342,16 @@ def add_render_observer(self, view_id):
         real_view_id = s_view.GetGlobalIDAsString()
 
         if real_view_id not in self.tracking_views:
-            observer_callback = lambda *args, **kwargs: self.push_render(real_view_id)
-            start_callback = lambda *args, **kwargs: self.start_view_animation(
-                real_view_id
-            )
-            stop_callback = lambda *args, **kwargs: self.stop_view_animation(
-                real_view_id
-            )
+
+            def observer_callback(*_, **__):
+                return self.push_render(real_view_id)
+
+            def start_callback(*_, **__):
+                return self.start_view_animation(real_view_id)
+
+            def stop_callback(*_, **__):
+                return self.stop_view_animation(real_view_id)
+
             tag = self.app.AddObserver("UpdateEvent", observer_callback)
             tag_start = self.app.AddObserver("StartInteractionEvent", start_callback)
             tag_stop = self.app.AddObserver("EndInteractionEvent", stop_callback)
diff --git a/trame_vtk/modules/vtk/protocols/local_rendering.py b/trame_vtk/modules/vtk/protocols/local_rendering.py
@@ -50,9 +50,13 @@ def push_geometry(new_subscription=False):
             return state_to_return
 
         if real_view_id not in self.tracking_views:
-            observer_callback = lambda *args, **kwargs: self.publish(
-                "viewport.geometry.view.subscription", push_geometry()
-            )
+
+            def observer_callback(*_, **__):
+                return self.publish(
+                    "viewport.geometry.view.subscription",
+                    push_geometry(),
+                )
+
             tag = self.app.AddObserver("UpdateEvent", observer_callback)
             self.tracking_views[real_view_id] = {"tags": [tag], "observerCount": 1}
         else:
@@ -95,7 +99,7 @@ def get_view_state(
         new_subscription=False,
         widgets=None,
         orientation_axis=0,
-        **kwargs
+        **kwargs,
     ):
         s_view = self.get_view(view_id)
         if not s_view:
diff --git a/trame_vtk/modules/vtk/protocols/publish_image_delivery.py b/trame_vtk/modules/vtk/protocols/publish_image_delivery.py
diff --git a/trame_vtk/widgets/vtk/common.py b/trame_vtk/widgets/vtk/common.py
