Merge pull request #24 from Carifio24/tox

Add codestyle check
glue-viz · May 16, 2024 · 16527d0 · 16527d0
2 parents b530fa2 + fb47452
commit 16527d0
Show file tree

Hide file tree

Showing 15 changed files with 56 additions and 38 deletions.
diff --git a/.github/workflows/deploy-examples.yml → .github/workflows/ci-workflows.yml b/.github/workflows/deploy-examples.yml → .github/workflows/ci-workflows.yml
@@ -1,15 +1,26 @@
-name: Deploy Examples
+name: CI Workflows
 
 on:
   push:
     branches:
       master
+  pull_request:
 
 permissions:
   contents: write
 
 jobs:
-  deploy:
+
+  initial_checks:
+    uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
+    with:
+      coverage: false
+      envs: |
+        # Code style
+        - linux: codestyle
+
+  deploy-examples:
+    if: github.event_name != "pull_request"
     runs-on: ubuntu-latest
     steps:
       - name: Checkout

diff --git a/glue_ar/__init__.py b/glue_ar/__init__.py
@@ -1,11 +1,10 @@
-from glue_ar.export_scatter import *
-from glue_ar.export_volume import *
-from glue_ar.tools import *
+from glue_ar.export_scatter import *  # noqa
+from glue_ar.export_volume import *  # noqa
+from glue_ar.tools import *  # noqa
 
 
 def setup():
-    from glue_qt.config import qt_client
-
+
     from glue_vispy_viewers.scatter.scatter_viewer import VispyScatterViewer
     VispyScatterViewer.tools += ["ar"]
     VispyScatterViewer.subtools = {

diff --git a/glue_ar/common.py b/glue_ar/common.py
@@ -1,9 +1,10 @@
 import pyvista as pv
 
+
 def layers_info(info_creator, viewer_state, layer_states=None):
     info = {}
     if layer_states is None:
-        layer_states = list((l for l in viewer_state.layers if l.visible))
+        layer_states = list((layer for layer in viewer_state.layers if layer.visible))
 
     for layer_state in layer_states:
         info[layer_state.layer.uuid] = info_creator(viewer_state, layer_state)
@@ -22,7 +23,7 @@ def create_plotter(adder, info_creator, viewer_state, layer_states=None):
 
         # The only error so far I've seen is a ValueError when using Plotter.add_mesh if
         # the mesh is empty (n_arrays = 0). We can be more explicit once our code is more definite
-        except:
+        except Exception:
             pass
 
     return plotter
diff --git a/glue_ar/export.py b/glue_ar/export.py
@@ -5,7 +5,9 @@
 import pyvista as pv
 from gltflib.gltf import GLTF
 
-GLTF_PIPELINE_FILEPATH = join(dirname(abspath(__file__)), "js", "node_modules", "gltf-pipeline", "bin", "gltf-pipeline.js")
+GLTF_PIPELINE_FILEPATH = join(dirname(abspath(__file__)), "js",
+                              "node_modules", "gltf-pipeline",
+                              "bin", "gltf-pipeline.js")
 
 
 def export_meshes(meshes, output_path):
@@ -63,16 +65,17 @@ def export_gl(plotter, filepath, with_alpha=True, compress=True):
 
 
 def export_modelviewer(output_path, gltf_path, alt_text):
+    mv_url = "https://ajax.googleapis.com/ajax/libs/model-viewer/3.3.0/model-viewer.min.js"
     html = f"""
         <html>
         <body>
-            <script type="module" src="https://ajax.googleapis.com/ajax/libs/model-viewer/3.3.0/model-viewer.min.js"></script>
+            <script type="module" src="{mv_url}"></script>
             <style>
         model-viewer {{
           width: 100%;
           height: 100%;
         }}
-    
+
         /* This keeps child nodes hidden while the element loads */
         :not(:defined) > * {{
           display: none;
@@ -163,6 +166,6 @@ def export_modelviewer(output_path, gltf_path, alt_text):
         </body>
     </html>
     """
-    
+
     with open(output_path, 'w') as f:
         f.write(html)
diff --git a/glue_ar/export_dialog.py b/glue_ar/export_dialog.py
@@ -7,8 +7,6 @@
 from glue.core.data_combo_helper import ComboHelper
 from glue.core.state_objects import State
 from glue_qt.utils import load_ui
-from qtpy.QtGui import QDoubleValidator, QIntValidator
-
 
 from qtpy.QtWidgets import QCheckBox, QDialog, QHBoxLayout, QLabel, QLineEdit
 from qtpy.QtGui import QIntValidator, QDoubleValidator

diff --git a/glue_ar/exporting_dialog.py b/glue_ar/exporting_dialog.py
@@ -3,8 +3,9 @@
 
 __all__ = ['ExportingDialog']
 
+
 class ExportingDialog(QDialog):
-    
+
     _max_dots = 3
 
     def __init__(self, parent=None, filetype=None):

diff --git a/glue_ar/qr.py b/glue_ar/qr.py
@@ -39,4 +39,3 @@ def create_qr(url):
     box = ((width - logo_img.size[0]) // 2, (height - logo_img.size[1]) // 2)
     img.paste(logo_img, box)
     return img
-
diff --git a/glue_ar/qr_dialog.py b/glue_ar/qr_dialog.py
@@ -11,7 +11,7 @@
 class QRDialog(QDialog):
 
     def __init__(self, parent, url=None, img=None):
-        
+
         super(QRDialog, self).__init__(parent=parent)
         img = create_qr(url)
         self.img = ImageQt(img)

diff --git a/glue_ar/scatter.py b/glue_ar/scatter.py
@@ -136,7 +136,7 @@ def scatter_layer_as_multiblock(viewer_state, layer_state,
             sizes = sqrt(ones(size_data.shape) * 10)
         else:
             sizes = sqrt((20 * (size_data - layer_state.size_vmin) /
-                     (layer_state.size_vmax - layer_state.size_vmin)))
+                         (layer_state.size_vmax - layer_state.size_vmin)))
         sizes *= (layer_state.size_scaling / factor)
         sizes[isnan(sizes)] = 0.
         spheres = [pv.Sphere(center=p, radius=r,
@@ -193,7 +193,7 @@ def scatter_layer_as_multiblock(viewer_state, layer_state,
         for axis in ['x', 'y', 'z']:
             if getattr(layer_state, f"{axis}err_visible"):
                 axis_bars = meshes_for_error_bars(viewer_state, layer_state,
-                                             axis, data, bounds, mask=mask)
+                                                  axis, data, bounds, mask=mask)
                 bars.extend(axis_bars)
                 if not fixed_color:
                     bars_cmap_values.extend([y for x in cmap_values for y in (x,) * 2])  # Each line has just two points

diff --git a/glue_ar/server.py b/glue_ar/server.py
@@ -1,13 +1,11 @@
-from os.path import split
-
 from http.server import SimpleHTTPRequestHandler
 from socketserver import TCPServer
 
 
 def create_handler(directory):
 
     class ARHttpRequestHandler(SimpleHTTPRequestHandler):
-    
+
         def __init__(self, *args, **kwargs):
             super().__init__(*args, directory=directory, **kwargs)
 
@@ -16,5 +14,5 @@ def __init__(self, *args, **kwargs):
 
 def run_ar_server(port, directory):
     handler_cls = create_handler(directory)
-    server = TCPServer(("", port), handler_cls) 
+    server = TCPServer(("", port), handler_cls)
     return server
diff --git a/glue_ar/tools.py b/glue_ar/tools.py
@@ -96,10 +96,11 @@ def activate(self):
         if result == QDialog.Rejected:
             return
 
-        export_path, _ = compat.getsavefilename(parent=self.viewer, basedir=f"{self._default_filename}.{dialog.state.filetype.lower()}")
+        export_path, _ = compat.getsavefilename(parent=self.viewer,
+                                                basedir=f"{self._default_filename}.{dialog.state.filetype.lower()}")
         if not export_path:
             return
-        
+
         _, ext = splitext(export_path)
         filetype = _FILETYPE_NAMES.get(ext, None)
         worker = Worker(self._export_to_ar, export_path, dialog.state_dictionary, compress=dialog.state.draco)
@@ -123,8 +124,6 @@ def _export_to_ar(self, filepath, state_dict, compress=True):
             plotter.export_obj(filepath)
 
 
-
-
 @viewer_tool
 class ARLocalQRTool(Tool):
     icon = AR_ICON
@@ -141,7 +140,6 @@ def activate(self):
             _, gltf_base = split(gltf_tmp.name)
             export_modelviewer(html_tmp.name, gltf_base, self.viewer.state.title)
 
-
             port = 4000
             directory, filename = split(html_tmp.name)
             server = run_ar_server(port, directory)
@@ -168,4 +166,3 @@ def activate(self):
                         pass
                 server.shutdown()
                 server.server_close()
-
diff --git a/glue_ar/utils.py b/glue_ar/utils.py
@@ -34,7 +34,7 @@ def bounds_3d_from_layers(viewer_state, layer_states):
         data = state.layer.layer
         mins = [min(min(data[att]), m) for m, att in zip(mins, atts)]
         maxes = [max(max(data[att]), m) for m, att in zip(maxes, atts)]
-    return [(l, u) for l, u in zip(mins, maxes)]
+    return [(lo, hi) for lo, hi in zip(mins, maxes)]
 
 
 def slope_intercept_between(a, b):
@@ -66,7 +66,7 @@ def bring_into_clip(data, bounds, preserve_aspect=True):
         line_data = [slope_intercept_between((bds[0], -1), (bds[1], 1)) for bds in bounds]
 
     scaled = [[m * d + b for d in data[idx]] for idx, (m, b) in enumerate(line_data)]
-    
+
     return scaled
 
 
@@ -95,5 +95,5 @@ def xyz_for_layer(viewer_state, layer_state,
     if scaled:
         bounds = xyz_bounds(viewer_state)
         vals = bring_into_clip(vals, bounds, preserve_aspect=preserve_aspect)
-        
+
     return array(list(zip(*vals)))
diff --git a/glue_ar/volume.py b/glue_ar/volume.py
@@ -104,8 +104,8 @@ def meshes_for_volume_layer(viewer_state, layer_state, bounds,
 
 def bounds_3d(viewer_state):
     return [(viewer_state.z_min, viewer_state.z_max, viewer_state.resolution),
-              (viewer_state.y_min, viewer_state.y_max, viewer_state.resolution),
-              (viewer_state.x_min, viewer_state.x_max, viewer_state.resolution)]
+            (viewer_state.y_min, viewer_state.y_max, viewer_state.resolution),
+            (viewer_state.x_min, viewer_state.x_max, viewer_state.resolution)]
 
 
 # For the 3D volume viewer
@@ -163,7 +163,6 @@ def create_meshes(viewer_state, layer_states, parameters):
                 parent_data = invert(subcube) * parent_data
                 meshes[parent.label]["data"] = parent_data
 
-
     for label, item in meshes.items():
         data = item["data"]
         isomin = item["isomin"]
@@ -177,7 +176,9 @@ def create_meshes(viewer_state, layer_states, parameters):
         grid = pv.ImageData()
         grid.dimensions = (viewer_state.resolution,) * 3
         grid.origin = (viewer_state.x_min, viewer_state.y_min, viewer_state.z_min)
-        # Comment from Luca: # I think the voxel spacing will always be 1, because of how glue downsamples to a fixed resolution grid. But don't hold me to this!
+        # Comment from Luca: # I think the voxel spacing will always be 1,
+        # because of how glue downsamples to a fixed resolution grid.
+        # But don't hold me to this!
         grid.spacing = (1, 1, 1)
         grid.point_data["values"] = data.flatten(order="F")
         isodata = grid.contour([isomin])
@@ -189,4 +190,3 @@ def create_meshes(viewer_state, layer_states, parameters):
         item["mesh"] = isodata
 
     return meshes
-
diff --git a/setup.py b/setup.py
@@ -57,6 +57,11 @@ def data_files(root_directory):
         "pyvista",
         "segno"
     ],
+    extras_require={
+        "test": [
+            "flake8"
+        ]
+    },
     entry_points={
         "glue.plugins": "glue_ar = glue_ar:setup"
     }

diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,6 @@
+[testenv:codestyle]
+deps = flake8
+skipsdist = true
+skip_install = true
+commands =
+    flake8 --max-line-length=120 --exclude=external glue_ar
Original file line number	Diff line number	Diff line change
Expand Up		@@ -39,4 +39,3 @@ def create_qr(url):
		box = ((width - logo_img.size[0]) // 2, (height - logo_img.size[1]) // 2)
		img.paste(logo_img, box)
		return img