Deprecation decorators for functions

pyproject.toml

@@ -41,6 +41,7 @@ dependencies = [
     "posthog",
     "pyyaml",
     "platformdirs",
+    "deprecation"
 ]
 
 [project.urls]

src/pybamm/expression_tree/symbol.py

@@ -15,6 +15,7 @@
 import pybamm
 from pybamm.util import import_optional_dependency
 from pybamm.expression_tree.printing.print_name import prettify_print_name
+from deprecation import deprecated
 
 if TYPE_CHECKING:  # pragma: no cover
     import casadi
@@ -356,6 +357,12 @@ def domain(self, domain):
         )
 
     @property
+    @deprecated(
+        deprecated_in="25.1.0",
+        removed_in="26.0.0",
+        current_version=pybamm.__version__,
+        details="Use `symbol.domains` instead.",
+    )
     def auxiliary_domains(self):
         """Returns auxiliary domains."""
         raise NotImplementedError(
@@ -994,6 +1001,12 @@ def create_copy(
         children = self._children_for_copying(new_children)
         return self.__class__(self.name, children, domains=self.domains)
 
+    @deprecated(
+        deprecated_in="25.1.0",
+        removed_in="26.0.0",
+        current_version=pybamm.__version__,
+        details="Use `create_copy` instead.",
+    )
     def new_copy(
         self,
         new_children: list[Symbol] | None = None,

src/pybamm/simulation.py

@@ -8,7 +8,7 @@
 from datetime import timedelta
 import pybamm.telemetry
 from pybamm.util import import_optional_dependency
-
+from deprecation import deprecated
 from pybamm.expression_tree.operations.serialise import Serialise
 
 
@@ -171,6 +171,12 @@ def _set_random_seed(self):
                 % (2**32)
             )
 
+    @deprecated(
+        deprecated_in="25.1.0",
+        removed_in="26.0.0",
+        current_version=pybamm.__version__,
+        details="pybamm.simulation.set_up_and_parameterise_experiment is deprecated and not meant to be accessed by users.",
+    )
     def set_up_and_parameterise_experiment(self, solve_kwargs=None):
         msg = "pybamm.simulation.set_up_and_parameterise_experiment is deprecated and not meant to be accessed by users."
         warnings.warn(msg, DeprecationWarning, stacklevel=2)
@@ -254,6 +260,12 @@ def _set_up_and_parameterise_experiment(self, solve_kwargs=None):
                 parameterised_model
             )
 
+    @deprecated(
+        deprecated_in="25.1.0",
+        removed_in="26.0.0",
+        current_version=pybamm.__version__,
+        details="pybamm.set_parameters is deprecated and not meant to be accessed by users.",
+    )
     def set_parameters(self):
         msg = (
             "pybamm.set_parameters is deprecated and not meant to be accessed by users."