Deprecate methods which were replaced by calc_key

Author: Ivan Nikolchev

tlslite/mathtls.py

@@ -13,6 +13,7 @@
 from .constants import CipherSuite
 from .utils import tlshashlib as hashlib
 from .utils import tlshmac as hmac
+from .utils.deprecations import deprecated_method
 
 # 1024, 1536, 2048, 3072, 4096, 6144, and 8192 bit groups
 # Formatted to match lines in RFC
@@ -509,6 +510,7 @@ def PRF_SSL(secret, seed, length):
             index += 1
     return bytes
 
+@deprecated_method("Please use calcKey method instead.")
 def calcExtendedMasterSecret(version, cipherSuite, premasterSecret,
                              handshakeHashes):
     """Derive Extended Master Secret from premaster and handshake msgs"""
@@ -532,6 +534,7 @@ def calcExtendedMasterSecret(version, cipherSuite, premasterSecret,
     return masterSecret
 
 
+@deprecated_method("Please use calcKey method instead.")
 def calcMasterSecret(version, cipherSuite, premasterSecret, clientRandom,
                      serverRandom):
     """Derive Master Secret from premaster secret and random values"""
@@ -556,6 +559,7 @@ def calcMasterSecret(version, cipherSuite, premasterSecret, clientRandom,
         raise AssertionError()
     return masterSecret
 
+@deprecated_method("Please use calcKey method instead.")
 def calcFinished(version, masterSecret, cipherSuite, handshakeHashes,
                  isClient):
     """Calculate the Handshake protocol Finished value

tlslite/utils/deprecations.py

@@ -202,3 +202,17 @@ def wrapper(cls):
         orig_vars.pop('__weakref__', None)
         return metaclass(cls.__name__, cls.__bases__, orig_vars)
     return wrapper
+
+def deprecated_method(message):
+    """Decorator for deprecating methods.
+
+    :param ste message: The message you want to display.
+    """
+    def decorator(func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            warnings.warn("{0} is a deprecated method. {1}".format(func.__name__, message),
+                          DeprecationWarning, stacklevel=2)
+            return func(*args, **kwargs)
+        return wrapper
+    return decorator

unit_tests/test_tlslite_utils_deprecations.py

@@ -17,7 +17,8 @@
     from unittest.mock import call
 
 from tlslite.utils.deprecations import deprecated_params, \
-        deprecated_attrs, deprecated_class_name
+        deprecated_attrs, deprecated_class_name, \
+        deprecated_method
 
 # see https://github.com/pytest-dev/py/issues/110
 # preload the list until the list of loaded modules is static
@@ -452,3 +453,19 @@ def method(cls):
         self.assertFalse(hasattr(Clazz, "new_cvar"))
         with self.assertWarns(DeprecationWarning) as e:
             self.assertFalse(hasattr(Clazz, "old_cvar"))
+
+
+class TestDeprecatedMethods(unittest.TestCase):
+    def test_deprecated_method(self):
+
+        @deprecated_method("Please use foo method instead.")
+        def test(param):
+            return param
+
+        with self.assertWarns(DeprecationWarning) as e:
+            r = test("test")
+            self.assertEqual(r, "test")
+
+        self.assertEqual("test is a deprecated method. Please" \
+                         " use foo method instead.",
+                         str(e.warning))