From 68664a5094e0cd8a070702a392e41c7f7d45c848 Mon Sep 17 00:00:00 2001 From: Elijah Ahianyo Date: Wed, 4 Oct 2023 21:15:37 +0000 Subject: [PATCH] Deprecate set_cookie and set_local_storage (#1917) --- reflex/components/base/script.py | 2 +- reflex/event.py | 12 ++++++++++++ reflex/utils/console.py | 2 +- reflex/vars.py | 6 ++++++ 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/reflex/components/base/script.py b/reflex/components/base/script.py index 714e9cd08..cbb5cf9b8 100644 --- a/reflex/components/base/script.py +++ b/reflex/components/base/script.py @@ -90,7 +90,7 @@ def client_side(javascript_code) -> Var[EventChain]: """ console.deprecate( feature_name="rx.client_side", - reason="Replaced by rx.call_script, which can be used from backend EventHandler too", + reason="and has been replaced by rx.call_script, which can be used from backend EventHandler too", deprecation_version="0.2.9", removal_version="0.2.10", ) diff --git a/reflex/event.py b/reflex/event.py index 0e81c5951..c3eb30ad5 100644 --- a/reflex/event.py +++ b/reflex/event.py @@ -330,6 +330,12 @@ def set_cookie(key: str, value: str) -> EventSpec: Returns: EventSpec: An event to set a cookie. """ + console.deprecate( + feature_name=f"rx.set_cookie", + reason="and has been replaced by rx.Cookie, which can be used as a state var", + deprecation_version="0.2.9", + removal_version="0.2.10", + ) return server_side( "_set_cookie", get_fn_signature(set_cookie), @@ -366,6 +372,12 @@ def set_local_storage(key: str, value: str) -> EventSpec: Returns: EventSpec: An event to set a key-value in local storage. """ + console.deprecate( + feature_name=f"rx.set_local_storage", + reason="and has been replaced by rx.LocalStorage, which can be used as a state var", + deprecation_version="0.2.9", + removal_version="0.2.10", + ) return server_side( "_set_local_storage", get_fn_signature(set_local_storage), diff --git a/reflex/utils/console.py b/reflex/utils/console.py index ce426c991..4159407d5 100644 --- a/reflex/utils/console.py +++ b/reflex/utils/console.py @@ -120,7 +120,7 @@ def deprecate( kwargs: Keyword arguments to pass to the print function. """ msg = ( - f"{feature_name} has been deprecated in version {deprecation_version} {reason}. It will be completely " + f"{feature_name} has been deprecated in version {deprecation_version} {reason.rstrip('.')}. It will be completely " f"removed in {removal_version}" ) if _LOG_LEVEL <= LogLevel.WARNING: diff --git a/reflex/vars.py b/reflex/vars.py index 6d805dbb6..e6026d921 100644 --- a/reflex/vars.py +++ b/reflex/vars.py @@ -1461,6 +1461,12 @@ def get_local_storage(key: Var | str | None = None) -> BaseVar: Raises: TypeError: if the wrong key type is provided. """ + console.deprecate( + feature_name=f"rx.get_local_storage", + reason="and has been replaced by rx.LocalStorage, which can be used as a state var", + deprecation_version="0.2.9", + removal_version="0.2.10", + ) if key is not None: if not (isinstance(key, Var) and key.type_ == str) and not isinstance(key, str): type_ = type(key) if not isinstance(key, Var) else key.type_