PK5Npyplugs/__init__.py"""PyPlugs, decorator based plug-in architecture for Python Current maintainers: -------------------- {maintainers} """ # Standard library imports from datetime import date as _date from collections import namedtuple as _namedtuple # Include PyPlugs functions at top level from pyplugs._plugins import * # noqa # Version of PyPlugs. # # This is automatically set using the bumpversion tool __version__ = "0.2.1" # Authors of Midgard. _Author = _namedtuple("_Author", ["name", "email", "start", "end"]) _AUTHORS = [ _Author("Geir Arne Hjelle", "geirarne@gmail.com", _date(2019, 4, 1), _date.max) ] __author__ = ", ".join(a.name for a in _AUTHORS if a.start < _date.today() < a.end) __contact__ = ", ".join(a.email for a in _AUTHORS if a.start < _date.today() < a.end) # Update doc with info about maintainers def _update_doc(doc: str) -> str: """Add information to doc-string Args: doc: The doc-string to update. Returns: The updated doc-string. """ # Maintainers maintainer_list = [ f"+ {a.name} <{a.email}>" for a in _AUTHORS if a.start < _date.today() < a.end ] maintainers = "\n".join(maintainer_list) # Add to doc-string return doc.format(maintainers=maintainers) __doc__ = _update_doc(__doc__) PK鵉N9kIIpyplugs/_plugins.py"""Decorators for registering plugins """ # Standard library imports import functools import importlib import pathlib import sys import textwrap from typing import Callable, Dict from typing import NamedTuple # Type aliases PackageName = str PluginName = str FuncName = str # Only expose decorated functions to the outside __all__ = [] def expose(func): """Add function to __all__ so it will be exposed at the top level""" __all__.append(func.__name__) return func class PluginInfo(NamedTuple): """Information about one plug-in""" package_name: PackageName plugin_name: PluginName func_name: FuncName func: Callable description: str doc: str module_doc: str sort_value: int # Dictionary with information about all registered plug-ins _PLUGINS: Dict[PackageName, Dict[PluginName, Dict[FuncName, PluginInfo]]] = dict() @expose def register(_func: Callable = None, *, sort_value: int = 0) -> Callable: """Decorator for registering a new plug-in""" def decorator_register(func): package_name, _, plugin_name = func.__module__.rpartition(".") description, _, doc = (func.__doc__ or "").partition("\n\n") func_name = func.__name__ module_doc = sys.modules[func.__module__].__doc__ pkg_info = _PLUGINS.setdefault(package_name, dict()) plugin_info = pkg_info.setdefault(plugin_name, dict()) plugin_info[func_name] = PluginInfo( package_name=package_name, plugin_name=plugin_name, func_name=func_name, func=func, description=description, doc=textwrap.dedent(doc), module_doc=module_doc, sort_value=sort_value, ) return func if _func is None: return decorator_register else: return decorator_register(_func) @expose def names(package): """List all plug-ins in one package""" _import_all(package) return sorted(_PLUGINS[package].keys()) @expose def funcs(package, plugin): """List all functions in one plug-in""" _import(package, plugin) plugin_info = _PLUGINS[package][plugin] return list(plugin_info.keys()) @expose def info(package, plugin, func=None): """Get information about a plug-in""" _import(package, plugin) plugin_info = _PLUGINS[package][plugin] func = next(iter(plugin_info.keys())) if func is None else func return plugin_info[func] @expose def get(package, plugin, func=None): """Get a given plugin""" return info(package, plugin, func).func @expose def call(package, plugin, func=None, *args, **kwargs): """Call the given plugin""" plugin_func = get(package, plugin, func) return plugin_func(*args, **kwargs) def _import(package, plugin): """Import the given plugin file from a package""" importlib.import_module(f"{package}.{plugin}") def _import_all(package): """Import all plugins in a package""" pkg = importlib.import_module(package) pkg_paths = [pathlib.Path(p) for p in pkg.__path__] for pkg_path in pkg_paths: for path in pkg_path.iterdir(): plugin = path.stem if not plugin.startswith("_"): _import(package, plugin) @expose def names_factory(package): """Create a names() function for one package""" return functools.partial(names, package) @expose def funcs_factory(package): """Create a funcs() function for one package""" return functools.partial(funcs, package) @expose def info_factory(package): """Create a info() function for one package""" return functools.partial(info, package) @expose def get_factory(package): """Create a get() function for one package""" return functools.partial(get, package) @expose def call_factory(package): """Create a call() function for one package""" return functools.partial(call, package) PK|N$011pyplugs-0.2.1.dist-info/LICENSEMIT License Copyright (c) 2019 Geir Arne Hjelle Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. PK!HPOpyplugs-0.2.1.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,szd&Y)r$[)T&UrPK!Hq'| pyplugs-0.2.1.dist-info/METADATAUmo6_qk7`")uАaF6FǨӽ  :Kl(\e˱v^O{o{I,x9ΨP:3ѸumüG)(^[XrDD6GEXyJ7Jט^GqyWa ]g%ޣR R`vzvnjnm򞉈v$J  \k.U%9Y+weoC]ï??KtJ)Ʌn<6> gBvsr%/EMMXXx -&e*>Oc؂7 F`oPGm2"v11VJ7ӻ&()vz"$r-q[]Z^a_-k=<"$vͩ-kZRcHt{qntT\<9<)}r i7s R>LwCm+t݈/~BH,"r7cO-ػ˯[3@ Ge*pqȬVNeFxXv]epNa.t|p_d[LggG;$g z ?ȸ$T"x16]AGYsZ^hRM8g5gdl(!vi*T_OM,&qUbPK!H/d,(pyplugs-0.2.1.dist-info/RECORDuλv0g!h: DQ\F(<}ہs8w~&ƌ%yR3&T})zp]VY^xw@~qSO3%h$/I^tMF&KYPѣs-w>;:X`"+2yR ɣbLzdpGBN!#'XAisV @8Ꞹ_{p:f:!,OƇ6F}Ap߶/[I/ Ḿ#D3idY"=2iugk%ε%iPK5Npyplugs/__init__.pyPK鵉N9kII7pyplugs/_plugins.pyPK|N$011pyplugs-0.2.1.dist-info/LICENSEPK!HPOpyplugs-0.2.1.dist-info/WHEELPK!Hq'| pyplugs-0.2.1.dist-info/METADATAPK!H/d,(dpyplugs-0.2.1.dist-info/RECORDPK