pretext 2.33.2__py3-none-any.whl → 2.33.2.dev20251211064632__py3-none-any.whl

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/codechat.py

@@ -88,9 +88,7 @@ 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)
-    # 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()
+    lxml.ElementInclude.include(src_tree, loader=my_loader)
 
     # 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/project/__init__.py

@@ -128,8 +128,6 @@ 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(
@@ -370,9 +368,29 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
             if server.name not in self_server_names:
                 self.server.append(server)
 
-        # 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.
+        # 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."
+                )
 
     def source_abspath(self) -> Path:
         return self._project.source_abspath() / self.source
@@ -390,21 +408,14 @@ 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.
         """
-        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
+        assembled = core.assembly_internal(
+            xml=self.source_abspath(),
+            pub_file=self.publication_abspath().as_posix(),
+            stringparams=self.stringparams.copy(),
+            method="version",
+        )
+        return assembled.getroot()
 
     def publication_abspath(self) -> Path:
         return self._project.publication_abspath() / self.publication
@@ -671,16 +682,12 @@ 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:
-        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}")
+        if not utils.xml_syntax_is_valid(self.source_abspath()):
             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_validates_against_schema(self.source_element())
+        utils.xml_source_validates_against_schema(self.source_abspath())
 
         # Clean output upon request
         if clean:

pretext/resources/resource_hash_table.json

@@ -513,14 +513,14 @@
     "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"
+  "2.33.2.dev20251211064632": {
+    "project.ptx": "2ab72c22ee7e4c2fa44428c41b26f991ef457ac543886029473e400413b7dcfd",
+    "codechat_config.yaml": "2f22e90dbf76a7918556f7f0ba43dc7b503b02c15c246757b4a53e093c69d04e",
+    ".gitignore": "c34611fa875e15a57a1aeddaad5a403933ac179e83333f78cbf6dfb00900624f",
+    "devcontainer.json": "6674ef076ce8df47d288c59a366b59e0a01039c2195eb7aba99ca9eb7b751c34",
+    "pretext-cli.yml": "cbffb8d0663cefc11832ebcff190bdfea67ec7caf99faa00276b47aa188e684f",
+    "pretext-deploy.yml": "d9bfed1750deaf694651e4113f1b3c5215153b429460bd08b6b3c683857529fc",
+    "installPandoc.sh": "28e29981435545a4cea0ad2fc0df8603ad51a32181b12e40c253396cc02a655f",
+    "installSage.sh": "2504f9fad7cb557b4f5a653f48868f53a6fa1abf66ce43a3c052cc76129c3c52"
   }
 }

pretext/utils.py

@@ -12,7 +12,6 @@ import shutil
 import socketserver
 import socket
 import subprocess
-import time as time
 import logging
 import logging.handlers
 import psutil
@@ -204,13 +203,17 @@ def xml_syntax_is_valid(xmlfile: Path, root_tag: str = "pretext") -> bool:
     return True
 
 
-def xml_validates_against_schema(etree: _Element) -> bool:
+def xml_source_validates_against_schema(xmlfile: Path) -> 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)
@@ -219,7 +222,7 @@ def xml_validates_against_schema(etree: _Element) -> bool:
 
     # validate against schema
     try:
-        relaxng.assertValid(etree)
+        relaxng.assertValid(source_xml)
         log.info("PreTeXt source passed schema validation.")
     except ET.DocumentInvalid as err:
         log.debug(
@@ -1101,30 +1104,3 @@ 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.2.dist-info → pretext-2.33.2.dev20251211064632.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pretext
-Version: 2.33.2
+Version: 2.33.2.dev20251211064632
 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 (>=6,<7)
+Requires-Dist: lxml (>=5.3,<6.0)
 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.6,<0.5.0) ; extra == "prefigure" or extra == "all"
+Requires-Dist: prefig[text] (>=0.4.2,<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.2.dist-info → pretext-2.33.2.dev20251211064632.dist-info}/RECORD

@@ -1,7 +1,7 @@
-pretext/__init__.py,sha256=rdKC3UaZMCdyUlCVIDr981_MwUA2v31WySTuFcnnWlc,1453
+pretext/__init__.py,sha256=MkSLodjubtmL4pHXaPrwTyY3-YrIdvLYKkQBLCcKqtc,1453
 pretext/__main__.py,sha256=MSmt_5Xg84uHqzTN38JwgseJK8rsJn_11A8WD99VtEo,61
 pretext/cli.py,sha256=VkDFWViY4Wa8aYdXC4rIHaAEq5-UUuVZR4Pw8mqp1f0,40546
-pretext/codechat.py,sha256=7FCz_TLf8yVSG5doGRvJ0rrpShZEejtlZ3ZyaWJrm9I,6305
+pretext/codechat.py,sha256=SezcA7kn-_4lvWSXbqILV2shzA_77NDNx_LryJiD6lk,6164
 pretext/constants.py,sha256=cKxyUUy0SNX1M41CtJJtBpaHXTrKrZQPLrrbOJpCoU8,6843
 pretext/core/__init__.py,sha256=CmOXWPslsSiVzldc2UXNRug-xL8Ax601zGrp_3VhWxQ,739
 pretext/core/braille_format.py,sha256=ra1zVsyoUSUuGWCtY0VGF0FuEfHQ34oXtJvgKiiImdg,36377
@@ -46,20 +46,20 @@ pretext/plastex/tikzcd.jinja2,sha256=SwJvImtyumC0Xq-PJvfGeBPAGa8bR_T9U_i60pO3OkI
 pretext/plastex/tikzpicture.jinja2,sha256=uceZoDivG5sF6-ASG8j22pbZ4GoGQ88q8fd8ogjU3hw,94
 pretext/plastex/url.jinja2s,sha256=DPZEIzrET-rjYVlf-1zH41ESjpifUxXT5lu8Bxu_FO8,184
 pretext/plastex/wrapfig.jinja2s,sha256=3tDkMzNtuEfbAZy1MeHnlmGa4QXXVN1yhFbY3phrooc,96
-pretext/project/__init__.py,sha256=Q4Met0dWYgoIA-hma8xiJipbQU48zEeubQJ8-joXOqk,87058
+pretext/project/__init__.py,sha256=4VVE9EC3IwxT2NZGqDN6VX7iQWhP6mP-uJOPoBEd1RU,87640
 pretext/project/generate.py,sha256=Qn79ap89dSHKYhFUw494nkMVCN4qJUQjZBnJOhAbyqQ,9158
 pretext/project/xml.py,sha256=wtaXS2isRG6QlfyfNNccAbFt6Izwm7yxAledwd1Q6AA,3456
 pretext/resources/__init__.py,sha256=1qPohIxCtL1_sUtlAoFrWzhl31l-oFj4RrBBsb3RzQQ,4081
-pretext/resources/core.zip,sha256=IBJZV9q77c6ZDpjXjpcGxo7q4x3sI01iJTgEgRFuXXg,1755857
-pretext/resources/pelican.zip,sha256=ScKnN5XOjRPIa7TCjCltfDUvBY_cd0jZ4J6xVKri_4Q,15974
-pretext/resources/resource_hash_table.json,sha256=B-GVe8axjL6b__IwoFecwCf1xg3gE3HJ6IK2GsjHAmw,39049
-pretext/resources/rs_cache.zip,sha256=ZAQmE1TyCWHHQE_IotiZtvLx9Zen_LBIHCm2GuG71Ko,14935348
-pretext/resources/templates.zip,sha256=npNH6I3-YA3rcDVy8aZye1JPHnaB7_YFKoSp1oybjAM,375199
+pretext/resources/core.zip,sha256=6R6Xan0TvGcBK6Amw3JAJc4AuNx-3u5ZHJOnkz7MSlo,1755857
+pretext/resources/pelican.zip,sha256=nFxIefqpdIcxTcUxBmISh2NQhmY1X23iPm1gB5lmf_0,15974
+pretext/resources/resource_hash_table.json,sha256=MMqp4mvFElUcY7IMlW7UEssNNZ8F68BjacblhwqcLV0,39067
+pretext/resources/rs_cache.zip,sha256=ofrVSh_xABMk7vIi80SDkMe84HGXiNzhXixAhuUbFUA,14931427
+pretext/resources/templates.zip,sha256=tX6DFeemj3tjTK4VHRBjPelHWJeK1WBvgvcXyuwzRbg,381764
 pretext/server.py,sha256=B90NC6kevNeJNbwtUh3iVxF_BH5tiA4522XsjONsGSc,10800
 pretext/types.py,sha256=Eyyu6xmmCYnKBfvzBZzZMWZMa3yNjZ8NnGmlFGj9p5I,168
-pretext/utils.py,sha256=xAOsqcJo3Z6v3UlRbZeQN9nFWTNdhBpfUZ_BwqJFpio,45029
-pretext-2.33.2.dist-info/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-pretext-2.33.2.dist-info/METADATA,sha256=paSsUBe4zZDqb0pYBnW2RvFbkU-ckso_gEobYgACrBk,11474
-pretext-2.33.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-pretext-2.33.2.dist-info/entry_points.txt,sha256=L-rrQFUIWZhdOdu-XBQ9iuFK3X1cMVOtC-0I7T87II8,44
-pretext-2.33.2.dist-info/RECORD,,
+pretext/utils.py,sha256=9fwXBJorCsvQOE4NY2riDbSllPHsEWNJ01F7y_GCKJE,44064
+pretext-2.33.2.dev20251211064632.dist-info/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+pretext-2.33.2.dev20251211064632.dist-info/METADATA,sha256=K9v9TgER6GJYjl79BX5Am3tjLcpvTz8V-q-gexHio_I,11496
+pretext-2.33.2.dev20251211064632.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+pretext-2.33.2.dev20251211064632.dist-info/entry_points.txt,sha256=L-rrQFUIWZhdOdu-XBQ9iuFK3X1cMVOtC-0I7T87II8,44
+pretext-2.33.2.dev20251211064632.dist-info/RECORD,,