Merge branch 'main' into html_not_str

Author: schloerke

CHANGELOG.md

@@ -21,6 +21,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 * Exported `ReprHtml` protocol class. If an object has a `_repr_html_` method, then it is of instance `ReprHtml`. (#86)
 
+### Bug fixes
+
+* Fixed an issue with `HTMLTextDocument()` returning extracted `HTMLDependency()`s in a non-determistic order. (#95)
+
 ## [0.5.3] 2024-07-18
 
 * HTML tags in docstrings are now escaped. (#90)

htmltools/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.5.3"
+__version__ = "0.5.3.9000"
 
 from . import svg, tags
 from ._core import TagAttrArg  # pyright: ignore[reportUnusedImport] # noqa: F401

htmltools/_core.py

@@ -1219,19 +1219,24 @@ def _static_extract_serialized_html_deps(
         # HTMLdependency.get_tag_representation()
         pattern = r'<script type="application/json" data-html-dependency="">((?:.|\r|\n)*?)</script>'
         dep_strs = re.findall(pattern, html)
-        # Deduplicate dependencies. htmltools normally would dedupe dependencies, but
-        # with HTMLTextDocuments, the input HTML would usually have been generated by
-        # something else (like Quarto) and may not have the dependencies deduped.
-        dep_strs = list(set(dep_strs))
 
         # Remove the serialized HTML dependencies from the HTML string
         html = re.sub(pattern, "", html)
 
+        # Reconstitute the HTMLDependency objects
+        #
+        # Note: htmltools normally would dedupe dependencies, but
+        # with HTMLTextDocuments, the input HTML would usually have been generated by
+        # something else (like Quarto) and may not have the dependencies deduped.
+        seen_deps: set[str] = set()
         deps: list[HTMLDependency] = []
         for dep_str in dep_strs:
+            if dep_str in seen_deps:
+                continue
             args = json.loads(dep_str)
             dep = HTMLDependency(**args)
             deps.append(dep)
+            seen_deps.add(dep_str)
 
         return (html, deps)
 
@@ -1554,13 +1559,7 @@ def as_html_tags(
         Render the dependency as a ``TagList()``.
         """
         d = self.as_dict(lib_prefix=lib_prefix, include_version=include_version)
-        metas = [
-            Tag(
-                "meta",
-                **m,  # pyright: ignore[reportArgumentType]
-            )
-            for m in self.meta
-        ]
+        metas = [Tag("meta", **m) for m in d["meta"]]
         links = [Tag("link", **s) for s in d["stylesheet"]]
         scripts = [Tag("script", **s) for s in d["script"]]
         return TagList(*metas, *links, *scripts, self.head)

tests/test_html_document.py

@@ -322,9 +322,9 @@ def test_json_roundtrip():
             x_str, deps_replace_pattern='<meta data-foo="">'
         ).render()
 
-        # Make sure both deps are present.
-        assert "testdep" in [d.name for d in rendered["dependencies"]]
-        assert "testdep2" in [d.name for d in rendered["dependencies"]]
+        # Make sure both deps are present and in the order they appear in x_str.
+        assert "testdep2" == rendered["dependencies"][0].name
+        assert "testdep" == rendered["dependencies"][1].name
 
         # Make sure testdep was deduplicated by HTMLTextDocument().render().
         assert rendered["dependencies"].count(testdep) == 1