From 02aa354172713e02453bde9e080b91765037394a Mon Sep 17 00:00:00 2001
From: Josef Friedrich <josef@friedrich.rocks>
Date: Sat, 20 Jan 2024 16:05:27 +0100
Subject: [PATCH] Use new Xml class

---
 Makefile             |   2 +-
 mscxyz/lyrics.py     |  17 ++--
 mscxyz/meta.py       |  22 ++---
 mscxyz/score.py      |   6 +-
 mscxyz/style.py      |  15 +--
 mscxyz/utils.py      | 211 +------------------------------------------
 tests/test_lyrics.py |  10 +-
 tests/test_utils.py  |  47 ----------
 tox.ini              |   9 +-
 9 files changed, 46 insertions(+), 293 deletions(-)

diff --git a/Makefile b/Makefile
index 564c4c9..7eacfae 100644
--- a/Makefile
+++ b/Makefile
@@ -4,7 +4,7 @@ test:
 	poetry run tox
 
 test_quick: autocomplete
-	poetry run tox -e py310,format,docs,lint
+	poetry run tox -e quick,format,docs,lint
 
 test_real_binary:
 	pytest _test_real-binary.py
diff --git a/mscxyz/lyrics.py b/mscxyz/lyrics.py
index b83f12a..7d3d364 100644
--- a/mscxyz/lyrics.py
+++ b/mscxyz/lyrics.py
@@ -8,8 +8,6 @@
 import lxml.etree as etree
 from lxml.etree import _Element
 
-from mscxyz import utils
-
 if typing.TYPE_CHECKING:
     from mscxyz.score import Score
 
@@ -102,7 +100,9 @@ def remap(self, remap_string: str) -> None:
             new = pair.split(":")[1]
             for element in self.elements:
                 if element.no == int(old):
-                    utils.xml.find_safe(element.element, "no").text = str(int(new) - 1)
+                    self.score.xml.find_safe("no", element.element).text = str(
+                        int(new) - 1
+                    )
 
     def __extract_one_lyrics_verse(self, number: int, mscore: bool = False) -> None:
         """Extract a lyric verse by verse number.
@@ -116,9 +116,9 @@ def __extract_one_lyrics_verse(self, number: int, mscore: bool = False) -> None:
             tag = element.element
 
             if element.no != number:
-                utils.xml.remove(tag)
+                self.score.xml.remove(tag)
             elif number != 1:
-                utils.xml.set_text(tag, "no", 0)
+                self.score.xml.set_text("no", 0, tag)
 
         ext: str = "." + score.extension
         new_name: str = str(score.path).replace(ext, "_" + str(number) + ext)
@@ -174,8 +174,11 @@ def fix_lyrics_verse(self, verse_number: int) -> None:
         for element in self.elements:
             if element.no == verse_number:
                 tag: _Element = element.element
-                element_text: _Element = utils.xml.find_safe(tag, "text")
-                text = utils.xml.get_text_safe(element_text)
+                element_text: _Element = self.score.xml.find_safe(
+                    "text",
+                    tag,
+                )
+                text = self.score.xml.get_text_safe(element_text)
                 element_syllabic: _Element = etree.Element("syllabic")
                 append_syllabic: bool = True
                 if text.endswith("-"):
diff --git a/mscxyz/meta.py b/mscxyz/meta.py
index 2344eaa..cf612e7 100644
--- a/mscxyz/meta.py
+++ b/mscxyz/meta.py
@@ -179,19 +179,19 @@ def __init__(self, score: "Score") -> None:
         self.xml_root = score.xml_root
 
     def __get_element(self, field: str) -> _Element:
-        score_element: _Element = utils.xml.find_safe(self.xml_root, "Score")
-        element: _Element | None = utils.xml.xpath(
-            self.xml_root, '//metaTag[@name="' + field + '"]'
+        score_element: _Element = self.score.xml.find_safe("Score")
+        element: _Element | None = self.score.xml.xpath(
+            '//metaTag[@name="' + field + '"]'
         )
         if element is None:
-            element = utils.xml.create_sub_element(
+            element = self.score.xml.create_sub_element(
                 score_element, "metaTag", "", attrib={"name": field}
             )
         return element
 
     def __get_text(self, field: str) -> str | None:
         element: _Element | None = self.__get_element(field)
-        return utils.xml.get_text(element)
+        return self.score.xml.get_text(element)
 
     def __set_text(self, field: str, value: str | None) -> None:
         if value is None:
@@ -466,12 +466,12 @@ def __init__(self, score: "Score") -> None:
         self.xml_root = score.xml_root
         xpath = '/museScore/Score/Staff[@id="1"]'
 
-        vbox = utils.xml.xpath(self.xml_root, xpath + "/VBox")
+        vbox = self.score.xml.xpath(xpath + "/VBox")
         if vbox is None:
             vbox = lxml.etree.Element("VBox")
             height = lxml.etree.SubElement(vbox, "height")
             height.text = "10"
-            utils.xml.xpath_safe(self.xml_root, xpath).insert(0, vbox)
+            self.score.xml.xpath_safe(xpath).insert(0, vbox)
         self.vbox = vbox
 
     def __normalize_style_name(self, style: str) -> str:
@@ -532,17 +532,17 @@ def __create_text_element(self, style: str, text: str) -> None:
           ``Title`` or ``Composer`` or for v4 ``title`` or ``composer``.
         :param text: The string inside the ``<text>`` tags.
         """
-        text_element: _Element = utils.xml.create_element("Text")
+        text_element: _Element = self.score.xml.create_element("Text")
 
         if self.score.version_major in (2, 3):
             style = style.title()
         elif self.score.version_major == 4:
             style = style.lower()
 
-        utils.xml.create_sub_element(
+        self.score.xml.create_sub_element(
             text_element, "style", self.__normalize_style_name(style)
         )
-        utils.xml.create_sub_element(text_element, "text", text)
+        self.score.xml.create_sub_element(text_element, "text", text)
         self.vbox.append(text_element)
 
     def __set_text(self, style: str, text: str | None) -> None:
@@ -567,7 +567,7 @@ def __remove_text_element(self, style: str) -> None:
         :param style: The string inside the ``<style>`` tags, for example
           ``Title`` or ``Composer`` or for v4 ``title`` or ``composer``.
         """
-        utils.xml.remove(self.__get_element(style))
+        self.score.xml.remove(self.__get_element(style))
         return None
 
     # composer -> Composer
diff --git a/mscxyz/score.py b/mscxyz/score.py
index b96d23c..8340d44 100644
--- a/mscxyz/score.py
+++ b/mscxyz/score.py
@@ -259,7 +259,7 @@ def save(self, new_dest: str = "", mscore: bool = False) -> None:
                 "//StaffText/text",
                 "//Jump/continueAt",
             ):
-                x: list[_Element] | None = utils.xml.xpathall(self.xml_root, xpath)
+                x: list[_Element] | None = self.xml.xpathall(xpath)
                 if x:
                     for tag in x:
                         if not tag.text:
@@ -269,7 +269,7 @@ def save(self, new_dest: str = "", mscore: bool = False) -> None:
 
             if self.extension == "mscz":
                 xml_dest = self.xml_file
-            utils.xml.write(xml_dest, self.xml_root)
+            self.xml.write(xml_dest)
 
             # Since MuseScore 4 the style is stored in a separate file.
             if self.style_file:
@@ -277,7 +277,7 @@ def save(self, new_dest: str = "", mscore: bool = False) -> None:
                     "museScore", {"version": str(self.version)}
                 )
                 element.append(self.style.parent_element)
-                utils.xml.write(self.style_file, element)
+                self.xml.write(self.style_file, element)
 
             if self.extension == "mscz" and self.zip_container:
                 self.zip_container.save(dest)
diff --git a/mscxyz/style.py b/mscxyz/style.py
index a5d0fc6..b3258fd 100644
--- a/mscxyz/style.py
+++ b/mscxyz/style.py
@@ -128,8 +128,9 @@ def __init__(self, score: "Score") -> None:
         self.score = score
 
         if self.score.style_file:
-            self.parent_element = utils.xml.find_safe(
-                utils.xml.read(self.score.style_file), "Style"
+            self.parent_element = self.score.xml.find_safe(
+                "Style",
+                self.score.xml.parse_file(self.score.style_file),
             )
         else:
             element: _Element | None = self.score.xml_root.find("Score/Style")
@@ -313,8 +314,8 @@ def __get_text_style_element(self, name: str) -> _Element:
                 "This operation is only allowed for MuseScore 2 score files"
             )
 
-        child: _Element | None = utils.xml.xpath(
-            self.score.xml_root, f'//TextStyle/name[contains(., "{name}")]'
+        child: _Element | None = self.score.xml.xpath(
+            f'//TextStyle/name[contains(., "{name}")]'
         )
 
         if child is not None:
@@ -392,7 +393,7 @@ def get_all_fonts(self) -> list[tuple[str, str]]:
         output: list[tuple[str, str]] = []
         for element in self.parent_element:
             if "FontFace" in element.tag:
-                output.append((element.tag, utils.xml.get_text_safe(element)))
+                output.append((element.tag, self.score.xml.get_text_safe(element)))
         return output
 
     def print_all_font_faces(self) -> None:
@@ -519,7 +520,7 @@ def set_musical_text_font(self, font_face: str) -> StyleChanges:
         return self.set("musicalTextFont", font_face)
 
     def __set_parent_style_element(self, parent_style: _Element) -> None:
-        score_element: _Element = utils.xml.find_safe(self.score.xml_root, "Score")
+        score_element: _Element = self.score.xml.find_safe("Score")
         score_element.insert(0, parent_style)
         self.parent_element = parent_style
 
@@ -553,7 +554,7 @@ def load_styles_as_string(self, styles: str) -> None:
         self.__set_parent_style_element(style[0])
 
     def load_style_file(self, file: str | Path | TextIOWrapper) -> None:
-        style: _Element = utils.xml.read(file)
+        style: _Element = self.score.xml.parse_file(file)
         self.__set_parent_style_element(style[0])
 
     def reload(self, save: bool = False) -> Style:
diff --git a/mscxyz/utils.py b/mscxyz/utils.py
index 2677b82..f55acfb 100644
--- a/mscxyz/utils.py
+++ b/mscxyz/utils.py
@@ -8,9 +8,7 @@
 import string
 import subprocess
 import tempfile
-import typing
 import zipfile
-from io import TextIOWrapper
 from pathlib import Path
 from typing import Any, Generator, List, Literal, Optional
 
@@ -21,10 +19,6 @@
 
 from mscxyz.settings import get_args
 
-if typing.TYPE_CHECKING:
-    from lxml.etree import _DictAnyStr, _XPathObject
-
-
 ListExtension = Literal["mscz", "mscx", "both"]
 
 INCH = 25.4
@@ -272,209 +266,6 @@ def color(
         return text
 
 
-class xml:
-    @staticmethod
-    def read(path: str | Path | TextIOWrapper) -> _Element:
-        """
-        Read an XML file and return the root element.
-
-        :param path: The path to the XML file.
-        :return: The root element of the XML file.
-        """
-        return lxml.etree.parse(path).getroot()
-
-    @staticmethod
-    def tostring(element: _Element | _ElementTree) -> str:
-        """
-        Convert the XML element or tree to a string.
-
-        :param element: The XML element or tree to write.
-        :return: None
-        """
-        # maybe use: xml_declaration=True, pretty_print=True
-        # TestFileCompare not passing ...
-        return (
-            '<?xml version="1.0" encoding="UTF-8"?>\n'
-            + lxml.etree.tostring(element, encoding="UTF-8").decode("utf-8")
-            + "\n"
-        )
-
-    @staticmethod
-    def write(path: str | Path, element: _Element | _ElementTree) -> None:
-        """
-        Write the XML element or tree to the specified file.
-
-        :param path: The path to the file.
-        :param element: The XML element or tree to write.
-        :return: None
-        """
-        with open(path, "w") as document:
-            document.write(xml.tostring(element))
-
-    @staticmethod
-    def find_safe(element: _Element, path: str) -> _Element:
-        """
-        Find an element in the given XML element using the specified element path.
-
-        :param element: The XML element to search within.
-        :param path: The path to the desired element.
-        :return: The found element.
-        :raises ValueError: If the element is not found.
-        """
-        result: _Element | None = element.find(path)
-        if result is None:
-            raise ValueError(f"Path {path} not found in element {element}!")
-        return result
-
-    @staticmethod
-    def xpath(element: _Element, path: str) -> _Element | None:
-        """
-        Find the first matching element in the XML tree using XPath.
-
-        :param element: The root element of the XML tree.
-        :param path: The XPath expression to search for.
-        :return: The first matching element or None if no match is found.
-        """
-        output: list[_Element] | None = xml.xpathall(element, path)
-        if output and len(output) > 0:
-            return output[0]
-
-        return None
-
-    @staticmethod
-    def xpath_safe(element: _Element, path: str) -> _Element:
-        """
-        Safely retrieves the first matching XML element using the given XPath expression.
-
-        :param element: The XML element to search within.
-        :param path: The XPath expression to match elements.
-        :return: The first matching XML element.XPath
-        :raises ValueError: If more than one element is found matching the XPath expression.
-        """
-        output: list[_Element] = xml.xpathall_safe(element, path)
-        if len(output) > 1:
-            raise ValueError(
-                f"XPath “{path}” found more than one element in {element}!"
-            )
-        return output[0]
-
-    @staticmethod
-    def xpathall(element: _Element, path: str) -> list[_Element] | None:
-        """
-        Returns a list of elements matching the given XPath expression.
-
-        :param element: The XML element to search within.
-        :param path: The XPath expression to match elements.
-        :return: A list of elements matching the XPath expression, or None if no
-          elements are found.
-        """
-        result: _XPathObject = element.xpath(path)
-        output: list[_Element] = []
-
-        if isinstance(result, list):
-            for item in result:
-                if isinstance(item, _Element):
-                    output.append(item)
-
-        if len(output) > 0:
-            return output
-
-        return None
-
-    @staticmethod
-    def xpathall_safe(element: _Element, path: str) -> list[_Element]:
-        """
-        Safely retrieves a list of elements matching the given XPath expression within
-        the specified element.
-
-        :param element: The XML element to search within.
-        :param path: The XPath expression to match elements.
-        :return: A list of elements matching the XPath expression.
-        :raises ValueError: If the XPath expression is not found in the element.
-        """
-        output: list[_Element] | None = xml.xpathall(element, path)
-        if output is None:
-            raise ValueError(f"XPath “{path}” not found in element {element}!")
-        return output
-
-    @staticmethod
-    def get_text(element: _Element | None) -> str | None:
-        """
-        Get the text content of an XML element.
-
-        :param element: The XML element.
-        :return: The text content of the XML element, or None if the element is None.
-        """
-        if element is None:
-            return None
-        if element.text is None:
-            return None
-        return element.text
-
-    @staticmethod
-    def get_text_safe(element: _Element | None) -> str:
-        """
-        Safely retrieves the text content from an XML element.
-
-        :param element: The XML element to retrieve the text from.
-        :return: The text content of the element.
-        :raises ValueError: If the element is None or has no text content.
-        """
-        if element is None or element.text is None:
-            raise ValueError(f"Element {element} has no text!")
-        return element.text
-
-    @staticmethod
-    def set_text(element: _Element, path: str, value: str | int | float) -> None:
-        """
-        Set the text value of an XML element at the specified element path.
-
-        :param element: The XML element to modify.
-        :param path: The element path expression to locate the target element.
-        :param value: The new value to set for the element's text.
-        :return: None
-        """
-        xml.find_safe(element, path).text = str(value)
-
-    @staticmethod
-    def replace(old: _Element, new: _Element) -> None:
-        parent: _Element | None = old.getparent()
-        if parent is not None:
-            parent.replace(old, new)
-
-    @staticmethod
-    def remove(element: _Element | None) -> None:
-        """
-        Remove the given element from its parent.
-
-        :param element: The element to be removed.
-        """
-        if element is None:
-            return None
-
-        parent: _Element | None = element.getparent()
-        if parent is None:
-            return None
-
-        parent.remove(element)
-
-    @staticmethod
-    def create_element(tag_name: str) -> _Element:
-        return lxml.etree.Element(tag_name)
-
-    @staticmethod
-    def create_sub_element(
-        parent: _Element,
-        tag_name: str,
-        text: Optional[str] = None,
-        attrib: Optional[_DictAnyStr] = None,
-    ) -> _Element:
-        element: _Element = lxml.etree.SubElement(parent, tag_name, attrib=attrib)
-        if text:
-            element.text = text
-        return element
-
-
 class PathChanger:
     path: Path
 
@@ -557,7 +348,7 @@ def __init__(self, abspath: str | Path) -> None:
         container_info: _ElementTree = lxml.etree.parse(
             self.tmp_dir / "META-INF" / "container.xml"
         )
-        root_files: _XPathObject = container_info.xpath("/container/rootfiles")
+        root_files = container_info.xpath("/container/rootfiles")
         if isinstance(root_files, list):
             for root_file in root_files[0]:
                 if isinstance(root_file, _Element):
diff --git a/tests/test_lyrics.py b/tests/test_lyrics.py
index 1169d23..a0c579a 100644
--- a/tests/test_lyrics.py
+++ b/tests/test_lyrics.py
@@ -7,7 +7,7 @@
 import pytest
 
 import mscxyz
-from mscxyz import Score, utils
+from mscxyz import Score
 from tests import helper
 from tests.helper import Cli
 
@@ -90,10 +90,10 @@ def test_fix_legacy(self, version: int) -> None:
             tag = element.element
             tag_text = tag.find("text")
 
-            text.append(utils.xml.get_text_safe(tag_text))
+            text.append(score.xml.get_text_safe(tag_text))
             tag_syllabic = tag.find("syllabic")
 
-            syllabic_text = utils.xml.get_text(tag_syllabic)
+            syllabic_text = score.xml.get_text(tag_syllabic)
             if syllabic_text:
                 syllabic.append(syllabic_text)
 
@@ -145,10 +145,10 @@ def test_fix(self, version: int) -> None:
             tag = element.element
             tag_text = tag.find("text")
 
-            text.append(utils.xml.get_text_safe(tag_text))
+            text.append(score.xml.get_text_safe(tag_text))
             tag_syllabic = tag.find("syllabic")
 
-            syllabic_text = utils.xml.get_text(tag_syllabic)
+            syllabic_text = score.xml.get_text(tag_syllabic)
             if syllabic_text:
                 syllabic.append(syllabic_text)
 
diff --git a/tests/test_utils.py b/tests/test_utils.py
index 6066bcd..5924351 100644
--- a/tests/test_utils.py
+++ b/tests/test_utils.py
@@ -3,12 +3,9 @@
 
 import os
 import tempfile
-from pathlib import Path
 from typing import Optional
 from unittest import mock
 
-import lxml
-import lxml.etree
 import pytest
 
 from mscxyz import utils
@@ -119,50 +116,6 @@ def test_function(self, popen: mock.Mock, get_mscore_bin: mock.Mock) -> None:
 root = helper.get_xml_root("simple.mscz", 4)
 
 
-def test_find_safe() -> None:
-    element = utils.xml.find_safe(root, ".//Score")
-    assert element.tag == "Score"
-
-
-def test_xpath() -> None:
-    element = utils.xml.xpath(root, ".//xxxxxxx")
-    assert element is None
-
-
-class TestXpathSave:
-    def test_xpath_safe(self) -> None:
-        element = utils.xml.xpath_safe(root, ".//Score")
-        assert element.tag == "Score"
-
-    def test_xpath_safe_raise(self) -> None:
-        with pytest.raises(ValueError) as e:
-            utils.xml.xpath_safe(root, ".//metaTag")
-        assert "XPath “.//metaTag” found more than one element in" in e.value.args[0]
-
-
-def test_xpathall() -> None:
-    element = utils.xml.xpathall(root, ".//xxxxxxx")
-    assert element is None
-
-
-def test_xpathall_safe() -> None:
-    element = utils.xml.xpathall_safe(root, ".//metaTag")
-    assert isinstance(element, list)
-    assert len(element) == 16
-
-
-def test_xml_write(tmp_path: Path) -> None:
-    dest = tmp_path / "test.xml"
-    element = lxml.etree.XML("<root><a><b/><c/></a><d><e/></d></root>")
-    utils.xml.write(dest, element)
-    result: str = utils.read_file(dest)
-    print(result)
-    assert result == (
-        '<?xml version="1.0" encoding="UTF-8"?>\n'
-        "<root><a><b/><c/></a><d><e/></d></root>\n"
-    )
-
-
 class TestClassDimension:
     def test_exception(self) -> None:
         with pytest.raises(ValueError):
diff --git a/tox.ini b/tox.ini
index 0a2ee55..c09e0ec 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,16 +1,21 @@
 [tox]
-envlist = py{39,310,311,312}, format, docs, lint
+envlist = py{39,310,311,312}, format, docs, lint, quick
 isolated_build = True
 
 [testenv]
 deps =
     pytest==7.4.4
-commands = pytest
+commands = pytest -m "not slow"
 passenv =
     XDG_RUNTIME_DIR
     DISPLAY
     XAUTHORITY
 
+[testenv:quick]
+basepython = python3.9
+commands =
+    pytest -m "not (slow or legacy)"
+
 [testenv:format]
 deps =
     ruff==0.1.9