cleanups

Author: adhami3310

reflex/app.py

@@ -25,6 +25,7 @@
     Callable,
     Coroutine,
     Dict,
+    Mapping,
     MutableMapping,
     Type,
     get_args,
@@ -87,7 +88,7 @@
     replace_brackets_with_keywords,
     verify_route_validity,
 )
-from reflex.sitemap import generate_sitemaps, read_sitemap_file
+from reflex.sitemap import PageConfig, generate_sitemaps, read_sitemap_file
 from reflex.state import (
     BaseState,
     RouterData,
@@ -412,7 +413,7 @@ class App(MiddlewareMixin, LifespanMixin):
     # Put the toast provider in the app wrap.
     toaster: Component | None = dataclasses.field(default_factory=toast.provider)
 
-    _sitemap_properties: Dict[str, Dict] = dataclasses.field(default_factory=dict)
+    _sitemap_properties: Dict[str, PageConfig] = dataclasses.field(default_factory=dict)
 
     @property
     def api(self) -> FastAPI | None:
@@ -715,8 +716,7 @@ def add_page(
             image: The image to display on the page.
             on_load: The event handler(s) that will be called each time the page load.
             meta: The metadata of the page.
-            sitemap_priority: The priority of the page in the sitemap. If None, the priority is calculated based on the
-            depth of the route.
+            sitemap_priority: The priority of the page in the sitemap. If None, the priority is calculated based on the depth of the route.
             sitemap_changefreq: The change frequency of the page in the sitemap. Default to 'weekly'
             context: Values passed to page for custom page-specific logic.
 
@@ -819,9 +819,15 @@ def _compile_page(self, route: str, save_page: bool = True):
         if save_page:
             self._pages[route] = component
 
-    def get_sitemap_properties(self) -> Dict[str, Dict]:
-        """Get the sitemap properties."""
-        return self._sitemap_properties
+    def get_sitemap_properties(self) -> Mapping[str, PageConfig]:
+        """Get the sitemap properties.
+
+        Returns:
+            The sitemap properties.
+        """
+        return {
+            route: value.copy() for route, value in self._sitemap_properties.items()
+        }
 
     def get_load_events(self, route: str) -> list[IndividualEventType[()]]:
         """Get the load events for a route.

reflex/sitemap.py

@@ -1,7 +1,7 @@
 """This module contains functions to generate and manage the sitemap.xml file."""
 
 from pathlib import Path
-from typing import Dict, List
+from typing import Dict, List, TypedDict
 from xml.dom import minidom
 from xml.etree.ElementTree import Element, SubElement, tostring
 
@@ -61,7 +61,14 @@ def generate_xml(links: List[Dict[str, str]]) -> str:
     return reparsed.toprettyxml(indent="  ")
 
 
-def generate_sitemaps(sitemap_config: Dict[str, Dict[str, str]]) -> None:
+class PageConfig(TypedDict):
+    """TypedDict for page configuration in sitemap."""
+
+    priority: float
+    changefreq: str
+
+
+def generate_sitemaps(sitemap_config: Dict[str, PageConfig]) -> None:
     """Generate the sitemap.xml file.
 
     This function generates the sitemap.xml file by crawling through the available pages in the app and generating a list
@@ -76,7 +83,7 @@ def generate_sitemaps(sitemap_config: Dict[str, Dict[str, str]]) -> None:
 
 
 def generate_links_for_sitemap(
-    sitemap_config: Dict[str, Dict[str, str]],
+    sitemap_config: Dict[str, PageConfig],
 ) -> List[dict[str, str]]:
     """Generate a list of links for which sitemaps are generated.
 

tests/units/test_app.py

@@ -352,8 +352,12 @@ def test_add_duplicate_page_route_error(app, first_page, second_page, route):
         app.add_page(second_page, route="/" + route.strip("/") if route else None)
 
 
-def test_add_page_with_sitemap_properties(app):
-    """Test if the sitemap properties of the app instance is set properly or not."""
+def test_add_page_with_sitemap_properties(app: App):
+    """Test if the sitemap properties of the app instance is set properly or not.
+
+    Args:
+        app: The app to test.
+    """
     # check with given values.
     app.add_page(
         page1, route="/page1", sitemap_priority=0.9, sitemap_changefreq="daily"

tests/units/test_sitemap.py

@@ -4,7 +4,7 @@
 import pytest
 
 import reflex as rx
-from reflex import Component, constants
+from reflex import constants
 from reflex.app import App
 from reflex.sitemap import (
     generate_links_for_sitemap,
@@ -23,42 +23,45 @@
 
 @pytest.fixture
 def app_instance():
-    """Fixture to create an instance of the app."""
+    """Fixture to create an instance of the app.
+
+    Returns:
+        An instance of the App class.
+    """
     app = App()
     return app
 
 
-class Page(Component):
-    """A simple Page component."""
+def page(text: str):
+    """A simple page component for testing.
 
-    def __init__(self, text, **kwargs):
-        """Initialize the Page component."""
-        super().__init__(**kwargs)
-        self.text = text
+    Args:
+        text: The text to display on the page.
 
-    def render(self):
-        """Render the Page component."""
-        return rx.box(self.text)
+    Returns:
+        A Reflex component with the given text.
+    """
+    return rx.box(text)
 
 
 @pytest.fixture
-def index_page() -> Page:
+def index_page():
     """Fixture that returns an IndexPage instance.
 
     Returns:
         An instance of IndexPage.
     """
-    return Page(text="Index")
+    return page(text="Index")
 
 
 @pytest.fixture
-def about_page() -> Page:
+def about_page():
     """Fixture that returns an AboutPage instance.
 
     Returns:
         An instance of AboutPage.
     """
-    return Page(text="About")
+    return page(text="About")
 
 
 mock_xml = """<?xml version="1.0" ?>
@@ -89,7 +92,13 @@ def test_generate_xml():
 
 
 def test_generate_static_sitemaps(app_instance, index_page, about_page):
-    """Test if the generated sitemap file is currently stored in static website or not."""
+    """Test if the generated sitemap file is currently stored in static website or not.
+
+    Args:
+        app_instance: The app instance.
+        index_page: The index page fixture.
+        about_page: The about page fixture.
+    """
     pages = {"index": index_page, "about": about_page}
     # remove the sitemap.xml file if it exists.
     sitemap_file_path.unlink(missing_ok=True)
@@ -107,12 +116,12 @@ def test_generate_links_for_sitemap():
     """Test if the links are generated correctly for the sitemap from the sitemap config file when no deploy url is
     given.
     """
-    sitemap_properties = {
-        "index": {"priority": 0.9, "changefreq": "weekly"},
-        "about": {"priority": 0.9, "changefreq": "weekly"},
-    }
-
-    links = generate_links_for_sitemap(sitemap_properties)
+    links = generate_links_for_sitemap(
+        {
+            "index": {"priority": 0.9, "changefreq": "weekly"},
+            "about": {"priority": 0.9, "changefreq": "weekly"},
+        }
+    )
 
     # Assert that the links are generated correctly
     assert links == [
@@ -129,15 +138,15 @@ def test_generate_links_for_sitemap_deploy_url():
     """Test if the links are generated correctly for the sitemap from the sitemap config file when a deploy url is
     given.
     """
-    sitemap_properties = {
-        "index": {"priority": 0.9, "changefreq": "weekly"},
-        "about": {"priority": 0.9, "changefreq": "weekly"},
-    }
-
     with unittest.mock.patch("reflex.sitemap.get_config") as mock_get_config:
         mock_get_config().deploy_url = "http://www.google.com"
 
-        links = generate_links_for_sitemap(sitemap_properties)
+        links = generate_links_for_sitemap(
+            {
+                "index": {"priority": 0.9, "changefreq": "weekly"},
+                "about": {"priority": 0.9, "changefreq": "weekly"},
+            }
+        )
 
         # Assert that the links are generated correctly
         assert links == [