mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2024-12-23 07:33:27 -06:00
151 lines
3.7 KiB
Python
151 lines
3.7 KiB
Python
# Authors:
|
|
# Jason Gerard DeRose <jderose@redhat.com>
|
|
#
|
|
# Copyright (C) 2008 Red Hat
|
|
# see file 'COPYING' for use and warranty information
|
|
#
|
|
# This program is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU General Public License as
|
|
# published by the Free Software Foundation; version 2 only
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
"""
|
|
Base classes for plug-in architecture and generative API.
|
|
"""
|
|
|
|
from exceptions import SetAttributeError
|
|
|
|
|
|
class Command(object):
|
|
def normalize(self, kw):
|
|
raise NotImplementedError
|
|
|
|
def validate(self, kw):
|
|
raise NotImplementedError
|
|
|
|
def execute(self, kw):
|
|
raise NotImplementedError
|
|
|
|
def __call__(self, **kw):
|
|
kw = self.normalize(kw)
|
|
invalid = self.validate(kw)
|
|
if invalid:
|
|
return invalid
|
|
return self.execute(kw)
|
|
|
|
|
|
class Argument(object):
|
|
pass
|
|
|
|
|
|
class NameSpace(object):
|
|
"""
|
|
A read-only namespace of (key, value) pairs that can be accessed
|
|
both as instance attributes and as dictionary items. For example:
|
|
|
|
>>> ns = NameSpace(dict(my_message='Hello world!'))
|
|
>>> ns.my_message
|
|
'Hello world!'
|
|
>>> ns['my_message']
|
|
'Hello world!'
|
|
|
|
Keep in mind that Python doesn't offer true ready-only attributes. A
|
|
NameSpace is read-only in that it prevents programmers from
|
|
*accidentally* setting its attributes, but a motivated programmer can
|
|
still set them.
|
|
|
|
For example, setting an attribute the normal way will raise an exception:
|
|
|
|
>>> ns.my_message = 'some new value'
|
|
(raises ipalib.exceptions.SetAttributeError)
|
|
|
|
But a programmer could still set the attribute like this:
|
|
|
|
>>> ns.__dict__['my_message'] = 'some new value'
|
|
|
|
You should especially not implement a security feature that relies upon
|
|
NameSpace being strictly read-only.
|
|
"""
|
|
|
|
__locked = False # Whether __setattr__ has been locked
|
|
|
|
def __init__(self, kw):
|
|
"""
|
|
The single constructor argument `kw` is a dict of the (key, value)
|
|
pairs to be in this NameSpace instance.
|
|
"""
|
|
assert isinstance(kw, dict)
|
|
self.__kw = dict(kw)
|
|
for (key, value) in self.__kw.items():
|
|
assert not key.startswith('_')
|
|
setattr(self, key, value)
|
|
self.__keys = sorted(self.__kw)
|
|
self.__locked = True
|
|
|
|
def __setattr__(self, name, value):
|
|
"""
|
|
Raises an exception if trying to set an attribute after the
|
|
NameSpace has been locked; otherwise calls object.__setattr__().
|
|
"""
|
|
if self.__locked:
|
|
raise SetAttributeError(name)
|
|
super(NameSpace, self).__setattr__(name, value)
|
|
|
|
def __getitem__(self, key):
|
|
"""
|
|
Returns item from namespace named `key`.
|
|
"""
|
|
return self.__kw[key]
|
|
|
|
def __hasitem__(self, key):
|
|
"""
|
|
Returns True if namespace has an item named `key`.
|
|
"""
|
|
return key in self.__kw
|
|
|
|
def __iter__(self):
|
|
"""
|
|
Yields the names in this NameSpace in ascending order.
|
|
|
|
For example:
|
|
|
|
>>> ns = NameSpace(dict(attr_b='world', attr_a='hello'))
|
|
>>> list(ns)
|
|
['attr_a', 'attr_b']
|
|
>>> [ns[k] for k in ns]
|
|
['hello', 'world']
|
|
"""
|
|
for key in self.__keys:
|
|
yield key
|
|
|
|
def __len__(self):
|
|
"""
|
|
Returns number of items in this NameSpace.
|
|
"""
|
|
return len(self.__keys)
|
|
|
|
|
|
class API(object):
|
|
def __init__(self):
|
|
self.__c = object()
|
|
self.__o = object()
|
|
|
|
def __get_c(self):
|
|
return self.__c
|
|
c = property(__get_c)
|
|
|
|
def __get_o(self):
|
|
return self.__o
|
|
o = property(__get_o)
|
|
|
|
def register_command(self, name, callback, override=False):
|
|
pass
|