excel2moodle 0.6.5__tar.gz → 0.7.0__tar.gz

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: excel2moodle
-Version: 0.6.5
+Version: 0.7.0
 Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
 Author: Jakob Bosse
 License-Expression: GPL-3.0-or-later
@@ -90,6 +90,21 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.7.0 (2025-09-30)
+Rework of the equation checker done!
+
+### feature (1 change)
+
+- [finalized equation Checker](https://gitlab.com/jbosse3/excel2moodle/-/commit/55e3891d3da56357ad00f672a86c2690d551d21c)
+
+### documentation (1 change)
+
+- [Documented feedback usages](https://gitlab.com/jbosse3/excel2moodle/-/commit/6f50ce023a3235b3f34b6272a4ce5057346f8751)
+
+### improvement (1 change)
+
+- [MainWindow got a currentQuestion property](https://gitlab.com/jbosse3/excel2moodle/-/commit/59b18e158201357b767a36dab0f300f88cb5e9ad)
+
 ## 0.6.5 (2025-09-02)
 Added Scripted Media Support now with the module
 

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/README.md

@@ -68,6 +68,21 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.7.0 (2025-09-30)
+Rework of the equation checker done!
+
+### feature (1 change)
+
+- [finalized equation Checker](https://gitlab.com/jbosse3/excel2moodle/-/commit/55e3891d3da56357ad00f672a86c2690d551d21c)
+
+### documentation (1 change)
+
+- [Documented feedback usages](https://gitlab.com/jbosse3/excel2moodle/-/commit/6f50ce023a3235b3f34b6272a4ce5057346f8751)
+
+### improvement (1 change)
+
+- [MainWindow got a currentQuestion property](https://gitlab.com/jbosse3/excel2moodle/-/commit/59b18e158201357b767a36dab0f300f88cb5e9ad)
+
 ## 0.6.5 (2025-09-02)
 Added Scripted Media Support now with the module
 

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/core/question.py

@@ -250,7 +250,7 @@ class Parametrics:
         self.equations: dict[int, str] = (
             equation if isinstance(equation, dict) else {1: equation}
         )
-        self._resultChecker: dict[int, float] = (
+        self.resultChecker: dict[int, float] = (
             firstResult if isinstance(firstResult, dict) else {1: firstResult}
         )
         self.id = identifier
@@ -258,6 +258,11 @@ class Parametrics:
         self.results: dict[int, list[float]] = {}
         self.logger = LogAdapterQuestionID(loggerObj, {"qID": self.id})
 
+    def setEquation(self, number: int, equation: str) -> None:
+        """Set the new equation and update all the calculations."""
+        self.equations[number] = equation
+        self._calculateResults()
+
     @property
     def variants(self) -> int:
         number = 1000
@@ -315,12 +320,12 @@ class Parametrics:
                     result,
                 )
                 if variant == 0 and not math.isclose(
-                    result, self._resultChecker[num], rel_tol=0.01
+                    result, self.resultChecker[num], rel_tol=0.01
                 ):
                     self.logger.warning(
                         "The calculated result %s differs from given firstResult: %s",
                         result,
-                        self._resultChecker,
+                        self.resultChecker,
                     )
                 self.logger.debug(
                     "Calculated result %s for variant %s", result, variant

excel2moodle-0.7.0/excel2moodle/extra/equationChecker.py

@@ -0,0 +1,141 @@
+"""Verify the equations written into the ``result`` field of ParametricQuestion.
+
+This module
+
+#. It calculates all the answers obtained from the series of variables.
+#. It compares the calculation of the first answer to the ``firstResult`` field.
+
+Usage
+=====
+
+From the main UI
+----------------
+
+#. Start this tool from the top bar in the main Window under the *Tools* section
+#. A new window will open with the currently selected question
+#. For Cloze Questions select the correct equation on the top
+#. You can edit the equation in the middle field
+#. Click on ``Check the equation now!`` and inspect the results.
+#. If the first calculated result matches the value in the field ``firstResult`` your equation is probably right.
+#. Now click on ``Save equation`` to copy all modified equations to the clipboard.
+"""
+
+import logging
+import math
+from pathlib import Path
+
+from PySide6.QtCore import Slot
+from PySide6.QtWidgets import QApplication, QDialog, QMainWindow, QMessageBox
+
+from excel2moodle import mainLogger
+from excel2moodle.core.question import ParametricQuestion, Parametrics
+from excel2moodle.extra.variableGenerator import populateDataSetTable
+from excel2moodle.logger import LogWindowHandler
+from excel2moodle.ui.UI_equationChecker import Ui_EquationChecker
+
+logger = logging.getLogger(__name__)
+
+loggerSignal = LogWindowHandler()
+mainLogger.addHandler(loggerSignal)
+
+
+class EqCheckerWindow(QDialog):
+    def __init__(self, parent: QMainWindow) -> None:
+        super().__init__(parent=parent)
+        self.mainWindow = parent
+        self.excelFile = Path()
+        self.ui = Ui_EquationChecker()
+        self.ui.setupUi(self)
+        self.ui.btnRunCheck.clicked.connect(
+            lambda: self.updateCalculation(),
+        )
+        self.ui.answerPartNum.valueChanged.connect(lambda: self.updateEquation())
+        self.ui.btnCancel.clicked.connect(self.reject)
+        self.ui.btnFetchQst.clicked.connect(lambda: self.updateQuestion())
+        self.ui.btnSave.clicked.connect(lambda: self.copyEquation())
+        self.parametrics: Parametrics
+
+    @Slot()
+    def updateQuestion(self) -> None:
+        """Get the current Question from the list and set up the checker."""
+        question = self.mainWindow.currentQuestion
+        if not isinstance(question, ParametricQuestion):
+            mainLogger.error("Can't check a question without parametrics")
+            return
+        self.ui.labelQuestionNum.setText(f"Question: {question.id}")
+        self.parametrics = question.parametrics
+        self.ui.answerPartNum.setValue(1)
+        self.ui.answerPartNum.setMaximum(len(self.parametrics.equations))
+        self.updateEquation()
+
+    @Slot()
+    def updateEquation(self) -> None:
+        """Update only the equation number of the same question."""
+        self.ui.equationText.clear()
+        eqVariant = self.ui.answerPartNum.value()
+        self.ui.lineFirstResult.setText(
+            str(self.parametrics.resultChecker.get(eqVariant))
+        )
+        if len(self.parametrics.equations) == 1:
+            self.ui.answerPartNum.hide()
+            self.ui.labelPartNum.hide()
+        else:
+            self.ui.answerPartNum.show()
+            self.ui.labelPartNum.show()
+        self.ui.equationText.appendPlainText(
+            str(self.parametrics.equations.get(eqVariant))
+        )
+        self.updateCalculation()
+
+    def updateCalculation(self) -> None:
+        """Calculate the current equation written in the textedit."""
+        equation = self.ui.equationText.toPlainText()
+        eqNum = self.ui.answerPartNum.value()
+        self.parametrics.setEquation(number=eqNum, equation=equation)
+        calculatedResult = self.parametrics.getResult(number=1, equation=eqNum)
+        check: bool = False
+        check = bool(
+            math.isclose(
+                calculatedResult,
+                self.parametrics.resultChecker.get(eqNum, 0),
+                rel_tol=0.01,
+            )
+        )
+        self.ui.lineCalculatedRes.setText(f"{calculatedResult}")
+        if check:
+            self.ui.lineCheckResult.setStyleSheet("color: rgb(24,150,0)")
+            self.ui.lineCheckResult.setText(
+                "[OK] Value of 'first result' matches calculated set 1"
+            )
+            logger.info(
+                "[OK] The first calculated result matches 'firstResult'",
+            )
+        else:
+            self.ui.lineCheckResult.setStyleSheet("color: rgb(255,0,0)")
+            self.ui.lineCheckResult.setText(
+                "[ERROR] Value of 'first result' doesn't match set 1"
+            )
+            logger.warning(
+                "The first calculated result does not match 'firstResult'",
+            )
+
+        populateDataSetTable(self.ui.tableVariables, self.parametrics)
+
+    @Slot()
+    def copyEquation(self) -> None:
+        clipb = QApplication.clipboard()
+        equationlist: list[str] = []
+        if len(self.parametrics.equations) > 1:
+            for i, eq in self.parametrics.equations.items():
+                equationlist.append(f"result:{i} \t{eq}")
+        else:
+            equationlist.append(f"result\t{self.parametrics.equations.get(1)}")
+        clipb.setText("\n".join(equationlist))
+        mainLogger.info("Copied equations to the clipboard")
+        QMessageBox.information(
+            self.mainWindow,
+            "Equation Copied!",
+            """All equations from the current parametric question are saved to the clipboard.\n
+            You can paste them with 'crtl + v' into the spreadsheet.
+            Make sure to import them with 'Tab' as the seperator.""",
+        )

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/extra/variableGenerator.py

@@ -26,7 +26,7 @@ class VariableGeneratorDialog(QDialog):
         self.ui.setupUi(self)
         self.origParametrics = parametrics
         self._generatedParametrics: Parametrics = Parametrics(
-            parametrics.equations, parametrics._resultChecker, identifier="genr"
+            parametrics.equations, parametrics.resultChecker, identifier="genr"
         )
         # Load existing rules
         for rule in self.origParametrics.variableRules:
@@ -271,4 +271,3 @@ def populateDataSetTable(
                 QTableWidgetItem(str(res)),
             )
     tableWidget.resizeColumnsToContents()
-

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/question_types/cloze.py

@@ -299,7 +299,7 @@ class ClozeQuestionParser(NFMQuestionParser):
                 else:
                     loclogger.info("Adding new equation to parametrics")
                     self.question.parametrics.equations[num] = eq
-                    self.question.parametrics._resultChecker[num] = firstResult.get(
+                    self.question.parametrics.resultChecker[num] = firstResult.get(
                         num, 0.0
                     )
                 if not hasattr(part, "result"):

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/ui/UI_equationChecker.py

@@ -3,7 +3,7 @@
 ################################################################################
 ## Form generated from reading UI file 'UI_equationChecker.ui'
 ##
-## Created by: Qt User Interface Compiler version 6.9.1
+## Created by: Qt User Interface Compiler version 6.9.2
 ##
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################
@@ -15,9 +15,10 @@ from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
     QFont, QFontDatabase, QGradient, QIcon,
     QImage, QKeySequence, QLinearGradient, QPainter,
     QPalette, QPixmap, QRadialGradient, QTransform)
-from PySide6.QtWidgets import (QApplication, QFrame, QGridLayout, QLabel,
-    QLineEdit, QPlainTextEdit, QPushButton, QSizePolicy,
-    QSpacerItem, QSpinBox, QTextEdit, QVBoxLayout,
+from PySide6.QtWidgets import (QAbstractScrollArea, QApplication, QFrame, QGridLayout,
+    QHBoxLayout, QHeaderView, QLabel, QLineEdit,
+    QPlainTextEdit, QPushButton, QSizePolicy, QSpacerItem,
+    QSpinBox, QTableWidget, QTableWidgetItem, QVBoxLayout,
     QWidget)
 
 class Ui_EquationChecker(object):
@@ -25,7 +26,7 @@ class Ui_EquationChecker(object):
         if not EquationChecker.objectName():
             EquationChecker.setObjectName(u"EquationChecker")
         EquationChecker.setWindowModality(Qt.WindowModality.WindowModal)
-        EquationChecker.resize(1213, 898)
+        EquationChecker.resize(650, 722)
         icon = QIcon(QIcon.fromTheme(QIcon.ThemeIcon.ListRemove))
         EquationChecker.setWindowIcon(icon)
         EquationChecker.setAutoFillBackground(False)
@@ -33,29 +34,21 @@ class Ui_EquationChecker(object):
         self.verticalLayout.setObjectName(u"verticalLayout")
         self.gridLayout = QGridLayout()
         self.gridLayout.setObjectName(u"gridLayout")
-        self.label_2 = QLabel(EquationChecker)
-        self.label_2.setObjectName(u"label_2")
-        self.label_2.setMinimumSize(QSize(200, 0))
-        self.label_2.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.label_4 = QLabel(EquationChecker)
+        self.label_4.setObjectName(u"label_4")
 
-        self.gridLayout.addWidget(self.label_2, 3, 0, 1, 1)
+        self.gridLayout.addWidget(self.label_4, 3, 2, 1, 1)
 
-        self.equationText = QPlainTextEdit(EquationChecker)
-        self.equationText.setObjectName(u"equationText")
-        sizePolicy = QSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
-        sizePolicy.setHorizontalStretch(0)
-        sizePolicy.setVerticalStretch(0)
-        sizePolicy.setHeightForWidth(self.equationText.sizePolicy().hasHeightForWidth())
-        self.equationText.setSizePolicy(sizePolicy)
-        self.equationText.setMinimumSize(QSize(0, 20))
-        self.equationText.setBaseSize(QSize(0, 20))
+        self.answerPartNum = QSpinBox(EquationChecker)
+        self.answerPartNum.setObjectName(u"answerPartNum")
+        self.answerPartNum.setMinimum(1)
 
-        self.gridLayout.addWidget(self.equationText, 3, 1, 1, 1)
+        self.gridLayout.addWidget(self.answerPartNum, 1, 3, 1, 1)
 
-        self.label_4 = QLabel(EquationChecker)
-        self.label_4.setObjectName(u"label_4")
+        self.labelPartNum = QLabel(EquationChecker)
+        self.labelPartNum.setObjectName(u"labelPartNum")
 
-        self.gridLayout.addWidget(self.label_4, 4, 3, 1, 1)
+        self.gridLayout.addWidget(self.labelPartNum, 1, 2, 1, 1)
 
         self.lineCalculatedRes = QLineEdit(EquationChecker)
         self.lineCalculatedRes.setObjectName(u"lineCalculatedRes")
@@ -66,119 +59,114 @@ class Ui_EquationChecker(object):
         self.lineCalculatedRes.setReadOnly(True)
         self.lineCalculatedRes.setClearButtonEnabled(False)
 
-        self.gridLayout.addWidget(self.lineCalculatedRes, 4, 4, 1, 1)
-
-        self.lineCheckResult = QLineEdit(EquationChecker)
-        self.lineCheckResult.setObjectName(u"lineCheckResult")
-        font1 = QFont()
-        font1.setBold(True)
-        font1.setItalic(True)
-        self.lineCheckResult.setFont(font1)
-        self.lineCheckResult.setLayoutDirection(Qt.LayoutDirection.LeftToRight)
-        self.lineCheckResult.setAlignment(Qt.AlignmentFlag.AlignCenter)
-        self.lineCheckResult.setReadOnly(True)
-
-        self.gridLayout.addWidget(self.lineCheckResult, 5, 4, 1, 1)
-
-        self.buttonRunCheck = QPushButton(EquationChecker)
-        self.buttonRunCheck.setObjectName(u"buttonRunCheck")
-        font2 = QFont()
-        font2.setPointSize(12)
-        font2.setBold(True)
-        self.buttonRunCheck.setFont(font2)
+        self.gridLayout.addWidget(self.lineCalculatedRes, 3, 3, 1, 1)
 
-        self.gridLayout.addWidget(self.buttonRunCheck, 5, 1, 1, 1)
-
-        self.label_8 = QLabel(EquationChecker)
-        self.label_8.setObjectName(u"label_8")
-        font3 = QFont()
-        font3.setPointSize(12)
-        self.label_8.setFont(font3)
+        self.lineFirstResult = QLineEdit(EquationChecker)
+        self.lineFirstResult.setObjectName(u"lineFirstResult")
+        self.lineFirstResult.setEnabled(True)
+        self.lineFirstResult.setFont(font)
+        self.lineFirstResult.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.lineFirstResult.setReadOnly(True)
 
-        self.gridLayout.addWidget(self.label_8, 5, 3, 1, 1)
+        self.gridLayout.addWidget(self.lineFirstResult, 2, 3, 1, 1)
 
-        self.variableText = QTextEdit(EquationChecker)
-        self.variableText.setObjectName(u"variableText")
+        self.label_3 = QLabel(EquationChecker)
+        self.label_3.setObjectName(u"label_3")
 
-        self.gridLayout.addWidget(self.variableText, 3, 3, 1, 1)
+        self.gridLayout.addWidget(self.label_3, 2, 2, 1, 1)
 
-        self.label_9 = QLabel(EquationChecker)
-        self.label_9.setObjectName(u"label_9")
-        self.label_9.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.btnFetchQst = QPushButton(EquationChecker)
+        self.btnFetchQst.setObjectName(u"btnFetchQst")
 
-        self.gridLayout.addWidget(self.label_9, 3, 2, 1, 1)
+        self.gridLayout.addWidget(self.btnFetchQst, 0, 3, 1, 1)
 
-        self.label_10 = QLabel(EquationChecker)
-        self.label_10.setObjectName(u"label_10")
+        self.labelQuestionNum = QLabel(EquationChecker)
+        self.labelQuestionNum.setObjectName(u"labelQuestionNum")
+        self.labelQuestionNum.setFont(font)
 
-        self.gridLayout.addWidget(self.label_10, 2, 0, 1, 1)
+        self.gridLayout.addWidget(self.labelQuestionNum, 0, 2, 1, 1)
 
-        self.answerPart = QSpinBox(EquationChecker)
-        self.answerPart.setObjectName(u"answerPart")
 
-        self.gridLayout.addWidget(self.answerPart, 2, 1, 1, 1)
+        self.verticalLayout.addLayout(self.gridLayout)
 
-        self.horizontalSpacer = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+        self.label_2 = QLabel(EquationChecker)
+        self.label_2.setObjectName(u"label_2")
 
-        self.gridLayout.addItem(self.horizontalSpacer, 2, 2, 1, 1)
+        self.verticalLayout.addWidget(self.label_2)
 
-        self.label_3 = QLabel(EquationChecker)
-        self.label_3.setObjectName(u"label_3")
+        self.equationText = QPlainTextEdit(EquationChecker)
+        self.equationText.setObjectName(u"equationText")
+        sizePolicy = QSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+        sizePolicy.setHorizontalStretch(0)
+        sizePolicy.setVerticalStretch(0)
+        sizePolicy.setHeightForWidth(self.equationText.sizePolicy().hasHeightForWidth())
+        self.equationText.setSizePolicy(sizePolicy)
+        self.equationText.setMinimumSize(QSize(0, 20))
+        self.equationText.setBaseSize(QSize(0, 20))
 
-        self.gridLayout.addWidget(self.label_3, 2, 3, 1, 1)
+        self.verticalLayout.addWidget(self.equationText)
 
-        self.lineFirstResult = QLineEdit(EquationChecker)
-        self.lineFirstResult.setObjectName(u"lineFirstResult")
-        self.lineFirstResult.setEnabled(True)
-        self.lineFirstResult.setFont(font)
-        self.lineFirstResult.setAlignment(Qt.AlignmentFlag.AlignCenter)
-        self.lineFirstResult.setReadOnly(True)
+        self.horizontalLayout = QHBoxLayout()
+        self.horizontalLayout.setObjectName(u"horizontalLayout")
+        self.horizontalLayout.setContentsMargins(-1, 5, -1, -1)
+        self.btnRunCheck = QPushButton(EquationChecker)
+        self.btnRunCheck.setObjectName(u"btnRunCheck")
+        font1 = QFont()
+        font1.setPointSize(12)
+        font1.setBold(True)
+        self.btnRunCheck.setFont(font1)
 
-        self.gridLayout.addWidget(self.lineFirstResult, 2, 4, 1, 1)
+        self.horizontalLayout.addWidget(self.btnRunCheck)
 
-        self.label_6 = QLabel(EquationChecker)
-        self.label_6.setObjectName(u"label_6")
-        font4 = QFont()
-        font4.setPointSize(15)
-        self.label_6.setFont(font4)
+        self.lineCheckResult = QLineEdit(EquationChecker)
+        self.lineCheckResult.setObjectName(u"lineCheckResult")
+        font2 = QFont()
+        font2.setBold(True)
+        font2.setItalic(True)
+        self.lineCheckResult.setFont(font2)
+        self.lineCheckResult.setLayoutDirection(Qt.LayoutDirection.LeftToRight)
+        self.lineCheckResult.setAlignment(Qt.AlignmentFlag.AlignCenter)
+        self.lineCheckResult.setReadOnly(True)
 
-        self.gridLayout.addWidget(self.label_6, 1, 3, 1, 1)
+        self.horizontalLayout.addWidget(self.lineCheckResult)
 
-        self.label_5 = QLabel(EquationChecker)
-        self.label_5.setObjectName(u"label_5")
-        self.label_5.setFont(font4)
 
-        self.gridLayout.addWidget(self.label_5, 1, 1, 1, 1)
+        self.verticalLayout.addLayout(self.horizontalLayout)
 
+        self.line = QFrame(EquationChecker)
+        self.line.setObjectName(u"line")
+        self.line.setFrameShape(QFrame.Shape.HLine)
+        self.line.setFrameShadow(QFrame.Shadow.Sunken)
 
-        self.verticalLayout.addLayout(self.gridLayout)
+        self.verticalLayout.addWidget(self.line)
 
-        self.verticalSpacer = QSpacerItem(20, 40, QSizePolicy.Policy.Minimum, QSizePolicy.Policy.Minimum)
+        self.tableVariables = QTableWidget(EquationChecker)
+        self.tableVariables.setObjectName(u"tableVariables")
+        sizePolicy.setHeightForWidth(self.tableVariables.sizePolicy().hasHeightForWidth())
+        self.tableVariables.setSizePolicy(sizePolicy)
+        self.tableVariables.setSizeAdjustPolicy(QAbstractScrollArea.SizeAdjustPolicy.AdjustToContents)
 
-        self.verticalLayout.addItem(self.verticalSpacer)
+        self.verticalLayout.addWidget(self.tableVariables)
 
-        self.label_7 = QLabel(EquationChecker)
-        self.label_7.setObjectName(u"label_7")
-        self.label_7.setFont(font3)
+        self.horizontalLayout_2 = QHBoxLayout()
+        self.horizontalLayout_2.setObjectName(u"horizontalLayout_2")
+        self.horizontalLayout_2.setContentsMargins(-1, 5, -1, -1)
+        self.horizontalSpacer = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
 
-        self.verticalLayout.addWidget(self.label_7)
+        self.horizontalLayout_2.addItem(self.horizontalSpacer)
 
-        self.line = QFrame(EquationChecker)
-        self.line.setObjectName(u"line")
-        self.line.setFrameShape(QFrame.Shape.HLine)
-        self.line.setFrameShadow(QFrame.Shadow.Sunken)
+        self.btnSave = QPushButton(EquationChecker)
+        self.btnSave.setObjectName(u"btnSave")
 
-        self.verticalLayout.addWidget(self.line)
+        self.horizontalLayout_2.addWidget(self.btnSave)
 
-        self.verticalLayout_2 = QVBoxLayout()
-        self.verticalLayout_2.setObjectName(u"verticalLayout_2")
-        self.textResultsOutput = QTextEdit(EquationChecker)
-        self.textResultsOutput.setObjectName(u"textResultsOutput")
+        self.btnCancel = QPushButton(EquationChecker)
+        self.btnCancel.setObjectName(u"btnCancel")
 
-        self.verticalLayout_2.addWidget(self.textResultsOutput)
+        self.horizontalLayout_2.addWidget(self.btnCancel)
 
 
-        self.verticalLayout.addLayout(self.verticalLayout_2)
+        self.verticalLayout.addLayout(self.horizontalLayout_2)
 
 
         self.retranslateUi(EquationChecker)
@@ -188,20 +176,22 @@ class Ui_EquationChecker(object):
 
     def retranslateUi(self, EquationChecker):
         EquationChecker.setWindowTitle(QCoreApplication.translate("EquationChecker", u"Equation Checker", None))
-        self.label_2.setText(QCoreApplication.translate("EquationChecker", u"Equation:", None))
         self.label_4.setText(QCoreApplication.translate("EquationChecker", u"calculated first Result", None))
+        self.labelPartNum.setText(QCoreApplication.translate("EquationChecker", u"Answer Part (Cloze)", None))
         self.lineCalculatedRes.setText(QCoreApplication.translate("EquationChecker", u"0.00", None))
-        self.lineCheckResult.setText("")
-        self.lineCheckResult.setPlaceholderText(QCoreApplication.translate("EquationChecker", u"waiting for check", None))
-        self.buttonRunCheck.setText(QCoreApplication.translate("EquationChecker", u"Run Check now", None))
-        self.label_8.setText(QCoreApplication.translate("EquationChecker", u"Check", None))
-        self.label_9.setText(QCoreApplication.translate("EquationChecker", u"Variables:", None))
-        self.label_10.setText(QCoreApplication.translate("EquationChecker", u"Answer Part (Cloze)", None))
-        self.label_3.setText(QCoreApplication.translate("EquationChecker", u"firstResult from spreadsheet", None))
         self.lineFirstResult.setText(QCoreApplication.translate("EquationChecker", u"0.00", None))
         self.lineFirstResult.setPlaceholderText(QCoreApplication.translate("EquationChecker", u"waiting", None))
-        self.label_6.setText(QCoreApplication.translate("EquationChecker", u"Output", None))
-        self.label_5.setText(QCoreApplication.translate("EquationChecker", u"Input", None))
-        self.label_7.setText(QCoreApplication.translate("EquationChecker", u"Calculated Values with corresponding properties", None))
+        self.label_3.setText(QCoreApplication.translate("EquationChecker", u"firstResult from spreadsheet", None))
+#if QT_CONFIG(tooltip)
+        self.btnFetchQst.setToolTip(QCoreApplication.translate("EquationChecker", u"Get the last selected question from the main windows list.", None))
+#endif // QT_CONFIG(tooltip)
+        self.btnFetchQst.setText(QCoreApplication.translate("EquationChecker", u"Fetch current question", None))
+        self.labelQuestionNum.setText(QCoreApplication.translate("EquationChecker", u"Question: ", None))
+        self.label_2.setText(QCoreApplication.translate("EquationChecker", u"Edit the equation below", None))
+        self.btnRunCheck.setText(QCoreApplication.translate("EquationChecker", u"Check the equation now !", None))
+        self.lineCheckResult.setText("")
+        self.lineCheckResult.setPlaceholderText(QCoreApplication.translate("EquationChecker", u"waiting for check", None))
+        self.btnSave.setText(QCoreApplication.translate("EquationChecker", u"Save equation", None))
+        self.btnCancel.setText(QCoreApplication.translate("EquationChecker", u"Close", None))
     # retranslateUi
 

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/ui/UI_variableGenerator.py

@@ -3,7 +3,7 @@
 ################################################################################
 ## Form generated from reading UI file 'UI_variableGenerator.ui'
 ##
-## Created by: Qt User Interface Compiler version 6.9.1
+## Created by: Qt User Interface Compiler version 6.9.2
 ##
 ## WARNING! All changes made in this file will be lost when recompiling UI file!
 ################################################################################

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle/ui/appUi.py

@@ -22,14 +22,12 @@ from excel2moodle import e2mMetadata, mainLogger
 from excel2moodle.core.category import Category
 from excel2moodle.core.dataStructure import QuestionDB
 from excel2moodle.core.exceptions import InvalidFieldException
-from excel2moodle.core.question import ParametricQuestion
+from excel2moodle.core.question import ParametricQuestion, Question
 from excel2moodle.core.settings import Settings, Tags
+from excel2moodle.extra.equationChecker import EqCheckerWindow
 from excel2moodle.extra.variableGenerator import VariableGeneratorDialog
 from excel2moodle.logger import LogWindowHandler
-from excel2moodle.question_types.mc import MCQuestion
-from excel2moodle.question_types.nf import NFQuestion
 from excel2moodle.ui import dialogs
-from excel2moodle.ui.equationChecker import EqCheckerWindow
 from excel2moodle.ui.treewidget import CategoryItem, QuestionItem
 from excel2moodle.ui.UI_mainWindow import Ui_MoodleTestGenerator
 
@@ -53,7 +51,8 @@ class MainWindow(QMainWindow):
         self.ui.setupUi(self)
         self.exportDialog = dialogs.ExportDialog(self)
         self.questionPreview = dialogs.QuestionPreview(self)
-        self.eqChecker = EqCheckerWindow()
+        self.eqChecker = EqCheckerWindow(self)
+        self.eqChecker.setModal(False)
         self.connectEvents()
         logger.info("Settings are stored under: %s", self.qSettings.fileName())
         self.ui.treeWidget.setSelectionMode(QAbstractItemView.MultiSelection)
@@ -155,6 +154,15 @@ class MainWindow(QMainWindow):
             self.settings.get(Tags.QUESTIONVARIANT),
         )
 
+    @property
+    def currentQuestion(self) -> Question | None:
+        """Get the current question."""
+        item = self.ui.treeWidget.currentItem()
+        if isinstance(item, QuestionItem):
+            return item.question
+        logger.info("No Question Item selected.")
+        return None
+
     @Slot()
     def onSelectionChanged(self, **args) -> None:
         """Whenever the selection changes the total of selected points needs to be recalculated."""
@@ -166,8 +174,9 @@ class MainWindow(QMainWindow):
             count += q.question.points
         self.ui.pointCounter.setValue(count)
         self.ui.questionCounter.setValue(questions)
-        if self.eqChecker.isVisible():
-            self.openEqCheckerDlg()
+        # This would automatically update the question of the checker
+        # if self.eqChecker.isVisible():
+        #     self.openEqCheckerDlg()
 
     @Slot()
     def toggleQuestionSelectionState(self, state) -> None:
@@ -249,11 +258,9 @@ class MainWindow(QMainWindow):
 
     @Slot()
     def updateQuestionPreview(self) -> None:
-        item = self.ui.treeWidget.currentItem()
-        if isinstance(item, QuestionItem):
-            self.questionPreview.setupQuestion(item.question)
-        else:
-            logger.info("current Item is not a Question, can't preview")
+        question = self.currentQuestion
+        if question is not None:
+            self.questionPreview.setupQuestion(question)
 
     def setStatus(self, status) -> None:
         self.ui.statusbar.clearMessage()
@@ -261,17 +268,15 @@ class MainWindow(QMainWindow):
 
     @Slot()
     def openEqCheckerDlg(self) -> None:
-        item = self.ui.treeWidget.currentItem()
-        if isinstance(item, QuestionItem):
-            question = item.question
-            if isinstance(question, (NFQuestion, MCQuestion)):
-                logger.debug("Can't check an MC or NF Question")
-            else:
-                logger.debug("opening wEquationChecker \n")
-                self.eqChecker.setup(item.question)
-                self.eqChecker.show()
+        question = self.currentQuestion
+        if question is None:
+            return
+        if isinstance(question, ParametricQuestion):
+            logger.debug("opening wEquationChecker \n")
+            self.eqChecker.show()
+            self.eqChecker.updateQuestion()
         else:
-            logger.debug("No Question Item selected: %s", type(item))
+            logger.debug("Can't check an MC or NF Question")
 
     @Slot()
     def openAboutDlg(self) -> None:
@@ -286,24 +291,21 @@ class MainWindow(QMainWindow):
 
     @Slot()
     def openVariableGeneratorDlg(self) -> None:
-        item = self.ui.treeWidget.currentItem()
-        if isinstance(item, QuestionItem):
-            question = item.question
-            if isinstance(question, ParametricQuestion):
-                dialog = VariableGeneratorDialog(self, parametrics=question.parametrics)
-                if dialog.exec():
-                    self.questionPreview.setupQuestion(question)
-                    self.treeRefreshCategory(question.category)
-                    logger.info("Updated QuestionItem display for %s", question.id)
-                    self.copyVariablesToClipboard(
-                        variables=question.parametrics.variables
-                    )
-                else:
-                    logger.warning("No variable sets were generated.")
+        question = self.currentQuestion
+        if question is None:
+            return
+        if isinstance(question, ParametricQuestion):
+            dialog = VariableGeneratorDialog(self, parametrics=question.parametrics)
+            dialog.setModal(False)
+            if dialog.exec():
+                self.questionPreview.setupQuestion(question)
+                self.treeRefreshCategory(question.category)
+                logger.info("Updated QuestionItem display for %s", question.id)
+                self.copyVariablesToClipboard(variables=question.parametrics.variables)
             else:
-                logger.info("Selected item is not a ParametricQuestion.")
+                logger.warning("No variable sets were generated.")
         else:
-            logger.info("No Question Item selected.")
+            logger.info("Selected item is not a ParametricQuestion.")
 
     @Slot()
     def copyVariablesToClipboard(
@@ -312,11 +314,11 @@ class MainWindow(QMainWindow):
         if variables is None:
             variables = {}
         if not variables:
-            item = self.ui.treeWidget.currentItem()
-            if isinstance(item, QuestionItem):
-                question = item.question
-                if isinstance(question, ParametricQuestion):
-                    variables = question.parametrics.variables
+            question = self.currentQuestion
+            if question is None:
+                return
+            if isinstance(question, ParametricQuestion):
+                variables = question.parametrics.variables
         varsList = [
             f"{name}\t{';    '.join(map(str, vals))}"
             for name, vals in variables.items()

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: excel2moodle
-Version: 0.6.5
+Version: 0.7.0
 Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
 Author: Jakob Bosse
 License-Expression: GPL-3.0-or-later
@@ -90,6 +90,21 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.7.0 (2025-09-30)
+Rework of the equation checker done!
+
+### feature (1 change)
+
+- [finalized equation Checker](https://gitlab.com/jbosse3/excel2moodle/-/commit/55e3891d3da56357ad00f672a86c2690d551d21c)
+
+### documentation (1 change)
+
+- [Documented feedback usages](https://gitlab.com/jbosse3/excel2moodle/-/commit/6f50ce023a3235b3f34b6272a4ce5057346f8751)
+
+### improvement (1 change)
+
+- [MainWindow got a currentQuestion property](https://gitlab.com/jbosse3/excel2moodle/-/commit/59b18e158201357b767a36dab0f300f88cb5e9ad)
+
 ## 0.6.5 (2025-09-02)
 Added Scripted Media Support now with the module
 

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/excel2moodle.egg-info/SOURCES.txt

@@ -23,7 +23,7 @@ excel2moodle/core/settings.py
 excel2moodle/core/stringHelpers.py
 excel2moodle/core/validator.py
 excel2moodle/extra/__init__.py
-excel2moodle/extra/equationVerification.py
+excel2moodle/extra/equationChecker.py
 excel2moodle/extra/scriptCaller.py
 excel2moodle/extra/updateQuery.py
 excel2moodle/extra/variableGenerator.py
@@ -41,7 +41,6 @@ excel2moodle/ui/UI_variantDialog.py
 excel2moodle/ui/__init__.py
 excel2moodle/ui/appUi.py
 excel2moodle/ui/dialogs.py
-excel2moodle/ui/equationChecker.py
 excel2moodle/ui/treewidget.py
 test/test_bullets.py
 test/test_feedbacking.py

{excel2moodle-0.6.5 → excel2moodle-0.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "excel2moodle"
-version = "0.6.5"
+version = "0.7.0"
 authors = [
   { name="Jakob Bosse" },
 ]

excel2moodle-0.6.5/excel2moodle/extra/equationVerification.py

@@ -1,126 +0,0 @@
-"""Script for verifying the equations written into the ``result`` field of NFM-type Question.
-
-This script does two things.
-
-#. It calculates all the answers obtained from the series of variables.
-#. It compares the calculation of the first answer to the ``firstResult`` field.
-
-Usage
-=====
-
-From the main UI
-----------------
-
-#. Start this tool from the top bar in the main Window under the *Tools* section
-#. A new window will open inside you:
-#. Enter the Number of the Category
-#. Enter the Number of the Question
-#. Click on ``Run check now`` and Inspect the results
-#. Rinse and repeat
-
-As Script
----------
-
-#. Start this script with ``py -m excel2moodle.extra.equationVerification`` inside the top-level Directory
-#. Enter the Number of the Category
-#. Enter the Number of the Question
-#. Inspect the results
-#. Rinse and repeat
-"""
-
-from pathlib import Path
-
-import pandas as pd
-
-# Hier Bitte die Frage angeben, die getestet Werden soll:
-
-# ===========================================================
-
-
-def checkResult(checkerValue: float, calculation: float, tolerance=0.01) -> bool:
-    """Checks if the two Arguments are within the tolerance the same value.
-
-    :param checkerValue: the value the calculation is compared against
-    :type checkerValue: fleat
-    :param calculation: the value to be compared against checker Value
-    :type calculation: float
-    :param tolerance: the standart tolerance is 0.01 -> 1%
-    :type tolerance: float, optional
-
-    :returns:
-        True if checkerValue == calculation
-        False if checkerValue != calculation
-    :rtype: bool
-    """
-    upper = abs(checkerValue + checkerValue * tolerance)
-    lower = abs(checkerValue - checkerValue * tolerance)
-    return bool(abs(calculation) > lower and abs(calculation) < upper)
-
-
-def equationChecker(
-    categoryName: str, qNumber: int, spreadsheetFile
-) -> tuple[list[str], list[float], float]:
-    """This Function calculates all Results an invokes the checkResult function.
-
-    Parameters
-    ----------
-    categoryName : str
-        The category in which the question to be tested is
-        This must match a sheet name of the spreadsheet
-    qNumber : int
-        The number of the question which results are tested
-    spreadsheetFile : Path
-        The Filepath to the spreadsheet
-
-    Returns
-    -------
-    bulletPointsString : list[str]
-        The string list with the bullet points, with numeric values instead of variables
-    results : list[str]
-        The list with the calculated results
-    checkerValue : float
-        The value taken from the ``firstResult`` field
-
-    """
-    spreadsheetFile.resolve()
-    df = pd.read_excel(spreadsheetFile, sheet_name=categoryName, index_col=0)
-    eq = df.loc["result"][qNumber]
-    bps = df.loc["bulletPoints"][qNumber]
-    try:
-        res = float(df.loc["firstResult"][qNumber])
-    except Exception:
-        res = 0
-    bps, calcs = nmq.parseNumericMultiQuestion(df, bps, eq, qNumber)
-    return bps, calcs, res
-
-
-def main(
-    spreadsheetFile=Path("../Fragensammlung/Main_question_all.xlsx"),
-    catN=None,
-    qNumber=None,
-) -> None:
-    """Takes the Spreadsheet, and asks for a category and a question number."""
-    if catN is None:
-        catN = input("Geben Sie die Kategorie an: KAT_")
-    categoryName = f"KAT_{catN}"
-    if qNumber is None:
-        qNumber = int(input("Geben Sie die Fragennummer an: "))
-    bullets, results, firstResult = equationChecker(
-        categoryName, qNumber, spreadsheetFile=spreadsheetFile
-    )
-    check = False
-
-    for i, calculation in enumerate(results):
-        if i == 0 and firstResult != 0:
-            check = checkResult(firstResult, calculation)
-
-    if check:
-        pass
-    else:
-        pass
-
-
-if __name__ == "__main__":
-    spreadsheet = input("Geben Sie den Pfad zu dem spreadsheet an:")
-    while True:
-        main(Path(spreadsheet))

excel2moodle-0.6.5/excel2moodle/ui/equationChecker.py

@@ -1,70 +0,0 @@
-import logging
-import math
-from pathlib import Path
-
-from PySide6.QtWidgets import QWidget
-
-from excel2moodle import mainLogger
-from excel2moodle.core.question import ParametricQuestion
-from excel2moodle.core.settings import Tags
-from excel2moodle.logger import LogWindowHandler
-from excel2moodle.question_types.nfm import NFMQuestionParser
-
-from .UI_equationChecker import Ui_EquationChecker
-
-logger = logging.getLogger(__name__)
-
-loggerSignal = LogWindowHandler()
-mainLogger.addHandler(loggerSignal)
-
-
-class EqCheckerWindow(QWidget):
-    def __init__(self) -> None:
-        super().__init__()
-        self.excelFile = Path()
-        self.ui = Ui_EquationChecker()
-        self.ui.setupUi(self)
-        self.ui.buttonRunCheck.clicked.connect(
-            lambda: self.updateCalculation(),
-        )
-        self.question: ParametricQuestion
-
-    def updateCalculation(self) -> None:
-        equation = self.ui.equationText.toPlainText()
-        results: list[float] = []
-        firstResult = self.question.rawData.get(Tags.FIRSTRESULT)
-        for i in range(self.question.variants):
-            NFMQuestionParser.setupAstIntprt(self.question.variables, i)
-            results.append(float(NFMQuestionParser.astEval(equation)))
-        check: bool = False
-        self.ui.textResultsOutput.insertHtml(f"<hr><br><h2>{equation:^30}</h2><br>")
-        for i, calculation in enumerate(results):
-            if i == 0 and firstResult != 0:
-                check = bool(math.isclose(calculation, firstResult, rel_tol=0.01))
-                self.ui.lineCalculatedRes.setText(f"{calculation}")
-                self.ui.textResultsOutput.append(f"<h3>Result {check = }</h3><br>")
-            self.ui.textResultsOutput.append(
-                f"Ergebnis {i + 1}: \t{calculation}",
-            )
-        if check:
-            self.ui.lineCheckResult.setText("[OK]")
-            logger.info(
-                " [OK] The first calculated result matches 'firstResult'",
-            )
-        else:
-            self.ui.lineCheckResult.setText("[ERROR]")
-            logger.warning(
-                "The first calculated result does not match 'firstResult'",
-            )
-
-    def setup(self, question: ParametricQuestion) -> None:
-        self.question = question
-        self.ui.textResultsOutput.clear()
-        self.ui.equationText.clear()
-        bullets = question.rawData.get(Tags.BPOINTS)
-        firstResult = question.rawData.get(Tags.FIRSTRESULT)
-        self.ui.lineFirstResult.setText(str(firstResult))
-        self.ui.equationText.appendPlainText(question.rawData.get(Tags.EQUATION))
-        for bullet in bullets:
-            self.ui.textResultsOutput.append(bullet)
-        self.updateCalculation()