feat: deprecate use_thread

widgetti · Dec 23, 2024 · 5e49cc6 · 5e49cc6
1 parent 6328ea7
commit 5e49cc6
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 3 deletions.
diff --git a/solara/hooks/use_thread.py b/solara/hooks/use_thread.py
@@ -7,13 +7,14 @@
 
 import solara
 from solara.datatypes import Result, ResultState
-from solara.util import cancel_guard, nullcontext
+from solara.util import cancel_guard, nullcontext, deprecated
 
 SOLARA_ALLOW_OTHER_TRACER = os.environ.get("SOLARA_ALLOW_OTHER_TRACER", False) in (True, "True", "true", "1")
 T = TypeVar("T")
 logger = logging.getLogger("solara.hooks.use_thread")
 
 
+@deprecated("use_thread is deprecated, use use_task or Task instead")
 def use_thread(
     callback: Union[
         Callable[[threading.Event], T],

diff --git a/solara/util.py b/solara/util.py
@@ -11,6 +11,7 @@
 from pathlib import Path
 from typing import TYPE_CHECKING, Dict, List, Optional, Tuple, Union
 from urllib.parse import urlencode
+import warnings
 
 if TYPE_CHECKING:
     import numpy as np
@@ -346,3 +347,25 @@ def wrapper():
         return return_value
 
     return wrapper
+
+
+def deprecated(reason: str):
+    """
+    Mark functions as deprecated.
+    """
+
+    def decorator(func):
+        @functools.wraps(func)
+        def wrapped(*args, **kwargs):
+            warnings.simplefilter("always", DeprecationWarning)
+            warnings.warn(
+                reason,
+                category=DeprecationWarning,
+                stacklevel=2,  # this way we show the line where the function is called
+            )
+            warnings.simplefilter("default", DeprecationWarning)
+            return func(*args, **kwargs)
+
+        return wrapped
+
+    return decorator
diff --git a/solara/website/pages/documentation/api/hooks/use_thread.md b/solara/website/pages/documentation/api/hooks/use_thread.md
@@ -1,4 +1,6 @@
-# use_thread
+# use_thread (deprecated)
+
+### use_thread is deprecated, use [use_task](/documentation/components/lab/use_task) or [Task](/documentation/components/lab/task) instead
 
 ```python
 def use_thread(

diff --git a/solara/website/pages/documentation/api/hooks/use_thread.py b/solara/website/pages/documentation/api/hooks/use_thread.py
@@ -6,7 +6,7 @@
 from solara.alias import rw
 
 HERE = Path(__file__).parent
-title = "use_thread"
+title = "use_thread (deprecated)"
 __doc__ = open(HERE / "use_thread.md").read()