render-engine 2025.9.1a2__tar.gz → 2025.10.1__tar.gz

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.9.1a2
+Version: 2025.10.1
 Summary: A Flexible Static Site Generator for Python
 Project-URL: homepage, https://github.com/render-engine/render-engine/
 Project-URL: repository, https://github.com/render-engine/render-engine/

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/docs/docs/page.md

@@ -63,17 +63,18 @@ When you create a page, you specify variables passed into rendering template.
 
 **Attributes:**
 
-| Name | Type | Description |
-| --- | --- | --- |
-| `content_path` | `str | None` |The path to the file that will be used to generate the Page's `content`. |
-| `extension` | `str | None` |The suffix to use for the page. Defaults to `.html`. |
-| `engine` | `str | None` | If present, the engine to use for rendering the page. **This is normally not set and the `Site` 's engine will be used.** |
-| `reference` | `str | None` |Used to determine how to reference the page in the `Site`'s route_list. Defaults to `slug`. |
-| `routes` | `str | None` |The routes to use for the page. Defaults to `["./"]`. |
-| `template` | `str | None` |The template used to render the page. If not provided, the `Site`'s `content`will be used. |
-| `Parser` | `type[BasePageParser]` |The parser to generate the page's `raw_content`. Defaults to `BasePageParser`. |
-| `title` | `str` |The title of the page. Defaults to the class name. |
-| `skip_site_map`    | `False` | When set to `True` the `Page` will not be included in the generated `SiteMap` |
+| Name | Type                     | Description                                                                                                                                  |
+| --- |--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| `content_path` | `str \| None`            | The path to the file that will be used to generate the Page's `content`.                                                                     |
+| `extension` | `str \| None`            | The suffix to use for the page. Defaults to `.html`.                                                                                         |
+| `engine` | `str \| None`            | If present, the engine to use for rendering the page. **This is normally not set and the `Site` 's engine will be used.**                    |
+| `reference` | `str \| None`            | Used to determine how to reference the page in the `Site`'s route_list. Defaults to `slug`.                                                  |
+| `routes` | `str \| None`            | The routes to use for the page. Defaults to `["./"]`.                                                                                        |
+| `template` | `str \| None`            | The template used to render the page. If not provided, the `Site`'s `content`will be used.                                                   |
+| `Parser` | `type[BasePageParser]`   | The parser to generate the page's `raw_content`. Defaults to `BasePageParser`.                                                               |
+| `title` | `str`                    | The title of the page. Defaults to the class name.                                                                                           |
+| `skip_site_map`    | `bool`                   | When set to `True` the `Page` will not be included in the generated `SiteMap`. Defaults to `False`.                                          |
+| `no_prerender` | `bool`           | When set to `True` the `Page`'s `content` will not be pre-rendered as a `Template` even if `{{ site_map }}` is present. Defaults to `False`. |
 
 ## About Page Attributes
 
@@ -109,8 +110,8 @@ By default Page._content will return the result of `Page.Parser.parse(Page.conte
 ### Accessing URLs for other pages in the site from within the page content
 
 In order to allow lookup of URLs for other pages within a Site the `content` of a page may be
-a template. If the `content` matches the pattern `{{.*?}}` we will render the `content` as a
-template prior to rendering the page itself.
+a template. If the `content` matches the pattern `{{.*?site_map.*?}}` we will render the `content` as a
+template prior to rendering the page itself unless the `no_prerender` attribute of the page is `True`.
 
 Example:
 

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/docs/docs/site_map.md

@@ -41,7 +41,7 @@ one found.
 The `SiteMap` object has an `html` property that will return an HTML sitemap with _absolute_ URLs with the
 `Site`'s `SITE_URL`.
 
-As a convenience, Render Engine will generate a site map page if the `Site` property of `render_site_map`
+As a convenience, Render Engine will generate a site map page if the `Site` property of `render_html_site_map`
 is `True` (it defaults to `False`.) Please note that this will not be templated. Should you wish the generated
 site map to be on a template you can add the following to your app:
 
@@ -53,7 +53,13 @@ class SiteMapPage(Page):
     skip_site_map = True
 ```
 
-Please note the `skip_site_map = True` to avoid having a self referential link to the site map.
+Please note the `skip_site_map = True` to avoid having a self-referential link to the site map.
+
+## Generating an XML site map
+
+To have your site generate an XML site map set the `render_xml_site_map` property of your `Site` object
+to `True` (defaults to `False`.) This will create the `site_map.xml` file in the root output directory
+of your site.
 
 ## The `SiteMapEntry` object
 

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine/page.py

@@ -1,3 +1,4 @@
+import logging
 import re
 from pathlib import Path
 from typing import Any
@@ -10,6 +11,8 @@ from render_engine.themes import ThemeManager
 from ._base_object import BaseObject
 from .plugins import PluginManager
 
+logger = logging.getLogger("Page")
+
 
 class BasePage(BaseObject):
     """
@@ -28,6 +31,8 @@ class BasePage(BaseObject):
         extension (str): The file extension for the page. Defaults to ".html".
         routes (list[str] | Path): The list of routes for the page. Defaults to ["./"].
         template (str | Template | None): The template to use for rendering the page.
+        site: The Site object that owns the page.
+        no_prerender: Flag to not prerender the content
     """
 
     extension: str = ".html"
@@ -36,7 +41,8 @@ class BasePage(BaseObject):
     rendered_content: str | None
     _reference: str = "_slug"
     plugin_manager: PluginManager | None
-    site = None
+    site = None  # This is a Site but circular imports so we can't actually type hint it.
+    no_prerender: bool = False
 
     @property
     def _content(self) -> any:
@@ -69,20 +75,35 @@ class BasePage(BaseObject):
             return f"/{route}/{self.path_name}"
 
     def _render_from_template(self, template: Template, **kwargs) -> str:
-        """Renders the page from a template."""
+        """
+        Renders the page from a template.
+
+        If the content looks like a template that
+
+        :param template: Template to render
+        :param **kwargs: Data to pass into the template for rendering.
+        :return: The rendered page
+        """
         template_data = {"data": self._data, "content": self._content}
         if site := getattr(self, "site", None):
             template_data["site_map"] = site.site_map
-        if isinstance(self._content, str) and re.search(r"{{.*}}", self._content):
+        if not self.no_prerender and isinstance(self._content, str) and re.search(r"{{.*?site_map.*?}}", self._content):
             # If the content looks like a template, try to render it.
-            content_template = Template(self._content)
-            template_data["content"] = content_template.render(
-                **{
-                    **self.to_dict(),
-                    **template_data,
-                    **kwargs,
-                }
-            )
+            try:
+                content_template = Template(self._content)
+            except Exception:
+                logger.info(f"Failed to parse {repr(self.path_name)} as a template.", exc_info=True)
+            else:
+                try:
+                    template_data["content"] = content_template.render(
+                        **{
+                            **self.to_dict(),
+                            **template_data,
+                            **kwargs,
+                        }
+                    )
+                except Exception:
+                    logger.info(f"Failed to pre-render {repr(self.path_name)}.", exc_info=True)
 
         return template.render(
             **{

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine/render_engine_templates/sitemap.xml

@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-{% for item in items %}
+{% for item in site_map %}
 {% include 'sitemap_item.xml' %}
+
 {% endfor %}
 </urlset>

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine/render_engine_templates/sitemap_item.xml

@@ -1,10 +1,10 @@
 <url>
-	<loc>{{SITE_URL}}/{{item}}</loc>
+	<loc>{{SITE_URL.rstrip("/")}}/{{item.url_for.lstrip("/")}}</loc>
 	{% if item.lastmod %}
 	<lastmod>{{item.lastmod}}</lastmod>
 	{% endif %}
 	{% if item.changefreq %}
-	<schangefreq>{{item.changefreq}}</changefreq>
+	<changefreq>{{item.changefreq}}</changefreq>
 	{% endif %}
 	{% if item.priority %}
 	<priority>{{item.priority}}</priority>

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine/site.py

@@ -21,7 +21,8 @@ class Site:
     Attributes:
         site_vars (dict): A dictionary containing site-wide variables and their values.
         plugin_settings (dict): A dictionary containing plugin settings.
-        render_site_map (bool): Whether to render the generated site map as a page.
+        render_html_site_map (bool): Whether to render the generated site map as an HTML page.
+        render_xml_site_map (bool): Whether to render the generated site map as XML.
 
     Methods:
         update_site_vars(**kwargs): Updates the site-wide variables with the given key-value pairs.
@@ -51,7 +52,8 @@ class Site:
     _template_path: str | Path = "templates"
     _static_paths: set = {"static"}
     plugin_settings: dict = {"plugins": defaultdict(dict)}
-    render_site_map: bool = False
+    render_html_site_map: bool = False
+    render_xml_site_map: bool = False
 
     def __init__(
         self,
@@ -253,7 +255,7 @@ class Site:
         with Progress() as progress:
             task_site_map = progress.add_task("Generating site map", total=1)
             self._site_map = SiteMap(self.route_list, self.site_vars.get("SITE_URL", ""))
-            if self.render_site_map:
+            if self.render_html_site_map:
 
                 @self.page
                 class SiteMapPage(Page):
@@ -262,6 +264,13 @@ class Site:
                     content = self._site_map.html
                     template = "page.html"
 
+            if self.render_xml_site_map:
+
+                @self.page
+                class SiteMapXml(Page):
+                    path_name = "site_map.xml"
+                    template = "sitemap.xml"
+
             progress.update(task_site_map, advance=1)
 
             pre_build_task = progress.add_task("Loading Pre-Build Plugins and Themes", total=1)

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine/site_map.py

@@ -22,7 +22,7 @@ class SiteMapEntry:
                 self._route = f"/{route.lstrip('/')}/{self.path_name}" if from_collection else f"/{self.path_name}"
                 self.entries = list()
             case Collection():
-                self._route = f"/{route.lstrip('/')}"
+                self._route = f"/{entry.routes[0].lstrip('/')}"
                 self.entries = [
                     SiteMapEntry(collection_entry, self._route, from_collection=True) for collection_entry in entry
                 ]
@@ -34,6 +34,10 @@ class SiteMapEntry:
         """The URL for the given entry"""
         return str(self._route)
 
+    def __str__(self) -> str:
+        """String representation of the entry as its URL"""
+        return self.url_for
+
 
 class SiteMap:
     """Site map"""
@@ -58,6 +62,12 @@ class SiteMap:
                 self._collections[sm_entry.slug] = sm_entry
         self.site_url = site_url
 
+    def __iter__(self):
+        """Iterator for the site map object"""
+        for entry in self._route_map.values():
+            yield entry
+            yield from entry.entries
+
     def find(
         self,
         value: str,
@@ -121,6 +131,8 @@ class SiteMap:
     def html(self) -> str:
         """Build the site map as HTML"""
         html_string = "<ul>\n"
+        # We can't iterate over `self` because that will flatten out the site map and we do not want that for the HTML
+        # version.
         for entry in self._route_map.values():
             html_string += f'\t<li><a href="{urljoin(self.site_url, entry.url_for)}">{entry.title}</a></li>\n'
             if entry.entries:

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/src/render_engine.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: render_engine
-Version: 2025.9.1a2
+Version: 2025.10.1
 Summary: A Flexible Static Site Generator for Python
 Project-URL: homepage, https://github.com/render-engine/render-engine/
 Project-URL: repository, https://github.com/render-engine/render-engine/

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/tests/test_page.py

@@ -1,3 +1,4 @@
+import logging
 import pathlib
 
 import jinja2
@@ -96,3 +97,71 @@ def test_rendered_page_from_template_has_data():
         data = [1, 2, 3, 4]
 
     assert CustomPage()._render_from_template(template=CustomPage.template) == "1234"
+
+
+def test_page_fails_to_render_content_as_template(caplog):
+    """Tests handling content that fails to render as a template"""
+    caplog.set_level(logging.INFO)
+
+    template = "{% for d in data %}{{d}}{% endfor %}\n{{content}}"
+
+    environment = jinja2.Environment(loader=jinja2.DictLoader({"test.html": template}))
+
+    class CustomPage(Page):
+        template = environment.get_template("test.html")
+        data = [1, 2, 3, 4]
+        content = "{{ site_map.find('test') }}"
+
+    assert CustomPage()._render_from_template(template=CustomPage.template) == "1234\n{{ site_map.find('test') }}"
+    assert "Failed to pre-render" in caplog.messages[0]
+
+
+def test_braces_ignored_without_sitemap():
+    """Tests that braces in content are ignored without `site_map`"""
+    template = "{% for d in data %}{{d}}{% endfor %}\n{{content}}"
+
+    environment = jinja2.Environment(loader=jinja2.DictLoader({"test.html": template}))
+
+    class CustomPage(Page):
+        template = environment.get_template("test.html")
+        data = [1, 2, 3, 4]
+        content = "{{ example }}"
+
+    assert CustomPage()._render_from_template(template=CustomPage.template) == "1234\n{{ example }}"
+
+
+def test_exception_in_parsing_content_as_template(monkeypatch, caplog):
+    """Test failing to parse content as template"""
+
+    def mock_template():
+        raise jinja2.exceptions.UndefinedError("Mocked error")
+
+    monkeypatch.setattr("render_engine.page.Template", mock_template)
+    caplog.set_level(logging.INFO)
+
+    template = "{% for d in data %}{{d}}{% endfor %}\n{{content}}"
+
+    environment = jinja2.Environment(loader=jinja2.DictLoader({"test.html": template}))
+
+    class CustomPage(Page):
+        template = environment.get_template("test.html")
+        data = [1, 2, 3, 4]
+        content = "{{ site_map.find('test') }}"
+
+    assert CustomPage()._render_from_template(template=CustomPage.template) == "1234\n{{ site_map.find('test') }}"
+    assert "Failed to parse" in caplog.messages[0]
+
+
+def test_no_prerender():
+    """Test pre-rendering does not occur when no_prerender is True"""
+    template = "{% for d in data %}{{d}}{% endfor %}\n{{content}}"
+
+    environment = jinja2.Environment(loader=jinja2.DictLoader({"test.html": template}))
+
+    class CustomPage(Page):
+        template = environment.get_template("test.html")
+        data = [1, 2, 3, 4]
+        content = "{{ site_map.find('test') }}"
+        no_prerender = True
+
+    assert CustomPage()._render_from_template(template=CustomPage.template) == "1234\n{{ site_map.find('test') }}"

{render_engine-2025.9.1a2 → render_engine-2025.10.1}/tests/test_site_map.py

@@ -60,7 +60,7 @@ def site(tmp_path_factory):
     for collection in ["coll1", "coll2"]:
 
         class MyColl(Collection):
-            routes = [collection]
+            routes = [f"{collection}-route"]
             pages = coll_pages[collection]
 
         collection_class = MyColl
@@ -82,19 +82,19 @@ def test_site_map_to_html(site):
     sm = SiteMap(site.route_list, "")
     assert sm.html == (
         "<ul>\n"
-        '\t<li><a href="/coll1">coll1</a></li>\n'
+        '\t<li><a href="/coll1-route">coll1</a></li>\n'
         "\t<ul>\n"
-        '\t\t<li><a href="/coll1/page0.html">coll1 -- Page 0</a></li>\n'
-        '\t\t<li><a href="/coll1/page1.html">coll1 -- Page 1</a></li>\n'
-        '\t\t<li><a href="/coll1/page2.html">coll1 -- Page 2</a></li>\n'
-        '\t\t<li><a href="/coll1/page3.html">coll1 -- Page 3</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page0.html">coll1 -- Page 0</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page1.html">coll1 -- Page 1</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page2.html">coll1 -- Page 2</a></li>\n'
+        '\t\t<li><a href="/coll1-route/page3.html">coll1 -- Page 3</a></li>\n'
         "\t</ul>\n"
-        '\t<li><a href="/coll2">coll2</a></li>\n'
+        '\t<li><a href="/coll2-route">coll2</a></li>\n'
         "\t<ul>\n"
-        '\t\t<li><a href="/coll2/page0.html">coll2 -- Page 0</a></li>\n'
-        '\t\t<li><a href="/coll2/page1.html">coll2 -- Page 1</a></li>\n'
-        '\t\t<li><a href="/coll2/page2.html">coll2 -- Page 2</a></li>\n'
-        '\t\t<li><a href="/coll2/page3.html">coll2 -- Page 3</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page0.html">coll2 -- Page 0</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page1.html">coll2 -- Page 1</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page2.html">coll2 -- Page 2</a></li>\n'
+        '\t\t<li><a href="/coll2-route/page3.html">coll2 -- Page 3</a></li>\n'
         "\t</ul>\n"
         '\t<li><a href="/page0.html">Page 0</a></li>\n'
         '\t<li><a href="/page1.html">Page 1</a></li>\n'
@@ -109,21 +109,21 @@ def test_site_map_to_html(site):
         ("page1", {}, "/page1.html"),
         ("page1", {"attr": "slug"}, "/page1.html"),
         ("page3", {"attr": "slug"}, None),
-        ("page3", {"attr": "slug", "full_search": True}, "/coll1/page3.html"),
-        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3", {"attr": "slug", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("page1.html", {"attr": "path_name"}, "/page1.html"),
         ("page3.html", {"attr": "path_name"}, None),
-        ("page3.html", {"attr": "path_name", "full_search": True}, "/coll1/page3.html"),
-        ("page3.html", {"attr": "path_name", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3.html", {"attr": "path_name", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3.html", {"attr": "path_name", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("page1", {"attr": "slug"}, "/page1.html"),
         ("page3", {"attr": "slug"}, None),
-        ("page3", {"attr": "slug", "full_search": True}, "/coll1/page3.html"),
-        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2/page3.html"),
+        ("page3", {"attr": "slug", "full_search": True}, "/coll1-route/page3.html"),
+        ("page3", {"attr": "slug", "collection": "coll2"}, "/coll2-route/page3.html"),
         ("Page 1", {"attr": "title"}, "/page1.html"),
         ("coll1 -- Page 3", {"attr": "title"}, None),
-        ("coll1 -- Page 3", {"attr": "title", "full_search": True}, "/coll1/page3.html"),
+        ("coll1 -- Page 3", {"attr": "title", "full_search": True}, "/coll1-route/page3.html"),
         ("coll1 -- Page 3", {"attr": "title", "collection": "coll2"}, None),
-        ("coll2 -- Page 3", {"attr": "title", "collection": "coll2"}, "/coll2/page3.html"),
+        ("coll2 -- Page 3", {"attr": "title", "collection": "coll2"}, "/coll2-route/page3.html"),
     ],
 )
 def test_site_map_search(site, value, params, expected):
@@ -137,4 +137,54 @@ def test_site_map_search(site, value, params, expected):
 
 def test_find_in_template(site):
     site.render()
-    assert (site.output_path / "page1.html").read_text() == "Page 1\n/coll1/page0.html"
+    assert (site.output_path / "page1.html").read_text() == "Page 1\n/coll1-route/page0.html"
+
+
+def test_site_map_to_xml(site):
+    site.render_xml_site_map = True
+    site.render()
+    assert (
+        (site.output_path / "site_map.xml").read_text()
+        == """<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+<url>
+	<loc>http://localhost:8000/coll1-route</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1-route/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1-route/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1-route/page2.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll1-route/page3.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2-route</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2-route/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2-route/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2-route/page2.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/coll2-route/page3.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page0.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page1.html</loc>
+</url>
+<url>
+	<loc>http://localhost:8000/page2.html</loc>
+</url>
+</urlset>"""
+    )