deprecated: Apply functools.wrap to retain meta-data of wrapped function

opcode81 · Mar 2, 2024 · 25ea617 · 25ea617
1 parent a8b69b7
commit 25ea617
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,7 +4,7 @@
 
 ### Improvements/Changes
 
-* `utils.cache`:
+* `util.cache`:
   * Add new base class `KeyValueCache` alongside `PersistentKeyValueCache`
   * Add `InMemoryKeyValueCache`
   * Implement `PickleCached` via nested functions instead of a class to improve IDE support 
@@ -15,6 +15,7 @@
   * `MultiDataEvaluationUtil`: Add option to supply test data (without using splitting)
 * `dft`:
   * `DFTNormalisation.RuleTemplate`: Add attributes `fit` and `array_valued`
+* `util.deprecation`: Apply `functools.wrap` to retain meta-data of wrapped function
 
 ### Fixes
 

diff --git a/src/sensai/util/deprecation.py b/src/sensai/util/deprecation.py
@@ -1,6 +1,6 @@
 import warnings
 import logging
-
+from functools import wraps
 
 log = logging.getLogger(__name__)
 
@@ -13,6 +13,7 @@ def deprecated(message):
     :return: decorated function
     """
     def deprecated_decorator(func):
+        @wraps(func)
         def deprecated_func(*args, **kwargs):
             msg = "{} is a deprecated function. {}".format(func.__name__, message)
             if logging.Logger.root.hasHandlers():