3276 lines
144 KiB
HTML
3276 lines
144 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.6">
|
||
<title>connpy.services 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</code></h1>
|
||
</header>
|
||
<section id="section-intro">
|
||
</section>
|
||
<section>
|
||
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
|
||
<dl>
|
||
<dt><code class="name"><a title="connpy.services.ai_service" href="ai_service.html">connpy.services.ai_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.base" href="base.html">connpy.services.base</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.config_service" href="config_service.html">connpy.services.config_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.context_service" href="context_service.html">connpy.services.context_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.exceptions" href="exceptions.html">connpy.services.exceptions</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.execution_service" href="execution_service.html">connpy.services.execution_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.import_export_service" href="import_export_service.html">connpy.services.import_export_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.node_service" href="node_service.html">connpy.services.node_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.plugin_service" href="plugin_service.html">connpy.services.plugin_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.profile_service" href="profile_service.html">connpy.services.profile_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.provider" href="provider.html">connpy.services.provider</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.sync_service" href="sync_service.html">connpy.services.sync_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt><code class="name"><a title="connpy.services.system_service" href="system_service.html">connpy.services.system_service</a></code></dt>
|
||
<dd>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
</dl>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
</section>
|
||
<section>
|
||
<h2 class="section-title" id="header-classes">Classes</h2>
|
||
<dl>
|
||
<dt id="connpy.services.AIService"><code class="flex name class">
|
||
<span>class <span class="ident">AIService</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 AIService(BaseService):
|
||
"""Business logic for interacting with AI agents and LLM configurations."""
|
||
|
||
def ask(self, input_text, dryrun=False, chat_history=None, status=None, debug=False, session_id=None, console=None, chunk_callback=None, confirm_handler=None, trust=False, **overrides):
|
||
"""Send a prompt to the AI agent."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config, console=console, confirm_handler=confirm_handler, trust=trust, **overrides)
|
||
return agent.ask(input_text, dryrun, chat_history, status=status, debug=debug, session_id=session_id, chunk_callback=chunk_callback)
|
||
|
||
|
||
def confirm(self, input_text, console=None):
|
||
"""Ask for a safe confirmation of an action."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config, console=console)
|
||
return agent.confirm(input_text)
|
||
|
||
|
||
def list_sessions(self):
|
||
"""Return a list of all saved AI sessions."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config)
|
||
return agent._get_sessions()
|
||
|
||
def delete_session(self, session_id):
|
||
"""Delete an AI session by ID."""
|
||
import os
|
||
sessions_dir = os.path.join(self.config.defaultdir, "ai_sessions")
|
||
path = os.path.join(sessions_dir, f"{session_id}.json")
|
||
if os.path.exists(path):
|
||
os.remove(path)
|
||
else:
|
||
raise InvalidConfigurationError(f"Session '{session_id}' not found.")
|
||
|
||
def configure_provider(self, provider, model=None, api_key=None):
|
||
"""Update AI provider settings in the configuration."""
|
||
settings = self.config.config.get("ai", {})
|
||
if model:
|
||
settings[f"{provider}_model"] = model
|
||
if api_key:
|
||
settings[f"{provider}_api_key"] = api_key
|
||
|
||
self.config.config["ai"] = settings
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def load_session_data(self, session_id):
|
||
"""Load a session's raw data by ID."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config)
|
||
return agent.load_session_data(session_id)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for interacting with AI agents and LLM configurations.</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.AIService.ask"><code class="name flex">
|
||
<span>def <span class="ident">ask</span></span>(<span>self,<br>input_text,<br>dryrun=False,<br>chat_history=None,<br>status=None,<br>debug=False,<br>session_id=None,<br>console=None,<br>chunk_callback=None,<br>confirm_handler=None,<br>trust=False,<br>**overrides)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def ask(self, input_text, dryrun=False, chat_history=None, status=None, debug=False, session_id=None, console=None, chunk_callback=None, confirm_handler=None, trust=False, **overrides):
|
||
"""Send a prompt to the AI agent."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config, console=console, confirm_handler=confirm_handler, trust=trust, **overrides)
|
||
return agent.ask(input_text, dryrun, chat_history, status=status, debug=debug, session_id=session_id, chunk_callback=chunk_callback)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Send a prompt to the AI agent.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.AIService.configure_provider"><code class="name flex">
|
||
<span>def <span class="ident">configure_provider</span></span>(<span>self, provider, model=None, api_key=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def configure_provider(self, provider, model=None, api_key=None):
|
||
"""Update AI provider settings in the configuration."""
|
||
settings = self.config.config.get("ai", {})
|
||
if model:
|
||
settings[f"{provider}_model"] = model
|
||
if api_key:
|
||
settings[f"{provider}_api_key"] = api_key
|
||
|
||
self.config.config["ai"] = settings
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Update AI provider settings in the configuration.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.AIService.confirm"><code class="name flex">
|
||
<span>def <span class="ident">confirm</span></span>(<span>self, input_text, console=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def confirm(self, input_text, console=None):
|
||
"""Ask for a safe confirmation of an action."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config, console=console)
|
||
return agent.confirm(input_text)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Ask for a safe confirmation of an action.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.AIService.delete_session"><code class="name flex">
|
||
<span>def <span class="ident">delete_session</span></span>(<span>self, session_id)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def delete_session(self, session_id):
|
||
"""Delete an AI session by ID."""
|
||
import os
|
||
sessions_dir = os.path.join(self.config.defaultdir, "ai_sessions")
|
||
path = os.path.join(sessions_dir, f"{session_id}.json")
|
||
if os.path.exists(path):
|
||
os.remove(path)
|
||
else:
|
||
raise InvalidConfigurationError(f"Session '{session_id}' not found.")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Delete an AI session by ID.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.AIService.list_sessions"><code class="name flex">
|
||
<span>def <span class="ident">list_sessions</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def list_sessions(self):
|
||
"""Return a list of all saved AI sessions."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config)
|
||
return agent._get_sessions()</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return a list of all saved AI sessions.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.AIService.load_session_data"><code class="name flex">
|
||
<span>def <span class="ident">load_session_data</span></span>(<span>self, session_id)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def load_session_data(self, session_id):
|
||
"""Load a session's raw data by ID."""
|
||
from connpy.ai import ai
|
||
agent = ai(self.config)
|
||
return agent.load_session_data(session_id)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Load a session's raw data by ID.</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>
|
||
<dt id="connpy.services.ConfigService"><code class="flex name class">
|
||
<span>class <span class="ident">ConfigService</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 ConfigService(BaseService):
|
||
"""Business logic for general application settings and state configuration."""
|
||
|
||
def get_settings(self) -> Dict[str, Any]:
|
||
"""Get the global configuration settings block."""
|
||
settings = self.config.config.copy()
|
||
settings["configfolder"] = self.config.defaultdir
|
||
return settings
|
||
|
||
def get_default_dir(self) -> str:
|
||
"""Get the default configuration directory."""
|
||
return self.config.defaultdir
|
||
|
||
def set_config_folder(self, folder_path: str):
|
||
"""Set the default location for config file by writing to ~/.config/conn/.folder"""
|
||
if not os.path.isdir(folder_path):
|
||
raise ConnpyError(f"readable_dir:{folder_path} is not a valid path")
|
||
|
||
pathfile = os.path.join(self.config.anchor_path, ".folder")
|
||
folder = os.path.abspath(folder_path).rstrip('/')
|
||
|
||
try:
|
||
with open(pathfile, "w") as f:
|
||
f.write(str(folder))
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to save config folder: {e}")
|
||
|
||
def update_setting(self, key, value):
|
||
"""Update a setting in the configuration file."""
|
||
self.config.config[key] = value
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def encrypt_password(self, password):
|
||
"""Encrypt a password using the application's configuration encryption key."""
|
||
return self.config.encrypt(password)
|
||
|
||
def apply_theme_from_file(self, theme_input):
|
||
"""Apply 'dark', 'light' theme or load a YAML theme file and save it to the configuration."""
|
||
import yaml
|
||
from ..printer import STYLES, LIGHT_THEME
|
||
|
||
if theme_input == "dark":
|
||
valid_styles = {}
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles
|
||
elif theme_input == "light":
|
||
valid_styles = LIGHT_THEME.copy()
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles
|
||
|
||
if not os.path.exists(theme_input):
|
||
raise InvalidConfigurationError(f"Theme file '{theme_input}' not found.")
|
||
|
||
try:
|
||
with open(theme_input, 'r') as f:
|
||
user_styles = yaml.safe_load(f)
|
||
except Exception as e:
|
||
raise InvalidConfigurationError(f"Failed to parse theme file: {e}")
|
||
|
||
if not isinstance(user_styles, dict):
|
||
raise InvalidConfigurationError("Theme file must be a YAML dictionary.")
|
||
|
||
# Filter for valid styles only (prevent junk in config)
|
||
valid_styles = {k: v for k, v in user_styles.items() if k in STYLES}
|
||
|
||
if not valid_styles:
|
||
raise InvalidConfigurationError("No valid style keys found in theme file.")
|
||
|
||
# Persist and return merged styles
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for general application settings and state configuration.</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.ConfigService.apply_theme_from_file"><code class="name flex">
|
||
<span>def <span class="ident">apply_theme_from_file</span></span>(<span>self, theme_input)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def apply_theme_from_file(self, theme_input):
|
||
"""Apply 'dark', 'light' theme or load a YAML theme file and save it to the configuration."""
|
||
import yaml
|
||
from ..printer import STYLES, LIGHT_THEME
|
||
|
||
if theme_input == "dark":
|
||
valid_styles = {}
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles
|
||
elif theme_input == "light":
|
||
valid_styles = LIGHT_THEME.copy()
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles
|
||
|
||
if not os.path.exists(theme_input):
|
||
raise InvalidConfigurationError(f"Theme file '{theme_input}' not found.")
|
||
|
||
try:
|
||
with open(theme_input, 'r') as f:
|
||
user_styles = yaml.safe_load(f)
|
||
except Exception as e:
|
||
raise InvalidConfigurationError(f"Failed to parse theme file: {e}")
|
||
|
||
if not isinstance(user_styles, dict):
|
||
raise InvalidConfigurationError("Theme file must be a YAML dictionary.")
|
||
|
||
# Filter for valid styles only (prevent junk in config)
|
||
valid_styles = {k: v for k, v in user_styles.items() if k in STYLES}
|
||
|
||
if not valid_styles:
|
||
raise InvalidConfigurationError("No valid style keys found in theme file.")
|
||
|
||
# Persist and return merged styles
|
||
self.update_setting("theme", valid_styles)
|
||
return valid_styles</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Apply 'dark', 'light' theme or load a YAML theme file and save it to the configuration.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ConfigService.encrypt_password"><code class="name flex">
|
||
<span>def <span class="ident">encrypt_password</span></span>(<span>self, password)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def encrypt_password(self, password):
|
||
"""Encrypt a password using the application's configuration encryption key."""
|
||
return self.config.encrypt(password)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Encrypt a password using the application's configuration encryption key.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ConfigService.get_default_dir"><code class="name flex">
|
||
<span>def <span class="ident">get_default_dir</span></span>(<span>self) ‑> str</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_default_dir(self) -> str:
|
||
"""Get the default configuration directory."""
|
||
return self.config.defaultdir</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Get the default configuration directory.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ConfigService.get_settings"><code class="name flex">
|
||
<span>def <span class="ident">get_settings</span></span>(<span>self) ‑> Dict[str, Any]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_settings(self) -> Dict[str, Any]:
|
||
"""Get the global configuration settings block."""
|
||
settings = self.config.config.copy()
|
||
settings["configfolder"] = self.config.defaultdir
|
||
return settings</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Get the global configuration settings block.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ConfigService.set_config_folder"><code class="name flex">
|
||
<span>def <span class="ident">set_config_folder</span></span>(<span>self, folder_path: str)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def set_config_folder(self, folder_path: str):
|
||
"""Set the default location for config file by writing to ~/.config/conn/.folder"""
|
||
if not os.path.isdir(folder_path):
|
||
raise ConnpyError(f"readable_dir:{folder_path} is not a valid path")
|
||
|
||
pathfile = os.path.join(self.config.anchor_path, ".folder")
|
||
folder = os.path.abspath(folder_path).rstrip('/')
|
||
|
||
try:
|
||
with open(pathfile, "w") as f:
|
||
f.write(str(folder))
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to save config folder: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Set the default location for config file by writing to ~/.config/conn/.folder</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ConfigService.update_setting"><code class="name flex">
|
||
<span>def <span class="ident">update_setting</span></span>(<span>self, key, value)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def update_setting(self, key, value):
|
||
"""Update a setting in the configuration file."""
|
||
self.config.config[key] = value
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Update a setting in the configuration file.</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>
|
||
<dt id="connpy.services.ConnpyError"><code class="flex name class">
|
||
<span>class <span class="ident">ConnpyError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class ConnpyError(Exception):
|
||
"""Base exception for all connpy services."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Base exception for all connpy services.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
<h3>Subclasses</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ExecutionError" href="exceptions.html#connpy.services.exceptions.ExecutionError">ExecutionError</a></li>
|
||
<li><a title="connpy.services.exceptions.InvalidConfigurationError" href="exceptions.html#connpy.services.exceptions.InvalidConfigurationError">InvalidConfigurationError</a></li>
|
||
<li><a title="connpy.services.exceptions.NodeAlreadyExistsError" href="exceptions.html#connpy.services.exceptions.NodeAlreadyExistsError">NodeAlreadyExistsError</a></li>
|
||
<li><a title="connpy.services.exceptions.NodeNotFoundError" href="exceptions.html#connpy.services.exceptions.NodeNotFoundError">NodeNotFoundError</a></li>
|
||
<li><a title="connpy.services.exceptions.ProfileAlreadyExistsError" href="exceptions.html#connpy.services.exceptions.ProfileAlreadyExistsError">ProfileAlreadyExistsError</a></li>
|
||
<li><a title="connpy.services.exceptions.ProfileNotFoundError" href="exceptions.html#connpy.services.exceptions.ProfileNotFoundError">ProfileNotFoundError</a></li>
|
||
<li><a title="connpy.services.exceptions.ReservedNameError" href="exceptions.html#connpy.services.exceptions.ReservedNameError">ReservedNameError</a></li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.ExecutionError"><code class="flex name class">
|
||
<span>class <span class="ident">ExecutionError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class ExecutionError(ConnpyError):
|
||
"""Raised when an execution fails or returns error."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when an execution fails or returns error.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.ExecutionService"><code class="flex name class">
|
||
<span>class <span class="ident">ExecutionService</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 ExecutionService(BaseService):
|
||
"""Business logic for executing commands on nodes and running automation scripts."""
|
||
|
||
def run_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: List[str],
|
||
variables: Optional[Dict[str, Any]] = None,
|
||
parallel: int = 10,
|
||
timeout: int = 10,
|
||
folder: Optional[str] = None,
|
||
prompt: Optional[str] = None,
|
||
on_node_complete: Optional[Callable] = None,
|
||
logger: Optional[Callable] = None,
|
||
name: Optional[str] = None
|
||
) -> Dict[str, str]:
|
||
|
||
"""Execute commands on a set of nodes."""
|
||
try:
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
results = executor.run(
|
||
commands=commands,
|
||
vars=variables,
|
||
parallel=parallel,
|
||
timeout=timeout,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_complete=on_node_complete,
|
||
logger=logger
|
||
)
|
||
|
||
# Combine output and status for the caller
|
||
full_results = {}
|
||
for unique in results:
|
||
full_results[unique] = {
|
||
"output": results[unique],
|
||
"status": executor.status.get(unique, 1)
|
||
}
|
||
|
||
return full_results
|
||
except Exception as e:
|
||
raise ConnpyError(f"Execution failed: {e}")
|
||
|
||
def test_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: List[str],
|
||
expected: List[str],
|
||
variables: Optional[Dict[str, Any]] = None,
|
||
parallel: int = 10,
|
||
timeout: int = 10,
|
||
folder: Optional[str] = None,
|
||
prompt: Optional[str] = None,
|
||
on_node_complete: Optional[Callable] = None,
|
||
logger: Optional[Callable] = None,
|
||
name: Optional[str] = None
|
||
) -> Dict[str, Dict[str, bool]]:
|
||
|
||
"""Run commands and verify expected output on a set of nodes."""
|
||
try:
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
results = executor.test(
|
||
commands=commands,
|
||
expected=expected,
|
||
vars=variables,
|
||
parallel=parallel,
|
||
timeout=timeout,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_complete=on_node_complete,
|
||
logger=logger
|
||
)
|
||
return results
|
||
except Exception as e:
|
||
raise ConnpyError(f"Testing failed: {e}")
|
||
|
||
def run_cli_script(self, nodes_filter: str, script_path: str, parallel: int = 10) -> Dict[str, str]:
|
||
"""Run a plain-text script containing one command per line."""
|
||
if not os.path.exists(script_path):
|
||
raise ConnpyError(f"Script file not found: {script_path}")
|
||
|
||
try:
|
||
with open(script_path, "r") as f:
|
||
commands = [line.strip() for line in f if line.strip()]
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to read script {script_path}: {e}")
|
||
|
||
return self.run_commands(nodes_filter, commands, parallel=parallel)
|
||
|
||
def run_yaml_playbook(self, playbook_data: str, parallel: int = 10) -> Dict[str, Any]:
|
||
"""Run a structured Connpy YAML automation playbook (from path or content)."""
|
||
playbook = None
|
||
if playbook_data.startswith("---YAML---\n"):
|
||
try:
|
||
content = playbook_data[len("---YAML---\n"):]
|
||
playbook = yaml.load(content, Loader=yaml.FullLoader)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to parse YAML content: {e}")
|
||
else:
|
||
if not os.path.exists(playbook_data):
|
||
raise ConnpyError(f"Playbook file not found: {playbook_data}")
|
||
try:
|
||
with open(playbook_data, "r") as f:
|
||
playbook = yaml.load(f, Loader=yaml.FullLoader)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to load playbook {playbook_data}: {e}")
|
||
|
||
# Basic validation
|
||
if not isinstance(playbook, dict) or "nodes" not in playbook or "commands" not in playbook:
|
||
raise ConnpyError("Invalid playbook format: missing 'nodes' or 'commands' keys.")
|
||
|
||
action = playbook.get("action", "run")
|
||
options = playbook.get("options", {})
|
||
|
||
# Extract all fields similar to RunHandler.cli_run
|
||
exec_args = {
|
||
"nodes_filter": playbook["nodes"],
|
||
"commands": playbook["commands"],
|
||
"variables": playbook.get("variables"),
|
||
"parallel": options.get("parallel", parallel),
|
||
"timeout": playbook.get("timeout", options.get("timeout", 10)),
|
||
"prompt": options.get("prompt"),
|
||
"name": playbook.get("name", "Task")
|
||
}
|
||
|
||
# Map 'output' field to folder path if it's not stdout/null
|
||
output_cfg = playbook.get("output")
|
||
if output_cfg not in [None, "stdout"]:
|
||
exec_args["folder"] = output_cfg
|
||
|
||
if action == "run":
|
||
return self.run_commands(**exec_args)
|
||
elif action == "test":
|
||
exec_args["expected"] = playbook.get("expected", [])
|
||
return self.test_commands(**exec_args)
|
||
else:
|
||
raise ConnpyError(f"Unsupported playbook action: {action}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for executing commands on nodes and running automation scripts.</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.ExecutionService.run_cli_script"><code class="name flex">
|
||
<span>def <span class="ident">run_cli_script</span></span>(<span>self, nodes_filter: str, script_path: str, parallel: int = 10) ‑> Dict[str, str]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def run_cli_script(self, nodes_filter: str, script_path: str, parallel: int = 10) -> Dict[str, str]:
|
||
"""Run a plain-text script containing one command per line."""
|
||
if not os.path.exists(script_path):
|
||
raise ConnpyError(f"Script file not found: {script_path}")
|
||
|
||
try:
|
||
with open(script_path, "r") as f:
|
||
commands = [line.strip() for line in f if line.strip()]
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to read script {script_path}: {e}")
|
||
|
||
return self.run_commands(nodes_filter, commands, parallel=parallel)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Run a plain-text script containing one command per line.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ExecutionService.run_commands"><code class="name flex">
|
||
<span>def <span class="ident">run_commands</span></span>(<span>self,<br>nodes_filter: str,<br>commands: List[str],<br>variables: Dict[str, Any] | None = None,<br>parallel: int = 10,<br>timeout: int = 10,<br>folder: str | None = None,<br>prompt: str | None = None,<br>on_node_complete: Callable | None = None,<br>logger: Callable | None = None,<br>name: str | None = None) ‑> Dict[str, str]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def run_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: List[str],
|
||
variables: Optional[Dict[str, Any]] = None,
|
||
parallel: int = 10,
|
||
timeout: int = 10,
|
||
folder: Optional[str] = None,
|
||
prompt: Optional[str] = None,
|
||
on_node_complete: Optional[Callable] = None,
|
||
logger: Optional[Callable] = None,
|
||
name: Optional[str] = None
|
||
) -> Dict[str, str]:
|
||
|
||
"""Execute commands on a set of nodes."""
|
||
try:
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
results = executor.run(
|
||
commands=commands,
|
||
vars=variables,
|
||
parallel=parallel,
|
||
timeout=timeout,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_complete=on_node_complete,
|
||
logger=logger
|
||
)
|
||
|
||
# Combine output and status for the caller
|
||
full_results = {}
|
||
for unique in results:
|
||
full_results[unique] = {
|
||
"output": results[unique],
|
||
"status": executor.status.get(unique, 1)
|
||
}
|
||
|
||
return full_results
|
||
except Exception as e:
|
||
raise ConnpyError(f"Execution failed: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Execute commands on a set of nodes.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ExecutionService.run_yaml_playbook"><code class="name flex">
|
||
<span>def <span class="ident">run_yaml_playbook</span></span>(<span>self, playbook_data: str, parallel: int = 10) ‑> Dict[str, Any]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def run_yaml_playbook(self, playbook_data: str, parallel: int = 10) -> Dict[str, Any]:
|
||
"""Run a structured Connpy YAML automation playbook (from path or content)."""
|
||
playbook = None
|
||
if playbook_data.startswith("---YAML---\n"):
|
||
try:
|
||
content = playbook_data[len("---YAML---\n"):]
|
||
playbook = yaml.load(content, Loader=yaml.FullLoader)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to parse YAML content: {e}")
|
||
else:
|
||
if not os.path.exists(playbook_data):
|
||
raise ConnpyError(f"Playbook file not found: {playbook_data}")
|
||
try:
|
||
with open(playbook_data, "r") as f:
|
||
playbook = yaml.load(f, Loader=yaml.FullLoader)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to load playbook {playbook_data}: {e}")
|
||
|
||
# Basic validation
|
||
if not isinstance(playbook, dict) or "nodes" not in playbook or "commands" not in playbook:
|
||
raise ConnpyError("Invalid playbook format: missing 'nodes' or 'commands' keys.")
|
||
|
||
action = playbook.get("action", "run")
|
||
options = playbook.get("options", {})
|
||
|
||
# Extract all fields similar to RunHandler.cli_run
|
||
exec_args = {
|
||
"nodes_filter": playbook["nodes"],
|
||
"commands": playbook["commands"],
|
||
"variables": playbook.get("variables"),
|
||
"parallel": options.get("parallel", parallel),
|
||
"timeout": playbook.get("timeout", options.get("timeout", 10)),
|
||
"prompt": options.get("prompt"),
|
||
"name": playbook.get("name", "Task")
|
||
}
|
||
|
||
# Map 'output' field to folder path if it's not stdout/null
|
||
output_cfg = playbook.get("output")
|
||
if output_cfg not in [None, "stdout"]:
|
||
exec_args["folder"] = output_cfg
|
||
|
||
if action == "run":
|
||
return self.run_commands(**exec_args)
|
||
elif action == "test":
|
||
exec_args["expected"] = playbook.get("expected", [])
|
||
return self.test_commands(**exec_args)
|
||
else:
|
||
raise ConnpyError(f"Unsupported playbook action: {action}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Run a structured Connpy YAML automation playbook (from path or content).</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ExecutionService.test_commands"><code class="name flex">
|
||
<span>def <span class="ident">test_commands</span></span>(<span>self,<br>nodes_filter: str,<br>commands: List[str],<br>expected: List[str],<br>variables: Dict[str, Any] | None = None,<br>parallel: int = 10,<br>timeout: int = 10,<br>folder: str | None = None,<br>prompt: str | None = None,<br>on_node_complete: Callable | None = None,<br>logger: Callable | None = None,<br>name: str | None = None) ‑> Dict[str, Dict[str, bool]]</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def test_commands(
|
||
self,
|
||
nodes_filter: str,
|
||
commands: List[str],
|
||
expected: List[str],
|
||
variables: Optional[Dict[str, Any]] = None,
|
||
parallel: int = 10,
|
||
timeout: int = 10,
|
||
folder: Optional[str] = None,
|
||
prompt: Optional[str] = None,
|
||
on_node_complete: Optional[Callable] = None,
|
||
logger: Optional[Callable] = None,
|
||
name: Optional[str] = None
|
||
) -> Dict[str, Dict[str, bool]]:
|
||
|
||
"""Run commands and verify expected output on a set of nodes."""
|
||
try:
|
||
matched_names = self.config._getallnodes(nodes_filter)
|
||
if not matched_names:
|
||
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
|
||
|
||
node_data = self.config.getitems(matched_names, extract=True)
|
||
executor = Nodes(node_data, config=self.config)
|
||
self.last_executor = executor
|
||
|
||
results = executor.test(
|
||
commands=commands,
|
||
expected=expected,
|
||
vars=variables,
|
||
parallel=parallel,
|
||
timeout=timeout,
|
||
folder=folder,
|
||
prompt=prompt,
|
||
on_complete=on_node_complete,
|
||
logger=logger
|
||
)
|
||
return results
|
||
except Exception as e:
|
||
raise ConnpyError(f"Testing failed: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Run commands and verify expected output on a set of nodes.</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>
|
||
<dt id="connpy.services.ImportExportService"><code class="flex name class">
|
||
<span>class <span class="ident">ImportExportService</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 ImportExportService(BaseService):
|
||
"""Business logic for YAML/JSON inventory import and export."""
|
||
|
||
def export_to_file(self, file_path, folders=None):
|
||
"""Export nodes/folders to a YAML file."""
|
||
if os.path.exists(file_path):
|
||
raise InvalidConfigurationError(f"File '{file_path}' already exists.")
|
||
|
||
data = self.export_to_dict(folders)
|
||
try:
|
||
with open(file_path, "w") as f:
|
||
yaml.dump(data, f, Dumper=NoAliasDumper, default_flow_style=False)
|
||
except OSError as e:
|
||
raise InvalidConfigurationError(f"Failed to export to '{file_path}': {e}")
|
||
|
||
def export_to_dict(self, folders=None):
|
||
"""Export nodes/folders to a dictionary."""
|
||
if not folders:
|
||
return self.config._getallnodesfull(extract=False)
|
||
else:
|
||
# Validate folders exist
|
||
for f in folders:
|
||
if f != "@" and f not in self.config._getallfolders():
|
||
raise NodeNotFoundError(f"Folder '{f}' not found.")
|
||
return self.config._getallnodesfull(folders, extract=False)
|
||
|
||
def import_from_file(self, file_path):
|
||
"""Import nodes/folders from a YAML file."""
|
||
if not os.path.exists(file_path):
|
||
raise InvalidConfigurationError(f"File '{file_path}' does not exist.")
|
||
|
||
try:
|
||
with open(file_path, "r") as f:
|
||
data = yaml.load(f, Loader=yaml.FullLoader)
|
||
self.import_from_dict(data)
|
||
except Exception as e:
|
||
raise InvalidConfigurationError(f"Failed to read/parse import file: {e}")
|
||
|
||
def import_from_dict(self, data):
|
||
"""Import nodes/folders from a dictionary."""
|
||
if not isinstance(data, dict):
|
||
raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
|
||
|
||
# Process imports
|
||
for k, v in data.items():
|
||
uniques = self.config._explode_unique(k)
|
||
|
||
# Ensure folders exist
|
||
if "folder" in uniques:
|
||
folder_name = f"@{uniques['folder']}"
|
||
if folder_name not in self.config._getallfolders():
|
||
folder_uniques = self.config._explode_unique(folder_name)
|
||
self.config._folder_add(**folder_uniques)
|
||
|
||
if "subfolder" in uniques:
|
||
sub_name = f"@{uniques['subfolder']}@{uniques['folder']}"
|
||
if sub_name not in self.config._getallfolders():
|
||
sub_uniques = self.config._explode_unique(sub_name)
|
||
self.config._folder_add(**sub_uniques)
|
||
|
||
# Add node/connection
|
||
v.update(uniques)
|
||
self._validate_node_name(k)
|
||
self.config._connections_add(**v)
|
||
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for YAML/JSON inventory import and export.</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.ImportExportService.export_to_dict"><code class="name flex">
|
||
<span>def <span class="ident">export_to_dict</span></span>(<span>self, folders=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def export_to_dict(self, folders=None):
|
||
"""Export nodes/folders to a dictionary."""
|
||
if not folders:
|
||
return self.config._getallnodesfull(extract=False)
|
||
else:
|
||
# Validate folders exist
|
||
for f in folders:
|
||
if f != "@" and f not in self.config._getallfolders():
|
||
raise NodeNotFoundError(f"Folder '{f}' not found.")
|
||
return self.config._getallnodesfull(folders, extract=False)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Export nodes/folders to a dictionary.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ImportExportService.export_to_file"><code class="name flex">
|
||
<span>def <span class="ident">export_to_file</span></span>(<span>self, file_path, folders=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def export_to_file(self, file_path, folders=None):
|
||
"""Export nodes/folders to a YAML file."""
|
||
if os.path.exists(file_path):
|
||
raise InvalidConfigurationError(f"File '{file_path}' already exists.")
|
||
|
||
data = self.export_to_dict(folders)
|
||
try:
|
||
with open(file_path, "w") as f:
|
||
yaml.dump(data, f, Dumper=NoAliasDumper, default_flow_style=False)
|
||
except OSError as e:
|
||
raise InvalidConfigurationError(f"Failed to export to '{file_path}': {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Export nodes/folders to a YAML file.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ImportExportService.import_from_dict"><code class="name flex">
|
||
<span>def <span class="ident">import_from_dict</span></span>(<span>self, data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def import_from_dict(self, data):
|
||
"""Import nodes/folders from a dictionary."""
|
||
if not isinstance(data, dict):
|
||
raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
|
||
|
||
# Process imports
|
||
for k, v in data.items():
|
||
uniques = self.config._explode_unique(k)
|
||
|
||
# Ensure folders exist
|
||
if "folder" in uniques:
|
||
folder_name = f"@{uniques['folder']}"
|
||
if folder_name not in self.config._getallfolders():
|
||
folder_uniques = self.config._explode_unique(folder_name)
|
||
self.config._folder_add(**folder_uniques)
|
||
|
||
if "subfolder" in uniques:
|
||
sub_name = f"@{uniques['subfolder']}@{uniques['folder']}"
|
||
if sub_name not in self.config._getallfolders():
|
||
sub_uniques = self.config._explode_unique(sub_name)
|
||
self.config._folder_add(**sub_uniques)
|
||
|
||
# Add node/connection
|
||
v.update(uniques)
|
||
self._validate_node_name(k)
|
||
self.config._connections_add(**v)
|
||
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Import nodes/folders from a dictionary.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ImportExportService.import_from_file"><code class="name flex">
|
||
<span>def <span class="ident">import_from_file</span></span>(<span>self, file_path)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def import_from_file(self, file_path):
|
||
"""Import nodes/folders from a YAML file."""
|
||
if not os.path.exists(file_path):
|
||
raise InvalidConfigurationError(f"File '{file_path}' does not exist.")
|
||
|
||
try:
|
||
with open(file_path, "r") as f:
|
||
data = yaml.load(f, Loader=yaml.FullLoader)
|
||
self.import_from_dict(data)
|
||
except Exception as e:
|
||
raise InvalidConfigurationError(f"Failed to read/parse import file: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Import nodes/folders from a YAML file.</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>
|
||
<dt id="connpy.services.InvalidConfigurationError"><code class="flex name class">
|
||
<span>class <span class="ident">InvalidConfigurationError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class InvalidConfigurationError(ConnpyError):
|
||
"""Raised when data or configuration input is invalid."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when data or configuration input is invalid.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.NodeAlreadyExistsError"><code class="flex name class">
|
||
<span>class <span class="ident">NodeAlreadyExistsError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class NodeAlreadyExistsError(ConnpyError):
|
||
"""Raised when a node or folder already exists."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when a node or folder already exists.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.NodeNotFoundError"><code class="flex name class">
|
||
<span>class <span class="ident">NodeNotFoundError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class NodeNotFoundError(ConnpyError):
|
||
"""Raised when a connection or folder is not found."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when a connection or folder is not found.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService"><code class="flex name class">
|
||
<span>class <span class="ident">NodeService</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 NodeService(BaseService):
|
||
def __init__(self, config=None):
|
||
super().__init__(config)
|
||
|
||
|
||
def list_nodes(self, filter_str=None, format_str=None):
|
||
"""Return a listed filtered by regex match and formatted if needed."""
|
||
nodes = self.config._getallnodes()
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
flags = re.IGNORECASE if not case_sensitive else 0
|
||
nodes = [n for n in nodes if re.search(filter_str, n, flags)]
|
||
|
||
if not format_str:
|
||
return nodes
|
||
|
||
from .profile_service import ProfileService
|
||
profile_service = ProfileService(self.config)
|
||
|
||
formatted_nodes = []
|
||
for n_id in nodes:
|
||
# Use ProfileService to resolve profiles for dynamic formatting
|
||
details = self.config.getitem(n_id, extract=False)
|
||
if details:
|
||
details = profile_service.resolve_node_data(details)
|
||
|
||
name = n_id.split("@")[0]
|
||
location = n_id.partition("@")[2] or "root"
|
||
|
||
# Prepare context for .format() with all details
|
||
context = details.copy()
|
||
context.update({
|
||
"name": name,
|
||
"NAME": name.upper(),
|
||
"location": location,
|
||
"LOCATION": location.upper(),
|
||
})
|
||
|
||
# Add exploded uniques (id, folder, subfolder)
|
||
uniques = self.config._explode_unique(n_id)
|
||
if uniques:
|
||
context.update(uniques)
|
||
|
||
# Add uppercase versions of all keys for convenience
|
||
for k, v in list(context.items()):
|
||
if isinstance(v, str):
|
||
context[k.upper()] = v.upper()
|
||
|
||
try:
|
||
formatted_nodes.append(format_str.format(**context))
|
||
except (KeyError, IndexError, ValueError):
|
||
# Fallback to original string if format fails
|
||
formatted_nodes.append(n_id)
|
||
return formatted_nodes
|
||
|
||
def list_folders(self, filter_str=None):
|
||
"""Return all unique folders, optionally filtered by regex."""
|
||
folders = self.config._getallfolders()
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
flags = re.IGNORECASE if not case_sensitive else 0
|
||
folders = [f for f in folders if re.search(filter_str, f, flags)]
|
||
return folders
|
||
|
||
def get_node_details(self, unique_id):
|
||
"""Return full configuration dictionary for a specific node."""
|
||
try:
|
||
details = self.config.getitem(unique_id)
|
||
if not details:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
return details
|
||
except (KeyError, TypeError):
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
|
||
def explode_unique(self, unique_id):
|
||
"""Explode a unique ID into a dictionary of its parts."""
|
||
return self.config._explode_unique(unique_id)
|
||
|
||
def generate_cache(self, nodes=None, folders=None, profiles=None):
|
||
"""Generate and update the internal nodes cache."""
|
||
self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)
|
||
|
||
def validate_parent_folder(self, unique_id):
|
||
"""Check if parent folder exists for a given node unique ID."""
|
||
node_folder = unique_id.partition("@")[2]
|
||
if node_folder:
|
||
parent_folder = f"@{node_folder}"
|
||
if parent_folder not in self.config._getallfolders():
|
||
raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
|
||
|
||
|
||
def add_node(self, unique_id, data, is_folder=False):
|
||
"""Logic for adding a new node or folder to configuration."""
|
||
if not is_folder:
|
||
self._validate_node_name(unique_id)
|
||
|
||
all_nodes = self.config._getallnodes()
|
||
all_folders = self.config._getallfolders()
|
||
|
||
if is_folder:
|
||
if unique_id in all_folders:
|
||
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
|
||
|
||
# Check if parent folder exists when creating a subfolder
|
||
if "subfolder" in uniques:
|
||
self.validate_parent_folder(unique_id)
|
||
|
||
self.config._folder_add(**uniques)
|
||
self.config._saveconfig(self.config.file)
|
||
else:
|
||
if unique_id in all_nodes:
|
||
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
|
||
|
||
# Check if parent folder exists when creating a node in a folder
|
||
self.validate_parent_folder(unique_id)
|
||
|
||
# Ensure 'id' is in data for config._connections_add
|
||
if "id" not in data:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if uniques and "id" in uniques:
|
||
data["id"] = uniques["id"]
|
||
|
||
self.config._connections_add(**data)
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def update_node(self, unique_id, data):
|
||
"""Explicitly update an existing node."""
|
||
all_nodes = self.config._getallnodes()
|
||
if unique_id not in all_nodes:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
|
||
# Ensure 'id' is in data for config._connections_add
|
||
if "id" not in data:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if uniques:
|
||
data["id"] = uniques["id"]
|
||
|
||
# config._connections_add actually handles updates if ID exists correctly
|
||
self.config._connections_add(**data)
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def delete_node(self, unique_id, is_folder=False):
|
||
"""Logic for deleting a node or folder."""
|
||
if is_folder:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise NodeNotFoundError(f"Folder '{unique_id}' not found or invalid.")
|
||
self.config._folder_del(**uniques)
|
||
else:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found or invalid.")
|
||
self.config._connections_del(**uniques)
|
||
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
|
||
"""Interact with a node directly."""
|
||
from connpy.core import node
|
||
from .profile_service import ProfileService
|
||
|
||
node_data = self.config.getitem(unique_id, extract=False)
|
||
if not node_data:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
|
||
# Resolve profiles
|
||
profile_service = ProfileService(self.config)
|
||
resolved_data = profile_service.resolve_node_data(node_data)
|
||
|
||
n = node(unique_id, **resolved_data, config=self.config)
|
||
if sftp:
|
||
n.protocol = "sftp"
|
||
|
||
n.interact(debug=debug, logger=logger)
|
||
|
||
def move_node(self, src_id, dst_id, copy=False):
|
||
"""Move or copy a node."""
|
||
self._validate_node_name(dst_id)
|
||
|
||
node_data = self.config.getitem(src_id)
|
||
if not node_data:
|
||
raise NodeNotFoundError(f"Source node '{src_id}' not found.")
|
||
|
||
if dst_id in self.config._getallnodes():
|
||
raise NodeAlreadyExistsError(f"Destination node '{dst_id}' already exists.")
|
||
|
||
new_uniques = self.config._explode_unique(dst_id)
|
||
if not new_uniques:
|
||
raise InvalidConfigurationError(f"Invalid destination format '{dst_id}'.")
|
||
|
||
new_node_data = node_data.copy()
|
||
new_node_data.update(new_uniques)
|
||
|
||
self.config._connections_add(**new_node_data)
|
||
|
||
if not copy:
|
||
src_uniques = self.config._explode_unique(src_id)
|
||
self.config._connections_del(**src_uniques)
|
||
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def bulk_add(self, ids, hosts, common_data):
|
||
"""Add multiple nodes with shared common configuration."""
|
||
count = 0
|
||
all_nodes = self.config._getallnodes()
|
||
|
||
for i, uid in enumerate(ids):
|
||
if uid in all_nodes:
|
||
continue
|
||
|
||
try:
|
||
self._validate_node_name(uid)
|
||
except ReservedNameError:
|
||
# For bulk, we might want to just skip or log.
|
||
# CLI caller will handle if it wants to be strict.
|
||
continue
|
||
|
||
host = hosts[i] if i < len(hosts) else hosts[0]
|
||
uniques = self.config._explode_unique(uid)
|
||
if not uniques:
|
||
continue
|
||
|
||
node_data = common_data.copy()
|
||
node_data.pop("ids", None)
|
||
node_data.pop("location", None)
|
||
node_data.update(uniques)
|
||
node_data["host"] = host
|
||
node_data["type"] = "connection"
|
||
|
||
self.config._connections_add(**node_data)
|
||
count += 1
|
||
|
||
if count > 0:
|
||
self.config._saveconfig(self.config.file)
|
||
return count
|
||
|
||
def full_replace(self, connections, profiles):
|
||
"""Replace all connections and profiles with new data."""
|
||
self.config.connections = connections
|
||
self.config.profiles = profiles
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def get_inventory(self):
|
||
"""Return a full snapshot of connections and profiles."""
|
||
return {
|
||
"connections": self.config.connections,
|
||
"profiles": self.config.profiles
|
||
}</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Base class for all connpy services, providing common configuration access.</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.NodeService.add_node"><code class="name flex">
|
||
<span>def <span class="ident">add_node</span></span>(<span>self, unique_id, data, is_folder=False)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def add_node(self, unique_id, data, is_folder=False):
|
||
"""Logic for adding a new node or folder to configuration."""
|
||
if not is_folder:
|
||
self._validate_node_name(unique_id)
|
||
|
||
all_nodes = self.config._getallnodes()
|
||
all_folders = self.config._getallfolders()
|
||
|
||
if is_folder:
|
||
if unique_id in all_folders:
|
||
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
|
||
|
||
# Check if parent folder exists when creating a subfolder
|
||
if "subfolder" in uniques:
|
||
self.validate_parent_folder(unique_id)
|
||
|
||
self.config._folder_add(**uniques)
|
||
self.config._saveconfig(self.config.file)
|
||
else:
|
||
if unique_id in all_nodes:
|
||
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
|
||
|
||
# Check if parent folder exists when creating a node in a folder
|
||
self.validate_parent_folder(unique_id)
|
||
|
||
# Ensure 'id' is in data for config._connections_add
|
||
if "id" not in data:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if uniques and "id" in uniques:
|
||
data["id"] = uniques["id"]
|
||
|
||
self.config._connections_add(**data)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Logic for adding a new node or folder to configuration.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.bulk_add"><code class="name flex">
|
||
<span>def <span class="ident">bulk_add</span></span>(<span>self, ids, hosts, common_data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def bulk_add(self, ids, hosts, common_data):
|
||
"""Add multiple nodes with shared common configuration."""
|
||
count = 0
|
||
all_nodes = self.config._getallnodes()
|
||
|
||
for i, uid in enumerate(ids):
|
||
if uid in all_nodes:
|
||
continue
|
||
|
||
try:
|
||
self._validate_node_name(uid)
|
||
except ReservedNameError:
|
||
# For bulk, we might want to just skip or log.
|
||
# CLI caller will handle if it wants to be strict.
|
||
continue
|
||
|
||
host = hosts[i] if i < len(hosts) else hosts[0]
|
||
uniques = self.config._explode_unique(uid)
|
||
if not uniques:
|
||
continue
|
||
|
||
node_data = common_data.copy()
|
||
node_data.pop("ids", None)
|
||
node_data.pop("location", None)
|
||
node_data.update(uniques)
|
||
node_data["host"] = host
|
||
node_data["type"] = "connection"
|
||
|
||
self.config._connections_add(**node_data)
|
||
count += 1
|
||
|
||
if count > 0:
|
||
self.config._saveconfig(self.config.file)
|
||
return count</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Add multiple nodes with shared common configuration.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.connect_node"><code class="name flex">
|
||
<span>def <span class="ident">connect_node</span></span>(<span>self, unique_id, sftp=False, debug=False, logger=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
|
||
"""Interact with a node directly."""
|
||
from connpy.core import node
|
||
from .profile_service import ProfileService
|
||
|
||
node_data = self.config.getitem(unique_id, extract=False)
|
||
if not node_data:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
|
||
# Resolve profiles
|
||
profile_service = ProfileService(self.config)
|
||
resolved_data = profile_service.resolve_node_data(node_data)
|
||
|
||
n = node(unique_id, **resolved_data, config=self.config)
|
||
if sftp:
|
||
n.protocol = "sftp"
|
||
|
||
n.interact(debug=debug, logger=logger)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Interact with a node directly.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.delete_node"><code class="name flex">
|
||
<span>def <span class="ident">delete_node</span></span>(<span>self, unique_id, is_folder=False)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def delete_node(self, unique_id, is_folder=False):
|
||
"""Logic for deleting a node or folder."""
|
||
if is_folder:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise NodeNotFoundError(f"Folder '{unique_id}' not found or invalid.")
|
||
self.config._folder_del(**uniques)
|
||
else:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if not uniques:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found or invalid.")
|
||
self.config._connections_del(**uniques)
|
||
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Logic for deleting a node or folder.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.explode_unique"><code class="name flex">
|
||
<span>def <span class="ident">explode_unique</span></span>(<span>self, unique_id)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def explode_unique(self, unique_id):
|
||
"""Explode a unique ID into a dictionary of its parts."""
|
||
return self.config._explode_unique(unique_id)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Explode a unique ID into a dictionary of its parts.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.full_replace"><code class="name flex">
|
||
<span>def <span class="ident">full_replace</span></span>(<span>self, connections, profiles)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def full_replace(self, connections, profiles):
|
||
"""Replace all connections and profiles with new data."""
|
||
self.config.connections = connections
|
||
self.config.profiles = profiles
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Replace all connections and profiles with new data.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.generate_cache"><code class="name flex">
|
||
<span>def <span class="ident">generate_cache</span></span>(<span>self, nodes=None, folders=None, profiles=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def generate_cache(self, nodes=None, folders=None, profiles=None):
|
||
"""Generate and update the internal nodes cache."""
|
||
self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Generate and update the internal nodes cache.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.get_inventory"><code class="name flex">
|
||
<span>def <span class="ident">get_inventory</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_inventory(self):
|
||
"""Return a full snapshot of connections and profiles."""
|
||
return {
|
||
"connections": self.config.connections,
|
||
"profiles": self.config.profiles
|
||
}</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return a full snapshot of connections and profiles.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.get_node_details"><code class="name flex">
|
||
<span>def <span class="ident">get_node_details</span></span>(<span>self, unique_id)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_node_details(self, unique_id):
|
||
"""Return full configuration dictionary for a specific node."""
|
||
try:
|
||
details = self.config.getitem(unique_id)
|
||
if not details:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
return details
|
||
except (KeyError, TypeError):
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return full configuration dictionary for a specific node.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.list_folders"><code class="name flex">
|
||
<span>def <span class="ident">list_folders</span></span>(<span>self, filter_str=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def list_folders(self, filter_str=None):
|
||
"""Return all unique folders, optionally filtered by regex."""
|
||
folders = self.config._getallfolders()
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
flags = re.IGNORECASE if not case_sensitive else 0
|
||
folders = [f for f in folders if re.search(filter_str, f, flags)]
|
||
return folders</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return all unique folders, optionally filtered by regex.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.list_nodes"><code class="name flex">
|
||
<span>def <span class="ident">list_nodes</span></span>(<span>self, filter_str=None, format_str=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def list_nodes(self, filter_str=None, format_str=None):
|
||
"""Return a listed filtered by regex match and formatted if needed."""
|
||
nodes = self.config._getallnodes()
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
flags = re.IGNORECASE if not case_sensitive else 0
|
||
nodes = [n for n in nodes if re.search(filter_str, n, flags)]
|
||
|
||
if not format_str:
|
||
return nodes
|
||
|
||
from .profile_service import ProfileService
|
||
profile_service = ProfileService(self.config)
|
||
|
||
formatted_nodes = []
|
||
for n_id in nodes:
|
||
# Use ProfileService to resolve profiles for dynamic formatting
|
||
details = self.config.getitem(n_id, extract=False)
|
||
if details:
|
||
details = profile_service.resolve_node_data(details)
|
||
|
||
name = n_id.split("@")[0]
|
||
location = n_id.partition("@")[2] or "root"
|
||
|
||
# Prepare context for .format() with all details
|
||
context = details.copy()
|
||
context.update({
|
||
"name": name,
|
||
"NAME": name.upper(),
|
||
"location": location,
|
||
"LOCATION": location.upper(),
|
||
})
|
||
|
||
# Add exploded uniques (id, folder, subfolder)
|
||
uniques = self.config._explode_unique(n_id)
|
||
if uniques:
|
||
context.update(uniques)
|
||
|
||
# Add uppercase versions of all keys for convenience
|
||
for k, v in list(context.items()):
|
||
if isinstance(v, str):
|
||
context[k.upper()] = v.upper()
|
||
|
||
try:
|
||
formatted_nodes.append(format_str.format(**context))
|
||
except (KeyError, IndexError, ValueError):
|
||
# Fallback to original string if format fails
|
||
formatted_nodes.append(n_id)
|
||
return formatted_nodes</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Return a listed filtered by regex match and formatted if needed.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.move_node"><code class="name flex">
|
||
<span>def <span class="ident">move_node</span></span>(<span>self, src_id, dst_id, copy=False)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def move_node(self, src_id, dst_id, copy=False):
|
||
"""Move or copy a node."""
|
||
self._validate_node_name(dst_id)
|
||
|
||
node_data = self.config.getitem(src_id)
|
||
if not node_data:
|
||
raise NodeNotFoundError(f"Source node '{src_id}' not found.")
|
||
|
||
if dst_id in self.config._getallnodes():
|
||
raise NodeAlreadyExistsError(f"Destination node '{dst_id}' already exists.")
|
||
|
||
new_uniques = self.config._explode_unique(dst_id)
|
||
if not new_uniques:
|
||
raise InvalidConfigurationError(f"Invalid destination format '{dst_id}'.")
|
||
|
||
new_node_data = node_data.copy()
|
||
new_node_data.update(new_uniques)
|
||
|
||
self.config._connections_add(**new_node_data)
|
||
|
||
if not copy:
|
||
src_uniques = self.config._explode_unique(src_id)
|
||
self.config._connections_del(**src_uniques)
|
||
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Move or copy a node.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.update_node"><code class="name flex">
|
||
<span>def <span class="ident">update_node</span></span>(<span>self, unique_id, data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def update_node(self, unique_id, data):
|
||
"""Explicitly update an existing node."""
|
||
all_nodes = self.config._getallnodes()
|
||
if unique_id not in all_nodes:
|
||
raise NodeNotFoundError(f"Node '{unique_id}' not found.")
|
||
|
||
# Ensure 'id' is in data for config._connections_add
|
||
if "id" not in data:
|
||
uniques = self.config._explode_unique(unique_id)
|
||
if uniques:
|
||
data["id"] = uniques["id"]
|
||
|
||
# config._connections_add actually handles updates if ID exists correctly
|
||
self.config._connections_add(**data)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Explicitly update an existing node.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.NodeService.validate_parent_folder"><code class="name flex">
|
||
<span>def <span class="ident">validate_parent_folder</span></span>(<span>self, unique_id)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def validate_parent_folder(self, unique_id):
|
||
"""Check if parent folder exists for a given node unique ID."""
|
||
node_folder = unique_id.partition("@")[2]
|
||
if node_folder:
|
||
parent_folder = f"@{node_folder}"
|
||
if parent_folder not in self.config._getallfolders():
|
||
raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Check if parent folder exists for a given node unique ID.</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>
|
||
<dt id="connpy.services.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:
|
||
is_mock = True
|
||
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")
|
||
|
||
# Get settings for CLI behavior
|
||
settings = self.services.config_svc.get_settings()
|
||
self.case = settings.get("case", False)
|
||
self.fzf = settings.get("fzf", False)
|
||
|
||
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
|
||
|
||
from rich.console import Console
|
||
buf = io.StringIO()
|
||
old_console = printer._get_console()
|
||
old_err_console = printer._get_err_console()
|
||
|
||
printer.set_thread_console(Console(file=buf, theme=printer.connpy_theme, force_terminal=True))
|
||
printer.set_thread_err_console(Console(file=buf, theme=printer.connpy_theme, force_terminal=True))
|
||
printer.set_thread_stream(buf)
|
||
|
||
try:
|
||
if hasattr(module, "Entrypoint"):
|
||
module.Entrypoint(args, parser, app)
|
||
except BaseException as e:
|
||
if not isinstance(e, SystemExit):
|
||
import traceback
|
||
printer.err_console.print(traceback.format_exc())
|
||
finally:
|
||
printer.set_thread_console(old_console)
|
||
printer.set_thread_err_console(old_err_console)
|
||
printer.set_thread_stream(None)
|
||
|
||
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.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.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.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.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.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.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.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:
|
||
is_mock = True
|
||
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")
|
||
|
||
# Get settings for CLI behavior
|
||
settings = self.services.config_svc.get_settings()
|
||
self.case = settings.get("case", False)
|
||
self.fzf = settings.get("fzf", False)
|
||
|
||
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
|
||
|
||
from rich.console import Console
|
||
buf = io.StringIO()
|
||
old_console = printer._get_console()
|
||
old_err_console = printer._get_err_console()
|
||
|
||
printer.set_thread_console(Console(file=buf, theme=printer.connpy_theme, force_terminal=True))
|
||
printer.set_thread_err_console(Console(file=buf, theme=printer.connpy_theme, force_terminal=True))
|
||
printer.set_thread_stream(buf)
|
||
|
||
try:
|
||
if hasattr(module, "Entrypoint"):
|
||
module.Entrypoint(args, parser, app)
|
||
except BaseException as e:
|
||
if not isinstance(e, SystemExit):
|
||
import traceback
|
||
printer.err_console.print(traceback.format_exc())
|
||
finally:
|
||
printer.set_thread_console(old_console)
|
||
printer.set_thread_err_console(old_err_console)
|
||
printer.set_thread_stream(None)
|
||
|
||
for line in buf.getvalue().splitlines(keepends=True):
|
||
yield line</code></pre>
|
||
</details>
|
||
<div class="desc"></div>
|
||
</dd>
|
||
<dt id="connpy.services.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>
|
||
<dt id="connpy.services.ProfileAlreadyExistsError"><code class="flex name class">
|
||
<span>class <span class="ident">ProfileAlreadyExistsError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class ProfileAlreadyExistsError(ConnpyError):
|
||
"""Raised when a profile with the same name already exists."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when a profile with the same name already exists.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileNotFoundError"><code class="flex name class">
|
||
<span>class <span class="ident">ProfileNotFoundError</span></span>
|
||
<span>(</span><span>*args, **kwargs)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">class ProfileNotFoundError(ConnpyError):
|
||
"""Raised when a profile is not found."""
|
||
pass</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Raised when a profile is not found.</p></div>
|
||
<h3>Ancestors</h3>
|
||
<ul class="hlist">
|
||
<li><a title="connpy.services.exceptions.ConnpyError" href="exceptions.html#connpy.services.exceptions.ConnpyError">ConnpyError</a></li>
|
||
<li>builtins.Exception</li>
|
||
<li>builtins.BaseException</li>
|
||
</ul>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService"><code class="flex name class">
|
||
<span>class <span class="ident">ProfileService</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 ProfileService(BaseService):
|
||
"""Business logic for node profiles management."""
|
||
|
||
def list_profiles(self, filter_str=None):
|
||
"""List all profile names, optionally filtered."""
|
||
profiles = list(self.config.profiles.keys())
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
if not case_sensitive:
|
||
f_str = filter_str.lower()
|
||
return [p for p in profiles if f_str in p.lower()]
|
||
else:
|
||
return [p for p in profiles if filter_str in p]
|
||
return profiles
|
||
|
||
def get_profile(self, name, resolve=True):
|
||
"""Get the profile dictionary, optionally resolved."""
|
||
profile = self.config.profiles.get(name)
|
||
if not profile:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
if resolve:
|
||
return self.resolve_node_data(profile)
|
||
return profile
|
||
|
||
def add_profile(self, name, data):
|
||
"""Add a new profile."""
|
||
if name in self.config.profiles:
|
||
raise ProfileAlreadyExistsError(f"Profile '{name}' already exists.")
|
||
|
||
# Filter data to match _profiles_add signature and ensure id is passed
|
||
allowed_keys = {"host", "options", "logs", "password", "port", "protocol", "user", "tags", "jumphost"}
|
||
filtered_data = {k: v for k, v in data.items() if k in allowed_keys}
|
||
|
||
self.config._profiles_add(id=name, **filtered_data)
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def resolve_node_data(self, node_data):
|
||
"""Resolve profile references (@profile) in node data and handle inheritance."""
|
||
resolved = node_data.copy()
|
||
|
||
# 1. Identify all referenced profiles to support inheritance
|
||
referenced_profiles = []
|
||
for value in resolved.values():
|
||
if isinstance(value, str) and value.startswith("@"):
|
||
referenced_profiles.append(value[1:])
|
||
elif isinstance(value, list):
|
||
for item in value:
|
||
if isinstance(item, str) and item.startswith("@"):
|
||
referenced_profiles.append(item[1:])
|
||
|
||
# 2. Resolve explicit references
|
||
for key, value in resolved.items():
|
||
if isinstance(value, str) and value.startswith("@"):
|
||
profile_name = value[1:]
|
||
try:
|
||
profile = self.get_profile(profile_name, resolve=True)
|
||
resolved[key] = profile.get(key, "")
|
||
except ProfileNotFoundError:
|
||
resolved[key] = ""
|
||
elif isinstance(value, list):
|
||
resolved_list = []
|
||
for item in value:
|
||
if isinstance(item, str) and item.startswith("@"):
|
||
profile_name = item[1:]
|
||
try:
|
||
profile = self.get_profile(profile_name, resolve=True)
|
||
if "password" in profile:
|
||
resolved_list.append(profile["password"])
|
||
except ProfileNotFoundError:
|
||
pass
|
||
else:
|
||
resolved_list.append(item)
|
||
resolved[key] = resolved_list
|
||
|
||
# 3. Inheritance: Fill empty keys from the first referenced profile
|
||
if referenced_profiles:
|
||
base_profile_name = referenced_profiles[0]
|
||
try:
|
||
base_profile = self.get_profile(base_profile_name, resolve=True)
|
||
for key, value in base_profile.items():
|
||
# Fill if key is missing or empty
|
||
if key not in resolved or resolved[key] == "" or resolved[key] == [] or resolved[key] is None:
|
||
resolved[key] = value
|
||
except ProfileNotFoundError:
|
||
pass
|
||
|
||
# 4. Handle default protocol
|
||
if resolved.get("protocol") == "" or resolved.get("protocol") is None:
|
||
try:
|
||
default_profile = self.get_profile("default", resolve=True)
|
||
resolved["protocol"] = default_profile.get("protocol", "ssh")
|
||
except ProfileNotFoundError:
|
||
resolved["protocol"] = "ssh"
|
||
|
||
return resolved
|
||
|
||
def delete_profile(self, name):
|
||
"""Delete an existing profile, with safety checks."""
|
||
if name not in self.config.profiles:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
if name == "default":
|
||
raise InvalidConfigurationError("Cannot delete the 'default' profile.")
|
||
|
||
used_by = self.config._profileused(name)
|
||
if used_by:
|
||
# We return the list of nodes using it so the UI can inform the user
|
||
raise InvalidConfigurationError(f"Profile '{name}' is used by nodes: {', '.join(used_by)}")
|
||
|
||
self.config._profiles_del(id=name)
|
||
self.config._saveconfig(self.config.file)
|
||
|
||
def update_profile(self, name, data):
|
||
"""Update an existing profile."""
|
||
if name not in self.config.profiles:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
# Merge with existing data
|
||
existing = self.get_profile(name, resolve=False)
|
||
updated_data = existing.copy()
|
||
updated_data.update(data)
|
||
|
||
# Filter data to match _profiles_add signature
|
||
allowed_keys = {"host", "options", "logs", "password", "port", "protocol", "user", "tags", "jumphost"}
|
||
filtered_data = {k: v for k, v in updated_data.items() if k in allowed_keys}
|
||
|
||
self.config._profiles_add(id=name, **filtered_data)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for node profiles management.</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.ProfileService.add_profile"><code class="name flex">
|
||
<span>def <span class="ident">add_profile</span></span>(<span>self, name, data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def add_profile(self, name, data):
|
||
"""Add a new profile."""
|
||
if name in self.config.profiles:
|
||
raise ProfileAlreadyExistsError(f"Profile '{name}' already exists.")
|
||
|
||
# Filter data to match _profiles_add signature and ensure id is passed
|
||
allowed_keys = {"host", "options", "logs", "password", "port", "protocol", "user", "tags", "jumphost"}
|
||
filtered_data = {k: v for k, v in data.items() if k in allowed_keys}
|
||
|
||
self.config._profiles_add(id=name, **filtered_data)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Add a new profile.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService.delete_profile"><code class="name flex">
|
||
<span>def <span class="ident">delete_profile</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_profile(self, name):
|
||
"""Delete an existing profile, with safety checks."""
|
||
if name not in self.config.profiles:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
if name == "default":
|
||
raise InvalidConfigurationError("Cannot delete the 'default' profile.")
|
||
|
||
used_by = self.config._profileused(name)
|
||
if used_by:
|
||
# We return the list of nodes using it so the UI can inform the user
|
||
raise InvalidConfigurationError(f"Profile '{name}' is used by nodes: {', '.join(used_by)}")
|
||
|
||
self.config._profiles_del(id=name)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Delete an existing profile, with safety checks.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService.get_profile"><code class="name flex">
|
||
<span>def <span class="ident">get_profile</span></span>(<span>self, name, resolve=True)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_profile(self, name, resolve=True):
|
||
"""Get the profile dictionary, optionally resolved."""
|
||
profile = self.config.profiles.get(name)
|
||
if not profile:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
if resolve:
|
||
return self.resolve_node_data(profile)
|
||
return profile</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Get the profile dictionary, optionally resolved.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService.list_profiles"><code class="name flex">
|
||
<span>def <span class="ident">list_profiles</span></span>(<span>self, filter_str=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def list_profiles(self, filter_str=None):
|
||
"""List all profile names, optionally filtered."""
|
||
profiles = list(self.config.profiles.keys())
|
||
case_sensitive = self.config.config.get("case", False)
|
||
|
||
if filter_str:
|
||
if not case_sensitive:
|
||
f_str = filter_str.lower()
|
||
return [p for p in profiles if f_str in p.lower()]
|
||
else:
|
||
return [p for p in profiles if filter_str in p]
|
||
return profiles</code></pre>
|
||
</details>
|
||
<div class="desc"><p>List all profile names, optionally filtered.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService.resolve_node_data"><code class="name flex">
|
||
<span>def <span class="ident">resolve_node_data</span></span>(<span>self, node_data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def resolve_node_data(self, node_data):
|
||
"""Resolve profile references (@profile) in node data and handle inheritance."""
|
||
resolved = node_data.copy()
|
||
|
||
# 1. Identify all referenced profiles to support inheritance
|
||
referenced_profiles = []
|
||
for value in resolved.values():
|
||
if isinstance(value, str) and value.startswith("@"):
|
||
referenced_profiles.append(value[1:])
|
||
elif isinstance(value, list):
|
||
for item in value:
|
||
if isinstance(item, str) and item.startswith("@"):
|
||
referenced_profiles.append(item[1:])
|
||
|
||
# 2. Resolve explicit references
|
||
for key, value in resolved.items():
|
||
if isinstance(value, str) and value.startswith("@"):
|
||
profile_name = value[1:]
|
||
try:
|
||
profile = self.get_profile(profile_name, resolve=True)
|
||
resolved[key] = profile.get(key, "")
|
||
except ProfileNotFoundError:
|
||
resolved[key] = ""
|
||
elif isinstance(value, list):
|
||
resolved_list = []
|
||
for item in value:
|
||
if isinstance(item, str) and item.startswith("@"):
|
||
profile_name = item[1:]
|
||
try:
|
||
profile = self.get_profile(profile_name, resolve=True)
|
||
if "password" in profile:
|
||
resolved_list.append(profile["password"])
|
||
except ProfileNotFoundError:
|
||
pass
|
||
else:
|
||
resolved_list.append(item)
|
||
resolved[key] = resolved_list
|
||
|
||
# 3. Inheritance: Fill empty keys from the first referenced profile
|
||
if referenced_profiles:
|
||
base_profile_name = referenced_profiles[0]
|
||
try:
|
||
base_profile = self.get_profile(base_profile_name, resolve=True)
|
||
for key, value in base_profile.items():
|
||
# Fill if key is missing or empty
|
||
if key not in resolved or resolved[key] == "" or resolved[key] == [] or resolved[key] is None:
|
||
resolved[key] = value
|
||
except ProfileNotFoundError:
|
||
pass
|
||
|
||
# 4. Handle default protocol
|
||
if resolved.get("protocol") == "" or resolved.get("protocol") is None:
|
||
try:
|
||
default_profile = self.get_profile("default", resolve=True)
|
||
resolved["protocol"] = default_profile.get("protocol", "ssh")
|
||
except ProfileNotFoundError:
|
||
resolved["protocol"] = "ssh"
|
||
|
||
return resolved</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Resolve profile references (@profile) in node data and handle inheritance.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.ProfileService.update_profile"><code class="name flex">
|
||
<span>def <span class="ident">update_profile</span></span>(<span>self, name, data)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def update_profile(self, name, data):
|
||
"""Update an existing profile."""
|
||
if name not in self.config.profiles:
|
||
raise ProfileNotFoundError(f"Profile '{name}' not found.")
|
||
|
||
# Merge with existing data
|
||
existing = self.get_profile(name, resolve=False)
|
||
updated_data = existing.copy()
|
||
updated_data.update(data)
|
||
|
||
# Filter data to match _profiles_add signature
|
||
allowed_keys = {"host", "options", "logs", "password", "port", "protocol", "user", "tags", "jumphost"}
|
||
filtered_data = {k: v for k, v in updated_data.items() if k in allowed_keys}
|
||
|
||
self.config._profiles_add(id=name, **filtered_data)
|
||
self.config._saveconfig(self.config.file)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Update an existing profile.</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>
|
||
<dt id="connpy.services.SystemService"><code class="flex name class">
|
||
<span>class <span class="ident">SystemService</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 SystemService(BaseService):
|
||
"""Business logic for application lifecycle (API, processes)."""
|
||
|
||
def start_api(self, port=None):
|
||
"""Start the Connpy REST API."""
|
||
from connpy.api import start_api
|
||
try:
|
||
start_api(port, config=self.config)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to start API: {e}")
|
||
|
||
def debug_api(self, port=None):
|
||
"""Start the Connpy REST API in debug mode."""
|
||
from connpy.api import debug_api
|
||
try:
|
||
debug_api(port, config=self.config)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to start API in debug mode: {e}")
|
||
|
||
|
||
def stop_api(self):
|
||
"""Stop the Connpy REST API."""
|
||
try:
|
||
import os
|
||
import signal
|
||
|
||
pids = ["/run/connpy.pid", "/tmp/connpy.pid"]
|
||
stopped = False
|
||
for pid_file in pids:
|
||
if os.path.exists(pid_file):
|
||
try:
|
||
with open(pid_file, "r") as f:
|
||
# Read only the first line (PID)
|
||
line = f.readline().strip()
|
||
if not line:
|
||
continue
|
||
pid = int(line)
|
||
os.kill(pid, signal.SIGTERM)
|
||
# Remove the PID file after successful kill
|
||
os.remove(pid_file)
|
||
stopped = True
|
||
except (ValueError, OSError, ProcessLookupError):
|
||
# If process is already dead, just remove the stale PID file
|
||
try:
|
||
os.remove(pid_file)
|
||
except OSError:
|
||
pass
|
||
continue
|
||
return stopped
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to stop API: {e}")
|
||
|
||
def restart_api(self, port=None):
|
||
"""Restart the Connpy REST API, maintaining the current port if none provided."""
|
||
if port is None:
|
||
status = self.get_api_status()
|
||
if status["running"] and status.get("port"):
|
||
port = status["port"]
|
||
|
||
self.stop_api()
|
||
import time
|
||
time.sleep(1)
|
||
self.start_api(port)
|
||
|
||
def get_api_status(self):
|
||
"""Check if the API is currently running."""
|
||
import os
|
||
pids = ["/run/connpy.pid", "/tmp/connpy.pid"]
|
||
for pid_file in pids:
|
||
if os.path.exists(pid_file):
|
||
try:
|
||
with open(pid_file, "r") as f:
|
||
pid_line = f.readline().strip()
|
||
port_line = f.readline().strip()
|
||
if not pid_line:
|
||
continue
|
||
pid = int(pid_line)
|
||
port = int(port_line) if port_line else None
|
||
# Signal 0 checks for process existence without killing it
|
||
os.kill(pid, 0)
|
||
return {"running": True, "pid": pid, "port": port, "pid_file": pid_file}
|
||
except (ValueError, OSError, ProcessLookupError):
|
||
continue
|
||
return {"running": False}</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Business logic for application lifecycle (API, processes).</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.SystemService.debug_api"><code class="name flex">
|
||
<span>def <span class="ident">debug_api</span></span>(<span>self, port=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def debug_api(self, port=None):
|
||
"""Start the Connpy REST API in debug mode."""
|
||
from connpy.api import debug_api
|
||
try:
|
||
debug_api(port, config=self.config)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to start API in debug mode: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Start the Connpy REST API in debug mode.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.SystemService.get_api_status"><code class="name flex">
|
||
<span>def <span class="ident">get_api_status</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def get_api_status(self):
|
||
"""Check if the API is currently running."""
|
||
import os
|
||
pids = ["/run/connpy.pid", "/tmp/connpy.pid"]
|
||
for pid_file in pids:
|
||
if os.path.exists(pid_file):
|
||
try:
|
||
with open(pid_file, "r") as f:
|
||
pid_line = f.readline().strip()
|
||
port_line = f.readline().strip()
|
||
if not pid_line:
|
||
continue
|
||
pid = int(pid_line)
|
||
port = int(port_line) if port_line else None
|
||
# Signal 0 checks for process existence without killing it
|
||
os.kill(pid, 0)
|
||
return {"running": True, "pid": pid, "port": port, "pid_file": pid_file}
|
||
except (ValueError, OSError, ProcessLookupError):
|
||
continue
|
||
return {"running": False}</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Check if the API is currently running.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.SystemService.restart_api"><code class="name flex">
|
||
<span>def <span class="ident">restart_api</span></span>(<span>self, port=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def restart_api(self, port=None):
|
||
"""Restart the Connpy REST API, maintaining the current port if none provided."""
|
||
if port is None:
|
||
status = self.get_api_status()
|
||
if status["running"] and status.get("port"):
|
||
port = status["port"]
|
||
|
||
self.stop_api()
|
||
import time
|
||
time.sleep(1)
|
||
self.start_api(port)</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Restart the Connpy REST API, maintaining the current port if none provided.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.SystemService.start_api"><code class="name flex">
|
||
<span>def <span class="ident">start_api</span></span>(<span>self, port=None)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def start_api(self, port=None):
|
||
"""Start the Connpy REST API."""
|
||
from connpy.api import start_api
|
||
try:
|
||
start_api(port, config=self.config)
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to start API: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Start the Connpy REST API.</p></div>
|
||
</dd>
|
||
<dt id="connpy.services.SystemService.stop_api"><code class="name flex">
|
||
<span>def <span class="ident">stop_api</span></span>(<span>self)</span>
|
||
</code></dt>
|
||
<dd>
|
||
<details class="source">
|
||
<summary>
|
||
<span>Expand source code</span>
|
||
</summary>
|
||
<pre><code class="python">def stop_api(self):
|
||
"""Stop the Connpy REST API."""
|
||
try:
|
||
import os
|
||
import signal
|
||
|
||
pids = ["/run/connpy.pid", "/tmp/connpy.pid"]
|
||
stopped = False
|
||
for pid_file in pids:
|
||
if os.path.exists(pid_file):
|
||
try:
|
||
with open(pid_file, "r") as f:
|
||
# Read only the first line (PID)
|
||
line = f.readline().strip()
|
||
if not line:
|
||
continue
|
||
pid = int(line)
|
||
os.kill(pid, signal.SIGTERM)
|
||
# Remove the PID file after successful kill
|
||
os.remove(pid_file)
|
||
stopped = True
|
||
except (ValueError, OSError, ProcessLookupError):
|
||
# If process is already dead, just remove the stale PID file
|
||
try:
|
||
os.remove(pid_file)
|
||
except OSError:
|
||
pass
|
||
continue
|
||
return stopped
|
||
except Exception as e:
|
||
raise ConnpyError(f"Failed to stop API: {e}")</code></pre>
|
||
</details>
|
||
<div class="desc"><p>Stop the Connpy REST API.</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" href="../index.html">connpy</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
|
||
<ul>
|
||
<li><code><a title="connpy.services.ai_service" href="ai_service.html">connpy.services.ai_service</a></code></li>
|
||
<li><code><a title="connpy.services.base" href="base.html">connpy.services.base</a></code></li>
|
||
<li><code><a title="connpy.services.config_service" href="config_service.html">connpy.services.config_service</a></code></li>
|
||
<li><code><a title="connpy.services.context_service" href="context_service.html">connpy.services.context_service</a></code></li>
|
||
<li><code><a title="connpy.services.exceptions" href="exceptions.html">connpy.services.exceptions</a></code></li>
|
||
<li><code><a title="connpy.services.execution_service" href="execution_service.html">connpy.services.execution_service</a></code></li>
|
||
<li><code><a title="connpy.services.import_export_service" href="import_export_service.html">connpy.services.import_export_service</a></code></li>
|
||
<li><code><a title="connpy.services.node_service" href="node_service.html">connpy.services.node_service</a></code></li>
|
||
<li><code><a title="connpy.services.plugin_service" href="plugin_service.html">connpy.services.plugin_service</a></code></li>
|
||
<li><code><a title="connpy.services.profile_service" href="profile_service.html">connpy.services.profile_service</a></code></li>
|
||
<li><code><a title="connpy.services.provider" href="provider.html">connpy.services.provider</a></code></li>
|
||
<li><code><a title="connpy.services.sync_service" href="sync_service.html">connpy.services.sync_service</a></code></li>
|
||
<li><code><a title="connpy.services.system_service" href="system_service.html">connpy.services.system_service</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li><h3><a href="#header-classes">Classes</a></h3>
|
||
<ul>
|
||
<li>
|
||
<h4><code><a title="connpy.services.AIService" href="#connpy.services.AIService">AIService</a></code></h4>
|
||
<ul class="two-column">
|
||
<li><code><a title="connpy.services.AIService.ask" href="#connpy.services.AIService.ask">ask</a></code></li>
|
||
<li><code><a title="connpy.services.AIService.configure_provider" href="#connpy.services.AIService.configure_provider">configure_provider</a></code></li>
|
||
<li><code><a title="connpy.services.AIService.confirm" href="#connpy.services.AIService.confirm">confirm</a></code></li>
|
||
<li><code><a title="connpy.services.AIService.delete_session" href="#connpy.services.AIService.delete_session">delete_session</a></code></li>
|
||
<li><code><a title="connpy.services.AIService.list_sessions" href="#connpy.services.AIService.list_sessions">list_sessions</a></code></li>
|
||
<li><code><a title="connpy.services.AIService.load_session_data" href="#connpy.services.AIService.load_session_data">load_session_data</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ConfigService" href="#connpy.services.ConfigService">ConfigService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.ConfigService.apply_theme_from_file" href="#connpy.services.ConfigService.apply_theme_from_file">apply_theme_from_file</a></code></li>
|
||
<li><code><a title="connpy.services.ConfigService.encrypt_password" href="#connpy.services.ConfigService.encrypt_password">encrypt_password</a></code></li>
|
||
<li><code><a title="connpy.services.ConfigService.get_default_dir" href="#connpy.services.ConfigService.get_default_dir">get_default_dir</a></code></li>
|
||
<li><code><a title="connpy.services.ConfigService.get_settings" href="#connpy.services.ConfigService.get_settings">get_settings</a></code></li>
|
||
<li><code><a title="connpy.services.ConfigService.set_config_folder" href="#connpy.services.ConfigService.set_config_folder">set_config_folder</a></code></li>
|
||
<li><code><a title="connpy.services.ConfigService.update_setting" href="#connpy.services.ConfigService.update_setting">update_setting</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ConnpyError" href="#connpy.services.ConnpyError">ConnpyError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ExecutionError" href="#connpy.services.ExecutionError">ExecutionError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ExecutionService" href="#connpy.services.ExecutionService">ExecutionService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.ExecutionService.run_cli_script" href="#connpy.services.ExecutionService.run_cli_script">run_cli_script</a></code></li>
|
||
<li><code><a title="connpy.services.ExecutionService.run_commands" href="#connpy.services.ExecutionService.run_commands">run_commands</a></code></li>
|
||
<li><code><a title="connpy.services.ExecutionService.run_yaml_playbook" href="#connpy.services.ExecutionService.run_yaml_playbook">run_yaml_playbook</a></code></li>
|
||
<li><code><a title="connpy.services.ExecutionService.test_commands" href="#connpy.services.ExecutionService.test_commands">test_commands</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ImportExportService" href="#connpy.services.ImportExportService">ImportExportService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.ImportExportService.export_to_dict" href="#connpy.services.ImportExportService.export_to_dict">export_to_dict</a></code></li>
|
||
<li><code><a title="connpy.services.ImportExportService.export_to_file" href="#connpy.services.ImportExportService.export_to_file">export_to_file</a></code></li>
|
||
<li><code><a title="connpy.services.ImportExportService.import_from_dict" href="#connpy.services.ImportExportService.import_from_dict">import_from_dict</a></code></li>
|
||
<li><code><a title="connpy.services.ImportExportService.import_from_file" href="#connpy.services.ImportExportService.import_from_file">import_from_file</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.InvalidConfigurationError" href="#connpy.services.InvalidConfigurationError">InvalidConfigurationError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.NodeAlreadyExistsError" href="#connpy.services.NodeAlreadyExistsError">NodeAlreadyExistsError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.NodeNotFoundError" href="#connpy.services.NodeNotFoundError">NodeNotFoundError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.NodeService" href="#connpy.services.NodeService">NodeService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.NodeService.add_node" href="#connpy.services.NodeService.add_node">add_node</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.bulk_add" href="#connpy.services.NodeService.bulk_add">bulk_add</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.connect_node" href="#connpy.services.NodeService.connect_node">connect_node</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.delete_node" href="#connpy.services.NodeService.delete_node">delete_node</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.explode_unique" href="#connpy.services.NodeService.explode_unique">explode_unique</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.full_replace" href="#connpy.services.NodeService.full_replace">full_replace</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.generate_cache" href="#connpy.services.NodeService.generate_cache">generate_cache</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.get_inventory" href="#connpy.services.NodeService.get_inventory">get_inventory</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.get_node_details" href="#connpy.services.NodeService.get_node_details">get_node_details</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.list_folders" href="#connpy.services.NodeService.list_folders">list_folders</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.list_nodes" href="#connpy.services.NodeService.list_nodes">list_nodes</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.move_node" href="#connpy.services.NodeService.move_node">move_node</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.update_node" href="#connpy.services.NodeService.update_node">update_node</a></code></li>
|
||
<li><code><a title="connpy.services.NodeService.validate_parent_folder" href="#connpy.services.NodeService.validate_parent_folder">validate_parent_folder</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.PluginService" href="#connpy.services.PluginService">PluginService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.PluginService.add_plugin" href="#connpy.services.PluginService.add_plugin">add_plugin</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.add_plugin_from_bytes" href="#connpy.services.PluginService.add_plugin_from_bytes">add_plugin_from_bytes</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.delete_plugin" href="#connpy.services.PluginService.delete_plugin">delete_plugin</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.disable_plugin" href="#connpy.services.PluginService.disable_plugin">disable_plugin</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.enable_plugin" href="#connpy.services.PluginService.enable_plugin">enable_plugin</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.get_plugin_source" href="#connpy.services.PluginService.get_plugin_source">get_plugin_source</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.invoke_plugin" href="#connpy.services.PluginService.invoke_plugin">invoke_plugin</a></code></li>
|
||
<li><code><a title="connpy.services.PluginService.list_plugins" href="#connpy.services.PluginService.list_plugins">list_plugins</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ProfileAlreadyExistsError" href="#connpy.services.ProfileAlreadyExistsError">ProfileAlreadyExistsError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ProfileNotFoundError" href="#connpy.services.ProfileNotFoundError">ProfileNotFoundError</a></code></h4>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.ProfileService" href="#connpy.services.ProfileService">ProfileService</a></code></h4>
|
||
<ul class="two-column">
|
||
<li><code><a title="connpy.services.ProfileService.add_profile" href="#connpy.services.ProfileService.add_profile">add_profile</a></code></li>
|
||
<li><code><a title="connpy.services.ProfileService.delete_profile" href="#connpy.services.ProfileService.delete_profile">delete_profile</a></code></li>
|
||
<li><code><a title="connpy.services.ProfileService.get_profile" href="#connpy.services.ProfileService.get_profile">get_profile</a></code></li>
|
||
<li><code><a title="connpy.services.ProfileService.list_profiles" href="#connpy.services.ProfileService.list_profiles">list_profiles</a></code></li>
|
||
<li><code><a title="connpy.services.ProfileService.resolve_node_data" href="#connpy.services.ProfileService.resolve_node_data">resolve_node_data</a></code></li>
|
||
<li><code><a title="connpy.services.ProfileService.update_profile" href="#connpy.services.ProfileService.update_profile">update_profile</a></code></li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<h4><code><a title="connpy.services.SystemService" href="#connpy.services.SystemService">SystemService</a></code></h4>
|
||
<ul class="">
|
||
<li><code><a title="connpy.services.SystemService.debug_api" href="#connpy.services.SystemService.debug_api">debug_api</a></code></li>
|
||
<li><code><a title="connpy.services.SystemService.get_api_status" href="#connpy.services.SystemService.get_api_status">get_api_status</a></code></li>
|
||
<li><code><a title="connpy.services.SystemService.restart_api" href="#connpy.services.SystemService.restart_api">restart_api</a></code></li>
|
||
<li><code><a title="connpy.services.SystemService.start_api" href="#connpy.services.SystemService.start_api">start_api</a></code></li>
|
||
<li><code><a title="connpy.services.SystemService.stop_api" href="#connpy.services.SystemService.stop_api">stop_api</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.6</a>.</p>
|
||
</footer>
|
||
</body>
|
||
</html>
|