pretext 2.41.2__tar.gz → 2.41.3.dev20260609094354__tar.gz

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pretext
-Version: 2.41.2
+Version: 2.41.3.dev20260609094354
 Summary: A package to author, build, and deploy PreTeXt projects.
 Home-page: https://pretextbook.org
 License: GPL-3.0-or-later

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/__init__.py

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

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/cli.py

@@ -80,9 +80,48 @@ def nice_errors(f: Callable[..., None]) -> Any:
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
 
+_VERBOSITY_HELP = "Sets the severity of log messaging: DEBUG for all, INFO (default) for most, then WARNING, ERROR, and CRITICAL for decreasing verbosity."
+
+
+def set_log_level(
+    _ctx: click.Context, _param: click.Parameter, value: Optional[str]
+) -> None:
+    _ = (_ctx, _param)  # Click's callback protocol requires these; not used here.
+    if value:
+        log.setLevel(value.upper())
+
+
+class PreTeXtGroup(click.Group):
+    """Click Group that injects a -v/--verbosity option into every subcommand so that
+    `pretext build -v debug` works in addition to the canonical `pretext -v debug build`.
+    """
+
+    def command(self, *args: Any, **kwargs: Any) -> Any:
+        original_decorator = super().command(*args, **kwargs)
+
+        def decorator(f: Callable[..., Any]) -> Any:
+            f = click.option(
+                "--verbosity",
+                "-v",
+                default=None,
+                expose_value=False,
+                is_eager=True,
+                callback=set_log_level,
+                type=click.Choice(
+                    ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+                    case_sensitive=False,
+                ),
+                help=_VERBOSITY_HELP,
+            )(f)
+            return original_decorator(f)
+
+        return decorator
+
 
 #  Click command-line interface
-@click.group(invoke_without_command=True, context_settings=CONTEXT_SETTINGS)
+@click.group(
+    cls=PreTeXtGroup, invoke_without_command=True, context_settings=CONTEXT_SETTINGS
+)
 @click.pass_context
 # Allow a verbosity command:
 @click_log.simple_verbosity_option(
@@ -96,8 +135,13 @@ CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
     is_flag=True,
     help='Display list of build/view "targets" available in the project manifest.',
 )
+@click.option(
+    "--save-tmp-dirs",
+    is_flag=True,
+    help="Do not clean temporary directories after a build or generate.  Might be useful for debugging (previously calling -v debug would also save these directories).",
+)
 @nice_errors
-def main(ctx: click.Context, targets: bool) -> None:
+def main(ctx: click.Context, targets: bool, save_tmp_dirs: bool) -> None:
     """
     Command line tools for quickly creating, authoring, and building PreTeXt projects.
 
@@ -177,7 +221,7 @@ def main(ctx: click.Context, targets: bool) -> None:
             f"No project.ptx manifest found in current workspace.  Using global configuration specified in '~/.ptx/{VERSION}/project.ptx'."
         )
     # Add project to context so it can be used in subcommands
-    ctx.obj = {"project": project}
+    ctx.obj = {"project": project, "save_tmp_dirs": save_tmp_dirs}
 
 
 @main.result_callback()
@@ -552,6 +596,7 @@ def build(
     # Create a new project, apply overlay, and get target. Note, the CLI always finds changes to the root folder of the project, so we don't need to specify a path to the project.ptx file.
     # Use the project discovered in the main command.
     project = ctx.obj["project"]
+    save_tmp_dirs = ctx.obj.get("save_tmp_dirs", False)
 
     # Check to see whether target_name is a path to a file:
     if target_name and Path(target_name).is_file():
@@ -620,7 +665,11 @@ def build(
             for t in targets:
                 log.info(f"Generating assets for {t.name}")
                 t.generate_assets(
-                    only_changed=False, xmlid=xmlid, clean=clean, skip_cache=True
+                    only_changed=False,
+                    xmlid=xmlid,
+                    clean=clean,
+                    skip_cache=True,
+                    clean_tmp_dirs=not save_tmp_dirs,
                 )
             no_generate = True
         except Exception as e:
@@ -645,6 +694,7 @@ def build(
                 xmlid=xmlid,
                 no_knowls=no_knowls,
                 latex=latex,
+                clean_tmp_dirs=not save_tmp_dirs,
             )
             if t.format == "html" and t.compression is None:
                 log.info(
@@ -761,6 +811,7 @@ def generate(
         return
 
     project = ctx.obj["project"]
+    save_tmp_dirs = ctx.obj.get("save_tmp_dirs", False)
     # Now create the target if the target_name is not missing.
     try:
         target = project.get_target(name=target_name)
@@ -780,6 +831,7 @@ def generate(
             clean=clean,
             skip_cache=force,
             slow=slow,
+            clean_tmp_dirs=not save_tmp_dirs,
         )
         # Check if there are errors reported by the build by looking at the error_flush_handler.
         if utils.has_errors(error_flush_handler):

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/core/common.py

@@ -533,18 +533,28 @@ def get_output_filename(xml, out_file, dest_dir, suffix):
     return os.path.join(dest_dir, derivedname)
 
 
-def release_temporary_directories():
-    """Release scratch directories unless requesting debugging info"""
+def release_temporary_directories(any_log_level):
+    """
+    Release scratch directories unless requesting debugging info
+    - any_log_level: can be set to True by an external tool to force cleanup even if log level is set to debug (log.level == 10)
+    """
 
     global __temps
 
     # log.level is 10 for debug, greater for all other levels.
-    if log.level > 10:
-        for td in __temps:
-            log.info("Removing temporary directory {}".format(td))
-            # conservatively, raise exception on errors
-            shutil.rmtree(td, ignore_errors=False)
-            # reset list of temp direcotries to empty, to avoid duplicate requests
+    if log.level > 10 or any_log_level:
+        try:
+            for td in __temps:
+                log.info("Removing temporary directory {}".format(td))
+                # let a removal failure raise, so it is caught and reported below
+                shutil.rmtree(td, ignore_errors=False)
+                log.debug("Removed temporary directory {}".format(td))
+        except Exception as e:
+            log.warning("Failed to remove temporary directories, starting with {} (and maybe some others): {}".format(td, str(e)))
+        finally:
+            # always empty the list, even if a removal raised partway, so a
+            # long-running caller (e.g. a server process) does not accumulate
+            # stale entries; this also avoids duplicate removal requests
             __temps = []
     else:
         log.debug("Temporary directories left behind for inspection: {}".format(__temps))

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/core/webwork.py

@@ -624,7 +624,7 @@ def webwork_to_xml(
             ww_image_path, ww_image_filename = os.path.split(ww_image_full_path)
             # split the filename into (name, extension). extension can be empty or like '.png'.
             ww_image_name, image_extension = os.path.splitext(ww_image_filename)
-            # rename, eg, webwork-representations/webwork-5-image-3.png
+            # rename the image file to, e.g., webworkParentExerciseLabel-image-3.png
             ptx_image_name = problem + "-image-" + str(count)
             ptx_image_filename = ptx_image_name + image_extension
             if image_extension == ".tgz":

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/project/__init__.py

@@ -582,7 +582,7 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         ) as f:
             json.dump(asset_table, f)
 
-    def ensure_myopenmath_xml(self) -> None:
+    def ensure_myopenmath_xml(self, clean_tmp_dirs: bool = True) -> None:
         """
         Ensures that the myopenmath xml files are present if the source contains myopenmath exercises.  Needed to generate other "static" assets and targets.
         """
@@ -607,14 +607,16 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
                         f"MyOpenMath problem {prob_num} does not exist, generating"
                     )
                     self.generate_assets(
-                        requested_asset_types=["myopenmath"], only_changed=False
+                        requested_asset_types=["myopenmath"],
+                        only_changed=False,
+                        clean_tmp_dirs=clean_tmp_dirs,
                     )
                     # Only need to generate once a single missing file is discovered.
                     break
         else:
             log.debug("Source does not contain myopenmath problems")
 
-    def ensure_webwork_reps(self) -> None:
+    def ensure_webwork_reps(self, clean_tmp_dirs: bool = True) -> None:
         """
         Ensures that the webwork representation file is present if the source contains webwork problems.  This is needed to build or generate other assets.
         """
@@ -634,7 +636,9 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
                         f'At least one WeBWorK representation file (for webwork problem with id "{id}") does not exist, generating'
                     )
                     self.generate_assets(
-                        requested_asset_types=["webwork"], only_changed=False
+                        requested_asset_types=["webwork"],
+                        only_changed=False,
+                        clean_tmp_dirs=clean_tmp_dirs,
                     )
                     break
             else:
@@ -720,6 +724,7 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         xmlid: t.Optional[str] = None,
         no_knowls: bool = False,
         latex: bool = False,
+        clean_tmp_dirs: bool = True,
     ) -> None:
         # Add cli.version to stringparams.  Use only the major and minor version numbers.
         self.stringparams["cli.version"] = VERSION[: VERSION.rfind(".")]
@@ -744,11 +749,11 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         self.ensure_asset_directories()
 
         # verify that a webwork_representations.xml file exists if it is needed; generated if needed.
-        self.ensure_webwork_reps()
+        self.ensure_webwork_reps(clean_tmp_dirs=clean_tmp_dirs)
 
         # Generate needed assets unless requested not to.
         if generate:
-            self.generate_assets(xmlid=xmlid)
+            self.generate_assets(xmlid=xmlid, clean_tmp_dirs=clean_tmp_dirs)
 
         # Ensure the output directories exist.
         self.ensure_output_directory()
@@ -936,7 +941,7 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
                 log.critical(f"Unknown format {self.format}")
                 # Delete temporary directories left behind by core:
         try:
-            core.release_temporary_directories()
+            core.release_temporary_directories(any_log_level=clean_tmp_dirs)
         except Exception as e:
             log.error(
                 "Unable to release temporary directories.  Please report this error to pretext-support"
@@ -952,6 +957,7 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         clean: bool = False,
         skip_cache: bool = False,
         slow: bool = False,
+        clean_tmp_dirs: bool = True,
     ) -> None:
         """
         Generates assets for the current target.  Options:
@@ -1320,11 +1326,9 @@ class Target(pxml.BaseXmlModel, tag="target", search_mode=SearchMode.UNORDERED):
         #        log.debug(e, exc_info=True)
         # Delete temporary directories left behind by core:
         try:
-            core.release_temporary_directories()
+            core.release_temporary_directories(any_log_level=clean_tmp_dirs)
         except Exception as e:
-            log.error(
-                "Unable to release temporary directories.  Please report this error to pretext-support"
-            )
+            log.debug("Unable to release temporary directories.")
             log.debug(e, exc_info=True)
         # After all assets are generated, update the asset cache (but we shouldn't do this if we didn't generate any assets successfully)
         log.debug(f"Updated these assets successfully: {successful_assets}")

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pretext/resources/resource_hash_table.json

@@ -648,5 +648,14 @@
     "pretext-cli.yml": "709ecabfc8302bbdbbb9a06d10d8b9b6c3fd81c5ab2148d3e74d5f8fd60597f9",
     "pretext-deploy.yml": "133779603fcb4165d020fb473c6fe8b74d59b3ef9c556c17ec751321654cd111",
     "installPandoc.sh": "3ecee8f323703a5b249f7617abbca2c35db9a412471eaa91f5d51517bfc63aaf"
+  },
+  "2.41.3.dev20260609094354": {
+    "project.ptx": "a2c233b6d83e1e0e63b12325d731177b0f878580eb0bbcdaf766f7f0c7a6b634",
+    "codechat_config.yaml": "afcac12174cfff2eea97260a5aee54e6ebcf67dd357309db348557f9aed81554",
+    ".gitignore": "d63c34bdc2333143fb69f7c5d55212d07b3ce85c23ad37ee70476d99b9617721",
+    "devcontainer.json": "c5756c143f21bf44a9db4d51fb06bdc5f5d701967bbec510b99c0d98ea01a45b",
+    "pretext-cli.yml": "8a10efc684d81bf66eede76ea95ebb219aabd448602b0106dd7f17d3bdff2239",
+    "pretext-deploy.yml": "0ad3f9e428e9d25b22c7f1fe57cf49f5f092e079b46ac8fc4da1e6bd49f50028",
+    "installPandoc.sh": "2bbca356abefcbe9586cc3e3b5068d3fb41d4a1e2817e27cca6f30e2c3cb336e"
   }
 }

{pretext-2.41.2 → pretext-2.41.3.dev20260609094354}/pyproject.toml

@@ -11,7 +11,7 @@
 # ----------------
 [tool.poetry]
 name = "pretext"
-version = "2.41.2"
+version = "2.41.3.dev20260609094354"
 description = "A package to author, build, and deploy PreTeXt projects."
 readme = "README.md"
 homepage = "https://pretextbook.org"