Package openid :: Package extensions :: Module ax :: Class AttrInfo
[hide private]
[frames] | no frames]

Class AttrInfo

source code

object --+
         |
        AttrInfo

Represents a single attribute in an attribute exchange request. This should be added to an AXRequest object in order to request the attribute.

Instance Methods [hide private]
 
__init__(self, type_uri, count=1, required=False, alias=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
wantsUnlimitedValues(self)
When processing a request for this attribute, the OP should call this method to determine whether all available attribute values were requested.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Instance Variables [hide private]
str or NoneType alias
The name that should be given to this alias in the request.
int count
How many values of this type to request from the subject.
bool required
Whether the attribute will be marked as required when presented to the subject of the attribute exchange request.
str type_uri
The identifier that determines what the attribute represents and how it is serialized.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, type_uri, count=1, required=False, alias=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

wantsUnlimitedValues(self)

source code 

When processing a request for this attribute, the OP should call this method to determine whether all available attribute values were requested. If self.count == UNLIMITED_VALUES, this returns True. Otherwise this returns False, in which case self.count is an integer.


Instance Variable Details [hide private]

alias

The name that should be given to this alias in the request. If it is not supplied, a generic name will be assigned. For example, if you want to call a Unix timestamp value 'tstamp', set its alias to that value. If two attributes in the same message request to use the same alias, the request will fail to be generated.
Type:
str or NoneType

count

How many values of this type to request from the subject. Defaults to one.
Type:
int

type_uri

The identifier that determines what the attribute represents and how it is serialized. For example, one type URI representing dates could represent a Unix timestamp in base 10 and another could represent a human-readable string.
Type:
str