best effort to deprecate page

Author: adhami3310

reflex/istate/data.py

@@ -6,7 +6,7 @@
 from urllib.parse import _NetlocResultMixinStr, urlsplit
 
 from reflex import constants
-from reflex.utils import format
+from reflex.utils import console, format
 from reflex.utils.serializers import serializer
 
 
@@ -195,10 +195,25 @@ class RouterData:
 
     session: SessionData = dataclasses.field(default_factory=SessionData)
     headers: HeaderData = dataclasses.field(default_factory=HeaderData)
-    page: PageData = dataclasses.field(default_factory=PageData)
+    _page: PageData = dataclasses.field(default_factory=PageData)
     url: ReflexURL = dataclasses.field(default=ReflexURL(""))
     route_id: str = ""
 
+    @property
+    def page(self) -> PageData:
+        """Get the page data.
+
+        Returns:
+            The PageData object.
+        """
+        console.deprecate(
+            "RouterData.page",
+            "Use RouterData.url instead",
+            deprecation_version="0.8.1",
+            removal_version="0.9.0",
+        )
+        return self._page
+
     @classmethod
     def from_router_data(cls, router_data: dict) -> "RouterData":
         """Create a RouterData object from the given router_data.
@@ -212,10 +227,29 @@ def from_router_data(cls, router_data: dict) -> "RouterData":
         return cls(
             session=SessionData(router_data),
             headers=HeaderData(router_data),
-            page=PageData(router_data),
+            _page=PageData(router_data),
             url=ReflexURL(
                 router_data.get(constants.RouteVar.HEADERS, {}).get("origin", "")
                 + router_data.get(constants.RouteVar.ORIGIN, "")
             ),
             route_id=router_data.get(constants.RouteVar.PATH, ""),
         )
+
+
+@serializer(to=dict)
+def serialize_router_data(obj: RouterData) -> dict:
+    """Serialize a RouterData object to a dict.
+
+    Args:
+        obj: the RouterData object.
+
+    Returns:
+        A dict representation of the RouterData object.
+    """
+    return {
+        "session": obj.session,
+        "headers": obj.headers,
+        "page": obj._page,
+        "url": obj.url,
+        "route_id": obj.route_id,
+    }

reflex/state.py

@@ -1204,15 +1204,15 @@ def setup_dynamic_args(cls, args: dict[str, str]):
 
         def argsingle_factory(param: str):
             def inner_func(self: BaseState) -> str:
-                return self.router.page.params.get(param, "")
+                return self.router._page.params.get(param, "")
 
             inner_func.__name__ = param
 
             return inner_func
 
         def arglist_factory(param: str):
             def inner_func(self: BaseState) -> list[str]:
-                return self.router.page.params.get(param, [])
+                return self.router._page.params.get(param, [])
 
             inner_func.__name__ = param
 
@@ -2466,7 +2466,7 @@ def on_load_internal(self) -> list[Event | EventSpec | event.EventCallback] | No
         """
         # Do not app._compile()!  It should be already compiled by now.
         load_events = prerequisites.get_and_validate_app().app.get_load_events(
-            self.router.page.path
+            self.router._page.path
         )
         if not load_events:
             self.is_hydrated = True

tests/units/test_app.py

@@ -1475,7 +1475,7 @@ def test_app_state_determination():
     assert a3._state is None
 
     # Referencing router enables state.
-    a3.add_page(rx.box(rx.text(State.router.page.full_path)), route="/")
+    a3.add_page(rx.box(rx.text(State.router._page.full_path)), route="/")
     a3._compile_page("index")
     assert a3._state is not None
 

tests/units/test_state.py

@@ -936,19 +936,19 @@ def test_get_client_ip(test_state, router_data):
 
 
 def test_get_current_page(test_state):
-    assert test_state.router.page.path == ""
+    assert test_state.router._page.path == ""
 
     route = "mypage/subpage"
     test_state.router = RouterData.from_router_data({RouteVar.PATH: route})
-    assert test_state.router.page.path == route
+    assert test_state.router._page.path == route
 
 
 def test_get_query_params(test_state):
-    assert test_state.router.page.params == {}
+    assert test_state.router._page.params == {}
 
     params = {"p1": "a", "p2": "b"}
     test_state.router = RouterData.from_router_data({RouteVar.QUERY: params})
-    assert dict(test_state.router.page.params) == params
+    assert dict(test_state.router._page.params) == params
 
 
 def test_add_var():
@@ -3289,7 +3289,7 @@ class RouterVarDepState(RouterVarParentState):
 
         @rx.var
         def foo(self) -> str:
-            return self.router.page.params.get("foo", "")
+            return self.router._page.params.get("foo", "")
 
     foo = RouterVarDepState.computed_vars["foo"]
     State._init_var_dependency_dicts()