1 files changed, 38 insertions, 0 deletions
diff --git a/debian/deprecation.py b/debian/deprecation.py
new file mode 100644
index 0000000..b9e4c09
--- /dev/null
+++ b/debian/deprecation.py
@@ -0,0 +1,38 @@
+# -*- coding: utf-8 -*- vim: fileencoding=utf-8 :
+#
+# debian/deprecation.py
+# Utility module to deprecate features
+#
+# Copyright © Ben Finney <ben+debian@benfinney.id.au>
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation, either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+""" Utility module to deprecate features """
+
+import warnings
+
+def function_deprecated_by(func):
+    """ Return a function that warns it is deprecated by another function.
+
+        Returns a new function that warns it is deprecated by function
+        ``func``, then acts as a pass-through wrapper for ``func``.
+
+        """
+    func_name = func.__name__
+    warn_msg = "Use %(func_name)s instead" % vars()
+    def deprecated_func(*args, **kwargs):
+        warnings.warn(warn_msg, DeprecationWarning, stacklevel=2)
+        return func(*args, **kwargs)
+    return deprecated_func