Merge pull request #367 from cadenmyers13/dep-msg-helper

feat: Deprecation message helper

Author: sbillinge

news/dep-msg-helper.rst

@@ -0,0 +1,23 @@
+**Added:**
+
+* Add ``deprecation_message`` helper for printing consistent deprecation messages.
+
+**Changed:**
+
+* <news item>
+
+**Deprecated:**
+
+* <news item>
+
+**Removed:**
+
+* <news item>
+
+**Fixed:**
+
+* <news item>
+
+**Security:**
+
+* <news item>

src/diffpy/utils/_deprecator.py

@@ -81,3 +81,28 @@ def wrapper(*args, **kwargs):
         )
 
     return decorator
+
+
+def deprecation_message(base, old_name, new_name, removal_version):
+    """Generate a deprecation message.
+
+    Parameters
+    ----------
+    base : str
+        The base module or class where the deprecated item resides.
+    old_name : str
+        The name of the deprecated item.
+    new_name : str
+        The name of the new item to use.
+    removal_version : str
+        The version when the deprecated item will be removed.
+
+    Returns
+    -------
+    str
+        A formatted deprecation message.
+    """
+    return (
+        f"'{base}.{old_name}' is deprecated and will be removed in "
+        f"version {removal_version}. Please use '{base}.{new_name}' instead."
+    )