laipeng/reflex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Deprecate set_cookie and set_local_storage (#1917)

Browse Source
This commit is contained in:
Elijah Ahianyo 2023-10-04 21:15:37 +00:00 committed by GitHub
parent 58933278ad
commit 68664a5094
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 20 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
reflex/components/base/script.py
View File

@ -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",
)

12
reflex/event.py
View File

@ -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),

2
reflex/utils/console.py
View File

@ -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:

6
reflex/vars.py
View File

@ -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_