]> granicus.if.org Git - python/commitdiff
Closes #13235: Added deprecation for warn() methods and function in logging.
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Fri, 21 Oct 2011 06:33:42 +0000 (07:33 +0100)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>
Fri, 21 Oct 2011 06:33:42 +0000 (07:33 +0100)
Doc/library/logging.rst
Lib/logging/__init__.py
Misc/NEWS

index 68cfa6ed790414b1483e52475608a3a03142529e..4998949a473cfbf22e937856712c7e1592ea3d8d 100644 (file)
@@ -189,6 +189,9 @@ instantiated directly, but always through the module-level function
    Logs a message with level :const:`WARNING` on this logger. The arguments are
    interpreted as for :meth:`debug`.
 
+   .. note:: There is an obsolete method `warn()` which is functionally
+      identical to `warning()`. As `warn()` is deprecated, please do not use
+      it - use `warning()` instead.
 
 .. method:: Logger.error(msg, *args, **kwargs)
 
@@ -880,8 +883,12 @@ functions.
 
 .. function:: warning(msg, *args, **kwargs)
 
-   Logs a message with level :const:`WARNING` on the root logger. The arguments are
-   interpreted as for :func:`debug`.
+   Logs a message with level :const:`WARNING` on the root logger. The arguments
+   are interpreted as for :func:`debug`.
+
+   .. note:: There is an obsolete function `warn()` which is functionally
+      identical to `warning()`. As `warn()` is deprecated, please do not use
+      it - use `warning()` instead.
 
 
 .. function:: error(msg, *args, **kwargs)
index 8406df3abd942e397f8f6f8b9f4e59a23db87ac7..6e0394fa3565ce5ee04c3344d0b29dfb751316df 100644 (file)
@@ -1243,7 +1243,10 @@ class Logger(Filterer):
         if self.isEnabledFor(WARNING):
             self._log(WARNING, msg, args, **kwargs)
 
-    warn = warning
+    def warn(self, msg, *args, **kwargs):
+        warnings.warn("The 'warn' method is deprecated, "
+            "use 'warning' instead", PendingDeprecationWarning, 2)
+        self.warning(msg, *args, **kwargs)
 
     def error(self, msg, *args, **kwargs):
         """
@@ -1556,7 +1559,10 @@ class LoggerAdapter(object):
         """
         self.log(WARNING, msg, *args, **kwargs)
 
-    warn = warning
+    def warn(self, msg, *args, **kwargs):
+        warnings.warn("The 'warn' method is deprecated, "
+            "use 'warning' instead", PendingDeprecationWarning, 2)
+        self.warning(msg, *args, **kwargs)
 
     def error(self, msg, *args, **kwargs):
         """
@@ -1766,7 +1772,10 @@ def warning(msg, *args, **kwargs):
         basicConfig()
     root.warning(msg, *args, **kwargs)
 
-warn = warning
+def warn(msg, *args, **kwargs):
+    warnings.warn("The 'warn' function is deprecated, "
+        "use 'warning' instead", PendingDeprecationWarning, 2)
+    warning(msg, *args, **kwargs)
 
 def info(msg, *args, **kwargs):
     """
index 7fe61430108cb4dc9690c49255be1d784622a61f..36aafd9fc2e81615de153fe18cae9e6aba9a3369 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -326,6 +326,8 @@ Core and Builtins
 Library
 -------
 
+- Issue #13235: Added PendingDeprecationWarning to warn() method and function.
+
 - Issue #9168: now smtpd is able to bind privileged port.
 
 - Issue #12529: fix cgi.parse_header issue on strings with double-quotes and