664 lines
30 KiB
HTML
664 lines
30 KiB
HTML
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
|
|
<meta name="generator" content="pdoc3 0.11.5">
|
|
<title>connpy.services.plugin_service API documentation</title>
|
|
<meta name="description" content="">
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
|
|
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
|
|
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
|
|
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
|
|
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
|
|
<script>window.addEventListener('DOMContentLoaded', () => {
|
|
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
|
|
hljs.highlightAll();
|
|
/* Collapse source docstrings */
|
|
setTimeout(() => {
|
|
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
|
|
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
|
|
.forEach(el => {
|
|
let d = document.createElement('details');
|
|
d.classList.add('hljs-string');
|
|
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
|
|
el.replaceWith(d);
|
|
});
|
|
}, 100);
|
|
})</script>
|
|
</head>
|
|
<body>
|
|
<main>
|
|
<article id="content">
|
|
<header>
|
|
<h1 class="title">Module <code>connpy.services.plugin_service</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="connpy.services.plugin_service.PluginService"><code class="flex name class">
|
|
<span>class <span class="ident">PluginService</span></span>
|
|
<span>(</span><span>config=None)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class PluginService(BaseService):
|
|
"""Business logic for enabling, disabling, and listing plugins."""
|
|
|
|
def list_plugins(self):
|
|
"""List all core and user-defined plugins with their status and hash."""
|
|
import os
|
|
import hashlib
|
|
|
|
# Check for user plugins directory
|
|
plugin_dir = os.path.join(self.config.defaultdir, "plugins")
|
|
# Check for core plugins directory
|
|
core_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "core_plugins")
|
|
|
|
all_plugin_info = {}
|
|
|
|
def get_hash(path):
|
|
try:
|
|
with open(path, "rb") as f:
|
|
return hashlib.md5(f.read()).hexdigest()
|
|
except Exception:
|
|
return ""
|
|
|
|
# User plugins
|
|
if os.path.exists(plugin_dir):
|
|
for f in os.listdir(plugin_dir):
|
|
if f.endswith(".py"):
|
|
name = f[:-3]
|
|
path = os.path.join(plugin_dir, f)
|
|
all_plugin_info[name] = {"enabled": True, "hash": get_hash(path)}
|
|
elif f.endswith(".py.bkp"):
|
|
name = f[:-7]
|
|
all_plugin_info[name] = {"enabled": False}
|
|
|
|
return all_plugin_info
|
|
|
|
def add_plugin(self, name, source_file, update=False):
|
|
"""Add or update a plugin from a local file."""
|
|
import os
|
|
import shutil
|
|
from connpy.plugins import Plugins
|
|
|
|
if not name.isalpha() or not name.islower() or len(name) > 15:
|
|
raise InvalidConfigurationError("Plugin name should be lowercase letters up to 15 characters.")
|
|
|
|
p_manager = Plugins()
|
|
# Check for bad script
|
|
error = p_manager.verify_script(source_file)
|
|
if error:
|
|
raise InvalidConfigurationError(f"Invalid plugin script: {error}")
|
|
|
|
self._save_plugin_file(name, source_file, update, is_path=True)
|
|
|
|
def add_plugin_from_bytes(self, name, content, update=False):
|
|
"""Add or update a plugin from bytes (gRPC)."""
|
|
import tempfile
|
|
import os
|
|
|
|
if not name.isalpha() or not name.islower() or len(name) > 15:
|
|
raise InvalidConfigurationError("Plugin name should be lowercase letters up to 15 characters.")
|
|
|
|
# Write to temp file to verify script
|
|
with tempfile.NamedTemporaryFile(suffix=".py", delete=False) as tmp:
|
|
tmp.write(content)
|
|
tmp_path = tmp.name
|
|
|
|
try:
|
|
from connpy.plugins import Plugins
|
|
p_manager = Plugins()
|
|
error = p_manager.verify_script(tmp_path)
|
|
if error:
|
|
raise InvalidConfigurationError(f"Invalid plugin script: {error}")
|
|
|
|
self._save_plugin_file(name, tmp_path, update, is_path=True)
|
|
finally:
|
|
if os.path.exists(tmp_path):
|
|
os.remove(tmp_path)
|
|
|
|
def _save_plugin_file(self, name, source, update=False, is_path=True):
|
|
import os
|
|
import shutil
|
|
|
|
plugin_dir = os.path.join(self.config.defaultdir, "plugins")
|
|
os.makedirs(plugin_dir, exist_ok=True)
|
|
|
|
target_file = os.path.join(plugin_dir, f"{name}.py")
|
|
backup_file = f"{target_file}.bkp"
|
|
|
|
if not update and (os.path.exists(target_file) or os.path.exists(backup_file)):
|
|
raise InvalidConfigurationError(f"Plugin '{name}' already exists.")
|
|
|
|
try:
|
|
if is_path:
|
|
shutil.copy2(source, target_file)
|
|
else:
|
|
with open(target_file, "wb") as f:
|
|
f.write(source)
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to save plugin file: {e}")
|
|
|
|
def delete_plugin(self, name):
|
|
"""Remove a plugin file permanently."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
deleted = False
|
|
for f in [plugin_file, disabled_file]:
|
|
if os.path.exists(f):
|
|
try:
|
|
os.remove(f)
|
|
deleted = True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to delete plugin file '{f}': {e}")
|
|
|
|
if not deleted:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found.")
|
|
|
|
def enable_plugin(self, name):
|
|
"""Activate a plugin by renaming its backup file."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
if os.path.exists(plugin_file):
|
|
return False # Already enabled
|
|
|
|
if not os.path.exists(disabled_file):
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found.")
|
|
|
|
try:
|
|
os.rename(disabled_file, plugin_file)
|
|
return True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to enable plugin '{name}': {e}")
|
|
|
|
def disable_plugin(self, name):
|
|
"""Deactivate a plugin by renaming it to a backup file."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
if os.path.exists(disabled_file):
|
|
return False # Already disabled
|
|
|
|
if not os.path.exists(plugin_file):
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found or is a core plugin.")
|
|
|
|
try:
|
|
os.rename(plugin_file, disabled_file)
|
|
return True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to disable plugin '{name}': {e}")
|
|
|
|
def get_plugin_source(self, name):
|
|
import os
|
|
from ..services.exceptions import InvalidConfigurationError
|
|
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
core_path = os.path.dirname(os.path.realpath(__file__)) + f"/../core_plugins/{name}.py"
|
|
|
|
if os.path.exists(plugin_file):
|
|
target = plugin_file
|
|
elif os.path.exists(core_path):
|
|
target = core_path
|
|
else:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found")
|
|
|
|
with open(target, "r") as f:
|
|
return f.read()
|
|
|
|
def invoke_plugin(self, name, args_dict):
|
|
import sys, io
|
|
from argparse import Namespace
|
|
from ..services.exceptions import InvalidConfigurationError
|
|
from connpy.plugins import Plugins
|
|
class MockApp:
|
|
def __init__(self, config):
|
|
from ..core import node, nodes
|
|
from ..ai import ai
|
|
from ..services.provider import ServiceProvider
|
|
|
|
self.config = config
|
|
self.node = node
|
|
self.nodes = nodes
|
|
self.ai = ai
|
|
|
|
self.services = ServiceProvider(config, mode="local")
|
|
try:
|
|
self.nodes_list = self.services.nodes.list_nodes()
|
|
self.folders = self.services.nodes.list_folders()
|
|
self.profiles = self.services.profiles.list_profiles()
|
|
except Exception:
|
|
self.nodes_list = {}
|
|
self.folders = {}
|
|
self.profiles = {}
|
|
|
|
args = Namespace(**args_dict)
|
|
|
|
p_manager = Plugins()
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
core_path = os.path.dirname(os.path.realpath(__file__)) + f"/../core_plugins/{name}.py"
|
|
|
|
if os.path.exists(plugin_file):
|
|
target = plugin_file
|
|
elif os.path.exists(core_path):
|
|
target = core_path
|
|
else:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found")
|
|
|
|
module = p_manager._import_from_path(target)
|
|
parser = module.Parser().parser if hasattr(module, "Parser") else None
|
|
|
|
if "__func_name__" in args_dict and hasattr(module, args_dict["__func_name__"]):
|
|
args.func = getattr(module, args_dict["__func_name__"])
|
|
|
|
app = MockApp(self.config)
|
|
|
|
from .. import printer
|
|
from rich.console import Console
|
|
|
|
buf = io.StringIO()
|
|
old_console = printer.console
|
|
old_err_console = printer.err_console
|
|
|
|
printer.console = Console(file=buf, theme=printer.connpy_theme, force_terminal=True)
|
|
printer.err_console = Console(file=buf, theme=printer.connpy_theme, force_terminal=True)
|
|
|
|
old_stdout = sys.stdout
|
|
sys.stdout = buf
|
|
|
|
try:
|
|
if hasattr(module, "Entrypoint"):
|
|
module.Entrypoint(args, parser, app)
|
|
except Exception as e:
|
|
import traceback
|
|
printer.err_console.print(traceback.format_exc())
|
|
finally:
|
|
sys.stdout = old_stdout
|
|
printer.console = old_console
|
|
printer.err_console = old_err_console
|
|
|
|
for line in buf.getvalue().splitlines(keepends=True):
|
|
yield line</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Business logic for enabling, disabling, and listing plugins.</p>
|
|
<p>Initialize the service.</p>
|
|
<h2 id="args">Args</h2>
|
|
<dl>
|
|
<dt><strong><code>config</code></strong></dt>
|
|
<dd>An instance of configfile (or None to instantiate a new one/use global context).</dd>
|
|
</dl></div>
|
|
<h3>Ancestors</h3>
|
|
<ul class="hlist">
|
|
<li><a title="connpy.services.base.BaseService" href="base.html#connpy.services.base.BaseService">BaseService</a></li>
|
|
</ul>
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
<dt id="connpy.services.plugin_service.PluginService.add_plugin"><code class="name flex">
|
|
<span>def <span class="ident">add_plugin</span></span>(<span>self, name, source_file, update=False)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def add_plugin(self, name, source_file, update=False):
|
|
"""Add or update a plugin from a local file."""
|
|
import os
|
|
import shutil
|
|
from connpy.plugins import Plugins
|
|
|
|
if not name.isalpha() or not name.islower() or len(name) > 15:
|
|
raise InvalidConfigurationError("Plugin name should be lowercase letters up to 15 characters.")
|
|
|
|
p_manager = Plugins()
|
|
# Check for bad script
|
|
error = p_manager.verify_script(source_file)
|
|
if error:
|
|
raise InvalidConfigurationError(f"Invalid plugin script: {error}")
|
|
|
|
self._save_plugin_file(name, source_file, update, is_path=True)</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Add or update a plugin from a local file.</p></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.add_plugin_from_bytes"><code class="name flex">
|
|
<span>def <span class="ident">add_plugin_from_bytes</span></span>(<span>self, name, content, update=False)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def add_plugin_from_bytes(self, name, content, update=False):
|
|
"""Add or update a plugin from bytes (gRPC)."""
|
|
import tempfile
|
|
import os
|
|
|
|
if not name.isalpha() or not name.islower() or len(name) > 15:
|
|
raise InvalidConfigurationError("Plugin name should be lowercase letters up to 15 characters.")
|
|
|
|
# Write to temp file to verify script
|
|
with tempfile.NamedTemporaryFile(suffix=".py", delete=False) as tmp:
|
|
tmp.write(content)
|
|
tmp_path = tmp.name
|
|
|
|
try:
|
|
from connpy.plugins import Plugins
|
|
p_manager = Plugins()
|
|
error = p_manager.verify_script(tmp_path)
|
|
if error:
|
|
raise InvalidConfigurationError(f"Invalid plugin script: {error}")
|
|
|
|
self._save_plugin_file(name, tmp_path, update, is_path=True)
|
|
finally:
|
|
if os.path.exists(tmp_path):
|
|
os.remove(tmp_path)</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Add or update a plugin from bytes (gRPC).</p></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.delete_plugin"><code class="name flex">
|
|
<span>def <span class="ident">delete_plugin</span></span>(<span>self, name)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def delete_plugin(self, name):
|
|
"""Remove a plugin file permanently."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
deleted = False
|
|
for f in [plugin_file, disabled_file]:
|
|
if os.path.exists(f):
|
|
try:
|
|
os.remove(f)
|
|
deleted = True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to delete plugin file '{f}': {e}")
|
|
|
|
if not deleted:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found.")</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Remove a plugin file permanently.</p></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.disable_plugin"><code class="name flex">
|
|
<span>def <span class="ident">disable_plugin</span></span>(<span>self, name)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def disable_plugin(self, name):
|
|
"""Deactivate a plugin by renaming it to a backup file."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
if os.path.exists(disabled_file):
|
|
return False # Already disabled
|
|
|
|
if not os.path.exists(plugin_file):
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found or is a core plugin.")
|
|
|
|
try:
|
|
os.rename(plugin_file, disabled_file)
|
|
return True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to disable plugin '{name}': {e}")</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Deactivate a plugin by renaming it to a backup file.</p></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.enable_plugin"><code class="name flex">
|
|
<span>def <span class="ident">enable_plugin</span></span>(<span>self, name)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def enable_plugin(self, name):
|
|
"""Activate a plugin by renaming its backup file."""
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
disabled_file = f"{plugin_file}.bkp"
|
|
|
|
if os.path.exists(plugin_file):
|
|
return False # Already enabled
|
|
|
|
if not os.path.exists(disabled_file):
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found.")
|
|
|
|
try:
|
|
os.rename(disabled_file, plugin_file)
|
|
return True
|
|
except OSError as e:
|
|
raise InvalidConfigurationError(f"Failed to enable plugin '{name}': {e}")</code></pre>
|
|
</details>
|
|
<div class="desc"><p>Activate a plugin by renaming its backup file.</p></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.get_plugin_source"><code class="name flex">
|
|
<span>def <span class="ident">get_plugin_source</span></span>(<span>self, name)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def get_plugin_source(self, name):
|
|
import os
|
|
from ..services.exceptions import InvalidConfigurationError
|
|
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
core_path = os.path.dirname(os.path.realpath(__file__)) + f"/../core_plugins/{name}.py"
|
|
|
|
if os.path.exists(plugin_file):
|
|
target = plugin_file
|
|
elif os.path.exists(core_path):
|
|
target = core_path
|
|
else:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found")
|
|
|
|
with open(target, "r") as f:
|
|
return f.read()</code></pre>
|
|
</details>
|
|
<div class="desc"></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.invoke_plugin"><code class="name flex">
|
|
<span>def <span class="ident">invoke_plugin</span></span>(<span>self, name, args_dict)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def invoke_plugin(self, name, args_dict):
|
|
import sys, io
|
|
from argparse import Namespace
|
|
from ..services.exceptions import InvalidConfigurationError
|
|
from connpy.plugins import Plugins
|
|
class MockApp:
|
|
def __init__(self, config):
|
|
from ..core import node, nodes
|
|
from ..ai import ai
|
|
from ..services.provider import ServiceProvider
|
|
|
|
self.config = config
|
|
self.node = node
|
|
self.nodes = nodes
|
|
self.ai = ai
|
|
|
|
self.services = ServiceProvider(config, mode="local")
|
|
try:
|
|
self.nodes_list = self.services.nodes.list_nodes()
|
|
self.folders = self.services.nodes.list_folders()
|
|
self.profiles = self.services.profiles.list_profiles()
|
|
except Exception:
|
|
self.nodes_list = {}
|
|
self.folders = {}
|
|
self.profiles = {}
|
|
|
|
args = Namespace(**args_dict)
|
|
|
|
p_manager = Plugins()
|
|
import os
|
|
plugin_file = os.path.join(self.config.defaultdir, "plugins", f"{name}.py")
|
|
core_path = os.path.dirname(os.path.realpath(__file__)) + f"/../core_plugins/{name}.py"
|
|
|
|
if os.path.exists(plugin_file):
|
|
target = plugin_file
|
|
elif os.path.exists(core_path):
|
|
target = core_path
|
|
else:
|
|
raise InvalidConfigurationError(f"Plugin '{name}' not found")
|
|
|
|
module = p_manager._import_from_path(target)
|
|
parser = module.Parser().parser if hasattr(module, "Parser") else None
|
|
|
|
if "__func_name__" in args_dict and hasattr(module, args_dict["__func_name__"]):
|
|
args.func = getattr(module, args_dict["__func_name__"])
|
|
|
|
app = MockApp(self.config)
|
|
|
|
from .. import printer
|
|
from rich.console import Console
|
|
|
|
buf = io.StringIO()
|
|
old_console = printer.console
|
|
old_err_console = printer.err_console
|
|
|
|
printer.console = Console(file=buf, theme=printer.connpy_theme, force_terminal=True)
|
|
printer.err_console = Console(file=buf, theme=printer.connpy_theme, force_terminal=True)
|
|
|
|
old_stdout = sys.stdout
|
|
sys.stdout = buf
|
|
|
|
try:
|
|
if hasattr(module, "Entrypoint"):
|
|
module.Entrypoint(args, parser, app)
|
|
except Exception as e:
|
|
import traceback
|
|
printer.err_console.print(traceback.format_exc())
|
|
finally:
|
|
sys.stdout = old_stdout
|
|
printer.console = old_console
|
|
printer.err_console = old_err_console
|
|
|
|
for line in buf.getvalue().splitlines(keepends=True):
|
|
yield line</code></pre>
|
|
</details>
|
|
<div class="desc"></div>
|
|
</dd>
|
|
<dt id="connpy.services.plugin_service.PluginService.list_plugins"><code class="name flex">
|
|
<span>def <span class="ident">list_plugins</span></span>(<span>self)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def list_plugins(self):
|
|
"""List all core and user-defined plugins with their status and hash."""
|
|
import os
|
|
import hashlib
|
|
|
|
# Check for user plugins directory
|
|
plugin_dir = os.path.join(self.config.defaultdir, "plugins")
|
|
# Check for core plugins directory
|
|
core_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), "..", "core_plugins")
|
|
|
|
all_plugin_info = {}
|
|
|
|
def get_hash(path):
|
|
try:
|
|
with open(path, "rb") as f:
|
|
return hashlib.md5(f.read()).hexdigest()
|
|
except Exception:
|
|
return ""
|
|
|
|
# User plugins
|
|
if os.path.exists(plugin_dir):
|
|
for f in os.listdir(plugin_dir):
|
|
if f.endswith(".py"):
|
|
name = f[:-3]
|
|
path = os.path.join(plugin_dir, f)
|
|
all_plugin_info[name] = {"enabled": True, "hash": get_hash(path)}
|
|
elif f.endswith(".py.bkp"):
|
|
name = f[:-7]
|
|
all_plugin_info[name] = {"enabled": False}
|
|
|
|
return all_plugin_info</code></pre>
|
|
</details>
|
|
<div class="desc"><p>List all core and user-defined plugins with their status and hash.</p></div>
|
|
</dd>
|
|
</dl>
|
|
<h3>Inherited members</h3>
|
|
<ul class="hlist">
|
|
<li><code><b><a title="connpy.services.base.BaseService" href="base.html#connpy.services.base.BaseService">BaseService</a></b></code>:
|
|
<ul class="hlist">
|
|
<li><code><a title="connpy.services.base.BaseService.set_reserved_names" href="base.html#connpy.services.base.BaseService.set_reserved_names">set_reserved_names</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
</article>
|
|
<nav id="sidebar">
|
|
<div class="toc">
|
|
<ul></ul>
|
|
</div>
|
|
<ul id="index">
|
|
<li><h3>Super-module</h3>
|
|
<ul>
|
|
<li><code><a title="connpy.services" href="index.html">connpy.services</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-classes">Classes</a></h3>
|
|
<ul>
|
|
<li>
|
|
<h4><code><a title="connpy.services.plugin_service.PluginService" href="#connpy.services.plugin_service.PluginService">PluginService</a></code></h4>
|
|
<ul class="">
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.add_plugin" href="#connpy.services.plugin_service.PluginService.add_plugin">add_plugin</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.add_plugin_from_bytes" href="#connpy.services.plugin_service.PluginService.add_plugin_from_bytes">add_plugin_from_bytes</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.delete_plugin" href="#connpy.services.plugin_service.PluginService.delete_plugin">delete_plugin</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.disable_plugin" href="#connpy.services.plugin_service.PluginService.disable_plugin">disable_plugin</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.enable_plugin" href="#connpy.services.plugin_service.PluginService.enable_plugin">enable_plugin</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.get_plugin_source" href="#connpy.services.plugin_service.PluginService.get_plugin_source">get_plugin_source</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.invoke_plugin" href="#connpy.services.plugin_service.PluginService.invoke_plugin">invoke_plugin</a></code></li>
|
|
<li><code><a title="connpy.services.plugin_service.PluginService.list_plugins" href="#connpy.services.plugin_service.PluginService.list_plugins">list_plugins</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
|
|
</footer>
|
|
</body>
|
|
</html>
|