diff options
| -rw-r--r-- | ipalib/cli.py | 4 | ||||
| -rw-r--r-- | ipalib/config.py | 4 | ||||
| -rw-r--r-- | ipalib/constants.py | 1 | ||||
| -rw-r--r-- | ipalib/frontend.py | 63 | ||||
| -rw-r--r-- | ipalib/plugable.py | 87 | ||||
| -rw-r--r-- | ipaserver/rpcserver.py | 12 | ||||
| -rwxr-xr-x | makeapi | 1 | ||||
| -rw-r--r-- | tests/test_ipalib/test_frontend.py | 3 |
8 files changed, 135 insertions, 40 deletions
diff --git a/ipalib/cli.py b/ipalib/cli.py index 7fe808755..7d79775ef 100644 --- a/ipalib/cli.py +++ b/ipalib/cli.py @@ -684,7 +684,7 @@ class help(frontend.Local): mcl = max((self._topics[topic_name][1], len(mod_name))) self._topics[topic_name][1] = mcl - def finalize(self): + def _on_finalize(self): # {topic: ["description", mcl, {"subtopic": ["description", mcl, [commands]]}]} # {topic: ["description", mcl, [commands]]} self._topics = {} @@ -736,7 +736,7 @@ class help(frontend.Local): len(s) for s in (self._topics.keys() + [c.name for c in self._builtins]) ) - super(help, self).finalize() + super(help, self)._on_finalize() def run(self, key): name = from_cli(key) diff --git a/ipalib/config.py b/ipalib/config.py index 410e5f0b2..5e3ef8d9b 100644 --- a/ipalib/config.py +++ b/ipalib/config.py @@ -492,6 +492,10 @@ class Env(object): if 'conf_default' not in self: self.conf_default = self._join('confdir', 'default.conf') + # Set plugins_on_demand: + if 'plugins_on_demand' not in self: + self.plugins_on_demand = (self.context == 'cli') + def _finalize_core(self, **defaults): """ Complete initialization of standard IPA environment. diff --git a/ipalib/constants.py b/ipalib/constants.py index 6d246288b..7ec897b58 100644 --- a/ipalib/constants.py +++ b/ipalib/constants.py @@ -188,6 +188,7 @@ DEFAULT_CONFIG = ( ('confdir', object), # Directory containing config files ('conf', object), # File containing context specific config ('conf_default', object), # File containing context independent config + ('plugins_on_demand', object), # Whether to finalize plugins on-demand (bool) # Set in Env._finalize_core(): ('in_server', object), # Whether or not running in-server (bool) diff --git a/ipalib/frontend.py b/ipalib/frontend.py index 851de4379..3dc30daee 100644 --- a/ipalib/frontend.py +++ b/ipalib/frontend.py @@ -388,17 +388,20 @@ class Command(HasParam): ipalib.frontend.my_command() """ + finalize_early = False + takes_options = tuple() takes_args = tuple() - args = None - options = None - params = None + # Create stubs for attributes that are set in _on_finalize() + args = Plugin.finalize_attr('args') + options = Plugin.finalize_attr('options') + params = Plugin.finalize_attr('params') obj = None use_output_validation = True - output = None + output = Plugin.finalize_attr('output') has_output = ('result',) - output_params = None + output_params = Plugin.finalize_attr('output_params') has_output_params = tuple() msg_summary = None @@ -411,6 +414,7 @@ class Command(HasParam): If not in a server context, the call will be forwarded over XML-RPC and the executed an the nearest IPA server. """ + self.ensure_finalized() params = self.args_options_2_params(*args, **options) self.debug( 'raw: %s(%s)', self.name, ', '.join(self._repr_iter(**params)) @@ -769,7 +773,7 @@ class Command(HasParam): """ return self.Backend.xmlclient.forward(self.name, *args, **kw) - def finalize(self): + def _on_finalize(self): """ Finalize plugin initialization. @@ -799,7 +803,7 @@ class Command(HasParam): ) self.output = NameSpace(self._iter_output(), sort=False) self._create_param_namespace('output_params') - super(Command, self).finalize() + super(Command, self)._on_finalize() def _iter_output(self): if type(self.has_output) is not tuple: @@ -1040,19 +1044,21 @@ class Local(Command): class Object(HasParam): - backend = None - methods = None - properties = None - params = None - primary_key = None - params_minus_pk = None + finalize_early = False + + # Create stubs for attributes that are set in _on_finalize() + backend = Plugin.finalize_attr('backend') + methods = Plugin.finalize_attr('methods') + properties = Plugin.finalize_attr('properties') + params = Plugin.finalize_attr('params') + primary_key = Plugin.finalize_attr('primary_key') + params_minus_pk = Plugin.finalize_attr('params_minus_pk') # Can override in subclasses: backend_name = None takes_params = tuple() - def set_api(self, api): - super(Object, self).set_api(api) + def _on_finalize(self): self.methods = NameSpace( self.__get_attrs('Method'), sort=False, name_attr='attr_name' ) @@ -1074,11 +1080,14 @@ class Object(HasParam): filter(lambda p: not p.primary_key, self.params()), sort=False #pylint: disable=E1102 ) else: + self.primary_key = None self.params_minus_pk = self.params if 'Backend' in self.api and self.backend_name in self.api.Backend: self.backend = self.api.Backend[self.backend_name] + super(Object, self)._on_finalize() + def params_minus(self, *names): """ Yield all Param whose name is not in ``names``. @@ -1166,16 +1175,20 @@ class Attribute(Plugin): only the base class for the `Method` and `Property` classes. Also see the `Object` class. """ - __obj = None + finalize_early = False + + NAME_REGEX = re.compile( + '^(?P<obj>[a-z][a-z0-9]+)_(?P<attr>[a-z][a-z0-9]+(?:_[a-z][a-z0-9]+)*)$' + ) + + # Create stubs for attributes that are set in _on_finalize() + __obj = Plugin.finalize_attr('_Attribute__obj') def __init__(self): - m = re.match( - '^([a-z][a-z0-9]+)_([a-z][a-z0-9]+(?:_[a-z][a-z0-9]+)*)$', - self.__class__.__name__ - ) + m = self.NAME_REGEX.match(type(self).__name__) assert m - self.__obj_name = m.group(1) - self.__attr_name = m.group(2) + self.__obj_name = m.group('obj') + self.__attr_name = m.group('attr') super(Attribute, self).__init__() def __get_obj_name(self): @@ -1194,9 +1207,9 @@ class Attribute(Plugin): return self.__obj obj = property(__get_obj) - def set_api(self, api): - self.__obj = api.Object[self.obj_name] - super(Attribute, self).set_api(api) + def _on_finalize(self): + self.__obj = self.api.Object[self.obj_name] + super(Attribute, self)._on_finalize() class Method(Attribute, Command): diff --git a/ipalib/plugable.py b/ipalib/plugable.py index b0e415656..a76f884d5 100644 --- a/ipalib/plugable.py +++ b/ipalib/plugable.py @@ -172,10 +172,15 @@ class Plugin(ReadOnly): Base class for all plugins. """ + finalize_early = True + label = None def __init__(self): self.__api = None + self.__finalize_called = False + self.__finalized = False + self.__finalize_lock = threading.RLock() cls = self.__class__ self.name = cls.__name__ self.module = cls.__module__ @@ -210,18 +215,85 @@ class Plugin(ReadOnly): def __get_api(self): """ - Return `API` instance passed to `finalize()`. + Return `API` instance passed to `set_api()`. - If `finalize()` has not yet been called, None is returned. + If `set_api()` has not yet been called, None is returned. """ return self.__api api = property(__get_api) def finalize(self): """ + Finalize plugin initialization. + + This method calls `_on_finalize()` and locks the plugin object. + + Subclasses should not override this method. Custom finalization is done + in `_on_finalize()`. """ - if not is_production_mode(self): - lock(self) + with self.__finalize_lock: + assert self.__finalized is False + if self.__finalize_called: + # No recursive calls! + return + self.__finalize_called = True + self._on_finalize() + self.__finalized = True + if not is_production_mode(self): + lock(self) + + def _on_finalize(self): + """ + Do custom finalization. + + This method is called from `finalize()`. Subclasses can override this + method in order to add custom finalization. + """ + pass + + def ensure_finalized(self): + """ + Finalize plugin initialization if it has not yet been finalized. + """ + with self.__finalize_lock: + if not self.__finalized: + self.finalize() + + class finalize_attr(object): + """ + Create a stub object for plugin attribute that isn't set until the + finalization of the plugin initialization. + + When the stub object is accessed, it calls `ensure_finalized()` to make + sure the plugin initialization is finalized. The stub object is expected + to be replaced with the actual attribute value during the finalization + (preferably in `_on_finalize()`), otherwise an `AttributeError` is + raised. + + This is used to implement on-demand finalization of plugin + initialization. + """ + __slots__ = ('name', 'value') + + def __init__(self, name, value=None): + self.name = name + self.value = value + + def __get__(self, obj, cls): + if obj is None or obj.api is None: + return self.value + obj.ensure_finalized() + try: + return getattr(obj, self.name) + except RuntimeError: + # If the actual attribute value is not set in _on_finalize(), + # getattr() calls __get__() again, which leads to infinite + # recursion. This can happen only if the plugin is written + # badly, so advise the developer about that instead of giving + # them a generic "maximum recursion depth exceeded" error. + raise AttributeError( + "attribute '%s' of plugin '%s' was not set in finalize()" % (self.name, obj.name) + ) def set_api(self, api): """ @@ -607,6 +679,7 @@ class API(DictProxy): lock(self) plugins = {} + tofinalize = set() def plugin_iter(base, subclasses): for klass in subclasses: assert issubclass(klass, base) @@ -616,6 +689,8 @@ class API(DictProxy): if not is_production_mode(self): assert base not in p.bases p.bases.append(base) + if klass.finalize_early or not self.env.plugins_on_demand: + tofinalize.add(p) yield p.instance production_mode = is_production_mode(self) @@ -637,8 +712,8 @@ class API(DictProxy): if not production_mode: assert p.instance.api is self - for p in plugins.itervalues(): - p.instance.finalize() + for p in tofinalize: + p.instance.ensure_finalized() if not production_mode: assert islocked(p.instance) is True object.__setattr__(self, '_API__finalized', True) diff --git a/ipaserver/rpcserver.py b/ipaserver/rpcserver.py index 35a109262..68d4379bb 100644 --- a/ipaserver/rpcserver.py +++ b/ipaserver/rpcserver.py @@ -143,9 +143,9 @@ class session(Executioner): finally: destroy_context() - def finalize(self): + def _on_finalize(self): self.url = self.env['mount_ipa'] - super(session, self).finalize() + super(session, self)._on_finalize() def route(self, environ, start_response): key = shift_path_info(environ) @@ -186,9 +186,9 @@ class WSGIExecutioner(Executioner): if 'session' in self.api.Backend: self.api.Backend.session.mount(self, self.key) - def finalize(self): + def _on_finalize(self): self.url = self.env.mount_ipa + self.key - super(WSGIExecutioner, self).finalize() + super(WSGIExecutioner, self)._on_finalize() def wsgi_execute(self, environ): result = None @@ -285,13 +285,13 @@ class xmlserver(WSGIExecutioner): content_type = 'text/xml' key = 'xml' - def finalize(self): + def _on_finalize(self): self.__system = { 'system.listMethods': self.listMethods, 'system.methodSignature': self.methodSignature, 'system.methodHelp': self.methodHelp, } - super(xmlserver, self).finalize() + super(xmlserver, self)._on_finalize() def listMethods(self, *params): return tuple(name.decode('UTF-8') for name in self.Command) @@ -397,6 +397,7 @@ def main(): validate_api=True, enable_ra=True, mode='developer', + plugins_on_demand=False, ) api.bootstrap(**cfg) diff --git a/tests/test_ipalib/test_frontend.py b/tests/test_ipalib/test_frontend.py index 0f6aecb3d..b717a43ad 100644 --- a/tests/test_ipalib/test_frontend.py +++ b/tests/test_ipalib/test_frontend.py @@ -942,7 +942,8 @@ class test_Object(ClassChecker): parameters.Str('four', primary_key=True), ) o = example3() - e = raises(ValueError, o.set_api, api) + o.set_api(api) + e = raises(ValueError, o.finalize) assert str(e) == \ 'example3 (Object) has multiple primary keys: one, two, four' |