boris-behav-obs 8.16.5__py3-none-any.whl → 9.7.12__py3-none-any.whl

boris/__init__.py

@@ -2,7 +2,7 @@
 BORIS
 Behavioral Observation Research Interactive Software
 
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 This file is part of BORIS.
 

boris/__main__.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 This file is part of BORIS.
 

boris/about.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 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
@@ -30,24 +30,9 @@ from . import version
 from . import config as cfg
 from . import utilities as util
 
-try:
-    from . import mpv2 as mpv
 
-    # check if MPV API v. 1
-    # is v. 1 use the old version of mpv.py
-    try:
-        if "libmpv.so.1" in mpv.sofile:
-            from . import mpv as mpv
-    except AttributeError:
-        if "mpv-1.dll" in mpv.dll:
-            from . import mpv as mpv
-
-except RuntimeError:  # libmpv found but version too old
-    from . import mpv as mpv
-
-from PyQt5.QtCore import QT_VERSION_STR, PYQT_VERSION_STR
-from PyQt5.QtGui import QPixmap
-from PyQt5.QtWidgets import QMessageBox
+from PySide6.QtGui import QPixmap
+from PySide6.QtWidgets import QMessageBox
 
 
 def actionAbout_activated(self):
@@ -55,25 +40,26 @@ def actionAbout_activated(self):
     About dialog
     """
 
-    programs_versions = ["MPV media player"]
-    if sys.platform.startswith("linux"):
-        programs_versions.append(
-            f"Library version: {'.'.join([str(x) for x in mpv._mpv_client_api_version()])} file: {mpv.sofile}"
-        )
-    if sys.platform.startswith("win"):
-        programs_versions.append(
-            f"Library version: {'.'.join([str(x) for x in mpv._mpv_client_api_version()])} file: {mpv.dll}"
+    programs_versions: list[str] = ["MPV media player"]
+
+    mpv_lib_version, mpv_lib_file_path, mpv_api_version = util.mpv_lib_version()
+    programs_versions.append(
+        (
+            f"Library version: {mpv_lib_version} file: {mpv_lib_file_path}\n"
+            f"MPV API version: {mpv_api_version}\n"
+            f"python-mpv version: {util.python_mpv_script_version()}"
         )
+    )
 
     # ffmpeg
     if self.ffmpeg_bin == "ffmpeg" and sys.platform.startswith("linux"):
-        ffmpeg_true_path = subprocess.getoutput("which ffmpeg")
+        ffmpeg_true_path: str = subprocess.getoutput("which ffmpeg")
     else:
         ffmpeg_true_path = self.ffmpeg_bin
     programs_versions.extend(
         [
             "\nFFmpeg",
-            subprocess.getoutput(f'"{self.ffmpeg_bin}" -version').split("\n")[0],
+            subprocess.getoutput(cmd=f'"{self.ffmpeg_bin}" -version').split(sep="\n")[0],
             f"Path: {ffmpeg_true_path}",
             "https://www.ffmpeg.org",
         ]
@@ -89,13 +75,11 @@ def actionAbout_activated(self):
     programs_versions.extend(["\nPandas", f"version {pd.__version__}", "https://pandas.pydata.org"])
 
     # graphviz
-    gv_result = subprocess.getoutput("dot -V")
+    gv_result = subprocess.getoutput(cmd="dot -V")
 
-    programs_versions.extend(
-        ["\nGraphViz", gv_result if "graphviz" in gv_result else "not installed", "https://www.graphviz.org/"]
-    )
+    programs_versions.extend(["\nGraphViz", gv_result if "graphviz" in gv_result else "not installed", "https://www.graphviz.org/"])
 
-    about_dialog = QMessageBox()
+    about_dialog: QMessageBox = QMessageBox()
     about_dialog.setIconPixmap(QPixmap(":/boris_unito"))
 
     about_dialog.setWindowTitle(f"About {cfg.programName}")
@@ -106,28 +90,29 @@ def actionAbout_activated(self):
     about_dialog.setInformativeText(
         (
             f"<b>{cfg.programName}</b> v. {version.__version__} - {version.__version_date__}"
-            "<p>Copyright &copy; 2012-2023 Olivier Friard - Marco Gamba<br>"
+            "<p>Copyright &copy; 2012-2025 Olivier Friard - Marco Gamba<br>"
             "Department of Life Sciences and Systems Biology<br>"
             "University of Torino - Italy<br>"
             "<br>"
-            'BORIS is released under the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public License</a><br>'
-            'See <a href="http://www.boris.unito.it">www.boris.unito.it</a> for more details.<br>'
+            'BORIS is released under the <a href="https://www.gnu.org/copyleft/gpl.html">GNU General Public License</a><br>'
+            'See <a href="https://www.boris.unito.it">www.boris.unito.it</a> for more details.<br>'
             "<br>"
             "The authors would like to acknowledge Valentina Matteucci for her precious help."
             "<hr>"
             "How to cite BORIS:<br>"
             "Friard, O. and Gamba, M. (2016), BORIS: a free, versatile open-source event-logging software for video/audio "
             "coding and live observations. Methods Ecol Evol, 7: 1325–1330.<br>"
-            '<a href="http://onlinelibrary.wiley.com/doi/10.1111/2041-210X.12584/abstract">DOI:10.1111/2041-210X.12584</a>'
+            '<a href="https://besjournals.onlinelibrary.wiley.com/doi/full/10.1111/2041-210X.12584">DOI:10.1111/2041-210X.12584</a>'
         )
     )
+    """
     n = "\n"
     current_system = platform.uname()
     details = (
         f"Operating system: {current_system.system} {current_system.release} {current_system.version} \n"
         f"CPU: {current_system.machine} {current_system.processor}\n\n"
         f"Python {platform.python_version()} ({'64-bit' if sys.maxsize > 2**32 else '32-bit'})"
-        f" - Qt {QT_VERSION_STR} - PyQt {PYQT_VERSION_STR}\n\n"
+        f"Qt {qVersion()} - PySide {PySide6.__version__}\n"
     )
 
     r, memory = util.mem_info()
@@ -136,8 +121,11 @@ def actionAbout_activated(self):
             f"Memory (RAM)  Total: {memory.get('total_memory', 'Not available'):.2f} Mb  "
             f"Free: {memory.get('free_memory', 'Not available'):.2f} Mb\n\n"
         )
+    """
+
+    details = util.get_systeminfo()
 
-    details += n.join(programs_versions)
+    details += "\n".join(programs_versions)
     """
     memory_in_use = f"{utilities.rss_memory_used(self.pid)} Mb" if utilities.rss_memory_used(self.pid) != -1 else "Not available"
     percent_memory_in_use = (f"({utilities.rss_memory_percent_used(self.pid):.1f} % of total memory)"
@@ -152,4 +140,4 @@ def actionAbout_activated(self):
 
     about_dialog.setDetailedText(details)
 
-    _ = about_dialog.exec_()
+    _ = about_dialog.exec()

boris/add_modifier.py

@@ -1,7 +1,7 @@
 """
 BORIS
 Behavioral Observation Research Interactive Software
-Copyright 2012-2023 Olivier Friard
+Copyright 2012-2025 Olivier Friard
 
 This file is part of BORIS.
 
@@ -16,15 +16,15 @@ This file is part of BORIS.
   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 see <http://www.gnu.org/licenses/>.
+  along with this program; if not see <http://www.gnu.org/licPbehav_enses/>.
 
 """
 
 import logging
 import json
 
-from PyQt5.QtGui import QIcon
-from PyQt5.QtWidgets import QDialog, QWidget, QFileDialog, QMessageBox
+from PySide6.QtGui import QIcon
+from PySide6.QtWidgets import QDialog, QWidget, QFileDialog, QMessageBox
 
 from . import dialog
 from .add_modifier_ui import Ui_Dialog
@@ -33,12 +33,10 @@ from .utilities import sorted_keys
 
 
 class addModifierDialog(QDialog, Ui_Dialog):
-
     tabMem = -1
     itemPositionMem = -1
 
-    def __init__(self, modifiers_str, subjects=[], parent=None):
-
+    def __init__(self, modifiers_str: str, subjects: list = [], ask_at_stop_enabled: bool = False, parent=None):
         super().__init__()
         self.setupUi(self)
 
@@ -46,10 +44,12 @@ class addModifierDialog(QDialog, Ui_Dialog):
         if not self.subjects:
             self.pb_add_subjects.setEnabled(False)
 
+        self.ask_at_stop_enabled = ask_at_stop_enabled
+
         self.pbAddModifier.clicked.connect(self.addModifier)
         self.pbAddModifier.setIcon(QIcon(":/frame_forward"))
-        self.pbAddSet.clicked.connect(self.addSet)
-        self.pbRemoveSet.clicked.connect(self.removeSet)
+        self.pbAddSet.clicked.connect(self.add_set_of_modifiers)
+        self.pbRemoveSet.clicked.connect(self.remove_set_of_modifiers)
         self.pbModifyModifier.clicked.connect(self.modifyModifier)
         self.pbModifyModifier.setIcon(QIcon(":/frame_backward"))
 
@@ -62,22 +62,27 @@ class addModifierDialog(QDialog, Ui_Dialog):
         self.pb_add_subjects.clicked.connect(self.add_subjects)
         self.pb_load_file.clicked.connect(self.add_modifiers_from_file)
 
-        self.pbOK.clicked.connect(lambda: self.pb_pushed("ok"))
-        self.pbCancel.clicked.connect(lambda: self.pb_pushed("cancel"))
+        self.pbOK.clicked.connect(lambda: self.pb_pushed(cfg.OK))
+        self.pbCancel.clicked.connect(lambda: self.pb_pushed(cfg.CANCEL))
 
         self.le_name.textChanged.connect(self.set_name_changed)
         self.le_description.textChanged.connect(self.set_description_changed)
 
         self.cbType.currentIndexChanged.connect(self.type_changed)
 
-        dummy_dict = json.loads(modifiers_str) if modifiers_str else {}
-        modif_values = []
+        # self.cb_ask_at_stop.clicked.connect(self.ask_at_stop_changed)
+
+        dummy_dict: dict = json.loads(modifiers_str) if modifiers_str else {}
+        modif_values: list = []
         for idx in sorted_keys(dummy_dict):
             modif_values.append(dummy_dict[idx])
 
-        self.modifiers_sets_dict = {}
+        self.modifiers_sets_dict: dict = {}
         for modif in modif_values:
             self.modifiers_sets_dict[str(len(self.modifiers_sets_dict))] = dict(modif)
+            if self.ask_at_stop_enabled:
+                if dict(modif).get("ask at stop", False):
+                    self.cb_ask_at_stop.setChecked(True)
 
         self.tabWidgetModifiersSets.currentChanged.connect(self.tabWidgetModifiersSets_changed)
 
@@ -104,6 +109,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 self.pb_add_subjects,
                 self.pb_load_file,
                 self.pb_sort_modifiers,
+                self.cb_ask_at_stop,
             ):
                 w.setVisible(False)
             for w in (self.leModifier, self.leCode, self.pbAddModifier, self.pbModifyModifier):
@@ -113,24 +119,19 @@ class addModifierDialog(QDialog, Ui_Dialog):
         self.tabMem = 0
 
     def pb_pushed(self, button):
-
         if self.leModifier.text():
             if (
                 dialog.MessageDialog(
                     cfg.programName,
-                    (
-                        "You are working on a behavior.<br>"
-                        "If you close the window it will be lost.<br>"
-                        "Do you want to change modifiers set"
-                    ),
-                    ["Close", cfg.CANCEL],
+                    ("You are working on a behavior.<br>If you close the window it will be lost.<br>Do you want to change modifiers set"),
+                    [cfg.CLOSE, cfg.CANCEL],
                 )
                 == cfg.CANCEL
             ):
                 return
-        if button == "ok":
+        if button == cfg.OK:
             self.accept()
-        if button == "cancel":
+        if button == cfg.CANCEL:
             self.reject()
 
     def add_subjects(self):
@@ -153,43 +154,38 @@ class addModifierDialog(QDialog, Ui_Dialog):
         add modifiers from file
         """
 
-        fn = QFileDialog().getOpenFileName(self, "Load modifiers from file", "", "All files (*)")
-        file_name = fn[0] if type(fn) is tuple else fn
-        if file_name:
-            try:
-                with open(file_name) as f_in:
-                    for line in f_in:
-                        if line.strip():
-
-                            for c in cfg.CHAR_FORBIDDEN_IN_MODIFIERS:
-                                if c in line.strip():
-                                    QMessageBox.critical(
-                                        self,
-                                        cfg.programName,
-                                        (
-                                            f"The character <b>{c}</b> is not allowed.<br>"
-                                            "The following characters are not allowed in modifiers:<br>"
-                                            f"<b>{cfg.CHAR_FORBIDDEN_IN_MODIFIERS}</b>"
-                                        ),
-                                    )
-                                    break
-                            else:
-
-                                if line.strip() not in [
-                                    self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())
-                                ]:
-
-                                    if self.itemPositionMem != -1:
-                                        self.lwModifiers.insertItem(self.itemPositionMem, line.strip())
-                                    else:
-                                        self.lwModifiers.addItem(line.strip())
-
-                self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())]["values"] = [
-                    self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())
-                ]
-            except Exception:
-                QMessageBox.warning(self, cfg.programName, f"Error reading modifiers from file:<br>{file_name}")
-                logging.warning(f"Error reading modifiers from file<br>{file_name}")
+        file_name, _ = QFileDialog.getOpenFileName(self, "Load modifiers from file", "", "All files (*)")
+        if not file_name:
+            return
+        try:
+            with open(file_name) as f_in:
+                for line in f_in:
+                    if line.strip():
+                        for c in cfg.CHAR_FORBIDDEN_IN_MODIFIERS:
+                            if c in line.strip():
+                                QMessageBox.critical(
+                                    self,
+                                    cfg.programName,
+                                    (
+                                        f"The character <b>{c}</b> is not allowed.<br>"
+                                        "The following characters are not allowed in modifiers:<br>"
+                                        f"<b>{cfg.CHAR_FORBIDDEN_IN_MODIFIERS}</b>"
+                                    ),
+                                )
+                                break
+                        else:
+                            if line.strip() not in [self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())]:
+                                if self.itemPositionMem != -1:
+                                    self.lwModifiers.insertItem(self.itemPositionMem, line.strip())
+                                else:
+                                    self.lwModifiers.addItem(line.strip())
+
+            self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())]["values"] = [
+                self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())
+            ]
+        except Exception:
+            QMessageBox.warning(self, cfg.programName, f"Error reading modifiers from file:<br>{file_name}")
+            logging.warning(f"Error reading modifiers from file<br>{file_name}")
 
     def sort_modifiers(self):
         """
@@ -222,9 +218,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
         """
         if not self.modifiers_sets_dict:
             self.modifiers_sets_dict["0"] = {"name": "", "description": "", "type": cfg.SINGLE_SELECTION, "values": []}
-        self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())][
-            "description"
-        ] = self.le_description.text().strip()
+        self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())]["description"] = self.le_description.text().strip()
 
     def type_changed(self):
         """
@@ -257,6 +251,12 @@ class addModifierDialog(QDialog, Ui_Dialog):
         else:
             self.lb_name.setText("Set name")
 
+    # def ask_at_stop_changed(self):
+    #    """
+    #    value changed
+    #    """
+    #    self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())]["ask at stop"] = self.cb_ask_at_stop.isChecked()
+
     def moveSetLeft(self):
         """
         move selected modifiers set left
@@ -277,7 +277,6 @@ class addModifierDialog(QDialog, Ui_Dialog):
         move selected modifiers set right
         """
         if self.tabWidgetModifiersSets.currentIndex() < self.tabWidgetModifiersSets.count() - 1:
-
             (
                 self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex() + 1)],
                 self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())],
@@ -315,7 +314,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())
             ]
 
-    def addSet(self):
+    def add_set_of_modifiers(self):
         """
         Add a set of modifiers
         """
@@ -326,6 +325,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 "name": "",
                 "description": "",
                 "type": cfg.SINGLE_SELECTION,
+                "ask at stop": False,
                 "values": [],
             }
             self.tabWidgetModifiersSets.addTab(QWidget(), f"Set #{len(self.modifiers_sets_dict)}")
@@ -353,6 +353,8 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 self.pb_sort_modifiers,
             ):
                 w.setVisible(True)
+            self.cb_ask_at_stop.setVisible(self.ask_at_stop_enabled)
+
             for w in (self.leModifier, self.leCode, self.pbAddModifier, self.pbModifyModifier):
                 w.setEnabled(True)
             return
@@ -362,6 +364,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 "name": "",
                 "description": "",
                 "type": cfg.SINGLE_SELECTION,
+                "ask at stop": False,
                 "values": [],
             }
             self.tabWidgetModifiersSets.addTab(QWidget(), f"Set #{len(self.modifiers_sets_dict)}")
@@ -375,16 +378,13 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 "It is not possible to add a modifiers' set while the current modifiers' set is empty.",
             )
 
-    def removeSet(self):
+    def remove_set_of_modifiers(self):
         """
         remove set of modifiers
         """
 
         if self.tabWidgetModifiersSets.currentIndex() != -1:
-            if (
-                dialog.MessageDialog(cfg.programName, "Confirm deletion of this set of modifiers?", [cfg.YES, cfg.NO])
-                == cfg.YES
-            ):
+            if dialog.MessageDialog(cfg.programName, "Confirm deletion of this set of modifiers?", [cfg.YES, cfg.NO]) == cfg.YES:
                 index_to_delete = self.tabWidgetModifiersSets.currentIndex()
 
                 for k in range(index_to_delete, len(self.modifiers_sets_dict) - 1):
@@ -417,14 +417,15 @@ class addModifierDialog(QDialog, Ui_Dialog):
                         self.pbRemoveSet,
                         self.pbMoveSetLeft,
                         self.pbMoveSetRight,
+                        self.cb_ask_at_stop,
                     ):
                         w.setVisible(False)
-                    for w in [self.leModifier, self.leCode, self.pbAddModifier, self.pbModifyModifier]:
+                    for w in (self.leModifier, self.leCode, self.pbAddModifier, self.pbModifyModifier):
                         w.setEnabled(False)
 
                 if not len(self.modifiers_sets_dict):
                     # set invisible and unavailable buttons and others elements
-                    for w in [
+                    for w in (
                         self.lb_name,
                         self.le_name,
                         self.lbType,
@@ -442,7 +443,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                         self.pb_add_subjects,
                         self.pb_load_file,
                         self.pb_sort_modifiers,
-                    ]:
+                    ):
                         w.setVisible(False)
                     for w in [self.leModifier, self.leCode, self.pbAddModifier, self.pbModifyModifier]:
                         w.setEnabled(False)
@@ -505,7 +506,6 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 return
 
         if txt:
-
             if txt in [self.lwModifiers.item(x).text() for x in range(self.lwModifiers.count())]:
                 QMessageBox.critical(self, cfg.programName, f"The modifier <b>{txt}</b> is already in the list")
                 return
@@ -515,6 +515,7 @@ class addModifierDialog(QDialog, Ui_Dialog):
                     "name": "",
                     "description": "",
                     "type": cfg.SINGLE_SELECTION,
+                    "ask at stop": False,
                     "values": [],
                 }
 
@@ -545,16 +546,14 @@ class addModifierDialog(QDialog, Ui_Dialog):
                         "name": "",
                         "description": "",
                         "type": cfg.SINGLE_SELECTION,
+                        "ask at stop": False,
                         "values": [],
                     }
 
                 if "(" + self.leCode.text().strip() + ")" in " ".join(
                     self.modifiers_sets_dict[str(self.tabWidgetModifiersSets.currentIndex())]["values"]
                 ):
-
-                    QMessageBox.critical(
-                        self, cfg.programName, f"The shortcut code <b>{self.leCode.text().strip()}</b> already exists!"
-                    )
+                    QMessageBox.critical(self, cfg.programName, f"The shortcut code <b>{self.leCode.text().strip()}</b> already exists!")
                     self.leCode.setFocus()
                     return
                 txt += f" ({self.leCode.text().strip()})"
@@ -600,6 +599,8 @@ class addModifierDialog(QDialog, Ui_Dialog):
             self.lwModifiers.clear()
             self.leCode.clear()
             self.leModifier.clear()
+            # if self.ask_at_stop_enabled:
+            #    self.cb_ask_at_stop.setChecked(False)
 
             self.tabMem = tabIndex
 
@@ -607,14 +608,21 @@ class addModifierDialog(QDialog, Ui_Dialog):
                 self.le_name.setText(self.modifiers_sets_dict[str(tabIndex)]["name"])
                 self.le_description.setText(self.modifiers_sets_dict[str(tabIndex)].get("description", ""))
                 self.cbType.setCurrentIndex(self.modifiers_sets_dict[str(tabIndex)]["type"])
+                # if self.ask_at_stop_enabled:
+                #    self.cb_ask_at_stop.setChecked(self.modifiers_sets_dict[str(tabIndex)].get("ask at stop", False))
+
                 self.lwModifiers.addItems(self.modifiers_sets_dict[str(tabIndex)]["values"])
 
-    def getModifiers(self) -> str:
+    def get_modifiers(self) -> str:
         """
         returns modifiers as string
         """
-        keys_to_delete = []
+        keys_to_delete: list = []
         for idx in self.modifiers_sets_dict:
+            # add ask_at_stop value (boolean) to each set of modifiers
+            if self.ask_at_stop_enabled:
+                self.modifiers_sets_dict[idx]["ask at stop"] = self.cb_ask_at_stop.isChecked()
+            # delete modifiers without values for selection
             if (
                 self.modifiers_sets_dict[idx]["type"] in (cfg.SINGLE_SELECTION, cfg.MULTI_SELECTION)
                 and not self.modifiers_sets_dict[idx]["values"]