pretext 2.33.1.dev20251210064446__tar.gz → 2.33.2__tar.gz

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pretext
-Version: 2.33.1.dev20251210064446
+Version: 2.33.2
 Summary: A package to author, build, and deploy PreTeXt projects.
 Home-page: https://pretextbook.org
 License: GPL-3.0-or-later
@@ -24,12 +24,12 @@ Requires-Dist: click-log (>=0.4,<0.5)
 Requires-Dist: coloraide (>=4,<5)
 Requires-Dist: ghp-import (>=2,<3)
 Requires-Dist: jinja2 (>=3,<4)
-Requires-Dist: lxml (>=5.3,<6.0)
+Requires-Dist: lxml (>=6,<7)
 Requires-Dist: pdfCropMargins (>=1.0.9,<1.1.0)
 Requires-Dist: pelican[markdown] (>=4.10,<5.0) ; extra == "homepage" or extra == "all"
 Requires-Dist: plastex (>=3,<4)
 Requires-Dist: playwright (>=1,<2)
-Requires-Dist: prefig[text] (>=0.4.2,<0.5.0) ; extra == "prefigure" or extra == "all"
+Requires-Dist: prefig[text] (>=0.4.6,<0.5.0) ; extra == "prefigure" or extra == "all"
 Requires-Dist: psutil (>=7,<8)
 Requires-Dist: pyMuPDF (>=1.24,<2.0)
 Requires-Dist: pydantic-xml (==2.14.3)

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pretext/__init__.py

@@ -19,7 +19,7 @@ from single_version import get_version
 VERSION = get_version("pretext", Path(__file__).parent.parent)
 
 
-CORE_COMMIT = '1c97959297d51749717f9b34ce5da131c960b92d'
+CORE_COMMIT = "1c97959297d51749717f9b34ce5da131c960b92d"
 
 
 def activate() -> None:

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pretext/codechat.py

@@ -88,7 +88,9 @@ def map_path_to_xml_id(
     # Load the XML, performing xincludes using this loader.
     huge_parser = ET.XMLParser(huge_tree=True)
     src_tree = ET.parse(_xml, parser=huge_parser)
-    lxml.ElementInclude.include(src_tree, loader=my_loader)
+    # Previously, we used the following line instead of .xinclude(), but that no longer seems to work in 6.0 lxml.
+    # lxml.ElementInclude.include(src_tree, loader=my_loader)
+    src_tree.xinclude()
 
     # Walk though every element with an xml ID. Note: the type stubs don't have the ``iterfind`` method, hence the ignore in the next line.
     for elem in src_tree.iterfind(f".//*[@{xml_id_attrib}]"):  # type: ignore

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pretext/project/__init__.py

@@ -128,6 +128,8 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
     #
     # A path to the root source for this target, relative to the project's `source` path.
     source: Path = pxml.attr(default=Path("main.ptx"))
+    # Cache of assembled source element.
+    _source_element: t.Optional[ET._Element] = None
     # A path to the publication file for this target, relative to the project's `publication` path. This is mostly validated by `post_validate`.
     publication: Path = pxml.attr(default=None)
     latex_engine: LatexEngine = pxml.attr(
@@ -368,29 +370,9 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
             if server.name not in self_server_names:
                 self.server.append(server)
 
-        # For the Runestone format, determine the `<document-id>`, which specifies the `output_dir`.
-        if self.format == Format.HTML and self.platform == Platform.RUNESTONE:
-            # We expect `d_list ==  ["document-id contents here"]`.
-            d_list = self.source_element().xpath("/pretext/docinfo/document-id/text()")
-            if isinstance(d_list, list):
-                if len(d_list) != 1:
-                    raise ValueError(
-                        "Only one `document-id` tag is allowed in a PreTeXt document."
-                    )
-                # NB as of 2025-04-08, we are no longer setting the output directory automatically for
-                # Runestone targets.  This must be managed by the project.ptx file or by a client script.
-                # The commented code below is how we used to do this.
-
-                # d = d_list[0]
-                # assert isinstance(d, str)
-                # # Use the correct number of `../` to undo the project's `output-dir`, so the output from the build is located in the correct directory of `published/document-id`.
-                # self.output_dir = Path(
-                #    f"{'../'*len(self._project.output_dir.parents)}published/{d}"
-                # )
-            else:
-                raise ValueError(
-                    "The `document-id` tag must be defined for the Runestone format."
-                )
+        # NB as of 2025-04-08, we are no longer setting the output directory automatically for
+        # Runestone targets.  This must be managed by the project.ptx file or by a client script.
+        # Check history here for how that was done.
 
     def source_abspath(self) -> Path:
         return self._project.source_abspath() / self.source
@@ -408,14 +390,21 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
     def source_element(self) -> ET._Element:
         """
         Returns the root element for the assembled source, after processing with the "version-only" assembly.
+        Caches the result for future calls.
         """
-        assembled = core.assembly_internal(
-            xml=self.source_abspath(),
-            pub_file=self.publication_abspath().as_posix(),
-            stringparams=self.stringparams.copy(),
-            method="version",
-        )
-        return assembled.getroot()
+        if self._source_element is None:
+            log.debug(
+                f"Parsing source element for target {self.name}",
+            )
+            self._source_element = core.assembly_internal(
+                xml=self.source_abspath(),
+                pub_file=self.publication_abspath().as_posix(),
+                stringparams=self.stringparams.copy(),
+                method="version",
+            ).getroot()
+        else:
+            log.debug(f"Using cached source_element for target {self.name}")
+        return self._source_element
 
     def publication_abspath(self) -> Path:
         return self._project.publication_abspath() / self.publication
@@ -682,12 +671,16 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         self.stringparams["cli.version"] = VERSION[: VERSION.rfind(".")]
 
         # Check for xml syntax errors and quit if xml invalid:
-        if not utils.xml_syntax_is_valid(self.source_abspath()):
+        try:
+            # Access the source_element to trigger assembly if it hasn't been done yet.
+            self.source_element()
+        except Exception as e:
+            log.error(f"Error assembling source file: {e}")
             raise RuntimeError("XML syntax for source file is invalid")
         if not utils.xml_syntax_is_valid(self.publication_abspath(), "publication"):
             raise RuntimeError("XML syntax for publication file is invalid")
         # Validate xml against schema; continue with warning if invalid:
-        utils.xml_source_validates_against_schema(self.source_abspath())
+        utils.xml_validates_against_schema(self.source_element())
 
         # Clean output upon request
         if clean:

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pretext/resources/resource_hash_table.json

@@ -503,14 +503,24 @@
     "installPandoc.sh": "410a4ef5ab8e6acb2ca06d250878e61e44e85331a9871c93bca31ea052dfd5df",
     "installSage.sh": "77b4ce12661071605ff48729ef84df1333d9e09e71e7b05e2cd6ef0fe95afa2f"
   },
-  "2.33.1.dev20251210064446": {
-    "project.ptx": "b7e04a13a58a300bb5c05bd43a81e558a326546827a403b7aa94408b33da47d1",
-    "codechat_config.yaml": "25a78ee644c31ebfa8a5df42ceca3b37d8baa4a97232baee0b54d6e4252cd589",
-    ".gitignore": "80af0856f9cbe7fd22606fa7a77b845a8303022367c955a8fb7ac9c2266db2ba",
-    "devcontainer.json": "53f05afcaae27ec4db24c829a2d98d2785bd32d022dfaaf9a13915331750a9ff",
-    "pretext-cli.yml": "ff4362c86ea52c5745b3d104ad95de1fe398329834612e64b8d29c142e4b246d",
-    "pretext-deploy.yml": "4a2e574935caaba462efe09ec8e2e1b6dee19a9e7da0c34910eee7b46e5abdb2",
-    "installPandoc.sh": "c8440c5eeefa521beae96d6484cca750d5096562315ab8ef4e55144ba94c9f93",
-    "installSage.sh": "b4cdce1dc196a83a7937154905ae8e25fafd1265241cee28839c42cbea59c16b"
+  "2.33.1": {
+    "project.ptx": "1fcb1aa1f15f78f9e58a9fbf88922a6b938ade35b70093e1a0ef78bf69f2c38f",
+    "codechat_config.yaml": "0963c6d7fa76fa4b5ea2f77cc858f0cacbb34651a703fc2fa760203887b62946",
+    ".gitignore": "abb4cc703620c8bc7cbd85469f3934a99a880b36aa0b432b72cab404f284f697",
+    "devcontainer.json": "a8a60dcf33d1f266a05b535b291225eb438fa532204d261568afd25b167c7851",
+    "pretext-cli.yml": "b2d3f4d4026d84bdabe78947690b9a0165f9bc3b79d5cec62aa3a473a904dc41",
+    "pretext-deploy.yml": "031198662ff32c0c368fd8bae0a99ff540fae02598c9ca0b4f8e9ea62579acc6",
+    "installPandoc.sh": "3d4ee0fe164575e7f17dda651c12570f12fed3e042ca4739edd5bbfcaaec5c24",
+    "installSage.sh": "e9682f35f46c2faf5c062b679fd2e17d9767098022b5f10164b8c4e5439544a9"
+  },
+  "2.33.2": {
+    "project.ptx": "08f992b2f4b2420bf9c3002deb8b4a2be8d6fc90ce770eb5bf47437859db10f7",
+    "codechat_config.yaml": "78634ed0c6f14bd1df9aaf7b29c73ff0f5cae126898179381549b6d7b00cb8b5",
+    ".gitignore": "d62ea9ea215f605c430ffcedeb33b81e808490a94c6d30cabbbefdf3a4de1ae8",
+    "devcontainer.json": "94ea6ba7e57b238543d39b2997142d52792fefaf543064184485f2a851f75348",
+    "pretext-cli.yml": "2d6fc8ad7efbf30ce061feb5c387a89d9e9cae3663e17ece9842d50a1bf14fa2",
+    "pretext-deploy.yml": "fe66cd20fb2bfb52b1cf01228a99a203829691dd173b7995c317180fdfcf3f09",
+    "installPandoc.sh": "a18b850870b5e2d744c99300c0643f12a81eba3e27dfd985927554af2062c967",
+    "installSage.sh": "8020b532e1101c77c5681c0dfaff308a36c60e95db6b0f652bf230f7de216cb8"
   }
 }

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pretext/utils.py

@@ -12,6 +12,7 @@ import shutil
 import socketserver
 import socket
 import subprocess
+import time as time
 import logging
 import logging.handlers
 import psutil
@@ -203,17 +204,13 @@ def xml_syntax_is_valid(xmlfile: Path, root_tag: str = "pretext") -> bool:
     return True
 
 
-def xml_source_validates_against_schema(xmlfile: Path) -> bool:
+def xml_validates_against_schema(etree: _Element) -> bool:
     # get path to RelaxNG schema file:
     schemarngfile = resources.resource_base_path() / "core" / "schema" / "pretext.rng"
 
     # Open schemafile for validation:
     relaxng = ET.RelaxNG(file=schemarngfile)
 
-    # Parse xml file:
-    source_xml = ET.parse(xmlfile)
-    source_xml.xinclude()
-
     # just for testing
     # ----------------
     # relaxng.validate(source_xml)
@@ -222,7 +219,7 @@ def xml_source_validates_against_schema(xmlfile: Path) -> bool:
 
     # validate against schema
     try:
-        relaxng.assertValid(source_xml)
+        relaxng.assertValid(etree)
         log.info("PreTeXt source passed schema validation.")
     except ET.DocumentInvalid as err:
         log.debug(
@@ -1104,3 +1101,30 @@ def rs_methods(
             f"PTX-BUG: Format {format} not recognized for running ext_rs_methods.  Something is wrong with the pretext script."
         )
     return None
+
+
+class Stopwatch:
+    """A simple stopwatch class for measuring elapsed time."""
+
+    """print_log set to false disables logging of elapsed time """
+
+    def __init__(self, name: str = "", print_log: bool = True):
+        self.name = name
+        self.print_log = print_log
+        self.start_time = time.time()
+        self.last_log_time = self.start_time
+
+    def reset(self) -> None:
+        """Reset the log timer to the current time."""
+        self.last_log_time = time.time()
+
+    def log(self, timepoint_description: str = "") -> None:
+        """Print a log message with the elapsed time since the last log event."""
+        if self.print_log:
+            cur_time = time.time()
+            elapsed_time = cur_time - self.start_time
+            since_last_log_time = cur_time - self.last_log_time
+            self.reset()
+            log.debug(
+                f"** Timing report from {self.name}: {timepoint_description}, {since_last_log_time:.2f}s since last watch reset. {elapsed_time:.2f}s total elapsed time."
+            )

{pretext-2.33.1.dev20251210064446 → pretext-2.33.2}/pyproject.toml

@@ -11,7 +11,7 @@
 # ----------------
 [tool.poetry]
 name = "pretext"
-version = "2.33.1.dev20251210064446"
+version = "2.33.2"
 description = "A package to author, build, and deploy PreTeXt projects."
 readme = "README.md"
 homepage = "https://pretextbook.org"
@@ -27,7 +27,7 @@ include = ["pretext/core/pretext.py", "pretext/core/braille_format.py", "pretext
 # ------------
 [tool.poetry.dependencies]
 python = "^3.10"
-lxml = "^5.3"
+lxml = "^6"
 requests = "^2"
 GitPython = "^3"
 click = "^8"
@@ -45,7 +45,7 @@ plastex = "^3"
 jinja2 = "^3"
 coloraide = "^4"
 pelican = { extras = ["markdown"], version = "^4.10", optional = true }
-prefig = { extras = ["text"], version = "^0.4.2", optional = true }
+prefig = { extras = ["text"], version = "^0.4.6", optional = true }
 citeproc-py = "^0"