boris-behav-obs 8.27.10__py2.py3-none-any.whl → 9.0.2__py2.py3-none-any.whl

boris/plot_spectrogram_rt.py

@@ -30,7 +30,7 @@ import numpy as np
 
 from . import config as cfg
 
-from PyQt5.QtWidgets import (
+from PySide6.QtWidgets import (
     QWidget,
     QVBoxLayout,
     QHBoxLayout,
@@ -38,8 +38,7 @@ from PyQt5.QtWidgets import (
     QLabel,
     QSpinBox,
 )
-from PyQt5.QtCore import pyqtSignal, QEvent
-from PyQt5 import Qt
+from PySide6.QtCore import Signal, QEvent, Qt
 from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
 from matplotlib.figure import Figure
 import matplotlib.ticker as mticker
@@ -49,7 +48,7 @@ import matplotlib.ticker as mticker
 
 class Plot_spectrogram_RT(QWidget):
     # send keypress event to mainwindow
-    sendEvent = pyqtSignal(QEvent)
+    sendEvent = Signal(QEvent)
 
     def __init__(self):
         super().__init__()
@@ -77,7 +76,7 @@ class Plot_spectrogram_RT(QWidget):
                 "+",
                 self,
                 clicked=lambda: self.time_interval_changed(1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         hlayout1.addWidget(
@@ -85,17 +84,17 @@ class Plot_spectrogram_RT(QWidget):
                 "-",
                 self,
                 clicked=lambda: self.time_interval_changed(-1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         layout.addLayout(hlayout1)
 
         hlayout2 = QHBoxLayout()
         hlayout2.addWidget(QLabel("Frequency interval"))
-        self.sb_freq_min = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.Qt.NoFocus)
+        self.sb_freq_min = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.NoFocus)
         self.sb_freq_min.setRange(0, 200000)
         self.sb_freq_min.setSingleStep(100)
-        self.sb_freq_max = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.Qt.NoFocus)
+        self.sb_freq_max = QSpinBox(valueChanged=self.frequency_interval_changed, focusPolicy=Qt.NoFocus)
         self.sb_freq_max.setRange(0, 200000)
         self.sb_freq_max.setSingleStep(100)
         hlayout2.addWidget(self.sb_freq_min)

boris/plot_waveform_rt.py

@@ -28,10 +28,9 @@ import matplotlib
 matplotlib.use("Qt5Agg")
 
 import numpy as np
-from PyQt5.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QPushButton, QLabel
-from PyQt5.QtCore import pyqtSignal, QEvent
-from PyQt5 import Qt
-from matplotlib.backends.backend_qt5agg import FigureCanvasQTAgg as FigureCanvas
+from PySide6.QtWidgets import QWidget, QVBoxLayout, QHBoxLayout, QPushButton, QLabel
+from PySide6.QtCore import Signal, QEvent, Qt
+from matplotlib.backends.backend_qtagg import FigureCanvasQTAgg as FigureCanvas
 from matplotlib.figure import Figure
 import matplotlib.ticker as mticker
 
@@ -40,7 +39,7 @@ import matplotlib.ticker as mticker
 
 class Plot_waveform_RT(QWidget):
     # send keypress event to mainwindow
-    sendEvent = pyqtSignal(QEvent)
+    sendEvent = Signal(QEvent)
 
     def __init__(self):
         super().__init__()
@@ -68,7 +67,7 @@ class Plot_waveform_RT(QWidget):
                 "+",
                 self,
                 clicked=lambda: self.time_interval_changed(1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         hlayout1.addWidget(
@@ -76,7 +75,7 @@ class Plot_waveform_RT(QWidget):
                 "-",
                 self,
                 clicked=lambda: self.time_interval_changed(-1),
-                focusPolicy=Qt.Qt.NoFocus,
+                focusPolicy=Qt.NoFocus,
             )
         )
         layout.addLayout(hlayout1)

boris/plugins.py

@@ -0,0 +1,79 @@
+"""
+BORIS
+Behavioral Observation Research Interactive Software
+Copyright 2012-2024 Olivier Friard
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+  MA 02110-1301, USA.
+"""
+
+import logging
+from PySide6.QtGui import QAction
+from . import config as cfg
+from pathlib import Path
+
+
+def add_plugins_to_menu(self):
+    """
+    add plugins to the plugins menu
+    """
+    for plugin_name in self.config_param.get(cfg.ANALYSIS_PLUGINS, {}):
+        logging.debug(f"adding plugin '{plugin_name}' to menu")
+        # Create an action for each submenu option
+        action = QAction(self, triggered=self.run_plugin)
+        action.setText(plugin_name)
+
+        self.menu_plugins.addAction(action)
+
+
+def get_plugin_name(plugin_path: str):
+    """
+    get name of plugin
+    """
+    # search plugin name
+    plugin_name = None
+    with open(plugin_path, "r") as f_in:
+        for line in f_in:
+            if line.startswith("__plugin_name__"):
+                plugin_name = line.split("=")[1].strip().replace('"', "")
+                break
+    return plugin_name
+
+
+def load_plugins(self):
+    """
+    load selected plugins in analysis menu
+    """
+    self.menu_plugins.clear()
+    self.config_param[cfg.ANALYSIS_PLUGINS] = {}
+
+    # load BORIS plugins
+    for file_ in (Path(__file__).parent / "analysis_plugins").glob("*.py"):
+        if file_.name == "__init__.py":
+            continue
+        plugin_name = get_plugin_name(file_)
+        if plugin_name is not None and plugin_name not in self.config_param.get(cfg.EXCLUDED_PLUGINS, set()):
+            self.config_param[cfg.ANALYSIS_PLUGINS][plugin_name] = str(file_)
+
+    # load personal plugins
+    if self.config_param.get(cfg.PERSONAL_PLUGINS_DIR, ""):
+        for file_ in Path(self.config_param.get(cfg.PERSONAL_PLUGINS_DIR, "")).glob("*.py"):
+            if file_.name == "__init__.py":
+                continue
+            plugin_name = get_plugin_name(file_)
+            if plugin_name is not None and plugin_name not in self.config_param.get(cfg.EXCLUDED_PLUGINS, set()):
+                self.config_param[cfg.ANALYSIS_PLUGINS][plugin_name] = str(file_)
+
+    print(f"{self.config_param.get(cfg.ANALYSIS_PLUGINS, {})=}")

boris/preferences.py

@@ -22,21 +22,19 @@ This file is part of BORIS.
 
 import logging
 import os
-import pathlib
+from pathlib import Path
 import sys
-
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), ".")))
-import qdarkstyle
-
 from . import dialog
 from . import gui_utilities
 from . import menu_options
 from . import config as cfg
 from . import config_file
+from . import plugins
 
 from .preferences_ui import Ui_prefDialog
 
-from PyQt5.QtWidgets import QDialog, QFileDialog
+from PySide6.QtWidgets import QDialog, QFileDialog, QListWidgetItem, QMessageBox
+from PySide6.QtCore import Qt
 
 
 class Preferences(QDialog, Ui_prefDialog):
@@ -44,6 +42,11 @@ class Preferences(QDialog, Ui_prefDialog):
         super().__init__()
         self.setupUi(self)
 
+        # plugins
+        """self.pb_add_plugin.clicked.connect(self.add_plugin)
+        self.pb_remove_plugin.clicked.connect(self.remove_plugin)"""
+        self.pb_browse_plugins_dir.clicked.connect(self.browse_plugins_dir)
+
         self.pbBrowseFFmpegCacheDir.clicked.connect(self.browseFFmpegCacheDir)
 
         self.pb_reset_behav_colors.clicked.connect(self.reset_behav_colors)
@@ -55,6 +58,28 @@ class Preferences(QDialog, Ui_prefDialog):
 
         self.flag_refresh = False
 
+    def browse_plugins_dir(self):
+        """
+        get the personal plugins directory
+        """
+        directory = QFileDialog.getExistingDirectory(None, "Select the plugins directory", self.le_personal_plugins_dir.text())
+        if not directory:
+            return
+
+        self.le_personal_plugins_dir.setText(directory)
+        self.lw_personal_plugins.clear()
+        for file_ in Path(directory).glob("*.py"):
+            item = QListWidgetItem(file_.stem)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            # if plugin_name in self.config_param.get(cfg.EXCLUDED_PLUGINS, set()):
+            #    item.setCheckState(Qt.Unchecked)
+            # else:
+            item.setCheckState(Qt.Checked)
+            item.setData(100, file_.stem)
+            self.lw_personal_plugins.addItem(item)
+        if self.lw_personal_plugins.count() == 0:
+            QMessageBox.warning(self, cfg.programName, f"No plugin found in {directory}")
+
     def refresh_preferences(self):
         """
         allow user to delete the config file (.boris)
@@ -74,11 +99,11 @@ class Preferences(QDialog, Ui_prefDialog):
         """
         allow user select a cache dir for ffmpeg images
         """
-        FFmpegCacheDir = QFileDialog().getExistingDirectory(
+        FFmpegCacheDir = QFileDialog.getExistingDirectory(
             self,
             "Select a directory",
             os.path.expanduser("~"),
-            options=QFileDialog().ShowDirsOnly,
+            options=QFileDialog.ShowDirsOnly,
         )
         if FFmpegCacheDir:
             self.leFFmpegCacheDir.setText(FFmpegCacheDir)
@@ -105,6 +130,30 @@ def preferences(self):
     show preferences window
     """
 
+    def show_plugin_info(item):
+        """
+        display information about the clicked plugin
+        """
+
+        if item.text() not in self.config_param[cfg.ANALYSIS_PLUGINS]:
+            return
+
+        import importlib
+
+        plugin_path = item.data(100)
+
+        module_name = Path(plugin_path).stem
+        spec = importlib.util.spec_from_file_location(module_name, plugin_path)
+        plugin_module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(plugin_module)
+        out: list = []
+        out.append(plugin_module.__plugin_name__ + "\n")
+        out.append(plugin_module.__author__)
+        out.append(f"{plugin_module.__version__} ({plugin_module.__version_date__})\n")
+        out.append(plugin_module.run.__doc__.strip())
+
+        preferencesWindow.pte_plugin_description.setPlainText("\n".join(out))
+
     preferencesWindow = Preferences()
     preferencesWindow.tabWidget.setCurrentIndex(0)
 
@@ -135,7 +184,7 @@ def preferences(self):
     # check for new version
     preferencesWindow.cbCheckForNewVersion.setChecked(self.checkForNewVersion)
     # display subtitles
-    preferencesWindow.cb_display_subtitles.setChecked(self.config_param[cfg.DISPLAY_SUBTITLES])
+    preferencesWindow.cb_display_subtitles.setChecked(self.config_param.get(cfg.DISPLAY_SUBTITLES, False))
     # pause before add event
     preferencesWindow.cb_pause_before_addevent.setChecked(self.pause_before_addevent)
     # MPV hwdec
@@ -148,6 +197,49 @@ def preferences(self):
     except Exception:
         preferencesWindow.cb_hwdec.setCurrentIndex(cfg.MPV_HWDEC_OPTIONS.index(cfg.MPV_HWDEC_DEFAULT_VALUE))
 
+    # BORIS plugins
+    preferencesWindow.lv_all_plugins.itemClicked.connect(show_plugin_info)
+
+    preferencesWindow.lv_all_plugins.clear()
+
+    for file_ in (Path(__file__).parent / "analysis_plugins").glob("*.py"):
+        if file_.name == "__init__.py":
+            continue
+        plugin_name = plugins.get_plugin_name(file_)
+        if plugin_name is not None:
+            item = QListWidgetItem(plugin_name)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            if plugin_name in self.config_param.get(cfg.EXCLUDED_PLUGINS, set()):
+                item.setCheckState(Qt.Unchecked)
+            else:
+                item.setCheckState(Qt.Checked)
+            item.setData(100, str(file_))
+            preferencesWindow.lv_all_plugins.addItem(item)
+
+    # personal plugins
+    preferencesWindow.le_personal_plugins_dir.setText(self.config_param.get(cfg.PERSONAL_PLUGINS_DIR, ""))
+    preferencesWindow.lw_personal_plugins.itemClicked.connect(show_plugin_info)
+
+    preferencesWindow.lw_personal_plugins.clear()
+    if self.config_param.get(cfg.PERSONAL_PLUGINS_DIR, ""):
+        for file_ in Path(self.config_param[cfg.PERSONAL_PLUGINS_DIR]).glob("*.py"):
+            if file_.name == "__init__.py":
+                continue
+            plugin_name = plugins.get_plugin_name(file_)
+            if plugin_name is None:
+                continue
+            # check if personal plugin name is in BORIS plugins (case sensitive)
+            if plugin_name in [preferencesWindow.lv_all_plugins.item(i).text() for i in range(preferencesWindow.lv_all_plugins.count())]:
+                continue
+            item = QListWidgetItem(plugin_name)
+            item.setFlags(item.flags() | Qt.ItemIsUserCheckable)
+            if plugin_name in self.config_param.get(cfg.EXCLUDED_PLUGINS, set()):
+                item.setCheckState(Qt.Unchecked)
+            else:
+                item.setCheckState(Qt.Checked)
+            item.setData(100, str(file_))
+            preferencesWindow.lw_personal_plugins.addItem(item)
+
     # PROJET FILE INDENTATION
     preferencesWindow.combo_project_file_indentation.clear()
     preferencesWindow.combo_project_file_indentation.addItems(cfg.PROJECT_FILE_INDENTATION_COMBO_OPTIONS)
@@ -201,7 +293,6 @@ def preferences(self):
 
     # interface
     preferencesWindow.sb_toolbar_icon_size.setValue(self.config_param.get(cfg.TOOLBAR_ICON_SIZE, cfg.DEFAULT_TOOLBAR_ICON_SIZE_VALUE))
-    preferencesWindow.cb_darkmode.setChecked(self.config_param.get(cfg.DARK_MODE, cfg.DARK_MODE_DEFAULT_VALUE))
 
     gui_utilities.restore_geometry(preferencesWindow, "preferences", (700, 500))
 
@@ -217,8 +308,8 @@ def preferences(self):
             self.close()
             # check if refresh canceled for not saved project
             if "refresh_preferences" in self.config_param:
-                if (pathlib.Path.home() / ".boris").exists():
-                    os.remove(pathlib.Path.home() / ".boris")
+                if (Path.home() / ".boris").exists():
+                    os.remove(Path.home() / ".boris")
                 sys.exit()
 
         if preferencesWindow.cbTimeFormat.currentIndex() == 0:
@@ -262,6 +353,30 @@ def preferences(self):
         # MPV hwdec
         self.config_param[cfg.MPV_HWDEC] = cfg.MPV_HWDEC_OPTIONS[preferencesWindow.cb_hwdec.currentIndex()]
 
+        # update BORIS analysis plugins
+        self.config_param[cfg.ANALYSIS_PLUGINS] = {}
+        self.config_param[cfg.EXCLUDED_PLUGINS] = set()
+        for i in range(preferencesWindow.lv_all_plugins.count()):
+            if preferencesWindow.lv_all_plugins.item(i).checkState() == Qt.Checked:
+                self.config_param[cfg.ANALYSIS_PLUGINS][preferencesWindow.lv_all_plugins.item(i).text()] = (
+                    preferencesWindow.lv_all_plugins.item(i).data(100)
+                )
+            else:
+                self.config_param[cfg.EXCLUDED_PLUGINS].add(preferencesWindow.lv_all_plugins.item(i).text())
+
+        # update personal plugins
+        self.config_param[cfg.PERSONAL_PLUGINS_DIR] = preferencesWindow.le_personal_plugins_dir.text()
+        for i in range(preferencesWindow.lw_personal_plugins.count()):
+            if preferencesWindow.lw_personal_plugins.item(i).checkState() == Qt.Checked:
+                self.config_param[cfg.ANALYSIS_PLUGINS][preferencesWindow.lw_personal_plugins.item(i).text()] = (
+                    preferencesWindow.lw_personal_plugins.item(i).data(100)
+                )
+            else:
+                self.config_param[cfg.EXCLUDED_PLUGINS].add(preferencesWindow.lw_personal_plugins.item(i).text())
+
+        plugins.load_plugins(self)
+        plugins.add_plugins_to_menu(self)
+
         # project file indentation
         self.config_param[cfg.PROJECT_FILE_INDENTATION] = cfg.PROJECT_FILE_INDENTATION_OPTIONS[
             preferencesWindow.combo_project_file_indentation.currentIndex()
@@ -285,11 +400,6 @@ def preferences(self):
 
         # interface
         self.config_param[cfg.TOOLBAR_ICON_SIZE] = preferencesWindow.sb_toolbar_icon_size.value()
-        self.config_param[cfg.DARK_MODE] = preferencesWindow.cb_darkmode.isChecked()
-        if self.config_param.get(cfg.DARK_MODE, cfg.DEFAULT_FRAME_MODE):
-            self.setStyleSheet(qdarkstyle.load_stylesheet(qt_api="pyqt5"))
-        else:
-            self.setStyleSheet("")
 
         menu_options.update_menu(self)