UserParam: Add deprecation warning for UserSettableParameter

projectmesa · May 27, 2022 · 241924d · 241924d
1 parent b3cf839
commit 241924d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/mesa/visualization/UserParam.py b/mesa/visualization/UserParam.py
@@ -1,4 +1,6 @@
 from numbers import Number
+from warnings import warn
+
 
 NUMBER = "number"
 CHECKBOX = "checkbox"
@@ -65,6 +67,13 @@ def __init__(
         choices=None,
         description=None,
     ):
+
+        warn(
+            "UserSettableParameter is deprecated in favor of UserParam objects "
+            "such as Slider, Checkbox, Choice, StaticText, NumberInput. "
+            "See the examples folder for how to use them. "
+            "UserSettableParameter will be removed in the next major release."
+        )
         if choices is None:
             choices = list()
         if param_type not in self.TYPES:

diff --git a/tests/test_usersettableparam.py b/tests/test_usersettableparam.py
@@ -5,7 +5,7 @@
     Checkbox,
     Choice,
     StaticText,
-    NumberInput
+    NumberInput,
 )