Some PEP-257 and reStructuredText fixes in ipalib/aci.py, ipa_server/ipaldap.py

This commit is contained in:
Jason Gerard DeRose
2008-10-17 23:25:50 -06:00
parent 83a662e87a
commit 675fadc641
2 changed files with 41 additions and 24 deletions

View File

@@ -38,12 +38,14 @@ from ipalib import errors
sasl_auth = ldap.sasl.sasl({},'GSSAPI') sasl_auth = ldap.sasl.sasl({},'GSSAPI')
class Entry: class Entry:
"""This class represents an LDAP Entry object. An LDAP entry consists of """
This class represents an LDAP Entry object. An LDAP entry consists of
a DN and a list of attributes. Each attribute consists of a name and a DN and a list of attributes. Each attribute consists of a name and
a list of values. In python-ldap, entries are returned as a list of a list of values. In python-ldap, entries are returned as a list of
2-tuples. Instance variables: 2-tuples. Instance variables:
dn - string - the string DN of the entry
data - CIDict - case insensitive dict of the attributes and values * dn - string - the string DN of the entry
* data - CIDict - case insensitive dict of the attributes and values
""" """
def __init__(self,entrydata): def __init__(self,entrydata):
"""data is the raw data returned from the python-ldap result method, which is """data is the raw data returned from the python-ldap result method, which is
@@ -88,14 +90,20 @@ class Entry:
return self.data.get(name,[None])[0] return self.data.get(name,[None])[0]
def setValue(self, name, *value): def setValue(self, name, *value):
"""Value passed in may be a single value, several values, or a single sequence. """
For example: Set a value on this entry.
ent.setValue('name', 'value')
ent.setValue('name', 'value1', 'value2', ..., 'valueN') The value passed in may be a single value, several values, or a
ent.setValue('name', ['value1', 'value2', ..., 'valueN']) single sequence. For example:
ent.setValue('name', ('value1', 'value2', ..., 'valueN'))
Since *value is a tuple, we may have to extract a list or tuple from that * ent.setValue('name', 'value')
tuple as in the last two examples above""" * ent.setValue('name', 'value1', 'value2', ..., 'valueN')
* ent.setValue('name', ['value1', 'value2', ..., 'valueN'])
* ent.setValue('name', ('value1', 'value2', ..., 'valueN'))
Since value is a tuple, we may have to extract a list or tuple from
that tuple as in the last two examples above.
"""
if isinstance(value[0],list) or isinstance(value[0],tuple): if isinstance(value[0],list) or isinstance(value[0],tuple):
self.data[name] = value[0] self.data[name] = value[0]
else: else:

View File

@@ -71,9 +71,14 @@ class ACI:
return self.export_to_string() return self.export_to_string()
def __getattr__(self, name): def __getattr__(self, name):
"""Backwards compatibility for the old ACI class. """
Backward compatibility for the old ACI class.
The following extra attributes are available: The following extra attributes are available:
source_group, dest_group and attrs.
- source_group
- dest_group
- attrs
""" """
if name == 'source_group': if name == 'source_group':
group = '' group = ''
@@ -96,9 +101,13 @@ class ACI:
raise AttributeError, "object has no attribute '%s'" % name raise AttributeError, "object has no attribute '%s'" % name
def __setattr__(self, name, value): def __setattr__(self, name, value):
"""Backwards compatibility for the old ACI class. """
Backward compatibility for the old ACI class.
The following extra attributes are available: The following extra attributes are available:
source_group, dest_group and attrs. - source_group
- dest_group
- attrs
""" """
if name == 'source_group': if name == 'source_group':
self.__dict__['bindrule'] = 'groupdn="ldap:///%s"' % value self.__dict__['bindrule'] = 'groupdn="ldap:///%s"' % value