o kh.@sdZddlZddlmZddlmZmZiZeeZ e e Z Gddde ZGddde ZGd d d e Zd d Zd dZddZddZddZdS)av lml.plugin ~~~~~~~~~~~~~~~~~~~ lml divides the plugins into two category: load-me-later plugins and load-me-now ones. load-me-later plugins refer to the plugins were loaded when needed due its bulky and/or memory hungry dependencies. Those plugins has to use lml and respect lml's design principle. load-me-now plugins refer to the plugins are immediately imported. All conventional Python classes are by default immediately imported. :class:`~lml.plugin.PluginManager` should be inherited to form new plugin manager class. If you have more than one plugins in your architecture, it is advisable to have one class per plugin type. :class:`~lml.plugin.PluginInfoChain` helps the plugin module to declare the available plugins in the module. :class:`~lml.plugin.PluginInfo` can be subclassed to describe your plugin. Its method :meth:`~lml.plugin.PluginInfo.tags` can be overridden to help its matching :class:`~lml.plugin.PluginManager` to look itself up. :copyright: (c) 2017-2018 by Onni Software Ltd. :license: New BSD License, see LICENSE for more details N) defaultdict) json_dumpsdo_import_classc@s<eZdZdZ d ddZddZddZd d Zd d ZdS) PluginInfoa) Information about the plugin. It is used together with PluginInfoChain to describe the plugins. Meanwhile, it is a class decorator and can be used to register a plugin immediately for use, in other words, the PluginInfo decorated plugin class is not loaded later. Parameters ------------- name: plugin name absolute_import_path: absolute import path from your plugin name space for your plugin class tags: a list of keywords help the plugin manager to retrieve your plugin keywords: Another custom properties. Examples ------------- For load-me-later plugins: >>> info = PluginInfo("sample", ... abs_class_path='lml.plugin.PluginInfo', # demonstration only. ... tags=['load-me-later'], ... custom_property = 'I am a custom property') >>> print(info.module_name) lml >>> print(info.custom_property) I am a custom property For load-me-now plugins: >>> @PluginInfo("sample", tags=['load-me-now']) ... class TestPlugin: ... def echo(self, words): ... print("echoing %s" % words) Now let's retrive the second plugin back: >>> class SamplePluginManager(PluginManager): ... def __init__(self): ... PluginManager.__init__(self, "sample") >>> sample_manager = SamplePluginManager() >>> test_plugin=sample_manager.get_a_plugin("load-me-now") >>> test_plugin.echo("hey..") echoing hey.. NcKs"||_||_d|_||_||_dSN) plugin_typeabsolute_import_pathcls properties_PluginInfo__tags)selfrabs_class_pathtagskeywordsrr?)r r:libraryr_PluginManager__keyrAr rrrrr9s     zPluginManager.load_me_nowcCs2|jdur|jd|jt|j}||_|jS)zDynamically load the plugin info if not loaded Parameters -------------- a_plugin_info: a instance of plugin info Nzimport )r r)r/rr)r r-r rrrrD$s  z"PluginManager.dynamic_load_librarycCs&|jdt|||_||dS)z for dynamically loaded plugin during runtime Parameters -------------- plugin_cls: the actual plugin class refered to by the second parameter plugin_info: a instance of plugin info z register %sN)r)r/_show_me_your_namer r@)r plugin_clsrArrrregister_a_plugin4s zPluginManager.register_a_plugincCs|}|j|dSr)rCr7r)r r:rGrrrget_primary_keyDszPluginManager.get_primary_keycCsPd}t|D]\}}|j|||dkr|}||j|<qdS)Nr) enumeraterr5rCappendr7)r rA primary_tagindexr:rrrr@Hsz4PluginManager._update_registry_and_expand_tag_groupsr) r!rr"r#rr<r?rBr9rDrJrKr@rrrrr2s     r2cCsttd|j|t|j<|jtvr8t|jD]}|jr#td|jn tdt|j||qt|j=dSdS)z(Reigister a newly created plugin managerzdeclare '%s' plugin managerzload cached plugin info: %sN) logr/r3PLUG_IN_MANAGERSCACHED_PLUGIN_INFOrrHr rB)r rArrrr8Qs     r8cCsFt|j}|r|||dStdt|jt|j |dS)z*module level function to register a pluginz caching %sN) rQrrrJrPr/rHr!rRrM)rArImanagerrrrrgs rcCsDt|j}|r||dStd|j|jt|j|dS)z- module level function to load a plugin laterzcaching %s for %sN) rQrrrBrPr/rrRrM)rArSrrrr0rs r0cCs8z|j}|dd}|ddWStyYdSw)Nrr_-)rrreplaceAttributeError)modulerroot_module_namerrrrEs rEcCs(z|jWStytt|YSwr)r!rWstrtype)cls_func_or_data_typerrrrHs  rH)r#r& collectionsr lml.utilsrrrQr4rRr'r!rPobjectrr$r2r8rr0rErHrrrrs   d9