]> granicus.if.org Git - python/commitdiff
whatsnew: hmac *digestmod* accepts strings, and default is deprecated. (#17276)
authorR David Murray <rdmurray@bitdance.com>
Sun, 9 Mar 2014 03:43:12 +0000 (22:43 -0500)
committerR David Murray <rdmurray@bitdance.com>
Sun, 9 Mar 2014 03:43:12 +0000 (22:43 -0500)
Doc/library/hmac.rst
Doc/whatsnew/3.4.rst

index 2e9b0b26a57525ffbba742046600d31de673ec7f..4858235107ba2951da3079950211bb2c90a3b4f8 100644 (file)
@@ -23,9 +23,8 @@ This module implements the HMAC algorithm as described by :rfc:`2104`.
    defaults to the :data:`hashlib.md5` constructor.
 
    .. versionchanged:: 3.4
-      Parameter *key* can be a bytes or bytearray object. Parameter *msg* can
-      be of any type supported by :mod:`hashlib`.
-
+      Parameter *key* can be a bytes or bytearray object.
+      Parameter *msg* can be of any type supported by :mod:`hashlib`.
       Paramter *digestmod* can be the name of a hash algorithm.
 
    .. deprecated:: 3.4
index 42af34963e126a7ac376d895f814fd932d191624..f556311eebb18884e3774854bd612318f486fe41 100644 (file)
@@ -826,6 +826,12 @@ argument to the :func:`~hmac.new` function, and the *msg* parameter to both the
 accepts any type supported by the :mod:`hashlib` module.  (Contributed
 by Jonas Borgström in :issue:`18240`.)
 
+The *digestmod* argument to the :func:`hmac.new` function may now be any hash
+digest name recognized by :mod:`hashlib`.  In addition, the current behavior in
+which the value of *digestmod* defaults to ``MD5`` is deprecated: in a
+future version of Python there will be no default value.  (Contributed by
+Christian Heimes in :issue:`17276`.)
+
 
 html
 ----
@@ -1849,6 +1855,9 @@ Deprecated Python Modules, Functions and Methods
 
 * The *strict* argument of :class:`~html.parser.HTMLParser` is deprecated.
 
+* The :func:`hmac.new` *digestmod* keyword having a default value (currently
+  ``MD5``) is deprecated.
+
 
 Deprecated Functions and Types in the C API
 -------------------------------------------
@@ -2139,7 +2148,11 @@ Changes in the Python API
   currently defaults to ``False`` for backward compatibility, but will
   eventually be changed to default to ``True``.  It is recommended that you add
   this keyword, with the appropriate value, to any
-  :class:`~html.parser.HTMLParser` calls in your code.
+  :class:`~html.parser.HTMLParser` calls in your code (:issue:`13633`).
+
+* Since the *digestmod* argument to the :func:`hmac.new` function will in the
+  future have no default, all calls to :func:`hmac.new` should be changed to
+  explicitly specify a *digestmod*. (:issue:`17276`).
 
 
 Changes in the C API