boris-behav-obs 9.7.7__py3-none-any.whl

boris/converters.py

@@ -0,0 +1,333 @@
+"""
+BORIS
+Behavioral Observation Research Interactive Software
+Copyright 2012-2025 Olivier Friard
+
+This file is part of BORIS.
+
+  BORIS 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 3 of the License, or
+  any later version.
+
+  BORIS 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 see <http://www.gnu.org/licenses/>.
+
+"""
+
+import sys
+import json
+import urllib.request
+
+
+from PySide6.QtWidgets import QMessageBox, QTableWidgetItem, QFileDialog, QInputDialog, QLineEdit
+
+from . import dialog
+from . import config as cfg
+
+
+def pb_code_help_clicked(self):
+    """
+    help for writing converters
+    """
+    msg = QMessageBox()
+    msg.setIcon(QMessageBox.Information)
+    msg.setWindowTitle("Help for writing converters")
+
+    msg.setText(
+        (
+            "A converter is a function that will convert a time value from external data into seconds.<br>"
+            "A time value like 00:23:59 must be converted into seconds before to be plotted synchronously with your media.<br>"
+            "For this you can use BORIS native converters or write your own converter.<br>"
+            'A converter must be written using the <a href="www.python.org">Python3</a> language.<br>'
+        )
+    )
+
+    # msg.setInformativeText("This is additional information")
+
+    msg.setStandardButtons(QMessageBox.Ok)
+    msg.exec_()
+
+
+def add_converter(self):
+    """
+    Add a new converter
+    """
+
+    for w in [
+        self.le_converter_name,
+        self.le_converter_description,
+        self.pteCode,
+        self.pb_save_converter,
+        self.pb_cancel_converter,
+    ]:
+        w.setEnabled(True)
+    # disable buttons
+    for w in [
+        self.pb_add_converter,
+        self.pb_modify_converter,
+        self.pb_delete_converter,
+        self.pb_load_from_file,
+        self.pb_load_from_repo,
+        self.tw_converters,
+    ]:
+        w.setEnabled(False)
+
+
+def modify_converter(self):
+    """
+    Modifiy the selected converter
+    """
+
+    if not self.tw_converters.selectedIndexes():
+        QMessageBox.warning(self, cfg.programName, "Select a converter in the table")
+        return
+
+    for w in [
+        self.le_converter_name,
+        self.le_converter_description,
+        self.pteCode,
+        self.pb_save_converter,
+        self.pb_cancel_converter,
+    ]:
+        w.setEnabled(True)
+
+    # disable buttons
+    for w in [
+        self.pb_add_converter,
+        self.pb_modify_converter,
+        self.pb_delete_converter,
+        self.pb_load_from_file,
+        self.pb_load_from_repo,
+        self.tw_converters,
+    ]:
+        w.setEnabled(False)
+
+    self.le_converter_name.setText(self.tw_converters.item(self.tw_converters.selectedIndexes()[0].row(), 0).text())
+    self.le_converter_description.setText(self.tw_converters.item(self.tw_converters.selectedIndexes()[0].row(), 1).text())
+    self.pteCode.setPlainText(self.tw_converters.item(self.tw_converters.selectedIndexes()[0].row(), 2).text().replace("@", "\n"))
+
+    self.row_in_modification = self.tw_converters.selectedIndexes()[0].row()
+
+
+def code_2_func(self, name: str, code: str):
+    """
+    convert code to function
+
+    Args:
+        name (str): function name
+        code (str): Python code
+
+    Returns:
+        str: string containing Python function
+    """
+
+    function = f"def {name}(INPUT):\n"
+    function += """    INPUT = INPUT.decode("utf-8") if isinstance(INPUT, bytes) else INPUT\n"""
+    function += "\n".join(["    " + row for row in code.split("\n")])
+    function += "\n    return OUTPUT"
+
+    return function
+
+
+def save_converter(self):
+    """Save converter"""
+
+    # check if name
+    self.le_converter_name.setText(self.le_converter_name.text().strip())
+    if not self.le_converter_name.text():
+        QMessageBox.critical(self, "BORIS", "The converter must have a name")
+        return
+
+    if not self.le_converter_name.text().replace("_", "a").isalnum():
+        QMessageBox.critical(self, "BORIS", "Forbidden characters are used in converter name.<br>Use a..z, A..Z, 0..9 _")
+        return
+
+    # test code with exec
+    code: str = self.pteCode.toPlainText()
+    if not code:
+        QMessageBox.critical(self, "BORIS", "The converter must have Python code")
+        return
+
+    function = code_2_func(self, name=self.le_converter_name.text(), code=code)
+
+    try:
+        exec(function)
+    except Exception:
+        QMessageBox.critical(self, "BORIS", f"The code produces an error:<br><b>{sys.exc_info()[1]}</b>")
+        return
+
+    if self.row_in_modification == -1:
+        self.tw_converters.setRowCount(self.tw_converters.rowCount() + 1)
+        row = self.tw_converters.rowCount() - 1
+    else:
+        row = self.row_in_modification
+
+    self.tw_converters.setItem(row, 0, QTableWidgetItem(self.le_converter_name.text()))
+    self.tw_converters.setItem(row, 1, QTableWidgetItem(self.le_converter_description.text()))
+    self.tw_converters.setItem(row, 2, QTableWidgetItem(self.pteCode.toPlainText().replace("\n", "@")))
+
+    self.row_in_modification = -1
+
+    for w in [self.le_converter_name, self.le_converter_description, self.pteCode]:
+        w.setEnabled(False)
+        w.clear()
+    self.pb_save_converter.setEnabled(False)
+    self.pb_cancel_converter.setEnabled(False)
+    self.tw_converters.setEnabled(True)
+
+    self.flag_modified = True
+
+    # enable buttons
+    for w in [
+        self.pb_add_converter,
+        self.pb_modify_converter,
+        self.pb_delete_converter,
+        self.pb_load_from_file,
+        self.pb_load_from_repo,
+        self.tw_converters,
+    ]:
+        w.setEnabled(True)
+
+
+def cancel_converter(self):
+    """Cancel converter"""
+
+    for w in [self.le_converter_name, self.le_converter_description, self.pteCode]:
+        w.setEnabled(False)
+        w.clear()
+    self.pb_save_converter.setEnabled(False)
+    self.pb_cancel_converter.setEnabled(False)
+
+    # enable buttons
+    for w in [
+        self.pb_add_converter,
+        self.pb_modify_converter,
+        self.pb_delete_converter,
+        self.pb_load_from_file,
+        self.pb_load_from_repo,
+        self.tw_converters,
+    ]:
+        w.setEnabled(True)
+
+
+def delete_converter(self):
+    """
+    Delete selected converter
+    """
+
+    if self.tw_converters.selectedIndexes():
+        if dialog.MessageDialog("BORIS", "Confirm converter deletion", [cfg.CANCEL, cfg.OK]) == cfg.OK:
+            self.tw_converters.removeRow(self.tw_converters.selectedIndexes()[0].row())
+    else:
+        QMessageBox.warning(self, cfg.programName, "Select a converter in the table")
+
+
+def load_converters_from_file_repo(self, mode: str):
+    """
+    Load converters from file (JSON) or BORIS remote repository
+    Args:
+        mode (str): string "repo" or "file"
+    """
+
+    converters_from_file = {}
+    if mode == "file":
+        file_name, _ = QFileDialog.getOpenFileName(self, "Load converters from file", "", "All files (*)")
+
+        if file_name:
+            with open(file_name, "r") as f_in:
+                try:
+                    converters_from_file = json.loads(f_in.read())["BORIS converters"]
+                except Exception:
+                    QMessageBox.critical(self, cfg.programName, "This file does not contain converters...")
+                    return
+
+    if mode == "repo":
+        converters_repo_URL = "https://www.boris.unito.it/static/converters.json"
+        try:
+            converters_from_repo = urllib.request.urlopen(converters_repo_URL).read().strip().decode("utf-8")
+        except Exception:
+            QMessageBox.critical(self, cfg.programName, "An error occured during retrieving converters from BORIS remote repository")
+            return
+
+        try:
+            converters_from_file = eval(converters_from_repo)["BORIS converters"]
+        except Exception:
+            QMessageBox.critical(self, cfg.programName, "An error occured during retrieving converters from BORIS remote repository")
+            return
+
+    if converters_from_file:
+        diag_choose_conv = dialog.ChooseObservationsToImport("Choose the converters to load:", sorted(list(converters_from_file.keys())))
+
+        if diag_choose_conv.exec_():
+            selected_converters = diag_choose_conv.get_selected_observations()
+            if selected_converters:
+                # extract converter names from table
+                converter_names = []
+                for row in range(self.tw_converters.rowCount()):
+                    converter_names.append(self.tw_converters.item(row, 0).text())
+
+                for converter in selected_converters:
+                    converter_name = converter
+
+                    if converter in converter_names:
+                        while True:
+                            text, ok = QInputDialog.getText(
+                                self,
+                                "Converter conflict",
+                                "The converter already exists<br>Rename it:",
+                                QLineEdit.Normal,
+                                converter,
+                            )
+                            if not ok:
+                                break
+                            if text in converter_names:
+                                QMessageBox.critical(self, cfg.programName, "This name already exists in converters")
+
+                            if not text.replace("_", "a").isalnum():
+                                QMessageBox.critical(
+                                    self,
+                                    cfg.programName,
+                                    "This name contains forbidden character(s).<br>Use a..z, A..Z, 0..9 _",
+                                )
+
+                            if text != converter and text not in converter_names and text.replace("_", "a").isalnum():
+                                break
+
+                        if ok:
+                            converter_name = text
+                        else:
+                            continue
+                    # test if code does not produce error
+                    function = code_2_func(self, name=converter_name, code=converters_from_file[converter]["code"])
+
+                    try:
+                        exec(function)
+                    except Exception:
+                        QMessageBox.critical(
+                            self,
+                            "BORIS",
+                            (f"The code of {converter_name} converter produces an error: <br><b>{sys.exc_info()[1]}</b>"),
+                        )
+
+                    self.tw_converters.setRowCount(self.tw_converters.rowCount() + 1)
+                    self.tw_converters.setItem(self.tw_converters.rowCount() - 1, 0, QTableWidgetItem(converter_name))
+                    self.tw_converters.setItem(
+                        self.tw_converters.rowCount() - 1,
+                        1,
+                        QTableWidgetItem(converters_from_file[converter]["description"]),
+                    )
+                    self.tw_converters.setItem(
+                        self.tw_converters.rowCount() - 1,
+                        2,
+                        QTableWidgetItem(converters_from_file[converter]["code"].replace("\n", "@")),
+                    )
+
+                    self.flag_modified = True
+
+            [self.tw_converters.resizeColumnToContents(idx) for idx in [0, 1]]

boris/converters_ui.py

@@ -0,0 +1,225 @@
+# -*- coding: utf-8 -*-
+
+################################################################################
+## Form generated from reading UI file 'converters.ui'
+##
+## Created by: Qt User Interface Compiler version 6.8.0
+##
+## WARNING! All changes made in this file will be lost when recompiling UI file!
+################################################################################
+
+from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale,
+    QMetaObject, QObject, QPoint, QRect,
+    QSize, QTime, QUrl, Qt)
+from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
+    QFont, QFontDatabase, QGradient, QIcon,
+    QImage, QKeySequence, QLinearGradient, QPainter,
+    QPalette, QPixmap, QRadialGradient, QTransform)
+from PySide6.QtWidgets import (QAbstractItemView, QApplication, QHBoxLayout, QHeaderView,
+    QLabel, QLineEdit, QPlainTextEdit, QPushButton,
+    QSizePolicy, QSpacerItem, QTableWidget, QTableWidgetItem,
+    QVBoxLayout, QWidget)
+
+class Ui_converters(object):
+    def setupUi(self, converters):
+        if not converters.objectName():
+            converters.setObjectName(u"converters")
+        converters.resize(1029, 530)
+        self.verticalLayout = QVBoxLayout(converters)
+        self.verticalLayout.setObjectName(u"verticalLayout")
+        self.label_4 = QLabel(converters)
+        self.label_4.setObjectName(u"label_4")
+
+        self.verticalLayout.addWidget(self.label_4)
+
+        self.tw_converters = QTableWidget(converters)
+        if (self.tw_converters.columnCount() < 3):
+            self.tw_converters.setColumnCount(3)
+        __qtablewidgetitem = QTableWidgetItem()
+        self.tw_converters.setHorizontalHeaderItem(0, __qtablewidgetitem)
+        __qtablewidgetitem1 = QTableWidgetItem()
+        self.tw_converters.setHorizontalHeaderItem(1, __qtablewidgetitem1)
+        __qtablewidgetitem2 = QTableWidgetItem()
+        self.tw_converters.setHorizontalHeaderItem(2, __qtablewidgetitem2)
+        self.tw_converters.setObjectName(u"tw_converters")
+        self.tw_converters.setEditTriggers(QAbstractItemView.NoEditTriggers)
+        self.tw_converters.setSelectionMode(QAbstractItemView.SingleSelection)
+        self.tw_converters.setSelectionBehavior(QAbstractItemView.SelectRows)
+        self.tw_converters.setSortingEnabled(True)
+
+        self.verticalLayout.addWidget(self.tw_converters)
+
+        self.horizontalLayout = QHBoxLayout()
+        self.horizontalLayout.setObjectName(u"horizontalLayout")
+        self.pb_add_converter = QPushButton(converters)
+        self.pb_add_converter.setObjectName(u"pb_add_converter")
+
+        self.horizontalLayout.addWidget(self.pb_add_converter)
+
+        self.pb_modify_converter = QPushButton(converters)
+        self.pb_modify_converter.setObjectName(u"pb_modify_converter")
+
+        self.horizontalLayout.addWidget(self.pb_modify_converter)
+
+        self.pb_delete_converter = QPushButton(converters)
+        self.pb_delete_converter.setObjectName(u"pb_delete_converter")
+
+        self.horizontalLayout.addWidget(self.pb_delete_converter)
+
+        self.pb_load_from_file = QPushButton(converters)
+        self.pb_load_from_file.setObjectName(u"pb_load_from_file")
+
+        self.horizontalLayout.addWidget(self.pb_load_from_file)
+
+        self.pb_load_from_repo = QPushButton(converters)
+        self.pb_load_from_repo.setObjectName(u"pb_load_from_repo")
+
+        self.horizontalLayout.addWidget(self.pb_load_from_repo)
+
+        self.horizontalSpacer = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+
+        self.horizontalLayout.addItem(self.horizontalSpacer)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout)
+
+        self.horizontalLayout_3 = QHBoxLayout()
+        self.horizontalLayout_3.setObjectName(u"horizontalLayout_3")
+        self.label_2 = QLabel(converters)
+        self.label_2.setObjectName(u"label_2")
+        self.label_2.setMinimumSize(QSize(120, 0))
+
+        self.horizontalLayout_3.addWidget(self.label_2)
+
+        self.le_converter_name = QLineEdit(converters)
+        self.le_converter_name.setObjectName(u"le_converter_name")
+
+        self.horizontalLayout_3.addWidget(self.le_converter_name)
+
+        self.horizontalSpacer_3 = QSpacerItem(10, 20, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum)
+
+        self.horizontalLayout_3.addItem(self.horizontalSpacer_3)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout_3)
+
+        self.horizontalLayout_5 = QHBoxLayout()
+        self.horizontalLayout_5.setObjectName(u"horizontalLayout_5")
+        self.label_3 = QLabel(converters)
+        self.label_3.setObjectName(u"label_3")
+        self.label_3.setMinimumSize(QSize(120, 0))
+
+        self.horizontalLayout_5.addWidget(self.label_3)
+
+        self.le_converter_description = QLineEdit(converters)
+        self.le_converter_description.setObjectName(u"le_converter_description")
+
+        self.horizontalLayout_5.addWidget(self.le_converter_description)
+
+        self.horizontalSpacer_4 = QSpacerItem(10, 20, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum)
+
+        self.horizontalLayout_5.addItem(self.horizontalSpacer_4)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout_5)
+
+        self.horizontalLayout_2 = QHBoxLayout()
+        self.horizontalLayout_2.setObjectName(u"horizontalLayout_2")
+        self.verticalLayout_3 = QVBoxLayout()
+        self.verticalLayout_3.setObjectName(u"verticalLayout_3")
+        self.label = QLabel(converters)
+        self.label.setObjectName(u"label")
+
+        self.verticalLayout_3.addWidget(self.label)
+
+        self.pb_code_help = QPushButton(converters)
+        self.pb_code_help.setObjectName(u"pb_code_help")
+
+        self.verticalLayout_3.addWidget(self.pb_code_help)
+
+        self.verticalSpacer_2 = QSpacerItem(20, 40, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding)
+
+        self.verticalLayout_3.addItem(self.verticalSpacer_2)
+
+
+        self.horizontalLayout_2.addLayout(self.verticalLayout_3)
+
+        self.pteCode = QPlainTextEdit(converters)
+        self.pteCode.setObjectName(u"pteCode")
+        font = QFont()
+        font.setFamilies([u"Monospace"])
+        self.pteCode.setFont(font)
+
+        self.horizontalLayout_2.addWidget(self.pteCode)
+
+        self.verticalLayout_2 = QVBoxLayout()
+        self.verticalLayout_2.setObjectName(u"verticalLayout_2")
+        self.pb_save_converter = QPushButton(converters)
+        self.pb_save_converter.setObjectName(u"pb_save_converter")
+
+        self.verticalLayout_2.addWidget(self.pb_save_converter)
+
+        self.pb_cancel_converter = QPushButton(converters)
+        self.pb_cancel_converter.setObjectName(u"pb_cancel_converter")
+
+        self.verticalLayout_2.addWidget(self.pb_cancel_converter)
+
+        self.verticalSpacer = QSpacerItem(20, 40, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Expanding)
+
+        self.verticalLayout_2.addItem(self.verticalSpacer)
+
+
+        self.horizontalLayout_2.addLayout(self.verticalLayout_2)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout_2)
+
+        self.horizontalLayout_4 = QHBoxLayout()
+        self.horizontalLayout_4.setObjectName(u"horizontalLayout_4")
+        self.horizontalSpacer_2 = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+
+        self.horizontalLayout_4.addItem(self.horizontalSpacer_2)
+
+        self.pb_cancel_widget = QPushButton(converters)
+        self.pb_cancel_widget.setObjectName(u"pb_cancel_widget")
+
+        self.horizontalLayout_4.addWidget(self.pb_cancel_widget)
+
+        self.pbOK = QPushButton(converters)
+        self.pbOK.setObjectName(u"pbOK")
+
+        self.horizontalLayout_4.addWidget(self.pbOK)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout_4)
+
+
+        self.retranslateUi(converters)
+
+        QMetaObject.connectSlotsByName(converters)
+    # setupUi
+
+    def retranslateUi(self, converters):
+        converters.setWindowTitle(QCoreApplication.translate("converters", u"Time converters", None))
+        self.label_4.setText(QCoreApplication.translate("converters", u"Converters", None))
+        ___qtablewidgetitem = self.tw_converters.horizontalHeaderItem(0)
+        ___qtablewidgetitem.setText(QCoreApplication.translate("converters", u"Name", None));
+        ___qtablewidgetitem1 = self.tw_converters.horizontalHeaderItem(1)
+        ___qtablewidgetitem1.setText(QCoreApplication.translate("converters", u"Description", None));
+        ___qtablewidgetitem2 = self.tw_converters.horizontalHeaderItem(2)
+        ___qtablewidgetitem2.setText(QCoreApplication.translate("converters", u"Code", None));
+        self.pb_add_converter.setText(QCoreApplication.translate("converters", u"Add new converter", None))
+        self.pb_modify_converter.setText(QCoreApplication.translate("converters", u"Modify converter", None))
+        self.pb_delete_converter.setText(QCoreApplication.translate("converters", u"Delete converter", None))
+        self.pb_load_from_file.setText(QCoreApplication.translate("converters", u"Load converters from file", None))
+        self.pb_load_from_repo.setText(QCoreApplication.translate("converters", u"Load converters from BORIS repository", None))
+        self.label_2.setText(QCoreApplication.translate("converters", u"Name", None))
+        self.label_3.setText(QCoreApplication.translate("converters", u"Description", None))
+        self.label.setText(QCoreApplication.translate("converters", u"Python code", None))
+        self.pb_code_help.setText(QCoreApplication.translate("converters", u"Help", None))
+        self.pb_save_converter.setText(QCoreApplication.translate("converters", u"Save converter", None))
+        self.pb_cancel_converter.setText(QCoreApplication.translate("converters", u"Cancel", None))
+        self.pb_cancel_widget.setText(QCoreApplication.translate("converters", u"Cancel", None))
+        self.pbOK.setText(QCoreApplication.translate("converters", u"OK", None))
+    # retranslateUi
+