FIX: Fix stability of stored compiled regex (#1369)

larsoner · web-flow · commit 3fce549803d9 · 2024-08-07T09:53:28.000+10:00
diff --git a/sphinx_gallery/gen_gallery.py b/sphinx_gallery/gen_gallery.py
@@ -159,9 +159,11 @@ def _update_gallery_conf_exclude_implicit_doc(gallery_conf):
 
     This is separate function for better testability.
     """
-    # prepare regex for exclusions from implicit documentation
+    # prepare regex for exclusions from implicit documentation, ensuring that what
+    # gets complied has a stable __repr__ (i.e., by sorting the exclude_implicit_doc
+    # set before joining)
     exclude_regex = (
-        re.compile("|".join(gallery_conf["exclude_implicit_doc"]))
+        re.compile("|".join(sorted(gallery_conf["exclude_implicit_doc"])))
         if gallery_conf["exclude_implicit_doc"]
         else False
     )
diff --git a/sphinx_gallery/gen_rst.py b/sphinx_gallery/gen_rst.py
@@ -1347,7 +1347,7 @@ def generate_file_rst(fname, target_dir, src_dir, gallery_conf):
         script_blocks, script_vars, gallery_conf, file_conf
     )
 
-    logger.debug("%s ran in : %.2g seconds\n", src_file, time_elapsed)
+    logger.debug("%s ran in : %.2g seconds", src_file, time_elapsed)
 
     # Create dummy images
     _make_dummy_images(executable, file_conf, script_vars)

Original file line number	Diff line number	Diff line change
`@@ -1347,7 +1347,7 @@ def generate_file_rst(fname, target_dir, src_dir, gallery_conf):`
`1347`	`1347`	`script_blocks, script_vars, gallery_conf, file_conf`
`1348`	`1348`	`)`
`1349`	`1349`
`1350`		`- logger.debug("%s ran in : %.2g seconds\n", src_file, time_elapsed)`
	`1350`	`+ logger.debug("%s ran in : %.2g seconds", src_file, time_elapsed)`
`1351`	`1351`
`1352`	`1352`	`# Create dummy images`
`1353`	`1353`	`_make_dummy_images(executable, file_conf, script_vars)`