Ef@/dZddlZddlmZddlmZmZiZeeZ ej e Z Gdde ZGdde ZGd d e Zd Zd Zd ZdZdZdS)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_classc4eZdZdZ ddZdZdZdZdZdS) 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.. Nc L||_||_d|_||_||_dSN) plugin_typeabsolute_import_pathcls properties_PluginInfo__tags)selfr abs_class_pathtagskeywordss L/var/www/ffwdstore.be/apps/py-env/lib/python3.11/site-packages/lml/plugin.py__init__zPluginInfo.__init___s-'$2!" c|dkr6|jr!|jdd}n |jj}|S|j|S)N module_name.r)r splitr __module__r get)rnamers r __getattr__zPluginInfo.__getattr__hs[ = ( 2"7==cBB1E "h1  ""4(((rc#JK|j |jVdS|jD]}|VdS)z A list of tags for identifying the plugin class The plugin class is described at the absolute_import_path N)rr )rtags rrzPluginInfo.tagsqsK ; " " " " " "{     rcr|j|jd}||jt |S)N)r path)r r updater r)rreps r__repr__zPluginInfo.__repr__}s<+-   4?####rc4||_t|||Sr )r _register_a_plugin)rr s r__call__zPluginInfo.__call__s4%%% r)NN) __name__r __qualname____doc__rrrr$r'rrrr'st55p6:)))   rrc,eZdZdZdZddZdZdZdS)PluginInfoChainzr Pandas style, chained list declaration It is used in the plugin packages to list all plugin classes cztj|jjdz|jjz|_||_dSNr)logging getLogger __class__rr(_loggerr)rr!s rrzPluginInfoChain.__init__s=( N % +dn.E E    rNc rt|||fi|}|||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)rr submoduler a_plugin_infos r add_a_pluginzPluginInfoChain.add_a_pluginsN# ++I66  :B   ""=111 rcp|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)r3debugr r _load_me_later)rplugin_info_instances rr6z%PluginInfoChain.add_a_plugin_instancesC  # 5 ,   +,,, rc|jd|Sr/)r)rr7s rr5zPluginInfoChain._get_abs_paths***II66rr )r(rr)r*rr9r6r5r+rrr-r-s_    ((77777rr-cJeZdZdZdZdZdZdZd dZdZ d Z d Z d Z dS) 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. c||_tt|_t |_t j|jj dz|jj z|_ t|dSr/) plugin_namerlistregistrydict tag_groupsr0r1r2rr(r3_register_class)rr s rrzPluginManager.__init__se&#D)) &&( N % +dn.E E    rc t|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)r3r; load_me_now)rkeyrplugins r get_a_pluginzPluginManager.get_a_plugins9 0111!!#&&vxxrc|j|jt d|jd|)zRaise plugin not found exception Override this method to raise custom exception Parameters ----------------- key: the key to find the plugin zNo z is found for )r3r;rDkeys ExceptionrB)rrJs rraise_exceptionzPluginManager.raise_exceptionsH 4=--//000i43C3C3CSSIJJJrcp|jd|j||dS)z Register a plugin info for later loading Parameters -------------- plugin_info: a instance of plugin info z load %s laterN)r3r;r &_update_registry_and_expand_tag_groups)r plugin_infos r load_me_laterzPluginManager.load_me_laters9 ?K,LMMM 33K@@@@@rNc |r|j||}||jvr|j|D]0}||}t |}|r||kr/n2|jd|z|||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)r3r;lowerrDdynamic_load_library_get_me_pypi_package_namerP)rrJlibraryr_PluginManager__keyrSr rs rrIzPluginManager.load_me_nows  ) L  x ( ( (  DM ! !#}U3 * * // <<7<< {g55E ""#87#BCCC$$S))) L  5sC @ @ @J   % % % % %rc|j=|jd|jzt |j}||_|jS)zDynamically load the plugin info if not loaded Parameters -------------- a_plugin_info: a instance of plugin info Nzimport )r r3r;r r)rr8r s rrWz"PluginManager.dynamic_load_library&sL   $ L  y=+MM N N N!-"DEEC #M   rc|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)r3r;_show_me_your_namer rR)r plugin_clsrSs rregister_a_pluginzPluginManager.register_a_plugin6sF =* + +K/  14  1&{77   k * * * * s / / /-,rct|j}|r|||dS tdt |jn8#t$r+tdt |YnwxYwt|j |dS)z*module level function to register a pluginz caching %sN) rirr r_rhr;r]r(AttributeErrorrjrd)rSr^managers rr&r&is"";#:;;GH!!*k::::: D IIl$6z7J$K$K L L L L D D D IIl$6z$B$B C C C C C D;23::;GGGGGs-A))2BBc t|j}|r||dStd|j|jt|j|dS)z- module level function to load a plugin laterzcaching %s for %sN) rirr rTrhr;r rjrd)rSrms rr<r<ws"";#:;;G Hk*****   ,  #   ;23::;GGGGGrc |j}|dd}|ddS#t$rYdSwxYw)Nrr_-)rrreplacerl)modulerroot_module_names rrXrXs`' &,,S11!4''S111 tts7: AAcj |jS#t$rtt|cYSwxYwr )r(rlstrtype)cls_func_or_data_types rr]r]sH0$-- 0004-../////0s  &22)r*r0 collectionsr lml.utilsrrrirCrjr1r(rhobjectrr-r@rGr&r<rXr]r+rrr|sX6######11111111 [&&g!!aaaaaaaaH6767676767f676767rL7L7L7L7L7FL7L7L7^000, H H H H H H00000r