Deprecated public sort_params

Author: MarkusH

laterpay/signing.py

@@ -3,6 +3,7 @@
 
 import hashlib
 import hmac
+import warnings
 
 import six
 from six.moves.urllib.parse import quote, urlparse
@@ -51,6 +52,23 @@ def sort_params(param_dict):
 
     This function should probably not be part of the public API, and thus will
     be deprecated in a future release to be replaced with a internal function.
+
+    .. deprecated:: 5.0.0
+
+        Use :func:`laterpay.signing.normalise_param_structure` instead.
+    """
+    warnings.warn(
+        'laterpay.signing.sort_params is deprecated and will be removed in '
+        'future versions. Use laterpay.signing.normalise_param_structure '
+        'instead.',
+        DeprecationWarning
+    )
+    return _sort_params(param_dict)
+
+
+def _sort_params(param_dict):
+    """
+    Sort a key-value mapping with non-unique keys.
     """
     param_list = []
     for name, value_list in six.iteritems(param_dict):

tests/test_signing.py

@@ -4,6 +4,7 @@
 
 import hashlib
 import unittest
+import warnings
 
 import furl
 
@@ -239,14 +240,24 @@ def test_sort_params(self):
             'key2': ['value22', 'value21'],
             'key3': ('value32', 'value31'),
         }
-        self.assertEqual(signing.sort_params(params), [
+        self.assertEqual(signing._sort_params(params), [
             ('key1', 'value1'),
             ('key2', 'value21'),
             ('key2', 'value22'),
             ('key3', 'value31'),
             ('key3', 'value32'),
         ])
 
+    def test_sort_params_public_deprecation(self):
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            signing.sort_params({})
+        self.assertEqual(
+            w[0].message.args[0],
+            'laterpay.signing.sort_params is deprecated and will be removed in future '
+            'versions. Use laterpay.signing.normalise_param_structure instead.'
+        )
+
 
 if __name__ == '__main__':
     unittest.main()