Add linting to CI

.github/workflows/lint.yml

@@ -0,0 +1,55 @@
+name: lint
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v2
+      with:
+        python-version: '3.11'
+
+    - name: Checkout HEXRD
+      uses: actions/checkout@v4
+      with:
+        repository: HEXRD/hexrd
+        path: hexrd
+
+    - name: Checkout HEXRDGUI
+      uses: actions/checkout@v4
+      with:
+        path: hexrdgui
+
+    - name: Install EGL (PySide6 needs it)
+      run: sudo apt-get update && sudo apt-get install -y libegl1-mesa-dev
+
+    - name: Install HEXRD
+      run: pip install .
+      working-directory: hexrd
+
+    - name: Install HEXRDGUI
+      run: pip install .
+      working-directory: hexrdgui
+
+    - name: Install linters
+      run: pip install mypy ruff types-PyYAML
+
+    - name: Run ruff format
+      run: ruff format --check hexrdgui/
+      working-directory: hexrdgui
+
+    - name: Run mypy
+      run: mypy hexrdgui/
+      working-directory: hexrdgui

hexrdgui/about_dialog.py

@@ -18,7 +18,8 @@ class AboutDialog(QObject):
     def __init__(self, parent: QObject | None = None) -> None:
         super().__init__(parent)
         self.ui = UiLoader().load_file(
-            'about_dialog.ui', parent  # type: ignore[arg-type]
+            'about_dialog.ui',
+            parent,  # type: ignore[arg-type]
         )
 
         self._populate_hexrd_logo()
@@ -74,11 +75,11 @@ def _populate_versions(self) -> None:
         tree = self.ui.information
 
         packages = [
-            "HEXRDGUI",
-            "HEXRD",
-            "NumPy",
-            "SciPy",
-            "PySide6",
+            'HEXRDGUI',
+            'HEXRD',
+            'NumPy',
+            'SciPy',
+            'PySide6',
         ]
 
         for package in packages:
@@ -87,5 +88,5 @@ def _populate_versions(self) -> None:
             item.setText(1, version(package.lower()))
 
         python = QTreeWidgetItem(tree)
-        python.setText(0, "Python")
+        python.setText(0, 'Python')
         python.setText(1, sys.version)

hexrdgui/absorption_correction_options_dialog.py

@@ -9,7 +9,6 @@
 
 
 class AbsorptionCorrectionOptionsDialog:
-
     def __init__(self, parent: QWidget | None = None) -> None:
         loader = UiLoader()
         self.ui = loader.load_file('absorption_correction_options_dialog.ui', parent)

hexrdgui/argument_parser.py

@@ -5,7 +5,7 @@
 
 def check_positive_int(value: str) -> int:
     """Ensure the value is a positive int"""
-    error_msg = f"invalid positive int value: {value}"
+    error_msg = f'invalid positive int value: {value}'
 
     try:
         ivalue = int(value)

hexrdgui/async_runner.py

@@ -8,7 +8,6 @@
 
 
 class AsyncRunner:
-
     def __init__(self, parent: QWidget) -> None:
         self.parent = parent
 

hexrdgui/async_worker.py

@@ -10,7 +10,7 @@
 
 
 class AsyncWorkerSignals(QObject):
-    '''
+    """
     Defines the signals available from a running worker thread.
 
     Supported signals are:
@@ -27,7 +27,7 @@ class AsyncWorkerSignals(QObject):
     progress
         `int` indicating % progress
 
-    '''
+    """
 
     finished = Signal()
     error = Signal(tuple)
@@ -36,7 +36,7 @@ class AsyncWorkerSignals(QObject):
 
 
 class AsyncWorker(QRunnable):
-    '''
+    """
     AsyncWorker
 
     Inherits from QRunnable to handler worker thread setup, signals and
@@ -49,7 +49,7 @@ class AsyncWorker(QRunnable):
     :param args: Arguments to pass to the callback function
     :param kwargs: Keywords to pass to the callback function
 
-    '''
+    """
 
     def __init__(self, fn: Callable[..., Any], *args: Any, **kwargs: Any) -> None:
         super().__init__()
@@ -67,9 +67,9 @@ def __init__(self, fn: Callable[..., Any], *args: Any, **kwargs: Any) -> None:
 
     @Slot()
     def run(self) -> None:
-        '''
+        """
         Initialise the runner function with passed args, kwargs.
-        '''
+        """
 
         # Retrieve args/kwargs here; and fire processing using them
         try:

hexrdgui/azimuthal_overlay_editor.py

@@ -7,7 +7,6 @@
 
 
 class AzimuthalOverlayEditor:
-
     def __init__(self, parent: QWidget | None = None) -> None:
         loader = UiLoader()
         self.ui = loader.load_file('azimuthal_overlay_editor.ui', parent)

hexrdgui/azimuthal_overlay_manager.py

@@ -31,7 +31,6 @@
 
 
 class AzimuthalOverlayManager:
-
     def __init__(self, parent: QWidget | None = None) -> None:
         loader = UiLoader()
         self.ui = loader.load_file('azimuthal_overlay_manager.ui', parent)

hexrdgui/azimuthal_overlay_style_picker.py

@@ -10,7 +10,6 @@
 
 
 class AzimuthalOverlayStylePicker(QObject):
-
     def __init__(self, overlay: Any, parent: QObject | None = None) -> None:
         super().__init__(parent)
 

hexrdgui/beam_marker_style_editor.py

@@ -11,7 +11,6 @@
 
 
 class BeamMarkerStyleEditor:
-
     def __init__(self, parent: QWidget | None = None) -> None:
         loader = UiLoader()
         self.ui = loader.load_file('beam_marker_style_editor.ui', parent)

hexrdgui/blit_manager.py

@@ -26,7 +26,7 @@ def __init__(self, canvas: Any) -> None:
         self.artists: dict[str, Any] = {}
 
         # grab the background on every draw
-        self.cid = canvas.mpl_connect("draw_event", self.on_draw)
+        self.cid = canvas.mpl_connect('draw_event', self.on_draw)
 
     def disconnect(self) -> None:
         self.remove_artists()

hexrdgui/brightness_contrast_editor.py

@@ -28,7 +28,6 @@
 
 
 class BrightnessContrastEditor(QObject):
-
     edited = Signal(float, float)
 
     reset = Signal()

hexrdgui/cal_tree_view.py

@@ -25,7 +25,6 @@
 
 
 class CalTreeItemModel(BaseTreeItemModel):
-
     def __init__(self, parent: QWidget | None = None) -> None:
         super().__init__(parent)
         self.root_item = TreeItem(['key', 'value'])
@@ -238,7 +237,6 @@ def set_value(self, key: Any, cur_config: Any, cur_tree_item: Any) -> None:
 
 
 class CalTreeView(QTreeView):
-
     def model(self) -> CalTreeItemModel:
         return super().model()  # type: ignore[return-value]
 

hexrdgui/calibration/auto/powder_calibration_dialog.py

@@ -14,7 +14,6 @@
 
 
 class PowderCalibrationDialog:
-
     def __init__(self, material: Material, parent: QWidget | None = None) -> None:
         loader = UiLoader()
         self.ui = loader.load_file('powder_calibration_dialog.ui', parent)
@@ -38,10 +37,7 @@ def setup_combo_boxes(self) -> None:
     def update_gui(self) -> None:
         if self.tth_tol is None:
             default = 0.125
-            msg = (
-                'Powder overlay width is required.\n\n'
-                f'Setting to default: {default}°'
-            )
+            msg = f'Powder overlay width is required.\n\nSetting to default: {default}°'
             QMessageBox.warning(self.ui.parent(), 'HEXRD', msg)
             self.tth_tol = default
 

hexrdgui/calibration/auto/powder_runner.py

@@ -25,7 +25,6 @@
 
 
 class PowderRunner(QObject):
-
     calibration_finished = Signal()
 
     def __init__(self, parent: QWidget | None = None) -> None:
@@ -195,7 +194,6 @@ def save_picks_to_overlay(self) -> None:
 
 
 class CalibrationCallbacks(MaterialCalibrationDialogCallbacks):
-
     @property
     def data_xys(self) -> dict:
         ret: dict[str, Any] = {}

hexrdgui/calibration/calibration_dialog.py

@@ -40,7 +40,6 @@
 
 
 class CalibrationDialog(QObject):
-
     draw_picks_toggled = Signal(bool)
     show_picks_from_all_xray_sources_toggled = Signal(bool)
 
@@ -73,7 +72,8 @@ def __init__(
 
         loader = UiLoader()
         self.ui = loader.load_file(
-            'calibration_dialog.ui', parent  # type: ignore[arg-type]
+            'calibration_dialog.ui',
+            parent,  # type: ignore[arg-type]
         )
 
         self.ui.setWindowFlags(self.ui.windowFlags() | Qt.WindowType.Tool)
@@ -217,15 +217,15 @@ def initialize_advanced_options(self) -> None:
     @property
     def default_advanced_options(self) -> dict[str, Any]:
         return {
-            "ftol": 1e-8,
-            "xtol": 1e-8,
-            "gtol": 1e-8,
-            "verbose": 2,
-            "max_nfev": 1000,
+            'ftol': 1e-8,
+            'xtol': 1e-8,
+            'gtol': 1e-8,
+            'verbose': 2,
+            'max_nfev': 1000,
             # Skip x_scale until we find a way to present it in the GUI
             # "x_scale": "jac",
-            "method": "trf",
-            "jac": "3-point",
+            'method': 'trf',
+            'jac': '3-point',
         }
 
     @property

hexrdgui/calibration/calibration_runner.py

@@ -54,7 +54,6 @@
 
 
 class CalibrationRunner(QObject):
-
     calibration_finished = Signal()
 
     def __init__(
@@ -996,7 +995,6 @@ def on_rejected() -> None:
 
 
 class CalibrationCallbacks(MaterialCalibrationDialogCallbacks):
-
     def __init__(self, overlays: list, *args: Any, **kwargs: Any) -> None:
         self.overlays = overlays
 

hexrdgui/calibration/cartesian_plot.py

@@ -34,7 +34,6 @@ def get_xray_propagation_sign(instr: HEDMInstrument) -> Any:
 
 
 class InstrumentViewer:
-
     def __init__(self) -> None:
         self.type = ViewType.cartesian
         self.instr = create_hedm_instrument()

hexrdgui/calibration/display_plane.py

@@ -15,7 +15,6 @@
 
 
 class DisplayPlane:
-
     def __init__(
         self,
         tilt: np.ndarray = tilt_DFTL,

hexrdgui/calibration/hedm/calibration_dialog.py

@@ -26,7 +26,6 @@
 
 
 class HEDMCalibrationDialog(CalibrationDialog):
-
     apply_refinement_selections_needed = Signal()
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
@@ -247,7 +246,6 @@ def validate_parameters(self) -> None:
 
 
 class HEDMCalibrationCallbacks(MaterialCalibrationDialogCallbacks):
-
     dialog: HEDMCalibrationDialog  # type: ignore[assignment]
 
     def __init__(
@@ -455,9 +453,9 @@ def run_calibration(self, **extra_kwargs: Any) -> Any:
         ims = next(iter(ims_dict.values()))  # grab first member
         delta_ome = ims.metadata['omega'][:, 1] - ims.metadata['omega'][:, 0]
         # In the spirit of Joel, I'm leaving his comment here...
-        assert (
-            np.max(np.abs(np.diff(delta_ome))) < cnst.sqrt_epsf
-        ), "something funky going one with your omegas"
+        assert np.max(np.abs(np.diff(delta_ome))) < cnst.sqrt_epsf, (
+            'something funky going one with your omegas'
+        )
         delta_ome = delta_ome[0]  # any one member will do
 
         # refit tolerances
@@ -510,9 +508,9 @@ def run_calibration(self, **extra_kwargs: Any) -> Any:
                 )
 
                 print(
-                    "INFO: Will keep %d of %d input reflections "
+                    'INFO: Will keep %d of %d input reflections '
                     % (sum(idx_1), sum(idx_0[det_key][ig]))
-                    + "on panel %s for re-fit" % det_key
+                    + 'on panel %s for re-fit' % det_key
                 )
 
                 idx_new = np.zeros_like(idx_0[det_key][ig], dtype=bool)
@@ -667,6 +665,6 @@ def parse_spots_data(
 REFINEMENT_OPTIONS = {
     'fix_det_y': 'Fix origin based on current sample/detector position',
     'fix_grain_centroid': 'Reset origin to grain centroid position',
-    'fix_grain_y': 'Reset Y axis origin to grain\'s Y position',
+    'fix_grain_y': "Reset Y axis origin to grain's Y position",
     'custom': 'Custom refinement parameters',
 }