]> SALOME platform Git repositories - modules/kernel.git/commitdiff
Salome HOME
Fix bug with Python 2.7 and update doc in module deprecation
authorbarate <barate>
Wed, 9 Nov 2011 15:11:15 +0000 (15:11 +0000)
committerbarate <barate>
Wed, 9 Nov 2011 15:11:15 +0000 (15:11 +0000)
src/KERNEL_PY/kernel/deprecation.py

index 9d53be0e2f731734755c1842c197ecb833589d03..c571d0812855580d8e59275c5d2e6cf76fe74adb 100644 (file)
 """
 This module provides several functions to indicate the deprecation of a
 module, a method or a function.
+
+Example::
+
+    from salome.kernel.deprecation import deprecated
+
+    @deprecated("Deprecated since version 6.3.0. Consider replacement with "
+                "newFunction()")
+    def oldFunction():
+      ...
+
 """
 
 import sys
@@ -112,4 +122,8 @@ def __show_colored_warning(message, category, filename,
     else:
         file.write(str)
 
+# Enable warnings for deprecated functions and modules (in Python 2.7, they
+# are disabled by default)
+warnings.filterwarnings("always", "Call to *", DeprecationWarning)
+warnings.filterwarnings("always", "Importation of *", DeprecationWarning)
 warnings.showwarning = __show_colored_warning