U [e@/@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-2020 by Onni Software Ltd. :license: New BSD License, see LICENSE for more details N) defaultdict) json_dumpsdo_import_classc@s:eZdZdZd 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)selfrZabs_class_pathtagskeywordsrL/var/www/html/services/stratfitenv/lib/python3.8/site-packages/lml/plugin.py__init___s zPluginInfo.__init__cCs8|dkr,|jr |jdd}n|jj}|S|j|S)N module_name.r)rsplitr __module__r get)r namerrrr __getattr__hs zPluginInfo.__getattr__ccs*|jdkr|jVn|jD] }|VqdS)z A list of tags for identifying the plugin class The plugin class is described at the absolute_import_path N)r r)r tagrrrr qs   zPluginInfo.tagscCs"|j|jd}||jt|S)N)rpath)rrupdater r)r reprrr__repr__}s  zPluginInfo.__repr__cCs||_t|||Sr)r _register_a_plugin)r r rrr__call__s zPluginInfo.__call__)NN) __name__r __qualname____doc__rrr rrrrrrr's8   rc@s2eZdZdZddZd ddZddZd d ZdS) PluginInfoChainzr Pandas style, chained list declaration It is used in the plugin packages to list all plugin classes cCs&t|jjd|jj|_||_dSNr)logging getLogger __class__rr _loggerr)r rrrrrszPluginInfoChain.__init__NcKs"t|||f|}|||S)z Add a plain plugin Parameters ------------- plugin_type: plugin manager name submodule: the relative import path to your plugin class )r _get_abs_pathadd_a_plugin_instance)r r submoduler a_plugin_inforrr add_a_plugins  zPluginInfoChain.add_a_plugincCs |jd|j|jt||S)z Add a plain plugin Parameters ------------- plugin_info_instance: an instance of PluginInfo The developer has to specify the absolute import path zadd %s as '%s' plugin)r(debugrr_load_me_later)r Zplugin_info_instancerrrr*s z%PluginInfoChain.add_a_plugin_instancecCsd|j|fS)Nz%s.%s)r)r r+rrrr)szPluginInfoChain._get_abs_path)N)r rr!r"rr-r*r)rrrrr#s  r#c@sZeZdZdZddZddZddZdd Zdd d Zd dZ ddZ ddZ ddZ d S) PluginManagerz Load plugin info into in-memory dictionary for later import Parameters -------------- plugin_type: the plugin type. All plugins of this plugin type will be registered to it. cCs@||_tt|_t|_t|jj d|jj |_ t |dSr$) plugin_namerlistregistrydict tag_groupsr%r&r'rr r(_register_class)r rrrrrs zPluginManager.__init__cKs|jd||}|S)z Get a plugin Parameters --------------- key: the key to find the plugins keywords: additional parameters for help the retrieval of the plugins zget a plugin called)r(r. load_me_now)r keyrpluginrrr get_a_plugins  zPluginManager.get_a_plugincCs(|j|jtd|j|fdS)zRaise plugin not found exception Override this method to raise custom exception Parameters ----------------- key: the key to find the plugin zNo %s is found for %sN)r(r.r3keys Exceptionr1)r r8rrrraise_exceptions zPluginManager.raise_exceptioncCs|jd|j||dS)z Register a plugin info for later loading Parameters -------------- plugin_info: a instance of plugin info z load %s laterN)r(r.r&_update_registry_and_expand_tag_groups)r plugin_inforrr load_me_laters zPluginManager.load_me_laterNcKs|r|j||}||jkr|j|D]*}||}t|}|rR||krRq,q,qrq,|jd||||jd|||S||dS)z Import a plugin from plugin registry Parameters ----------------- key: the key to find the plugin library: to use a specific plugin module z%s is not installedzload %s now for '%s'N)r(r.lowerr3dynamic_load_library_get_me_pypi_package_namer=)r r8libraryr_PluginManager__keyr?r rrrrr7s      zPluginManager.load_me_nowcCs2|jdkr,|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 rrrrB&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_clsr?rrrregister_a_plugin6s zPluginManager.register_a_plugincCs|}|j|dSr)rAr5r)r r8rErrrget_primary_keyFszPluginManager.get_primary_keycCsPd}t|D]:\}}|j|||dkr<|}||j|<qdS)Nr) enumerater r3rAappendr5)r r?Z primary_tagindexr8rrrr>Js z4PluginManager._update_registry_and_expand_tag_groups)N) r rr!r"rr:r=r@r7rBrHrIr>rrrrr0s   "r0cCsptd|j|t|j<|jtkrlt|jD]6}|jrFtd|jntdt|j||q,t|j=dS)z(Reigister a newly created plugin managerzdeclare '%s' plugin managerzload cached plugin info: %sN) logr.r1PLUG_IN_MANAGERSCACHED_PLUGIN_INFOrrFr r@)r r?rrrr6Ss   r6cCsnt|j}|r|||nLztdt|jWn$tk rXtdt|YnXt |j |dS)z*module level function to register a pluginz caching %sN) rNrrrHrMr.rFr AttributeErrorrOrK)r?rGmanagerrrrris rcCsBt|j}|r||n"td|j|jt|j|dS)z- module level function to load a plugin laterzcaching %s for %sN) rNrrr@rMr.rrOrK)r?rQrrrr/ws  r/cCs>z"|j}|dd}|ddWStk r8YdSXdS)Nrr_-)rrreplacerP)modulerZroot_module_namerrrrCs rCcCs.z|jWStk r(tt|YSXdSr)r rPstrtype)Zcls_func_or_data_typerrrrFsrF)r"r% collectionsrZ lml.utilsrrrNr2rOr&r rMobjectrr#r0r6rr/rCrFrrrrs  d9