Changeset 4566 for TI12-security/trunk/python

Timestamp:

09/12/08 08:56:15 (12 years ago)

Author:

pjkersha

Message:

Add deprecation warning for SQLObject CredentialRepository? implementation. Replace with SQLAlchemy based implementation in a future release

File:

• TI12-security/trunk/python/ndg.security.common/ndg/security/common/SQLObject.py (modified) (11 diffs)

TI12-security/trunk/python/ndg.security.common/ndg/security/common/SQLObject.py

@@ -12 +12 @@
 __contact__ = "Philip.Kershaw@stfc.ac.uk"
 __revision__ = '$Id$'
+warnings.warn("sqlobject based implementation to be replaced with SQLAlchemy "
+              "equivalent in a future release", 
+              DeprecationWarning, stacklevel=2)
 
 # SQLObject Database interface
@@ -29 +32 @@
 
 
-#_____________________________________________________________________________
 class CredentialRepository(CredentialRepositoryBase):
     """Interface to Credential Repository Database
     
-    Nb. inherits from CredentialWallet.CredentialRepository to ensure correct interface
-    to the wallet"""
+    Nb. inherits from CredentialWallet.CredentialRepository to ensure correct 
+    interface to the wallet"""
 
     # valid configuration property keywords
@@ -40 +42 @@
     
     
-    #_________________________________________________________________________    
     def __init__(self, propFilePath=None, dbPPhrase=None, **prop):
         """Initialise Credentials Repository Database object.
@@ -52 +53 @@
         Nb. propFilePath setting overrides input dbURI
         """
+        warnings.warn("sqlobject based implementation to be replaced with "
+                      "SQLAlchemy equivalent in a future release", 
+                      DeprecationWarning, stacklevel=2)
             
         self.__con = None
@@ -66 +70 @@
             self.setProperties(dbPPhrase=dbPPhrase, **prop)
 
-
-    #_________________________________________________________________________    
     def __setConnection(self,
                         dbType=None,
@@ -139 +141 @@
           
 
-    #_________________________________________________________________________    
     def setProperties(self, dbPPhrase=None, **prop):
         """Update existing properties from an input dictionary
@@ -156 +157 @@
 
 
-    #_________________________________________________________________________    
     def readProperties(self,
                        propFilePath=None,
@@ -204 +204 @@
 
             
-    #_________________________________________________________________________    
     def addUser(self, userName, dn):
         """A new user to Credentials Repository"""
@@ -214 +213 @@
                                                                 (userName, e)
 
-
-    #_________________________________________________________________________    
     def auditCredentials(self, dn=None, **attCertValidKeys):
         """Check the attribute certificates held in the repository and delete
@@ -263 +260 @@
 
 
-    #_________________________________________________________________________    
     def getCredentials(self, dn):
         """Get the list of credentials for a given user's DN"""
@@ -274 +270 @@
 
 
-    #_________________________________________________________________________    
     def addCredentials(self, dn, attCertList):
         """Add new attribute certificates for a user.  The user must have