Ignore:
Timestamp:
28/06/10 13:54:57 (11 years ago)
Author:
pjkersha
Message:

Incomplete - task 2: XACML-Security Integration

  • updating epydoc ready for release.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/ndg_xacml/ndg/xacml/utils/__init__.py

    r7087 r7109  
    1919    from the list 
    2020    """ 
     21     
    2122    def extend(self, iter): 
     23        """Extend a list with input iterable 
     24        @param iter: iterable object 
     25        @type iter: iterable type 
     26        """ 
    2227        return super(UniqList, self).extend([i for i in iter if i not in self]) 
    2328         
    2429    def __iadd__(self, iter): 
     30        """Extend a list with input iterable 
     31        @param iter: iterable object 
     32        @type iter: iterable type 
     33        """ 
    2534        return super(UniqList, self).__iadd__([i for i in iter  
    2635                                               if i not in self]) 
    2736          
    2837    def append(self, item): 
     38        """Add an item to the list 
     39        @param item: item to append to list 
     40        @type item: any 
     41        """ 
    2942        for i in self: 
    3043            if i == item: 
     
    5063 
    5164    def __repr__(self): 
     65        """@return: represent instance giving type information about the  
     66        elements 
     67        @rtype: string 
     68        """ 
    5269        return "%r type: %s" % (self.__elementType,  
    5370                                super(TypedList, self).__repr__()) 
    5471         
    5572    def _getElementType(self): 
     73        """@return: the element type for this list 
     74        @rtype: type 
     75        """ 
    5676        return self.__elementType 
    5777     
     
    6080      
    6181    def extend(self, iter): 
     82        """Extend a list with input iterable 
     83        @param iter: iterable object 
     84        @type iter: iterable type 
     85        @raise TypeError: input item doesn't match list type 
     86        """ 
    6287        for i in iter: 
    6388            if not isinstance(i, self.__elementType): 
     
    6893         
    6994    def __iadd__(self, iter): 
     95        """Extend a list with input iterable 
     96        @param iter: iterable object 
     97        @type iter: iterable type 
     98        @raise TypeError: input item doesn't match list type 
     99        """ 
    70100        for i in iter: 
    71101            if not isinstance(i, self.__elementType): 
     
    76106          
    77107    def append(self, item): 
     108        """Add an item to the list 
     109        @param iter: iterable object 
     110        @type iter: iterable type 
     111        @raise TypeError: input item doesn't match list type 
     112        """ 
    78113        if not isinstance(item, self.__elementType): 
    79114                raise TypeError("List items must be of type %s" %  
     
    95130           
    96131    def __setitem__(self, key, val): 
     132        """@param key: key for item to set 
     133        @type key: any 
     134        @param val: value to set for this key 
     135        @type val: any 
     136        """ 
    97137        if key not in self.__keyNames: 
    98138            raise KeyError('Key name %r not recognised.  Valid key names ' 
     
    102142 
    103143    def update(self, d, **kw):         
     144        """@param d: dictionary to update from 
     145        @type d: dict 
     146        @param kw: keywords to update dictionary with 
     147        @type kw: dict 
     148        """ 
    104149        for dictArg in (d, kw): 
    105150            for k in dictArg: 
     
    117162class VettedDict(UserDict.DictMixin): 
    118163    """Enforce custom checking on keys and items before addition to a  
    119     dictionary""" 
     164    dictionary 
     165    """ 
    120166     
    121167    def __init__(self, *args): 
     
    145191        filtered out.  Filter functions may also raise an exception if they 
    146192        wish to abort completely 
     193         
     194        @param key: dict key to check 
     195        @type key: basestring 
     196        @param val: value to check 
     197        @type val: any 
    147198        """ 
    148199        if not self.__KeyFilter(key): 
     
    156207                   
    157208    def __setitem__(self, key, val): 
    158         """Enforce type checking when setting new items"""        
     209        """Enforce type checking when setting new items 
     210         
     211        @param key: key for item to set 
     212        @type key: any 
     213        @param val: value to set for this key 
     214        @type val: any 
     215        """        
    159216        if self._verifyKeyValPair(key, val): 
    160217            self.__map[key] = val 
    161218 
    162219    def __getitem__(self, key): 
    163         """Provde implementation for getting items""" 
     220        """Provide implementation for getting items 
     221        @param key: key for item to retrieve 
     222        @type key: any 
     223        @return: value for input key 
     224        @rtype: any 
     225        """ 
    164226        if key not in self.__map: 
    165227            raise KeyError('%r key not found in dict' % key) 
     
    168230     
    169231    def get(self, key, *arg): 
    170         """Provide implementation of get item with default""" 
     232        """Provide implementation of get item with default 
     233         
     234        @param key: key for item to retrieve 
     235        @type key: any 
     236        @param arg: use to set a default argument 
     237        @type arg: tuple 
     238        """ 
    171239        if key in self.__map: 
    172240            return self.__map[key] 
Note: See TracChangeset for help on using the changeset viewer.