excel2moodle 0.5.1__tar.gz → 0.6.0__tar.gz

{excel2moodle-0.5.1/excel2moodle.egg-info → excel2moodle-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: excel2moodle
-Version: 0.5.1
+Version: 0.6.0
 Summary: A package for converting questions from a spreadsheet, to valid moodle-xml
 Author: Jakob Bosse
 License-Expression: GPL-3.0-or-later
@@ -12,11 +12,11 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pyside6>=6.8.0
 Requires-Dist: pandas>=2.1.3
 Requires-Dist: lxml>=5.4.0
 Requires-Dist: asteval>=1.0.6
 Requires-Dist: python-calamine>=0.3.2
+Requires-Dist: pyside6-essentials>=6.8.0
 Dynamic: license-file
 
 # excel 2 Moodle
@@ -81,6 +81,71 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.6.0 (2025-07-12)
+Added variable generator and other architechtural improvements
+
+### documentation (1 change)
+
+- [Documenting variable generator usage](https://gitlab.com/jbosse3/excel2moodle/-/commit/3e4d3019b29872b5cfddf5539d5ebe7638bca049)
+
+### feature (5 changes)
+
+- [Opening spreadsheet file works from within excel2moodle](https://gitlab.com/jbosse3/excel2moodle/-/commit/9470f12ea5f098745a3210b281a5144a938ae8b5)
+- [Variables are copied to clipboard](https://gitlab.com/jbosse3/excel2moodle/-/commit/87a7e5ec75f899b293e89ad3c1742567e3ec1c29)
+- [Removed dependence on pyside6-addons](https://gitlab.com/jbosse3/excel2moodle/-/commit/2b3a7cf48581c14bd9cb570cd61d1d41aa410e11)
+- [Var Generator ready](https://gitlab.com/jbosse3/excel2moodle/-/commit/ea97f0639dc35a4c99a64ae3976ccc8a0ac5d109)
+- [Merge development of BulletsObj, Parametrization and VarGenerator](https://gitlab.com/jbosse3/excel2moodle/-/commit/40b46f3c143e082f1bb985d6c8c4e68bb6b6a7a8)
+
+### improvement (7 changes)
+
+- [Adapted Param. Parser to use bullet Obj](https://gitlab.com/jbosse3/excel2moodle/-/commit/194cab7cc6aecb2d25d1cb9c1538ed7d607dd9e1)
+- [Added bulleList Object](https://gitlab.com/jbosse3/excel2moodle/-/commit/4ea982b8d8dc270675d2cb059c59fa980ce38894)
+- [Parametrics in beta stage](https://gitlab.com/jbosse3/excel2moodle/-/commit/7d04d8ef2fc603c1b12b6934c827ce079df5d540)
+- [Refactor parse() method, to construct complete xml-Tree](https://gitlab.com/jbosse3/excel2moodle/-/commit/8dc4bea9aa0673d39357115254dd55b02c04114e)
+- [Refactored question assembly to only update fields.](https://gitlab.com/jbosse3/excel2moodle/-/commit/d7accb69be3b4a1e65f59eeecfb463f2663fabd4)
+- [Adapted NFM Question to parametricResult](https://gitlab.com/jbosse3/excel2moodle/-/commit/fe552cd2b538ca8886415c200e4a2a3ecc1fbb2f) ([merge request](https://gitlab.com/jbosse3/excel2moodle/-/merge_requests/5))
+- [Implemented ParametricResult Object](https://gitlab.com/jbosse3/excel2moodle/-/commit/e36d025955f1cab8e0542d66263ab70e3d8980df) ([merge request](https://gitlab.com/jbosse3/excel2moodle/-/merge_requests/5))
+
+## 0.5.2 (2025-06-30)
+Extended Documentation and bugfix for import Module
+
+### bugfix (2 changes)
+
+- [Default question variant saved and reused.](https://gitlab.com/jbosse3/excel2moodle/-/commit/097705ba83727463a9b27cd76e99814a7ecf28df)
+- [bugfix: Import module working again](https://gitlab.com/jbosse3/excel2moodle/-/commit/5f293970bcdac3858911cdcc102b72714af057bd)
+
+### documentation (1 change)
+
+- [documentation: Added how to build question database](https://gitlab.com/jbosse3/excel2moodle/-/commit/71ceb122aa37e8bf2735b659359ae37d81017599)
+
+### feature (1 change)
+
+- [Implemented MC question string method](https://gitlab.com/jbosse3/excel2moodle/-/commit/c4f2081d0000ee60322fe8eec8468fa3317ce7be)
+
+### improvement (1 change)
+
+- [Implemented ClozePart object](https://gitlab.com/jbosse3/excel2moodle/-/commit/878f90f45e37421384c4f8f602115e7596b4ceb9)
+
+## 0.5.2 (2025-06-30)
+Extended Documentation and bugfix for import Module
+
+### bugfix (2 changes)
+
+- [Default question variant saved and reused.](https://gitlab.com/jbosse3/excel2moodle/-/commit/097705ba83727463a9b27cd76e99814a7ecf28df)
+- [bugfix: Import module working again](https://gitlab.com/jbosse3/excel2moodle/-/commit/5f293970bcdac3858911cdcc102b72714af057bd)
+
+### documentation (1 change)
+
+- [documentation: Added how to build question database](https://gitlab.com/jbosse3/excel2moodle/-/commit/71ceb122aa37e8bf2735b659359ae37d81017599)
+
+### feature (1 change)
+
+- [Implemented MC question string method](https://gitlab.com/jbosse3/excel2moodle/-/commit/c4f2081d0000ee60322fe8eec8468fa3317ce7be)
+
+### improvement (1 change)
+
+- [Implemented ClozePart object](https://gitlab.com/jbosse3/excel2moodle/-/commit/878f90f45e37421384c4f8f602115e7596b4ceb9)
+
 ## 0.5.1 (2025-06-24)
 Minor docs improvement and question variant bugfix
 

{excel2moodle-0.5.1 → excel2moodle-0.6.0}/README.md

@@ -60,6 +60,71 @@ If You want to support my work as well, you can by me a [coffee](https://ko-fi.c
 
 # Changelogs
 
+## 0.6.0 (2025-07-12)
+Added variable generator and other architechtural improvements
+
+### documentation (1 change)
+
+- [Documenting variable generator usage](https://gitlab.com/jbosse3/excel2moodle/-/commit/3e4d3019b29872b5cfddf5539d5ebe7638bca049)
+
+### feature (5 changes)
+
+- [Opening spreadsheet file works from within excel2moodle](https://gitlab.com/jbosse3/excel2moodle/-/commit/9470f12ea5f098745a3210b281a5144a938ae8b5)
+- [Variables are copied to clipboard](https://gitlab.com/jbosse3/excel2moodle/-/commit/87a7e5ec75f899b293e89ad3c1742567e3ec1c29)
+- [Removed dependence on pyside6-addons](https://gitlab.com/jbosse3/excel2moodle/-/commit/2b3a7cf48581c14bd9cb570cd61d1d41aa410e11)
+- [Var Generator ready](https://gitlab.com/jbosse3/excel2moodle/-/commit/ea97f0639dc35a4c99a64ae3976ccc8a0ac5d109)
+- [Merge development of BulletsObj, Parametrization and VarGenerator](https://gitlab.com/jbosse3/excel2moodle/-/commit/40b46f3c143e082f1bb985d6c8c4e68bb6b6a7a8)
+
+### improvement (7 changes)
+
+- [Adapted Param. Parser to use bullet Obj](https://gitlab.com/jbosse3/excel2moodle/-/commit/194cab7cc6aecb2d25d1cb9c1538ed7d607dd9e1)
+- [Added bulleList Object](https://gitlab.com/jbosse3/excel2moodle/-/commit/4ea982b8d8dc270675d2cb059c59fa980ce38894)
+- [Parametrics in beta stage](https://gitlab.com/jbosse3/excel2moodle/-/commit/7d04d8ef2fc603c1b12b6934c827ce079df5d540)
+- [Refactor parse() method, to construct complete xml-Tree](https://gitlab.com/jbosse3/excel2moodle/-/commit/8dc4bea9aa0673d39357115254dd55b02c04114e)
+- [Refactored question assembly to only update fields.](https://gitlab.com/jbosse3/excel2moodle/-/commit/d7accb69be3b4a1e65f59eeecfb463f2663fabd4)
+- [Adapted NFM Question to parametricResult](https://gitlab.com/jbosse3/excel2moodle/-/commit/fe552cd2b538ca8886415c200e4a2a3ecc1fbb2f) ([merge request](https://gitlab.com/jbosse3/excel2moodle/-/merge_requests/5))
+- [Implemented ParametricResult Object](https://gitlab.com/jbosse3/excel2moodle/-/commit/e36d025955f1cab8e0542d66263ab70e3d8980df) ([merge request](https://gitlab.com/jbosse3/excel2moodle/-/merge_requests/5))
+
+## 0.5.2 (2025-06-30)
+Extended Documentation and bugfix for import Module
+
+### bugfix (2 changes)
+
+- [Default question variant saved and reused.](https://gitlab.com/jbosse3/excel2moodle/-/commit/097705ba83727463a9b27cd76e99814a7ecf28df)
+- [bugfix: Import module working again](https://gitlab.com/jbosse3/excel2moodle/-/commit/5f293970bcdac3858911cdcc102b72714af057bd)
+
+### documentation (1 change)
+
+- [documentation: Added how to build question database](https://gitlab.com/jbosse3/excel2moodle/-/commit/71ceb122aa37e8bf2735b659359ae37d81017599)
+
+### feature (1 change)
+
+- [Implemented MC question string method](https://gitlab.com/jbosse3/excel2moodle/-/commit/c4f2081d0000ee60322fe8eec8468fa3317ce7be)
+
+### improvement (1 change)
+
+- [Implemented ClozePart object](https://gitlab.com/jbosse3/excel2moodle/-/commit/878f90f45e37421384c4f8f602115e7596b4ceb9)
+
+## 0.5.2 (2025-06-30)
+Extended Documentation and bugfix for import Module
+
+### bugfix (2 changes)
+
+- [Default question variant saved and reused.](https://gitlab.com/jbosse3/excel2moodle/-/commit/097705ba83727463a9b27cd76e99814a7ecf28df)
+- [bugfix: Import module working again](https://gitlab.com/jbosse3/excel2moodle/-/commit/5f293970bcdac3858911cdcc102b72714af057bd)
+
+### documentation (1 change)
+
+- [documentation: Added how to build question database](https://gitlab.com/jbosse3/excel2moodle/-/commit/71ceb122aa37e8bf2735b659359ae37d81017599)
+
+### feature (1 change)
+
+- [Implemented MC question string method](https://gitlab.com/jbosse3/excel2moodle/-/commit/c4f2081d0000ee60322fe8eec8468fa3317ce7be)
+
+### improvement (1 change)
+
+- [Implemented ClozePart object](https://gitlab.com/jbosse3/excel2moodle/-/commit/878f90f45e37421384c4f8f602115e7596b4ceb9)
+
 ## 0.5.1 (2025-06-24)
 Minor docs improvement and question variant bugfix
 

excel2moodle-0.6.0/excel2moodle/core/bullets.py

@@ -0,0 +1,98 @@
+import logging
+import re
+
+import lxml.etree as ET
+
+from excel2moodle.core import stringHelpers
+from excel2moodle.core.globals import TextElements
+from excel2moodle.core.question import ParametricQuestion
+from excel2moodle.logger import LogAdapterQuestionID
+
+loggerObj = logging.getLogger(__name__)
+
+
+class BulletList:
+    def __init__(self, rawBullets: list[str], qID: str) -> None:
+        self.rawBullets: list[str] = rawBullets
+        self.element: ET.Element = ET.Element("ul")
+        self.bullets: dict[str, BulletP] = {}
+        self.id = qID
+        self.logger = LogAdapterQuestionID(loggerObj, {"qID": self.id})
+        self._setupBullets(rawBullets)
+
+    def updateBullets(
+        self, variables: dict[str, list[float]], variant: int = 1
+    ) -> None:
+        for var, bullet in self.bullets.items():
+            bullet.update(value=variables[var][variant - 1])
+
+    def getVariablesDict(self, question: ParametricQuestion) -> dict[str, list[float]]:
+        """Read variabel values for vars in `question.rawData`.
+
+        Returns
+        -------
+        A dictionary containing a list of values for each variable name
+
+        """
+        keyList = self.varNames
+        dic: dict = {}
+        for k in keyList:
+            val = question.rawData[k.lower()]
+            if isinstance(val, str):
+                li = stringHelpers.getListFromStr(val)
+                variables: list[float] = [float(i.replace(",", ".")) for i in li]
+                dic[str(k)] = variables
+            else:
+                dic[str(k)] = [str(val)]
+        loggerObj.debug("The following variables were provided: %s", dic)
+        return dic
+
+    @property
+    def varNames(self) -> list[str]:
+        names = [i for i in self.bullets if isinstance(i, str)]
+        if len(names) > 0:
+            self.logger.debug("returning Var names: %s", names)
+            return names
+        msg = "Bullet variable names not given."
+        raise ValueError(msg)
+
+    def _setupBullets(self, bps: list[str]) -> ET.Element:
+        self.logger.debug("Formatting the bulletpoint list")
+        varFinder = re.compile(r"=\s*\{(\w+)\}")
+        for i, item in enumerate(bps):
+            sc_split = item.split()
+            name = sc_split[0]
+            var = sc_split[1]
+            quant = sc_split[3]
+            unit = sc_split[4]
+
+            match = re.search(varFinder, item)
+            if match is None:
+                self.logger.debug("Got a normal bulletItem")
+                num: float = float(quant.replace(",", "."))
+                bulletName: str = str(i + 1)
+            else:
+                bulletName = match.group(1)
+                num: float = 0.0
+                self.logger.debug("Got an variable bulletItem, match: %s", match)
+
+            self.bullets[bulletName] = BulletP(name=name, var=var, unit=unit, value=num)
+            self.element.append(self.bullets[bulletName].element)
+        return self.element
+
+
+class BulletP:
+    def __init__(self, name: str, var: str, unit: str, value: float = 0.0) -> None:
+        self.name: str = name
+        self.var: str = var
+        self.unit: str = unit
+        self.element: ET.Element
+        self.update(value=value)
+
+    def update(self, value: float = 1) -> None:
+        if not hasattr(self, "element"):
+            self.element = TextElements.LISTITEM.create()
+        valuestr = str(value).replace(".", r",\!")
+        self.element.text = (
+            f"{self.name} \\( {self.var} = {valuestr} \\mathrm{{ {self.unit} }} \\)"
+        )

{excel2moodle-0.5.1 → excel2moodle-0.6.0}/excel2moodle/core/dataStructure.py

@@ -11,8 +11,8 @@ from typing import TYPE_CHECKING
 
 import lxml.etree as ET  # noqa: N812
 import pandas as pd
-from PySide6 import QtWidgets
 from PySide6.QtCore import QObject, Signal
+from PySide6.QtWidgets import QDialog
 
 from excel2moodle.core import stringHelpers
 from excel2moodle.core.category import Category
@@ -131,7 +131,7 @@ class QuestionDB:
         if Tags.IMPORTMODULE in self.settings:
             logger.warning(
                 "Appending: %s to sys.path. All names defined by it will be usable",
-                sheetPath,
+                sheetPath.parent,
             )
             sys.path.append(str(sheetPath.parent))
         if Tags.PICTURESUBFOLDER not in self.settings:
@@ -286,7 +286,7 @@ class QuestionDB:
         self.signals.categoryQuestionsReady.emit(category)
 
     @classmethod
-    def setupAndParseQuestion(cls, category: Category, qNumber: int) -> Question | None:
+    def setupAndParseQuestion(cls, category: Category, qNumber: int) -> Question:
         """Check if the Question Data is valid. Then parse it.
 
         The Question data is accessed from  `category.dataframe` via its number
@@ -322,7 +322,7 @@ class QuestionDB:
         question = QuestionTypeMapping[qtype].create(category, validData)
         if question.isParsed:
             locallogger.info("Question already parsed")
-            return None
+            return question
         if isinstance(question, NFQuestion):
             cls.nfParser.setup(question)
             locallogger.debug("setup a new NF parser ")
@@ -381,10 +381,9 @@ class QuestionDB:
             if hasattr(q, "variants") and q.variants is not None:
                 if variant == 0 or variant > q.variants:
                     dialog = QuestionVariantDialog(self.window, q)
-                    if dialog.exec() == QtWidgets.QDialog.Accepted:
+                    if dialog.exec() == QDialog.Accepted:
                         variant = dialog.variant
                         logger.debug("Die Fragen-Variante %s wurde gewählt", variant)
                     else:
                         logger.warning("Keine Fragenvariante wurde gewählt.")
-            q.assemble(variant=variant)
-            tree.append(q.element)
+            tree.append(q.getUpdatedElement(variant=variant))

{excel2moodle-0.5.1 → excel2moodle-0.6.0}/excel2moodle/core/globals.py

@@ -17,14 +17,9 @@ class TextElements(Enum):
     SPANRED = "span", "color: rgb(239, 69, 64)"
     SPANGREEN = "span", "color: rgb(152, 202, 62)"
     SPANORANGE = "span", "color: rgb(152, 100, 100)"
-    ULIST = (
-        "ul",
-        "",
-    )
-    LISTITEM = (
-        "li",
-        "text-align: left;",
-    )
+    ULIST = "ul", ""
+    LISTITEM = "li", "text-align: left;"
+    DIV = "div", ""
 
     def create(self, tag: str | None = None):
         if tag is None:

{excel2moodle-0.5.1 → excel2moodle-0.6.0}/excel2moodle/core/parser.py

@@ -1,9 +1,9 @@
 import logging
-import re
 
 import lxml.etree as ET
 
 import excel2moodle.core.etHelpers as eth
+from excel2moodle.core.bullets import BulletList
 from excel2moodle.core.exceptions import QNotParsedException
 from excel2moodle.core.globals import (
     Tags,
@@ -58,65 +58,19 @@ class QuestionParser:
             )
         return bool(self.question.picture.ready)
 
-    def setMainText(self) -> None:
-        paragraphs: list[ET._Element] = [TextElements.PLEFT.create()]
-        ET.SubElement(paragraphs[0], "b").text = f"ID {self.question.id}"
+    def getMainTextElement(self) -> ET.Element:
+        """Get the root question Text with the question paragraphs."""
+        textHTMLroot: ET._Element = ET.Element("div")
+        ET.SubElement(
+            ET.SubElement(textHTMLroot, "p"), "b"
+        ).text = f"ID {self.question.id}"
         text = self.rawInput[Tags.TEXT]
         for t in text:
-            paragraphs.append(TextElements.PLEFT.create())
-            paragraphs[-1].text = t
-        self.question.qtextParagraphs = paragraphs
+            par = TextElements.PLEFT.create()
+            par.text = t
+            textHTMLroot.append(par)
         self.logger.debug("Created main Text with: %s paragraphs", len(text))
-
-    def setBPoints(self) -> None:
-        """If there bulletPoints are set in the Spreadsheet it creates an unordered List-Element in ``Question.bulletList``."""
-        if Tags.BPOINTS in self.rawInput:
-            bps: list[str] = self.rawInput[Tags.BPOINTS]
-            try:
-                bulletList = self.formatBulletList(bps)
-            except IndexError:
-                msg = f"konnt Bullet Liste {self.question.id} nicht generieren"
-                raise QNotParsedException(
-                    msg,
-                    self.question.id,
-                    # exc_info=e,
-                )
-            self.logger.debug(
-                "Generated BPoint List: \n %s",
-                ET.tostring(bulletList, encoding="unicode"),
-            )
-            self.question.bulletList = bulletList
-
-    def formatBulletList(self, bps: list[str]) -> ET.Element:
-        self.logger.debug("Formatting the bulletpoint list")
-        name = []
-        var = []
-        quant = []
-        unit = []
-        unorderedList = TextElements.ULIST.create()
-        for item in bps:
-            sc_split = item.split()
-            name.append(sc_split[0])
-            var.append(sc_split[1])
-            quant.append(sc_split[3])
-            unit.append(sc_split[4])
-        for i in range(len(name)):
-            if re.fullmatch(r"{\w+}", quant[i]):
-                self.logger.debug("Got an variable bulletItem")
-                num_s = quant[i]
-            else:
-                self.logger.debug("Got a normal bulletItem")
-                num = quant[i].split(",")
-                if len(num) == 2:
-                    num_s = f"{num[0]!s},\\!{num[1]!s}~"
-                else:
-                    num_s = f"{num[0]!s},\\!0~"
-            bullet = TextElements.LISTITEM.create()
-            bullet.text = (
-                f"{name[i]}: \\( {var[i]} = {num_s} \\mathrm{{ {unit[i]}  }}\\)\n"
-            )
-            unorderedList.append(bullet)
-        return unorderedList
+        return textHTMLroot
 
     def appendToTmpEle(
         self,
@@ -148,7 +102,7 @@ class QuestionParser:
         """Parse the Question.
 
         Generates an new Question Element stored as ``self.tmpEle:ET.Element``
-        if no Exceptions are raised, ``self.tmpEle`` is passed to ``self.question.element``
+        if no Exceptions are raised, ``self.tmpEle`` is passed to ``question.element``
         """
         self.logger.info("Starting to parse")
         self.tmpEle: ET.Elemnt = ET.Element(
@@ -156,21 +110,39 @@ class QuestionParser:
         )
         self.appendToTmpEle(XMLTags.NAME, text=Tags.NAME, txtEle=True)
         self.appendToTmpEle(XMLTags.ID, text=self.question.id)
-        if self.hasPicture():
-            self.tmpEle.append(self.question.picture.element)
-        self.tmpEle.append(ET.Element(XMLTags.QTEXT, format="html"))
+        textRootElem = ET.Element(XMLTags.QTEXT, format="html")
+        mainTextEle = ET.SubElement(textRootElem, "text")
+        self.tmpEle.append(textRootElem)
         self.appendToTmpEle(XMLTags.POINTS, text=str(self.question.points))
         self._appendStandardTags()
         for feedb in self.genFeedbacks:
             self.tmpEle.append(eth.getFeedBEle(feedb))
+
+        self.htmlRoot = ET.Element("div")
+        self.htmlRoot.append(self.getMainTextElement())
+        if Tags.BPOINTS in self.rawInput:
+            bps: list[str] = self.rawInput[Tags.BPOINTS]
+            try:
+                bullets: BulletList = BulletList(bps, self.question.id)
+            except IndexError:
+                msg = f"konnt Bullet Liste {self.question.id} nicht generieren"
+                raise QNotParsedException(
+                    msg,
+                    self.question.id,
+                )
+            self.htmlRoot.append(bullets.element)
+            self.question.bulletList = bullets
+        if self.hasPicture():
+            self.htmlRoot.append(self.question.picture.htmlTag)
+            textRootElem.append(self.question.picture.element)
         ansList = self._parseAnswers()
-        self.setMainText()
-        self.setBPoints()
         if ansList is not None:
             for ele in ansList:
                 self.tmpEle.append(ele)
-        self.question.element = self.tmpEle
+        self.question._element = self.tmpEle
+        self.question.htmlRoot = self.htmlRoot
         self.question.isParsed = True
+        self.question.textElement = mainTextEle
         self.logger.info("Sucessfully parsed")
 
     def getFeedBEle(
@@ -195,7 +167,7 @@ class QuestionParser:
 
     def getNumericAnsElement(
         self,
-        result: float,
+        result: float = 0.0,
         fraction: float = 100,
         format: str = "moodle_auto_format",
     ) -> ET.Element: