Ignore:
Timestamp:
01/06/10 11:25:08 (10 years ago)
Author:
pjkersha
Message:

Incomplete - task 6: Put NDG SAML package on PyPI

  • updating epydoc for 'etree' package
File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/ndg_saml/ndg/saml/saml2/core.py

    r6911 r6913  
    33903390        @raise TypeError: incorrect type for attributes list 
    33913391        ''' 
    3392         if not isinstance(value, TypedList): 
    3393             raise TypeError('Expecting %r type for "attributes"; got %r' % 
    3394                             (TypedList, (type))) 
    3395          
    3396         if not issubclass(value.elementType, Attribute): 
     3392        if isinstance(value, TypedList) and not issubclass(value.elementType,  
     3393                                                           Attribute): 
    33973394            raise TypeError('Expecting %r derived type for "attributes" ' 
    33983395                            'elements; got %r' % (Attribute, value.elementType)) 
    3399              
    3400         self.__attributes = value 
    3401  
     3396        else: 
     3397            self.__attributes = TypedList(Attribute) 
     3398            for i in value: 
     3399                self.__attributes.append(i) 
     3400             
    34023401    attributes = property(fget=_getAttributes,  
    34033402                          fset=_setAttributes,  
     
    40154014    @type TYPE_LOCAL_NAME: string 
    40164015    @cvar TYPE_NAME: QName of the XSI type. 
    4017     @type TYPE_NAME: string 
     4016    @type TYPE_NAME: ndg.saml.common.xml.QName 
    40184017    @cvar ID_ATTRIB_NAME: ID attribute name 
    40194018    @type ID_ATTRIB_NAME: string 
     
    40434042    @type INAPPLICABLE_CONSENT: string 
    40444043 
     4044    @ivar __version: SAML version 
     4045    @type __version: string 
     4046    @ivar __id: response identifier 
     4047    @type __id: string 
     4048    @ivar __inResponseTo: identifier corresponding to the query this response is 
     4049    responding to 
     4050    @type __inResponseTo: string 
     4051    @ivar __issueInstant: issue instant for the response 
     4052    @type __issueInstant: datetime.datetime 
     4053    @ivar __destination: destination for the response 
     4054    @type __destination: string 
     4055    @ivar __consent: consent information 
     4056    @type __consent: string 
     4057    @ivar __issuer: issuer identifier 
     4058    @type __issuer: ndg.saml.saml2.core.Issuer 
     4059    @ivar __status: status of the response 
     4060    @type __status: ndg.saml.saml2.core.Status 
     4061    @ivar __extensions: response extensions 
     4062    @type __extensions: list or tuple 
    40454063    ''' 
    40464064 
     
    41054123     
    41064124    def __init__(self, **kw): 
     4125        ''' 
     4126        @param **kw: keywords for initialisation of superclass 
     4127        @type **kw: dict 
     4128        ''' 
    41074129        super(StatusResponseType, self).__init__(**kw) 
    41084130         
     
    41364158     
    41374159    def _get_version(self): 
    4138         '''@return: the SAML Version of this response. 
     4160        '''@return: the SAML Version of this response 
     4161        @rtype: string 
    41394162        ''' 
    41404163        return self.__version 
     
    41424165    def _set_version(self, version): 
    41434166        '''@param version: the SAML Version of this response 
     4167        @type version: basestring 
     4168        @raise TypeError: incorrect type for input version  
    41444169        ''' 
    41454170        if not isinstance(version, SAMLVersion): 
     
    41574182         
    41584183        @return: the ID of this response 
     4184        @rtype: basestring 
    41594185        ''' 
    41604186        return self.__id 
     
    41644190         
    41654191        @param value: the ID of this response 
     4192        @type value: basestring 
     4193        @raise TypeError: incorrect type for input value 
    41664194        ''' 
    41674195        if not isinstance(value, basestring): 
     
    41774205        @return: the unique identifier of the originating  
    41784206        request 
     4207        @rtype: basestring 
    41794208        ''' 
    41804209        return self.__inResponseTo 
     
    41854214        @param value: the unique identifier of the originating  
    41864215        request 
     4216        @type value: basestring 
     4217        @raise TypeError: incorrect type for input value 
    41874218        ''' 
    41884219        if not isinstance(value, basestring): 
     
    41974228 
    41984229    def _get_issueInstant(self): 
    4199         '''Gets the issue instance of this response. 
    4200          
    4201         @return: the issue instance of this response''' 
     4230        '''Gets the issue instant of this response. 
     4231         
     4232        @return: the issue instant of this response 
     4233        @rtype: datetime.datetime''' 
    42024234        return self.__issueInstant 
    42034235     
    42044236    def _set_issueInstant(self, issueInstant): 
    4205         '''Sets the issue instance of this response. 
    4206          
    4207         @param newIssueInstance: the issue instance of this response 
     4237        '''Set the issue instant of this response 
     4238         
     4239        @param issueInstant: the issue instance of this response 
     4240        @type issueInstant: datetime.datetime 
     4241        @raise TypeError: incorrect type for input value 
    42084242        ''' 
    42094243        if not isinstance(issueInstant, datetime): 
     
    42214255         
    42224256        @return: the URI of the destination of the response 
     4257        @rtype: basestring 
    42234258        ''' 
    42244259        return self.__destination 
     
    42274262        '''Sets the URI of the destination of the response. 
    42284263         
    4229         @param value: the URI of the destination of the response''' 
     4264        @param value: the URI of the destination of the response 
     4265        @type value: basestring 
     4266        @raise TypeError: incorrect type for input value 
     4267        ''' 
    42304268        if not isinstance(value, basestring): 
    42314269            raise TypeError('Expecting basestring derived type for ' 
     
    42384276      
    42394277    def _get_consent(self): 
    4240         '''Gets the consent obtained from the principal for sending this  
    4241         response. 
     4278        '''Get the consent obtained from the principal for sending this  
     4279        response 
    42424280         
    42434281        @return: the consent obtained from the principal for sending this  
    42444282        response 
     4283        @rtype: basestring 
    42454284        ''' 
    42464285        return self.__consent 
     
    42524291        @param value: the new consent obtained from the principal for  
    42534292        sending this response 
     4293        @type value: basestring 
     4294        @raise TypeError: incorrect type for input value 
    42544295        '''  
    42554296        if not isinstance(value, basestring): 
     
    42634304    
    42644305    def _set_issuer(self, issuer): 
    4265         """Set issuer of response""" 
     4306        """Set issuer of response 
     4307         
     4308        @param value: issuer of this response  
     4309        sending this response 
     4310        @type value: ndg.saml.saml2.core.Issuer 
     4311        @raise TypeError: incorrect type for input value 
     4312        """ 
    42664313        if not isinstance(issuer, Issuer): 
    42674314            raise TypeError('"issuer" must be a %r, got %r' % (Issuer, 
     
    42704317     
    42714318    def _get_issuer(self): 
    4272         """Get the issuer name """ 
     4319        """Get the issuer name  
     4320         
     4321        @return: issuer of this response  
     4322        sending this response 
     4323        @rtype: ndg.saml.saml2.core.Issuer 
     4324        """ 
    42734325        return self.__issuer 
    42744326 
     
    42814333         
    42824334        @return: the Status of this response 
     4335        @rtype: ndg.saml.saml2.core.Status 
    42834336        ''' 
    42844337        return self.__status 
     
    42874340        '''Sets the Status of this response. 
    42884341         
    4289         @param newStatus: the Status of this response 
     4342        @param value: the Status of this response 
     4343        @type value: ndg.saml.saml2.core.Status 
     4344        @raise TypeError: incorrect type for input value 
    42904345        ''' 
    42914346        if not isinstance(value, Status): 
     
    43004355         
    43014356        @return: the Status of this response 
     4357        @rtype: tuple/list/NoneType 
    43024358        ''' 
    43034359        return self.__extensions 
     
    43074363         
    43084364        @param value: the Extensions of this response 
     4365        @type value: tuple or list 
     4366        @raise TypeError: incorrect type for input value         
    43094367        ''' 
    43104368        if not isinstance(value, (list, tuple)): 
     
    43194377 
    43204378class Response(StatusResponseType): 
    4321     '''SAML2 Core Response''' 
     4379    '''SAML2 Core Response 
     4380     
     4381    @cvar DEFAULT_ELEMENT_LOCAL_NAME: Element local name. 
     4382    @type DEFAULT_ELEMENT_LOCAL_NAME: ndg.saml.common.xml.QName 
     4383    @cvar DEFAULT_ELEMENT_NAME: Default element name. 
     4384    @type DEFAULT_ELEMENT_NAME: string 
     4385    @cvar TYPE_LOCAL_NAME: Local name of the XSI type. 
     4386    @type TYPE_LOCAL_NAME: string 
     4387    @cvar TYPE_NAME: QName of the XSI type. 
     4388    @type TYPE_NAME: ndg.saml.common.xml.QName 
     4389     
     4390    @ivar __indexedChildren: response elements 
     4391    @type __indexedChildren: list 
     4392    ''' 
    43224393     
    43234394    # Element local name. 
     
    43404411     
    43414412    def __init__(self, **kw): 
    4342         ''''''  
     4413        ''' 
     4414        @param **kw: keywords to initialise superclass instance 
     4415        @type **kw: dict 
     4416        '''  
    43434417        super(Response, self).__init__(**kw) 
    43444418         
     
    43664440    @property 
    43674441    def assertions(self):  
    4368         "Assertions contained in this response" 
     4442        """Assertions contained in this response 
     4443         
     4444        @return: list of assertion for this response 
     4445        @rtype: list 
     4446        """ 
    43694447        return self.__indexedChildren 
Note: See TracChangeset for help on using the changeset viewer.