IntenseWebs/freeipa
3
0
Fork 0
mirror of https://salsa.debian.org/freeipa-team/freeipa.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

298: Cleaned up docstrings in ReadOnly methods

Browse Source
This commit is contained in:
Jason Gerard DeRose 2008-09-18 22:01:04 +00:00
parent e524c826db
commit 81ebe078be
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
ipalib/plugable.py
View File

@ -71,22 +71,25 @@ class ReadOnly(object):
def __lock__(self):
"""
Puts this instance into a read-only state, after which attempting to
set or delete an attribute will raise AttributeError.
Put this instance into a read-only state.
After the instance has been locked, attempting to set or delete an
attribute will raise AttributeError.
"""
assert self.__locked is False, '__lock__() can only be called once'
self.__locked = True
def __islocked__(self):
"""
Returns True if this instance is locked, False otherwise.
Return whether instance is locked.
"""
return self.__locked
def __setattr__(self, name, value):
"""
Raises an AttributeError if `ReadOnly.__lock__()` has already been
called; otherwise calls object.__setattr__().
If unlocked, set attribute named ``name`` to ``value``.
If this instance is locked, AttributeError will be raised.
"""
if self.__locked:
raise AttributeError('read-only: cannot set %s.%s' %
@ -96,8 +99,9 @@ class ReadOnly(object):
def __delattr__(self, name):
"""
Raises an AttributeError if `ReadOnly.__lock__()` has already been
called; otherwise calls object.__delattr__().
If unlocked, delete attribute named ``name``.
If this instance is locked, AttributeError will be raised.
"""
if self.__locked:
raise AttributeError('read-only: cannot del %s.%s' %