Added deprecation warnings fro User.hasRole.

lib/python/AccessControl/User.py

@@ -84,7 +84,7 @@
 ##############################################################################
 """Access control package"""
 
-__version__='$Revision: 1.158 $'[11:-2]
+__version__='$Revision: 1.159 $'[11:-2]
 
 import Globals, socket, SpecialUsers,re
 import os
@@ -304,7 +304,19 @@ class BasicUser(Implicit):
             break
         return None
 
-    hasRole=allowed
+    def hasRole(self, *args, **kw):
+        """hasRole is an alias for 'allowed' and has been deprecated.
+        
+        Code still using this method should convert to either 'has_role' or
+        'allowed', depending on the intended behaviour.
+
+        """
+        import warnings
+        warnings.warn('BasicUser.hasRole is deprecated, please use '
+            'BasicUser.allowed instead; hasRole was an alias for allowed, but '
+            'you may have ment to use has_role.', DeprecationWarning)
+        self.allowed(*args, **kw)
+
     domains=[]
     
     def has_role(self, roles, object=None):
@@ -372,7 +384,19 @@ class UnrestrictedUser(SpecialUser):
     def allowed(self,parent,roles=None):
         return roles is not _what_not_even_god_should_do
 
-    hasRole=allowed
+    def hasRole(self, *args, **kw):
+        """hasRole is an alias for 'allowed' and has been deprecated.
+        
+        Code still using this method should convert to either 'has_role' or
+        'allowed', depending on the intended behaviour.
+
+        """
+        import warnings
+        warnings.warn('UnrestrictedUser.hasRole is deprecated, please use '
+            'UnrestrictedUser.allowed instead; hasRole was an alias for '
+            'allowed, but you may have ment to use has_role.',
+            DeprecationWarning)
+        self.allowed(*args, **kw)
 
     def has_role(self, roles, object=None): return 1
 
@@ -412,7 +436,19 @@ class NullUnrestrictedUser(SpecialUser):
     def allowed(self, parent, roles=None):
         return 0
 
-    hasRole=allowed
+    def hasRole(self, *args, **kw):
+        """hasRole is an alias for 'allowed' and has been deprecated.
+        
+        Code still using this method should convert to either 'has_role' or
+        'allowed', depending on the intended behaviour.
+
+        """
+        import warnings
+        warnings.warn('NullUnrestrictedUser.hasRole is deprecated, please use '
+            'NullUnrestrictedUser.allowed instead; hasRole was an alias for '
+            'allowed, but you may have ment to use has_role.',
+            DeprecationWarning)
+        self.allowed(*args, **kw)
 
     def has_role(self, roles, object=None):
         return 0

lib/python/AccessControl/tests/testDeprecatedAPI.py

+
+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+"""Tests for the DeprecationWarning thrown by accessing hasRole
+
+To be removed together with the API in due time.
+
+"""
+
+__rcs_id__='$Id: testDeprecatedAPI.py,v 1.1 2001/10/16 21:42:12 mj Exp $'
+__version__='$Revision: 1.1 $'[11:-2]
+
+import ZODB # Sigh. Persistent needs to be set, so we import ZODB.
+from AccessControl import User
+import unittest, warnings
+
+class DeprecatedAPI(unittest.TestCase):
+    def setUp(self):
+        # We test for warnings by turning them into exceptions
+        warnings.filterwarnings('error', category=DeprecationWarning,
+            module='AccessControl')
+    
+    def testDeprecatedHasRole(self):
+        """hasRole has been deprecated, we expect a warning."""
+        try:
+            self.userObject.hasRole(None)
+        except DeprecationWarning:
+            pass
+        else:
+            self.fail('Expected DeprecationWarning, none given')
+
+    def testAllowed(self):
+        """hasRole is an alias for allowed, which should be unaffected."""
+        try:
+            self.userObject.allowed(None)
+        except DeprecationWarning:
+            self.fail('Expected DeprecationWarning, none given')
+        else:
+            pass
+
+    def tearDown(self):
+        warnings.resetwarnings()
+
+class BasicUser(DeprecatedAPI):
+    userObject = User.SimpleUser('JoeBloke', '123', [], [])
+
+class UnrestrictedUser(DeprecatedAPI):
+    userObject = User.UnrestrictedUser('Special', '123', [], [])
+
+class NullUnrestrictedUser(DeprecatedAPI):
+    userObject = User.NullUnrestrictedUser()
+
+def test_suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(BasicUser))
+    suite.addTest(unittest.makeSuite(UnrestrictedUser))
+    suite.addTest(unittest.makeSuite(NullUnrestrictedUser))
+    return suite