boris-behav-obs 8.26__tar.gz → 8.27__tar.gz

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: boris-behav-obs
-Version: 8.26
+Version: 8.27
 Summary: BORIS - Behavioral Observation Research Interactive Software
 Author-email: Olivier Friard <olivier.friard@unito.it>
 License:                     GNU GENERAL PUBLIC LICENSE

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/boris/core.py

@@ -53,6 +53,8 @@ import gzip
 from collections import deque
 
 import matplotlib
+import zipfile
+import shutil
 
 matplotlib.use("Qt5Agg")
 
@@ -1360,28 +1362,81 @@ class MainWindow(QMainWindow, Ui_MainWindow):
     def actionCheckUpdate_activated(self, flagMsgOnlyIfNew=False):
         """
         check BORIS web site for updates
+        ask user for updating
         """
 
+        versionURL = "https://www.boris.unito.it/static/ver4.dat"
         try:
-            versionURL = "https://www.boris.unito.it/static/ver4.dat"
             last_version = urllib.request.urlopen(versionURL).read().strip().decode("utf-8")
-            if util.versiontuple(last_version) > util.versiontuple(__version__):
-                msg = (
-                    f"A new version is available: v. <b>{last_version}</b><br>"
-                    'Go to <a href="https://www.boris.unito.it">'
-                    "https://www.boris.unito.it</a> to install it."
+        except Exception:
+            QMessageBox.warning(self, cfg.programName, "Can not check for updates...")
+            return
+
+        # record check timestamp
+        config_file.save(self, lastCheckForNewVersion=int(time.mktime(time.localtime())))
+
+        if util.versiontuple(last_version) > util.versiontuple(__version__):
+            if (
+                dialog.MessageDialog(
+                    cfg.programName,
+                    (
+                        f"A new version is available: v. {last_version}.<br><br>"
+                        'For updating manually go to <a href="https://www.boris.unito.it">https://www.boris.unito.it</a>.<br>'
+                    ),
+                    (cfg.CANCEL, "Update automatically"),
                 )
-                # https://github.com/olivierfriard/BORIS/archive/refs/tags/v{last_version}.zip
-            else:
-                msg = f"The version you are using is the last one: <b>{__version__}</b>"
+                == cfg.CANCEL
+            ):
+                return
+
+        else:
+            msg = f"The version you are using is the last one: <b>{__version__}</b>"
+            QMessageBox.information(self, cfg.programName, msg)
+
+            # any news?
             newsURL = "https://www.boris.unito.it/static/news.dat"
             news = urllib.request.urlopen(newsURL).read().strip().decode("utf-8")
-            config_file.save(self, lastCheckForNewVersion=int(time.mktime(time.localtime())))
-            QMessageBox.information(self, cfg.programName, msg)
             if news:
                 QMessageBox.information(self, cfg.programName, news)
+            return
+
+        # check if a .git is present
+        if (pl.Path(__file__).parent.parent / pl.Path(".git")).is_dir():
+            QMessageBox.critical(self, cfg.programName, "A .git directory is present, BORIS cannot be automatically updated.")
+            return
+
+        # download zip archive
+        try:
+            zip_content = urllib.request.urlopen(f"https://github.com/olivierfriard/BORIS/archive/refs/tags/v{last_version}.zip").read()
         except Exception:
-            QMessageBox.warning(self, cfg.programName, "Can not check for updates...")
+            QMessageBox.critical(self, cfg.programName, "Cannot download the new version")
+            return
+
+        temp_zip = tempfile.NamedTemporaryFile(suffix=".zip")
+        try:
+            with open(temp_zip.name, "wb") as f_out:
+                f_out.write(zip_content)
+        except Exception:
+            QMessageBox.critical(self, cfg.programName, "A problem occurred during saving the new version of BORIS.")
+            return
+
+        # extract to temp dir
+        try:
+            temp_dir = tempfile.TemporaryDirectory()
+            with zipfile.ZipFile(temp_zip.name, "r") as zip_ref:
+                zip_ref.extractall(temp_dir.name)
+        except Exception:
+            QMessageBox.critical(self, cfg.programName, "A problem occurred during the unzip of the new version.")
+            return
+
+        # copy from temp dir to current BORIS dir
+        try:
+            shutil.copytree(f"{temp_dir.name}/BORIS-{last_version}", pl.Path(__file__).parent.parent, dirs_exist_ok=True)
+        except Exception:
+            QMessageBox.critical(self, cfg.programName, "A problem occurred during the copy the new version of BORIS.")
+            return
+
+        QMessageBox.information(self, cfg.programName, f"BORIS was updated to v. {last_version}. Restart the program to apply the changes.")
 
     def seek_mediaplayer(self, new_time: dec, player=0) -> int:
         """

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/boris/preferences.py

@@ -54,7 +54,6 @@ class Preferences(QDialog, Ui_prefDialog):
         self.pbCancel.clicked.connect(self.reject)
 
         self.flag_refresh = False
-        self.flag_reset_frames_memory = False
 
     def refresh_preferences(self):
         """

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/boris/select_modifiers.py

@@ -43,6 +43,10 @@ from . import utilities as util
 
 
 class ModifiersList(QDialog):
+    """
+    class for selection the modifier(s)
+    """
+
     def __init__(self, code: str, modifiers_dict: dict, currentModifier: str):
         super().__init__()
         self.setWindowTitle(cfg.programName)
@@ -60,11 +64,11 @@ class ModifiersList(QDialog):
         self.modifiersSetNumber = 0
 
         for idx in util.sorted_keys(modifiers_dict):
-            if self.modifiers_dict[idx]["type"] not in [
+            if self.modifiers_dict[idx]["type"] not in (
                 cfg.SINGLE_SELECTION,
                 cfg.MULTI_SELECTION,
                 cfg.NUMERIC_MODIFIER,
-            ]:
+            ):
                 continue
 
             V2layout = QVBoxLayout()
@@ -75,10 +79,13 @@ class ModifiersList(QDialog):
             lb.setText(f"Modifier <b>{self.modifiers_dict[idx]['name']}</b>")
             V2layout.addWidget(lb)
 
-            if self.modifiers_dict[idx]["type"] in [
+            lb = QLabel(f"<small>{self.modifiers_dict[idx]['description']}</small>")
+            V2layout.addWidget(lb)
+
+            if self.modifiers_dict[idx]["type"] in (
                 cfg.SINGLE_SELECTION,
                 cfg.MULTI_SELECTION,
-            ]:
+            ):
                 lw = QListWidget()
                 self.modifiers_dict[idx]["widget"] = lw
                 lw.setObjectName(f"lw_modifiers_({self.modifiers_dict[idx]['type']})")
@@ -114,6 +121,7 @@ class ModifiersList(QDialog):
             if self.modifiers_dict[idx]["type"] in [cfg.NUMERIC_MODIFIER]:
                 le = QLineEdit()
                 self.modifiers_dict[idx]["widget"] = le
+                le.setObjectName(f"le_modifiers_({self.modifiers_dict[idx]['type']})")
 
                 if currentModifierList != [""] and currentModifierList[int(idx)] != "None":
                     le.setText(currentModifierList[int(idx)])
@@ -160,10 +168,14 @@ class ModifiersList(QDialog):
 
             # accept and close dialog if enter pressed
             if ek == Qt.Key_Enter or ek == Qt.Key_Return:  # enter or enter from numeric pad
-                self.accept()
+                if not self.pbOK_clicked():
+                    return False
                 return True
 
+            modifiersSetIndex = 0
             for widget in self.children():
+                if "_modifiers" in widget.objectName():
+                    modifiersSetIndex = modifiersSetIndex + 1
                 if "lw_modifiers" in widget.objectName():
                     if self.modifiersSetNumber == 1:
                         # check if modifiers have code
@@ -172,7 +184,7 @@ class ModifiersList(QDialog):
                                 break
                         else:
                             # modifiers have no associated code: the modifier starting with hit key will be selected
-                            if ek not in [Qt.Key_Down, Qt.Key_Up]:
+                            if ek not in (Qt.Key_Down, Qt.Key_Up):
                                 if ek == Qt.Key_Space and f"({cfg.MULTI_SELECTION})" in widget.objectName():  # checking using SPACE bar
                                     if widget.item(widget.currentRow()).checkState() == Qt.Checked:
                                         widget.item(widget.currentRow()).setCheckState(Qt.Unchecked)
@@ -198,6 +210,7 @@ class ModifiersList(QDialog):
                                     return
 
                     for index in range(widget.count()):
+                        # check function kesy (F1, F2...)
                         if ek in cfg.function_keys:
                             if f"({cfg.function_keys[ek]})" in widget.item(index).text().upper():
                                 if f"({cfg.SINGLE_SELECTION})" in widget.objectName():
@@ -206,6 +219,10 @@ class ModifiersList(QDialog):
                                     if self.modifiersSetNumber == 1:
                                         self.accept()
                                         return True
+                                    # else move to next set of mofifiers
+                                    elif modifiersSetIndex != self.modifiersSetNumber:
+                                        widget.parent().focusNextChild()
+                                        return True
 
                                 if f"({cfg.MULTI_SELECTION})" in widget.objectName():
                                     if widget.item(index).checkState() == Qt.Checked:
@@ -220,6 +237,10 @@ class ModifiersList(QDialog):
                                 if self.modifiersSetNumber == 1:
                                     self.accept()
                                     return True
+                                # else move to next set of mofifiers
+                                elif modifiersSetIndex != self.modifiersSetNumber:
+                                    widget.parent().focusNextChild()
+                                    return True
 
                             if f"({cfg.MULTI_SELECTION})" in widget.objectName():
                                 if widget.item(index).checkState() == Qt.Checked:
@@ -271,6 +292,9 @@ class ModifiersList(QDialog):
         return self.modifiers_dict
 
     def pbOK_clicked(self):
+        """
+        OK button is clicked
+        """
         for idx in util.sorted_keys(self.modifiers_dict):
             if self.modifiers_dict[idx]["type"] == cfg.NUMERIC_MODIFIER:
                 if self.modifiers_dict[idx]["widget"].text():
@@ -280,8 +304,8 @@ class ModifiersList(QDialog):
                         QMessageBox.warning(
                             self,
                             cfg.programName,
-                            "<b>{}</b> is not a numeric value".format(self.modifiers_dict[idx]["widget"].text()),
+                            f"<b>{self.modifiers_dict[idx]['widget'].text()}</b> is not a numeric value",
                         )
-                        return
+                        return False
 
         self.accept()

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/boris/version.py

@@ -20,5 +20,5 @@ This file is part of BORIS.
 
 """
 
-__version__ = "8.26"
-__version_date__ = "2024-06-04"
+__version__ = "8.27"
+__version_date__ = "2024-06-06"

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/boris_behav_obs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: boris-behav-obs
-Version: 8.26
+Version: 8.27
 Summary: BORIS - Behavioral Observation Research Interactive Software
 Author-email: Olivier Friard <olivier.friard@unito.it>
 License:                     GNU GENERAL PUBLIC LICENSE

{boris_behav_obs-8.26 → boris_behav_obs-8.27}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "boris-behav-obs"
-version = "8.26"
+version = "8.27"
 description = "BORIS - Behavioral Observation Research Interactive Software"
 authors = [{ name="Olivier Friard", email="olivier.friard@unito.it" }]
 readme = "README.rst"
@@ -58,7 +58,7 @@ line-length = 140
 exclude = ["*_ui.py", "mpv*"]
 
 [tool.bumpver]
-current_version = "8.26"
+current_version = "8.27"
 version_pattern = "MAJOR.MINOR.PATCH"