Changeset 6906

Timestamp:

28/05/10 14:58:47 (11 years ago)

Author:

pjkersha

Message:

Incomplete - task 6: Put NDG SAML package on PyPI

• updating epydoc for 'core' module

Location:

TI12-security/trunk/ndg_saml/ndg/saml

Files:

• common/xml.py (modified) (1 diff)
• saml2/core.py (modified) (52 diffs)

TI12-security/trunk/ndg_saml/ndg/saml/common/xml.py

@@ -396 +396 @@
     def _setPrefix(self, value):
         """Set prefix
-        @param: prefix
+        @param value: prefix
         @type: string
         @raise TypeError: invalid input value type

TI12-security/trunk/ndg_saml/ndg/saml/saml2/core.py

@@ -993 +993 @@
     @type TYPE_NAME: ndg.saml.common.xml.QName
     
-    @ivar __baseID:
-    @type __baseID:
-    @ivar __nameID:
-    @type __nameID:
-    @ivar __encryptedID:
-    @type __encryptedID:
-    @ivar __subjectConfirmations:
-    @type __subjectConfirmations:    
+    @ivar __baseID: base identifier
+    @type __baseID: basestring
+    @ivar __nameID: name identifier
+    @type __nameID: basestring
+    @ivar __encryptedID: encrypted identifier
+    @type __encryptedID: any - not implemented for type checking
+    @ivar __subjectConfirmations: list of subject confirmations
+    @type __subjectConfirmations: list
     '''
     
@@ -1027 +1027 @@
     
     def __init__(self, **kw):
+        '''
+        @param **kw: keywords for initialisation of parent class attributes
+        @type **kw: dict
+        '''
         super(Subject, self).__init__(**kw)
         
@@ -1059 +1063 @@
     
     def _getBaseID(self): 
+        """Get base identifier
+        @return: base identifier
+        @rtype: basestring
+        """ 
         return self.__baseID
 
     def _setBaseID(self, value):
+        """Set base identifier
+        @param: base identifier
+        @type: basestring
+        @raise TypeError: invalid input value type
+        """ 
         if not isinstance(value, basestring):
             raise TypeError("Expecting %r type for \"baseID\" got %r" %
@@ -1072 +1085 @@
       
     def _getNameID(self):
+        """Get name identifier
+        @return: name identifier
+        @rtype: basestring
+        """ 
         return self.__nameID
     
     def _setNameID(self, value):
+        """Set name identifier
+        @param: name identifier
+        @type: basestring
+        @raise TypeError: invalid input value type
+        """ 
         if not isinstance(value, NameID):
             raise TypeError("Expecting %r type for \"nameID\" got %r" %
@@ -1085 +1107 @@
     
     def _getEncryptedID(self):
+        """Get encrypted identifier
+        @return: encrypted identifier
+        @rtype: basestring
+        """ 
         return self.__encryptedID
     
     def _setEncryptedID(self, value): 
+        """Set encrypted identifier
+        
+        @param: encrypted identifier
+        @type: any type
+        @raise TypeError: invalid input value type
+        """ 
         self.__encryptedID = value
 
@@ -1095 +1127 @@
     
     def _getSubjectConfirmations(self): 
+        """Get list of subject confirmations
+        @return: list of subject confirmations
+        @rtype: list
+        """ 
         return self.__subjectConfirmations
 
@@ -1101 +1137 @@
     
     def getOrderedChildren(self): 
+        """Get list containing base, name and encrypted IDs and the subject 
+        confirmations
+        
+        @return: list of all child attributes
+        @rtype: list
+        """ 
         children = []
 
@@ -1118 +1160 @@
 
 class AbstractNameIDType(SAMLObject):
-    '''Abstract implementation of NameIDType'''
+    '''Abstract implementation of NameIDType
+    
+    @cvar SP_NAME_QUALIFIER_ATTRIB_NAME: SPNameQualifier attribute name.
+    @type SP_NAME_QUALIFIER_ATTRIB_NAME: string
+    @cvar FORMAT_ATTRIB_NAME: Format attribute name.
+    @type FORMAT_ATTRIB_NAME: string
+    @cvar SPPROVIDED_ID_ATTRIB_NAME: SPProviderID attribute name.
+    @type SPPROVIDED_ID_ATTRIB_NAME: string
+    @cvar UNSPECIFIED: URI for unspecified name format.
+    @type UNSPECIFIED: string
+    @cvar EMAIL: URI for email name format.
+    @type EMAIL: string
+    @cvar X509_SUBJECT: URI for X509 subject name format.
+    @type X509_SUBJECT: string
+    @cvar WIN_DOMAIN_QUALIFIED: URI for windows domain qualified name name 
+    format.
+    @type WIN_DOMAIN_QUALIFIED: string
+    @cvar KERBEROS: URI for kerberos name format.
+    @type KERBEROS: string
+    @cvar ENTITY: URI for SAML entity name format.
+    @type ENTITY: string
+    @cvar PERSISTENT: URI for persistent name format.
+    @type PERSISTENT: string
+    @cvar TRANSIENT: URI for transient name format.
+    @type TRANSIENT: string
+    @cvar ENCRYPTED: Special URI used by NameIDPolicy to indicate a NameID 
+    should be encrypted
+    @type ENCRYPTED: string
+
+    @ivar __name: Name of the Name ID.
+    @type __name: string
+    @ivar __nameQualifier: Name Qualifier of the Name ID.
+    @type __nameQualifier: string
+    @ivar __spNameQualifier: SP Name Qualifier of the Name ID.
+    @type __spNameQualifier: string
+    @ivar __format: Format of the Name ID.
+    @type __format: string
+    @ivar __spProvidedID: SP ProvidedID of the NameID.
+    @type __spProvidedID: string
+    '''
 
     # SPNameQualifier attribute name.
@@ -1167 +1248 @@
     
     def __init__(self, **kw): 
-        '''@param namespaceURI: the namespace the element is in
-        @param elementLocalName: the local name of the XML element this Object 
-        represents
-        @param namespacePrefix: the prefix for the given namespace
+        '''
+        @param **kw: keywords to set attributes of parent class
+        @type **kw: dict
         '''
         super(AbstractNameIDType, self).__init__(**kw)
@@ -1210 +1290 @@
              
     def _getValue(self):
+        """Get name value
+        @return: name value
+        @rtype: string
+        """
         return self.__value
         
     def _setValue(self, value):
+        """Set name value
+        @param: name value
+        @type: string
+        @raise TypeError: invalid input value type
+        """
         if not isinstance(value, basestring):
             raise TypeError("\"value\" must be a basestring derived type, "
@@ -1222 +1311 @@
     
     def _getNameQualifier(self): 
+        """Get name qualifier
+        @return: name qualifier
+        @rtype: string
+        """
         return self.__nameQualifier
     
     def _setNameQualifier(self, value): 
+        """Set name qualifier
+        @param: name qualifier
+        @type: string
+        """
         self.__nameQualifier = value
 
@@ -1232 +1329 @@
 
     def _getSPNameQualifier(self): 
+        """Get SP name qualifier
+        @return: SP name qualifier
+        @rtype: string
+        """
         return self.__spNameQualifier
     
     def _setSPNameQualifier(self, value): 
+        """Set SP name qualifier
+        @param: SP name qualifier
+        @type: string
+        """
         self.__spNameQualifier = value
 
@@ -1242 +1347 @@
     
     def _getFormat(self):
+        """Get name format
+        @return: name format
+        @rtype: string
+        """
         return self.__format
         
     def _setFormat(self, format):
+        """Set name format
+        @param: name format
+        @type: string
+        @raise TypeError: invalid input value type
+        """
         if not isinstance(format, basestring):
             raise TypeError("\"format\" must be a basestring derived type, "
@@ -1254 +1368 @@
     
     def _getSPProvidedID(self): 
+        """Get SP provided identifier
+        @return: SP provided identifier
+        @rtype: string
+        """
         return self.__spProvidedID
     
     def _setSPProvidedID(self, value): 
+        """Set SP provided identifier
+        @param: SP provided identifier
+        @type: string
+        """
         self.__spProvidedID = value
 
@@ -1263 +1385 @@
     
     def getOrderedChildren(self): 
+        """Get attributes as a list - not currently implemented
+        @return: list of object attribute values
+        @rtype: tuple
+        @raise NotImplementedError: not implemented in this version
+        """
         raise NotImplementedError()
 
    
 class Issuer(AbstractNameIDType):
-    """SAML 2.0 Core Issuer type"""
+    """SAML 2.0 Core Issuer type
+    
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: Qualified Name of the XSI type.
+    @type TYPE_NAME: ndg.saml.common.xml.QName
+    """
     
     # Element local name. 
@@ -1289 +1426 @@
      
 class NameID(AbstractNameIDType):
-    '''SAML 2.0 Core NameID'''
+    '''SAML 2.0 Core NameID
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: Qualified Name of the XSI type.
+    @type TYPE_NAME: ndg.saml.common.xml.QName
+    '''
+    
     # Element local name. 
     DEFAULT_ELEMENT_LOCAL_NAME = "NameID"
@@ -1310 +1457 @@
 
 class Conditions(SAMLObject): 
-    '''SAML 2.0 Core Conditions.'''
+    '''SAML 2.0 Core Conditions.
+    
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: Qualified Name of the XSI type.
+    @type TYPE_NAME: ndg.saml.common.xml.QName
+    @cvar NOT_BEFORE_ATTRIB_NAME: NotBefore attribute name.
+    @type NOT_BEFORE_ATTRIB_NAME: string
+    @cvar NOT_ON_OR_AFTER_ATTRIB_NAME: NotOnOrAfter attribute name.
+    @type NOT_ON_OR_AFTER_ATTRIB_NAME: string
+    
+    @ivar self.__conditions: A list of Conditions.
+    @type self.__conditions: list
+    @ivar self.__notBefore: Not Before condition
+    @type self.__notBefore: NoneType / datetime.datetime
+    @ivar self.__notOnOrAfter: Not On Or After conditions.
+    @type self.__notOnOrAfter: NoneType / datetime.datetime
+    '''
     
     # Element local name.
@@ -1343 +1511 @@
         super(Conditions, self).__init__(**kw)
         
-        # A Condition.
+        # A list of Conditions
         self.__conditions = []
     
-        # Not Before conditions.
+        # Not Before time condition
         self.__notBefore = None
     
-        # Not On Or After conditions.
+        # Not On Or After time conditions
         self.__notOnOrAfter = None
 
@@ -1358 +1526 @@
         @rtype: dict
         '''
-
         _dict = super(Conditions, self).__getstate__()
         for attrName in Conditions.__slots__:
@@ -1373 +1540 @@
         '''Get the date/time before which the assertion is invalid.
         
-        @return: the date/time before which the assertion is invalid'''
+        @return: the date/time before which the assertion is invalid
+        @rtype: NoneType / datetime.datetime
+        '''
         return self.__notBefore
     
@@ -1380 +1549 @@
         
         @param value: the date/time before which the assertion is invalid
+        @type: datetime.datetime
         '''
         if not isinstance(value, datetime):
@@ -1390 +1560 @@
         
         @return: the date/time on, or after, which the assertion is invalid'
+        @rtype: NoneType / datetime.datetime
         '''
         return self.__notOnOrAfter
@@ -1398 +1569 @@
         @param value: the date/time on, or after, which the assertion 
         is invalid
+        @type: datetime.datetime
         '''
         if not isinstance(value, datetime):
@@ -1415 +1587 @@
         
         @return: all the conditions on the assertion
+        @rtype: list
         '''
         return self.__conditions
     
     def _getAudienceRestrictions(self):
-        '''Gets the audience restriction conditions for the assertion.
+        '''Get the audience restriction conditions for the assertion.
         
         @return: the audience restriction conditions for the assertion
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
 
     def _getOneTimeUse(self):
-        '''Gets the OneTimeUse condition for the assertion.
+        '''Get the OneTimeUse condition for the assertion
         
         @return: the OneTimeUse condition for the assertion
+        @rtype: ?
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
 
     def _getProxyRestriction(self):    
-        '''Gets the ProxyRestriction condition for the assertion.
+        '''Get the ProxyRestriction condition for the assertion
         
         @return: the ProxyRestriction condition for the assertion
+        @rtype: ?
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1441 +1620 @@
     
 class Advice(SAMLObject):
-    '''SAML 2.0 Core Advice.
+    '''SAML 2.0 Core Advice.  Only the skeleton of this class is implemented
+    
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
     '''
 
@@ -1467 +1653 @@
         
         @return: the list of all child elements attached to this advice
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1474 +1662 @@
         
         @return: the list of AssertionID references used as advice
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1481 +1671 @@
         
         @return: the list of AssertionURI references used as advice
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1488 +1680 @@
         
         @return: the list of Assertions used as advice
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1495 +1689 @@
         
         @return: the list of EncryptedAssertions used as advice
+        @rtype: list
+        @raise NotImplementedError: not currently implemented
         '''
         raise NotImplementedError()
@@ -1501 +1697 @@
 class Assertion(SAMLObject):
     """SAML 2.0 Attribute Assertion for use with NERC DataGrid    
-    """    
+
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: QName of the XSI type.
+    @type TYPE_NAME: ndg.saml.common.xml.QName
+    @cvar VERSION_ATTRIB_NAME: Version attribute name.
+    @type VERSION_ATTRIB_NAME: string
+    @cvar ISSUE_INSTANT_ATTRIB_NAME: IssueInstant attribute name.
+    @type ISSUE_INSTANT_ATTRIB_NAME: string
+    @cvar ID_ATTRIB_NAME: ID attribute name.
+    @type ID_ATTRIB_NAME: string
+    
+    @ivar __version: SAML version used
+    @type __version: ndg.saml.common.SAMLVersion
+    @ivar __issueInstant: issue instant for assertion
+    @type __issueInstant: datetime.datetime
+    @ivar __id: assertion identifier
+    @type __id: string
+    @ivar __issuer: issuer of this assertion
+    @type __issuer: ndg.saml.saml2.core.Issuer
+    @ivar __subject: subject of this assertion
+    @type __subject: ndg.saml.saml2.core.Subject
+    @ivar __conditions: conditions for this assertion
+    @type __conditions: ndg.saml.saml2.core.Conditions
+    @ivar __advice: advice statement
+    @type __advice: string
+    @ivar __statements: asserted statements
+    @type __statements: ndg.saml.utils.TypedList
+    @ivar __authnStatements: asserted authentication statements
+    @type __authnStatements: list
+    @ivar __authzDecisionStatements: asserted authorization decision statements
+    @type __authzDecisionStatements: ndg.saml.utils.TypedList
+    @ivar __attributeStatements: asserted attribute statements
+    @type __attributeStatements: ndg.saml.utils.TypedList
+    """   
+     
     # Element local name.
     DEFAULT_ELEMENT_LOCAL_NAME = "Assertion"
@@ -1554 +1789 @@
         self.__statements = TypedList(Statement)
         
-        # TODO: Implement AuthnStatement and AuthzDecisionStatement classes
+        # TODO: Implement AuthnStatement class
         self.__authnStatements = []
         self.__authzDecisionStatements = TypedList(AuthzDecisionStatement)
@@ -1565 +1800 @@
         @rtype: dict
         '''
-
         _dict = super(Assertion, self).__getstate__()
         for attrName in Assertion.__slots__:
@@ -1578 +1812 @@
                  
     def _get_version(self):
-        '''@return: the SAML Version of this assertion.
+        '''
+        @return: the SAML Version of this assertion
+        @rtype: ndg.saml.common.SAMLVersion/NoneType
         '''
         return self.__version
     
     def _set_version(self, version):
-        '''@param version: the SAML Version of this assertion
+        '''
+        @param version: the SAML Version of this assertion
+        @type version: ndg.saml.common.SAMLVersion
+        @raise TypeError: incorrect type for input value
         '''
         if not isinstance(version, SAMLVersion):
@@ -1598 +1837 @@
         '''Gets the issue instance of this assertion.
         
-        @return: the issue instance of this assertion'''
+        @return: the issue instance of this assertion
+        @rtype: datetime.datetime/NoneType
+        '''
         return self.__issueInstant
     
@@ -1605 +1846 @@
         
         @param issueInstant: the issue instance of this assertion
+        @type issueInstant: datetime.datetime/NoneType
+        @raise TypeError: incorrect type for input value
         '''
         if not isinstance(issueInstant, datetime):
@@ -1617 +1860 @@
 
     def _get_id(self):
-        '''Sets the ID of this assertion.
+        '''Get the ID of this assertion
         
         @return: the ID of this assertion
+        @rtype: basestring/NoneType
         '''
         return self.__id
     
     def _set_id(self, _id):
-        '''Sets the ID of this assertion.
+        '''Set the ID of this assertion
         
         @param _id: the ID of this assertion
+        @type _id: basestring
+        @raise TypeError: incorrect type for input value
         '''
         if not isinstance(_id, basestring):
@@ -1636 +1882 @@
     
     def _set_issuer(self, issuer):
-        """Set issuer"""
+        """Set issuer
+        @param issuer: issuer of the assertion
+        @type issuer: ndg.saml.saml2.core.Issuer
+        @raise TypeError: incorrect type for input value
+        """
         if not isinstance(issuer, Issuer):
             raise TypeError("issuer must be %r, got %r" % (Issuer, 
@@ -1643 +1893 @@
     
     def _get_issuer(self):
-        """Get the issuer name """
+        """Get the issuer name 
+        @return: issuer name
+        @rtype: ndg.saml.saml2.core.Issuer
+        """
         return self.__issuer
 
@@ -1651 +1904 @@
     
     def _set_subject(self, subject):
-        """Set subject string."""
+        """Set subject string
+        @param subject: subject of this assertion
+        @type subject: ndg.saml.saml2.core.Subject
+        @raise TypeError: incorrect type for input value"""
         if not isinstance(subject, Subject):
             raise TypeError("subject must be %r, got %r" % (Subject, 
@@ -1659 +1915 @@
     
     def _get_subject(self):
-        """Get subject string."""
+        """Get subject string
+        
+        @return: subject of this assertion
+        @rtype subject: ndg.saml.saml2.core.Subject
+        """
         return self.__subject
 
@@ -1667 +1927 @@
     
     def _get_conditions(self):
-        """Get conditions string."""
+        """Get conditions 
+        @return: conditions for this assertion
+        @rtype: ndg.saml.saml2.core.Conditions
+        """
         return self.__conditions
     
     def _set_conditions(self, value):
-        """Get conditions string."""
+        """Set conditions 
+        @param value: conditions for this assertion
+        @type value: ndg.saml.saml2.core.Conditions
+        @raise TypeError: incorrect type for input value"""
         if not isinstance(value, Conditions):
             raise TypeError("Conditions must be %r, got %r" % (Conditions, 
@@ -1683 +1949 @@
     
     def _set_advice(self, advice):
-        """Set advice string."""
+        """Set advice string
+        
+        @param advice: advice for this assertion
+        @type advice: basestring
+        @raise TypeError: incorrect type for input value"""
         if not isinstance(advice, basestring):
             raise TypeError("advice must be a string")
@@ -1690 +1960 @@
     
     def _get_advice(self):
-        """Get advice string."""
+        """Get advice string
+        
+        @return: advice for this assertion
+        @rtype: basestring
+        """
         return self.__advice
 
@@ -1699 +1973 @@
     @property
     def statements(self):
-        """Attribute Assertion statements"""
+        """Assertion statements
+        
+        @return: list of assertion statements
+        @rtype: ndg.saml.utils.TypedList
+        """
         return self.__statements
     
     @property
     def authnStatements(self):
-        """Attribute Assertion authentication"""
+        """Attribute Assertion authentication
+        
+        @return: list of assertion statements
+        @rtype: ndg.saml.utils.TypedList
+        """
         return self.__authnStatements
     
     @property
     def authzDecisionStatements(self):
-        """Attribute Assertion authorisation decision statements"""
+        """Attribute Assertion authorisation decision statements
+        
+        @return: list of assertion statements
+        @rtype: ndg.saml.utils.TypedList
+        """
         return self.__authzDecisionStatements
     
     @property
     def attributeStatements(self):
-        """Attribute Assertion attribute statements"""
+        """Attribute Assertion attribute statements
+        
+        @return: list of assertion statements
+        @rtype: ndg.saml.utils.TypedList
+        """
         return self.__attributeStatements
     
 
 class AttributeValue(SAMLObject):
-    """Base class for Attribute Value type"""
+    """Base class for Attribute Value type
+    
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element name, no namespace
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name
+    @type DEFAULT_ELEMENT_NAME: ndg.saml.common.xml.QName    
+    """
     
     # Element name, no namespace
@@ -1732 +2028 @@
 
 class XSStringAttributeValue(AttributeValue):
-    """XML XS:String Attribute Value type"""
+    """XML XS:String Attribute Value type
+    
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: QName of the XSI type
+    @type TYPE_NAME: ndg.saml.common.xml.QName
+    
+    @ivar __value: value of this attribute
+    @type __value: basestring
+    """
     
     # Local name of the XSI type
@@ -1747 +2052 @@
     
     def __init__(self, **kw):
+        """
+        @param **kw: keywords for setting attributes of parent class
+        @type **kw: dict
+        """
         super(XSStringAttributeValue, self).__init__(**kw)
         self.__value = None
@@ -1756 +2065 @@
         @rtype: dict
         '''
-
         _dict = super(XSStringAttributeValue, self).__getstate__()
         for attrName in XSStringAttributeValue.__slots__:
@@ -1769 +2077 @@
             
     def _getValue(self):
+        """Set value of XS string
+        @return: value of string to assign
+        @rtype: string
+        """
         return self.__value
         
     def _setValue(self, value):
+        """Set value of XS string
+        @param: value
+        @type: string
+        @raise TypeError: invalid input value type
+        """
         if not isinstance(value, basestring):
             raise TypeError("Input must be a basestring derived type, got %r" %
@@ -1782 +2099 @@
 
 class StatusDetail(SAMLObject):
-    '''Implementation of SAML 2.0 StatusDetail'''
+    '''Implementation of SAML 2.0 StatusDetail
+    
+    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Local Name of StatusDetail.
+    @type DEFAULT_ELEMENT_LOCAL_NAME: string
+    @cvar DEFAULT_ELEMENT_NAME: Default element name.
+    @type DEFAULT_ELEMENT_NAME: string
+    @cvar TYPE_LOCAL_NAME: Local name of the XSI type.
+    @type TYPE_LOCAL_NAME: string
+    @cvar TYPE_NAME: QName of the XSI type.
+    @type TYPE_NAME: string
+    
+    @ivar __unknownChildren: unknown child elements
+    @type __unknownChildren: ndg.saml.common.SAMLObject
+    
+    '''
     
     # Local Name of StatusDetail.
@@ -1803 +2134 @@
     
     def __init__(self, **kw):
+        """
+        @param **kw: keywords for setting attributes of parent class
+        @type **kw: dict
+        """
         super(StatusDetail, self).__init__(**kw)
         
@@ -1826 +2161 @@
         return _dict
     
-    def getUnknownXMLTypes(self, qname=None): 
+    def getUnknownXMLTypes(self, qname=None):
+        """Retrieve unknown child attributes
+        
+        This is untested
+        @param qname: qualified name for matching types to be retrieved
+        @type qname: ndg.saml.common.xml.QName
+        @raise TypeError: incorrect type for qname keyword
+        """ 
         if qname is not None:
             if not isinstance(qname, QName):