diff --git a/docs/connpy/auth_utils.html b/docs/connpy/auth_utils.html index dfb90a5..3e4787f 100644 --- a/docs/connpy/auth_utils.html +++ b/docs/connpy/auth_utils.html @@ -86,6 +86,78 @@ el.replaceWith(d);
Clear local variables on all frames in an exception's traceback chain.
+def compile_active_context_patterns(cfg_dict: Any, *, strict: bool = False) ‑> list[re.Pattern[str]]
+def compile_active_context_patterns(
+ cfg_dict: Any,
+ *,
+ strict: bool = False,
+) -> list[re.Pattern[str]]:
+ """Compile active context regexes purely respecting cfg_dict['case']."""
+ patterns, _ = compile_active_context_patterns_with_status(cfg_dict, strict=strict)
+ return patterns
+Compile active context regexes purely respecting cfg_dict['case'].
+def compile_active_context_patterns_with_status(cfg_dict: Any, *, strict: bool = False) ‑> tuple[list[re.Pattern[str]], bool]
+def compile_active_context_patterns_with_status(
+ cfg_dict: Any,
+ *,
+ strict: bool = False,
+) -> tuple[list[re.Pattern[str]], bool]:
+ """Compile active context regexes purely, returning (patterns, had_error)."""
+ if is_default_all_context_cfg(cfg_dict):
+ return ([re.compile(".*")], False)
+
+ current_ctx = cfg_dict.get("current_context", "all")
+ contexts = cfg_dict.get("contexts", {"all": [".*"]})
+ raw_patterns = contexts.get(current_ctx, [".*"]) if isinstance(contexts, dict) else [".*"]
+ flags = 0 if cfg_dict.get("case", False) else re.IGNORECASE
+
+ if not isinstance(raw_patterns, list):
+ if strict:
+ raise ValueError("Context regexes must be a list")
+ return ([], True)
+
+ had_error = False
+ if len(raw_patterns) > MAX_CONTEXT_REGEXES:
+ if strict:
+ raise ValueError(f"Context exceeds maximum of {MAX_CONTEXT_REGEXES} regexes")
+ had_error = True
+ raw_patterns = raw_patterns[:MAX_CONTEXT_REGEXES]
+
+ patterns: list[re.Pattern[str]] = []
+ for pat in raw_patterns:
+ if not isinstance(pat, str) or not pat or len(pat) > MAX_CONTEXT_PATTERN_LEN:
+ if strict:
+ raise ValueError(
+ f"Context pattern must be a non-empty string up to {MAX_CONTEXT_PATTERN_LEN} chars"
+ )
+ had_error = True
+ continue
+ try:
+ patterns.append(re.compile(pat, flags))
+ except re.error as exc:
+ if strict:
+ raise ValueError(f"Invalid context regex {pat!r}: {exc}") from None
+ had_error = True
+ return (patterns, had_error)
+Compile active context regexes purely, returning (patterns, had_error).
def extract_compose_profile_refs(expr: str) ‑> set[str]
Return True if value is a string with the explicit compose: prefix.
+def is_default_all_context_cfg(cfg_dict: Any) ‑> bool
+def is_default_all_context_cfg(cfg_dict: Any) -> bool:
+ """Return True when config uses the default unrestricted 'all' context."""
+ if not isinstance(cfg_dict, dict):
+ return True
+ current_ctx = cfg_dict.get("current_context", "all")
+ if current_ctx != "all":
+ return False
+ contexts = cfg_dict.get("contexts", {"all": [".*"]})
+ if not isinstance(contexts, dict):
+ return True
+ return contexts.get("all", [".*"]) == [".*"]
+Return True when config uses the default unrestricted 'all' context.
def is_rsa_blob(value: Any) ‑> bool
Recursively mask sensitive node/profile credentials with '***' using a closed key list.
+def match_active_context_patterns(name: Any, patterns: Iterable[re.Pattern[str]]) ‑> bool
+def match_active_context_patterns(name: Any, patterns: Iterable[re.Pattern[str]]) -> bool:
+ """Return True if non-empty string name matches at least one compiled context regex."""
+ if not isinstance(name, str) or not name:
+ return False
+ return any(p.match(name) for p in patterns)
+Return True if non-empty string name matches at least one compiled context regex.
def normalize_prompt_line(before_bytes: bytes, after_bytes: bytes) ‑> str
clear_exception_framescompile_active_context_patternscompile_active_context_patterns_with_statusextract_compose_profile_refsextract_profile_refs_from_valuehas_insecure_hostkey_checkinghost_exact_reis_compose_expressionis_default_all_context_cfgis_rsa_blobmask_node_secretsmatch_active_context_patternsnormalize_prompt_lineparse_compose_expressionraise_sanitized_auth_errordef bulk_folder_validation(self, answers, current):
- if not self.app.case:
+ case = getattr(self.app, "case", False)
+ if not case:
current = current.lower()
-
- candidate = current
- if "/" in current:
- candidate = current.split("/")[0]
-
+
+ candidate = current.split("/")[0] if "/" in current else current
+
+ if hasattr(self.app, "services") and hasattr(self.app.services, "context"):
+ raw_folders = list(getattr(self.app, "folders", []) or [])
+ if hasattr(self.app.services, "nodes"):
+ raw_fn = getattr(self.app.services.nodes, "_get_raw_folders", None)
+ if callable(raw_fn) and not hasattr(raw_fn, "assert_called"):
+ raw_res = raw_fn()
+ if isinstance(raw_res, (list, tuple, set)):
+ raw_folders = list(raw_res)
+
+ def _folder_exists_norm(folder_name: str) -> bool:
+ if case:
+ return folder_name in raw_folders
+ return folder_name.lower() in {f.lower() for f in raw_folders}
+
+ if current != "" and not _folder_exists_norm(candidate):
+ _raise_val_err(f"Location {current} don't exist")
+
+ ctx_svc = self.app.services.context
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ raw_ids = answers.get("ids", "") if isinstance(answers, dict) else ""
+ for nid in str(raw_ids).split(","):
+ nid_stripped = nid.strip()
+ if not nid_stripped:
+ continue
+ nid_norm = nid_stripped if case else nid_stripped.lower()
+ full_id = f"{nid_norm}{candidate}" if candidate else nid_norm
+ if not ctx_svc.matches_active_context(full_id):
+ _raise_val_err(
+ f"Node '{full_id}' does not match active context '{ctx_svc.current_context}'."
+ )
+ parent = full_id.partition("@")[2]
+ if parent and not _folder_exists_norm(f"@{parent}"):
+ _raise_val_err(f"Location @{parent} don't exist")
+ return True
+
matches = list(filter(lambda k: k == candidate, self.app.folders))
if current != "" and len(matches) == 0:
_raise_val_err("Location {} don't exist".format(current))
@@ -334,9 +426,19 @@ el.replaceWith(d);
return True
if len(stripped.encode("utf-8", errors="replace")) > MAX_JSON_INPUT_BYTES:
_raise_val_err(f"Fallback exceeds maximum size of {MAX_JSON_INPUT_BYTES} bytes")
- if stripped.startswith("@") and "+" not in stripped:
- if stripped[1:] not in self.app.profiles:
- _raise_val_err(f"Profile {stripped} don't exist")
+ if stripped.startswith("@") and not stripped.startswith("@@") and "+" not in stripped:
+ parts = [p.strip() for p in stripped.split(",")]
+ if any(not p for p in parts):
+ _raise_val_err("Fallback profile entry cannot be empty")
+ if len(parts) > MAX_FALLBACK_ENTRIES:
+ _raise_val_err(f"Fallback exceeds maximum of {MAX_FALLBACK_ENTRIES} entries")
+ for p in parts:
+ if not p.startswith("@") or not re.fullmatch(r"[A-Za-z0-9_.$:/-]+", p[1:]):
+ _raise_val_err(
+ "Comma-separated fallback entries must be valid @profile references"
+ )
+ if p[1:] not in self.app.profiles:
+ _raise_val_err(f"Profile {p} don't exist")
return True
try:
if is_compose_expression(stripped):
@@ -384,10 +486,9 @@ el.replaceWith(d);
def jumphost_validation(self, answers, current):
if current.startswith("@"):
if current[1:] not in self.app.profiles:
- _raise_val_err("Profile {} don't exist".format(current))
- elif current != "":
- if current not in self.app.nodes_list:
- _raise_val_err("Node {} don't exist.".format(current))
+ _raise_val_err(f"Profile {current} don't exist")
+ elif current != "" and not self._node_exists(current):
+ _raise_val_err(f"Node {current} don't exist.")
return True
@@ -448,9 +549,8 @@ el.replaceWith(d);
Expand source code
def profile_jumphost_validation(self, answers, current):
- if current != "":
- if current not in self.app.nodes_list:
- _raise_val_err("Node {} don't exist.".format(current))
+ if current != "" and not self._node_exists(current):
+ _raise_val_err(f"Node {current} don't exist.")
return True
diff --git a/docs/connpy/grpc_layer/server.html b/docs/connpy/grpc_layer/server.html
index 089efed..4e581cd 100644
--- a/docs/connpy/grpc_layer/server.html
+++ b/docs/connpy/grpc_layer/server.html
@@ -110,7 +110,7 @@ el.replaceWith(d);
from connpy.grpc_layer.user_registry import UserRegistry
from connpy.services.provider import ServiceProvider
- fallback_provider = ServiceProvider(config, mode="local")
+ fallback_provider = ServiceProvider(config, mode="local", enforce_context=False)
registry = UserRegistry(config.defaultdir)
# Check if trusted_gateway provider is configured if SSO Gateway Secret is present in env
@@ -163,9 +163,7 @@ el.replaceWith(d);
class AIServicer(connpy_pb2_grpc.AIServiceServicer):
def __init__(self, provider, registry=None, debug=False):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
self.server_debug = debug
@@ -927,9 +925,7 @@ interceptor chooses to service this RPC, or None otherwise.
class ConfigServicer(connpy_pb2_grpc.ConfigServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
@@ -1015,9 +1011,7 @@ def service(self):
class ExecutionServicer(connpy_pb2_grpc.ExecutionServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
@@ -1186,9 +1180,7 @@ def service(self):
class ImportExportServicer(connpy_pb2_grpc.ImportExportServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
@@ -1374,9 +1366,7 @@ interceptor chooses to service this RPC, or None otherwise.
class NodeServicer(connpy_pb2_grpc.NodeServiceServicer):
def __init__(self, provider, registry=None, debug=False):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
self.server_debug = debug
@@ -2041,9 +2031,7 @@ def service(self):
class PluginServicer(connpy_pb2_grpc.PluginServiceServicer, remote_plugin_pb2_grpc.RemotePluginServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
@@ -2148,9 +2136,7 @@ def service(self):
class ProfileServicer(connpy_pb2_grpc.ProfileServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
@@ -2451,9 +2437,7 @@ def service(self):
class SystemServicer(connpy_pb2_grpc.SystemServiceServicer):
def __init__(self, provider, registry=None):
- if not hasattr(provider, "mode"):
- from connpy.services.provider import ServiceProvider
- provider = ServiceProvider(provider, mode="local")
+ provider = _ensure_server_provider(provider)
self._fallback_provider = provider
self._registry = registry
diff --git a/docs/connpy/grpc_layer/stubs.html b/docs/connpy/grpc_layer/stubs.html
index 82f62f7..27b0b13 100644
--- a/docs/connpy/grpc_layer/stubs.html
+++ b/docs/connpy/grpc_layer/stubs.html
@@ -42,8 +42,2993 @@ el.replaceWith(d);
+Functions
+
+
+def handle_errors(func)
+
+-
+
+
+Expand source code
+
+def handle_errors(func):
+ @wraps(func)
+ def wrapper(*args, **kwargs):
+ try:
+ return func(*args, **kwargs)
+ except grpc.RpcError as e:
+ # Re-raise gRPC errors as native ConnpyError to keep CLI handlers agnostic
+ details = e.details()
+
+ # Identify the host if available on the instance
+ instance = args[0] if args else None
+ host = getattr(instance, "remote_host", "remote host")
+
+ # Make common gRPC errors more readable
+ if "failed to connect to all addresses" in details:
+ simplified = f"Failed to connect to remote host at {host} (Connection refused)"
+ elif "Method not found" in details:
+ simplified = f"Remote server at {host} is using an incompatible version"
+ elif "Deadline Exceeded" in details:
+ simplified = f"Request to {host} timed out"
+ else:
+ simplified = details
+
+ raise ConnpyError(simplified)
+ return wrapper
+
+
+
+
+Classes
+
+
+class AIStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class AIStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.AIServiceStub(channel)
+ self.remote_host = remote_host
+
+ def _ai_chat_stream(self, stub_method, input_text, dryrun=False, chat_history=None, session_id=None, debug=False, status=None, chunk_callback=None, **overrides):
+ import queue
+ from rich.prompt import Prompt
+ from rich.text import Text
+ from rich.panel import Panel
+ from rich.markdown import Markdown
+
+ req_queue = queue.Queue()
+
+ initial_req = connpy_pb2.AskRequest(
+ input_text=input_text,
+ dryrun=dryrun,
+ session_id=session_id or "",
+ debug=debug,
+ engineer_model=overrides.get("engineer_model", ""),
+ engineer_api_key=overrides.get("engineer_api_key", ""),
+ architect_model=overrides.get("architect_model", ""),
+ architect_api_key=overrides.get("architect_api_key", ""),
+ trust=overrides.get("trust", False)
+ )
+ if chat_history is not None:
+ initial_req.chat_history.CopyFrom(to_value(chat_history))
+ if "engineer_auth" in overrides and overrides["engineer_auth"]:
+ initial_req.engineer_auth.CopyFrom(to_struct(overrides["engineer_auth"]))
+ if "architect_auth" in overrides and overrides["architect_auth"]:
+ initial_req.architect_auth.CopyFrom(to_struct(overrides["architect_auth"]))
+
+ req_queue.put(initial_req)
+
+ def request_generator():
+ while True:
+ req = req_queue.get()
+ if req is None: break
+ yield req
+
+ responses = stub_method(request_generator())
+
+ full_content = ""
+ header_printed = False
+ current_responder = "engineer"
+ final_result = {"response": "", "chat_history": []}
+
+ # Background thread to pull responses from gRPC into a local queue
+ # This prevents KeyboardInterrupt from corrupting the gRPC iterator state
+ response_queue = queue.Queue()
+
+ def pull_responses():
+ try:
+ for response in responses:
+ response_queue.put(("data", response))
+ except Exception as e:
+ response_queue.put(("error", e))
+ finally:
+ response_queue.put((None, None))
+
+ threading.Thread(target=pull_responses, daemon=True).start()
+
+ try:
+ while True:
+ try:
+ # BLOCKING GET from local queue (interruptible by signal)
+ msg_type, response = response_queue.get()
+ except KeyboardInterrupt:
+ # Signal interruption to the server
+ if status:
+ status.update("[error]Interrupted! Closing pending tasks...")
+
+ # Send the interrupt signal to the server
+ req_queue.put(connpy_pb2.AskRequest(interrupt=True))
+
+ # CONTINUE the loop to receive remaining data and summary from the queue
+ continue
+
+ if msg_type is None: # Sentinel
+ break
+
+ if msg_type == "error":
+ # Re-raise or handle gRPC error from background thread
+ if isinstance(response, grpc.RpcError):
+ raise response
+ printer.warning(f"Stream interrupted: {response}")
+ break
+
+ if response.status_update:
+ if response.status_update.startswith("__RESPONDER__:"):
+ current_responder = response.status_update.split(":")[1].lower()
+ continue
+
+ if response.requires_confirmation:
+ if status: status.stop()
+
+ # Show prompt and wait for answer
+ prompt_text = Text.from_ansi(response.status_update)
+ ans = Prompt.ask(prompt_text)
+
+ if status:
+ status.update("[ai_status]Agent: Resuming...")
+ status.start()
+
+ req_queue.put(connpy_pb2.AskRequest(confirmation_answer=ans))
+ continue
+
+ if status:
+ status.update(response.status_update)
+ continue
+
+ if response.debug_message:
+ if debug:
+ if status:
+ try: status.stop()
+ except: pass
+ printer.console.print(Text.from_ansi(response.debug_message))
+ if status:
+ try: status.start()
+ except: pass
+ continue
+
+ if response.important_message:
+ if status:
+ try: status.stop()
+ except: pass
+ printer.console.print(Text.from_ansi(response.important_message))
+ if status:
+ try: status.start()
+ except: pass
+ continue
+
+ if not response.is_final:
+ if response.text_chunk:
+ if not header_printed:
+ if status:
+ try: status.stop()
+ except: pass
+
+ if chunk_callback:
+ header_printed = True
+ else:
+ from rich.console import Console as RichConsole
+ from rich.rule import Rule
+ from ..printer import connpy_theme, get_original_stdout, IncrementalMarkdownParser
+ stable_console = RichConsole(theme=connpy_theme, file=get_original_stdout())
+
+ # Print header on first chunk
+ alias = "architect" if current_responder == "architect" else "engineer"
+ role_label = "Network Architect" if current_responder == "architect" else "Network Engineer"
+ stable_console.print(Rule(f"[bold {alias}]{role_label}[/bold {alias}]", style=alias))
+ header_printed = True
+
+ # Initialize parser
+ md_parser = IncrementalMarkdownParser(console=stable_console)
+
+ full_content += response.text_chunk
+ if chunk_callback:
+ chunk_callback(response.text_chunk)
+ elif md_parser:
+ md_parser.feed(response.text_chunk)
+ continue
+
+ if response.is_final:
+ if not chunk_callback and header_printed:
+ from rich.rule import Rule
+ md_parser.flush()
+
+ if status:
+ try: status.stop()
+ except: pass
+
+ final_result = from_struct(response.full_result)
+
+ if not chunk_callback and header_printed:
+ from rich.console import Console as RichConsole
+ from ..printer import connpy_theme, get_original_stdout
+ stable_console = RichConsole(theme=connpy_theme, file=get_original_stdout())
+ stable_console.print(Rule(style=alias))
+ break
+ except Exception as e:
+ # Check if it was a gRPC error that we should let handle_errors catch
+ if isinstance(e, grpc.RpcError):
+ raise
+ printer.warning(f"Stream interrupted: {e}")
+ finally:
+ req_queue.put(None)
+
+ if full_content:
+ final_result["streamed"] = True
+
+ return final_result
+
+ @handle_errors
+ def ask(self, input_text, dryrun=False, chat_history=None, session_id=None, debug=False, status=None, **overrides):
+ return self._ai_chat_stream(self.stub.ask, input_text, dryrun=dryrun, chat_history=chat_history, session_id=session_id, debug=debug, status=status, **overrides)
+
+ @handle_errors
+ def build_playbook_chat(self, user_input, chat_history=None, status=None, chunk_callback=None):
+ return self._ai_chat_stream(self.stub.build_playbook_chat, user_input, chat_history=chat_history, status=status, chunk_callback=chunk_callback)
+
+ def _process_unary_stream(self, responses, status=None, chunk_callback=None):
+ full_content = ""
+ header_printed = False
+ final_result = {"response": "", "chat_history": []}
+ md_parser = None
+
+ try:
+ for response in responses:
+ if response.status_update:
+ if status:
+ status.update(response.status_update)
+ continue
+
+ if response.important_message:
+ if status:
+ try: status.stop()
+ except: pass
+ printer.console.print(Text.from_ansi(response.important_message))
+ if status:
+ try: status.start()
+ except: pass
+ continue
+
+ if not response.is_final:
+ if response.text_chunk:
+ if not header_printed:
+ if status:
+ try: status.stop()
+ except: pass
+
+ if chunk_callback:
+ header_printed = True
+ else:
+ from rich.console import Console as RichConsole
+ from rich.rule import Rule
+ from ..printer import connpy_theme, get_original_stdout, IncrementalMarkdownParser
+ stable_console = RichConsole(theme=connpy_theme, file=get_original_stdout())
+
+ # Print default header
+ stable_console.print(Rule("[bold engineer]AI Analysis[/bold engineer]", style="engineer"))
+ header_printed = True
+ md_parser = IncrementalMarkdownParser(console=stable_console)
+
+ full_content += response.text_chunk
+ if chunk_callback:
+ chunk_callback(response.text_chunk)
+ elif md_parser:
+ md_parser.feed(response.text_chunk)
+ continue
+
+ if response.is_final:
+ if md_parser:
+ md_parser.flush()
+
+ if status:
+ try: status.stop()
+ except: pass
+
+ final_result = from_struct(response.full_result)
+
+ if md_parser:
+ from rich.console import Console as RichConsole
+ from rich.rule import Rule
+ from ..printer import connpy_theme, get_original_stdout
+ stable_console = RichConsole(theme=connpy_theme, file=get_original_stdout())
+ stable_console.print(Rule(style="engineer"))
+ break
+ except Exception as e:
+ if isinstance(e, grpc.RpcError):
+ raise
+ printer.warning(f"Stream interrupted: {e}")
+
+ if full_content:
+ final_result["streamed"] = True
+
+ return final_result
+
+ @handle_errors
+ def analyze_execution_results(self, results, query=None, status=None, chunk_callback=None):
+ req = connpy_pb2.AnalyzeRequest(query=query or "")
+ req.results.CopyFrom(to_struct(results))
+ responses = self.stub.analyze_execution_results(req)
+ return self._process_unary_stream(responses, status, chunk_callback)
+
+ @handle_errors
+ def predict_execution_results(self, target_nodes, commands, status=None, chunk_callback=None):
+ req = connpy_pb2.PreflightRequest(target_nodes=target_nodes, commands=commands)
+ responses = self.stub.predict_execution_results(req)
+ return self._process_unary_stream(responses, status, chunk_callback)
+
+ @handle_errors
+ def confirm(self, input_text, console=None):
+ return self.stub.confirm(connpy_pb2.StringRequest(value=input_text)).value
+
+ @handle_errors
+ def list_sessions(self, limit=None):
+ from .utils import from_value
+ res = self.stub.list_sessions(Empty())
+ sessions = from_value(res.data) or []
+ if limit and len(sessions) > limit:
+ return sessions[:limit], len(sessions)
+ return sessions, len(sessions)
+
+ @handle_errors
+ def delete_session(self, session_id):
+ self.stub.delete_session(connpy_pb2.StringRequest(value=session_id))
+
+ @handle_errors
+ def configure_provider(self, provider, model=None, api_key=None, auth=None):
+ req = connpy_pb2.ProviderRequest(provider=provider, model=model or "", api_key=api_key or "")
+ if auth:
+ req.auth.CopyFrom(to_struct(auth))
+ self.stub.configure_provider(req)
+
+ @handle_errors
+ def configure_mcp(self, name, url=None, enabled=True, auto_load_on_os=None, remove=False):
+ req = connpy_pb2.MCPRequest(
+ name=name,
+ url=url or "",
+ enabled=enabled,
+ auto_load_on_os=auto_load_on_os or "",
+ remove=remove
+ )
+ self.stub.configure_mcp(req)
+
+ @handle_errors
+ def list_mcp_servers(self):
+ res = self.stub.list_mcp_servers(Empty())
+ return from_value(res.data) or {}
+
+ @handle_errors
+ def load_session_data(self, session_id):
+ return from_struct(self.stub.load_session_data(connpy_pb2.StringRequest(value=session_id)).data)
+
+
+Methods
+
+
+def analyze_execution_results(self, results, query=None, status=None, chunk_callback=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def analyze_execution_results(self, results, query=None, status=None, chunk_callback=None):
+ req = connpy_pb2.AnalyzeRequest(query=query or "")
+ req.results.CopyFrom(to_struct(results))
+ responses = self.stub.analyze_execution_results(req)
+ return self._process_unary_stream(responses, status, chunk_callback)
+
+
+
+
+def ask(self,
input_text,
dryrun=False,
chat_history=None,
session_id=None,
debug=False,
status=None,
**overrides)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def ask(self, input_text, dryrun=False, chat_history=None, session_id=None, debug=False, status=None, **overrides):
+ return self._ai_chat_stream(self.stub.ask, input_text, dryrun=dryrun, chat_history=chat_history, session_id=session_id, debug=debug, status=status, **overrides)
+
+
+
+
+def build_playbook_chat(self, user_input, chat_history=None, status=None, chunk_callback=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def build_playbook_chat(self, user_input, chat_history=None, status=None, chunk_callback=None):
+ return self._ai_chat_stream(self.stub.build_playbook_chat, user_input, chat_history=chat_history, status=status, chunk_callback=chunk_callback)
+
+
+
+
+def configure_mcp(self, name, url=None, enabled=True, auto_load_on_os=None, remove=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def configure_mcp(self, name, url=None, enabled=True, auto_load_on_os=None, remove=False):
+ req = connpy_pb2.MCPRequest(
+ name=name,
+ url=url or "",
+ enabled=enabled,
+ auto_load_on_os=auto_load_on_os or "",
+ remove=remove
+ )
+ self.stub.configure_mcp(req)
+
+
+
+
+def configure_provider(self, provider, model=None, api_key=None, auth=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def configure_provider(self, provider, model=None, api_key=None, auth=None):
+ req = connpy_pb2.ProviderRequest(provider=provider, model=model or "", api_key=api_key or "")
+ if auth:
+ req.auth.CopyFrom(to_struct(auth))
+ self.stub.configure_provider(req)
+
+
+
+
+def confirm(self, input_text, console=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def confirm(self, input_text, console=None):
+ return self.stub.confirm(connpy_pb2.StringRequest(value=input_text)).value
+
+
+
+
+def delete_session(self, session_id)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def delete_session(self, session_id):
+ self.stub.delete_session(connpy_pb2.StringRequest(value=session_id))
+
+
+
+
+def list_mcp_servers(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def list_mcp_servers(self):
+ res = self.stub.list_mcp_servers(Empty())
+ return from_value(res.data) or {}
+
+
+
+
+def list_sessions(self, limit=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def list_sessions(self, limit=None):
+ from .utils import from_value
+ res = self.stub.list_sessions(Empty())
+ sessions = from_value(res.data) or []
+ if limit and len(sessions) > limit:
+ return sessions[:limit], len(sessions)
+ return sessions, len(sessions)
+
+
+
+
+def load_session_data(self, session_id)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def load_session_data(self, session_id):
+ return from_struct(self.stub.load_session_data(connpy_pb2.StringRequest(value=session_id)).data)
+
+
+
+
+def predict_execution_results(self, target_nodes, commands, status=None, chunk_callback=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def predict_execution_results(self, target_nodes, commands, status=None, chunk_callback=None):
+ req = connpy_pb2.PreflightRequest(target_nodes=target_nodes, commands=commands)
+ responses = self.stub.predict_execution_results(req)
+ return self._process_unary_stream(responses, status, chunk_callback)
+
+
+
+
+
+
+class AuthClientInterceptor
+(token_provider)
+
+-
+
+
+Expand source code
+
+class AuthClientInterceptor(grpc.UnaryUnaryClientInterceptor,
+ grpc.UnaryStreamClientInterceptor,
+ grpc.StreamUnaryClientInterceptor,
+ grpc.StreamStreamClientInterceptor):
+ def __init__(self, token_provider):
+ self.token_provider = token_provider
+
+ def _add_metadata(self, client_call_details):
+ token = self.token_provider()
+ if not token:
+ return client_call_details
+
+ metadata = []
+ if client_call_details.metadata:
+ metadata = list(client_call_details.metadata)
+
+ # Check if already present to avoid duplicates
+ if not any(k.lower() == "authorization" for k, v in metadata):
+ metadata.append(("authorization", f"Bearer {token}"))
+
+ return _ClientCallDetails(
+ method=client_call_details.method,
+ timeout=client_call_details.timeout,
+ metadata=metadata,
+ credentials=client_call_details.credentials,
+ wait_for_ready=client_call_details.wait_for_ready,
+ compression=client_call_details.compression,
+ )
+
+ def intercept_unary_unary(self, continuation, client_call_details, request):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request)
+
+ def intercept_unary_stream(self, continuation, client_call_details, request):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request)
+
+ def intercept_stream_unary(self, continuation, client_call_details, request_iterator):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request_iterator)
+
+ def intercept_stream_stream(self, continuation, client_call_details, request_iterator):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request_iterator)
+
+Affords intercepting unary-unary invocations.
+Ancestors
+
+- grpc.UnaryUnaryClientInterceptor
+- grpc.UnaryStreamClientInterceptor
+- grpc.StreamUnaryClientInterceptor
+- grpc.StreamStreamClientInterceptor
+- abc.ABC
+
+Methods
+
+
+def intercept_stream_stream(self, continuation, client_call_details, request_iterator)
+
+-
+
+
+Expand source code
+
+def intercept_stream_stream(self, continuation, client_call_details, request_iterator):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request_iterator)
+
+Intercepts a stream-stream invocation.
+
+- Args
+- -----=
+continuation
+- A function that proceeds with the invocation by
+executing the next interceptor in chain or invoking the
+actual RPC on the underlying Channel. It is the interceptor's
+responsibility to call it if it decides to move the RPC forward.
+The interceptor can use
+
response_iterator = continuation(client_call_details, request_iterator)
+to continue with the RPC. continuation returns an object that is
+both a Call for the RPC and an iterator for response values.
+Drawing response values from the returned Call-iterator may
+raise RpcError indicating termination of the RPC with non-OK
+status.
+client_call_details
+- A ClientCallDetails object describing the
+outgoing RPC.
+request_iterator
+- An iterator that yields request values for the RPC.
+
+Returns
+-----=
+An object that is both a Call for the RPC and an iterator of
+response values. Drawing response values from the returned
+Call-iterator may raise RpcError indicating termination of
+the RPC with non-OK status. This object should also fulfill the
+Future interface, though it may not.
+
+
+def intercept_stream_unary(self, continuation, client_call_details, request_iterator)
+
+-
+
+
+Expand source code
+
+def intercept_stream_unary(self, continuation, client_call_details, request_iterator):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request_iterator)
+
+Intercepts a stream-unary invocation asynchronously.
+
+- Args
+- -----=
+continuation
+- A function that proceeds with the invocation by
+executing the next interceptor in chain or invoking the
+actual RPC on the underlying Channel. It is the interceptor's
+responsibility to call it if it decides to move the RPC forward.
+The interceptor can use
+
response_future = continuation(client_call_details, request_iterator)
+to continue with the RPC. continuation returns an object that is
+both a Call for the RPC and a Future. In the event of RPC completion,
+the return Call-Future's result value will be the response message
+of the RPC. Should the event terminate with non-OK status, the
+returned Call-Future's exception value will be an RpcError.
+client_call_details
+- A ClientCallDetails object describing the
+outgoing RPC.
+request_iterator
+- An iterator that yields request values for the RPC.
+
+Returns
+-----=
+An object that is both a Call for the RPC and a Future.
+In the event of RPC completion, the return Call-Future's
+result value will be the response message of the RPC.
+Should the event terminate with non-OK status, the returned
+Call-Future's exception value will be an RpcError.
+
+
+def intercept_unary_stream(self, continuation, client_call_details, request)
+
+-
+
+
+Expand source code
+
+def intercept_unary_stream(self, continuation, client_call_details, request):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request)
+
+Intercepts a unary-stream invocation.
+
+- Args
+- -----=
+continuation
+- A function that proceeds with the invocation by
+executing the next interceptor in chain or invoking the
+actual RPC on the underlying Channel. It is the interceptor's
+responsibility to call it if it decides to move the RPC forward.
+The interceptor can use
+
response_iterator = continuation(client_call_details, request)
+to continue with the RPC. continuation returns an object that is
+both a Call for the RPC and an iterator for response values.
+Drawing response values from the returned Call-iterator may
+raise RpcError indicating termination of the RPC with non-OK
+status.
+client_call_details
+- A ClientCallDetails object describing the
+outgoing RPC.
+request
+- The request value for the RPC.
+
+Returns
+-----=
+An object that is both a Call for the RPC and an iterator of
+response values. Drawing response values from the returned
+Call-iterator may raise RpcError indicating termination of
+the RPC with non-OK status. This object should also fulfill the
+Future interface, though it may not.
+
+
+def intercept_unary_unary(self, continuation, client_call_details, request)
+
+-
+
+
+Expand source code
+
+def intercept_unary_unary(self, continuation, client_call_details, request):
+ new_details = self._add_metadata(client_call_details)
+ return continuation(new_details, request)
+
+Intercepts a unary-unary invocation asynchronously.
+
+- Args
+- -----=
+continuation
+- A function that proceeds with the invocation by
+executing the next interceptor in chain or invoking the
+actual RPC on the underlying Channel. It is the interceptor's
+responsibility to call it if it decides to move the RPC forward.
+The interceptor can use
+
response_future = continuation(client_call_details, request)
+to continue with the RPC. continuation returns an object that is
+both a Call for the RPC and a Future. In the event of RPC
+completion, the return Call-Future's result value will be
+the response message of the RPC. Should the event terminate
+with non-OK status, the returned Call-Future's exception value
+will be an RpcError.
+client_call_details
+- A ClientCallDetails object describing the
+outgoing RPC.
+request
+- The request value for the RPC.
+
+Returns
+-----=
+An object that is both a Call for the RPC and a Future.
+In the event of RPC completion, the return Call-Future's
+result value will be the response message of the RPC.
+Should the event terminate with non-OK status, the returned
+Call-Future's exception value will be an RpcError.
+
+
+
+
+class AuthStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class AuthStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.AuthServiceStub(channel)
+ self.remote_host = remote_host
+
+ @handle_errors
+ def login(self, username, password):
+ req = connpy_pb2.LoginRequest(username=username, password=password)
+ resp = self.stub.login(req)
+ return {
+ "token": resp.token,
+ "username": resp.username,
+ "expires_at": resp.expires_at
+ }
+
+ @handle_errors
+ def change_password(self, old_password, new_password):
+ req = connpy_pb2.ChangePasswordRequest(old_password=old_password, new_password=new_password)
+ self.stub.change_password(req)
+
+ @handle_errors
+ def create_api_token(self, name, expires_in_days=0):
+ req = connpy_pb2.CreateApiTokenRequest(name=name, expires_in_days=expires_in_days)
+ resp = self.stub.create_api_token(req)
+ return {
+ "token_id": resp.token_id,
+ "raw_token": resp.raw_token,
+ "name": resp.name,
+ }
+
+ @handle_errors
+ def list_api_tokens(self):
+ resp = self.stub.list_api_tokens(Empty())
+ return [
+ {
+ "token_id": t.token_id,
+ "name": t.name,
+ "token_prefix": t.token_prefix,
+ "created_at": t.created_at,
+ "last_used_at": t.last_used_at,
+ "expires_at": t.expires_at,
+ }
+ for t in resp.tokens
+ ]
+
+ @handle_errors
+ def revoke_api_token(self, token_id):
+ req = connpy_pb2.RevokeApiTokenRequest(token_id=token_id)
+ self.stub.revoke_api_token(req)
+
+
+Methods
+
+
+def change_password(self, old_password, new_password)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def change_password(self, old_password, new_password):
+ req = connpy_pb2.ChangePasswordRequest(old_password=old_password, new_password=new_password)
+ self.stub.change_password(req)
+
+
+
+
+def create_api_token(self, name, expires_in_days=0)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def create_api_token(self, name, expires_in_days=0):
+ req = connpy_pb2.CreateApiTokenRequest(name=name, expires_in_days=expires_in_days)
+ resp = self.stub.create_api_token(req)
+ return {
+ "token_id": resp.token_id,
+ "raw_token": resp.raw_token,
+ "name": resp.name,
+ }
+
+
+
+
+def list_api_tokens(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def list_api_tokens(self):
+ resp = self.stub.list_api_tokens(Empty())
+ return [
+ {
+ "token_id": t.token_id,
+ "name": t.name,
+ "token_prefix": t.token_prefix,
+ "created_at": t.created_at,
+ "last_used_at": t.last_used_at,
+ "expires_at": t.expires_at,
+ }
+ for t in resp.tokens
+ ]
+
+
+
+
+def login(self, username, password)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def login(self, username, password):
+ req = connpy_pb2.LoginRequest(username=username, password=password)
+ resp = self.stub.login(req)
+ return {
+ "token": resp.token,
+ "username": resp.username,
+ "expires_at": resp.expires_at
+ }
+
+
+
+
+def revoke_api_token(self, token_id)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def revoke_api_token(self, token_id):
+ req = connpy_pb2.RevokeApiTokenRequest(token_id=token_id)
+ self.stub.revoke_api_token(req)
+
+
+
+
+
+
+class ConfigStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class ConfigStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.ConfigServiceStub(channel)
+ self.remote_host = remote_host
+
+ @handle_errors
+ def get_settings(self):
+ return from_struct(self.stub.get_settings(Empty()).data)
+
+ @handle_errors
+ def update_setting(self, key, value):
+ self.stub.update_setting(connpy_pb2.UpdateRequest(key=key, value=to_value(value)))
+
+ @handle_errors
+ def get_default_dir(self):
+ return self.stub.get_default_dir(Empty()).value
+
+ @handle_errors
+ def set_config_folder(self, folder):
+ self.stub.set_config_folder(connpy_pb2.StringRequest(value=folder))
+
+ @handle_errors
+ def encrypt_password(self, password):
+ return self.stub.encrypt_password(connpy_pb2.StringRequest(value=password)).value
+
+
+Methods
+
+
+def encrypt_password(self, password)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def encrypt_password(self, password):
+ return self.stub.encrypt_password(connpy_pb2.StringRequest(value=password)).value
+
+
+
+
+def get_default_dir(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_default_dir(self):
+ return self.stub.get_default_dir(Empty()).value
+
+
+
+
+def get_settings(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_settings(self):
+ return from_struct(self.stub.get_settings(Empty()).data)
+
+
+
+
+def set_config_folder(self, folder)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def set_config_folder(self, folder):
+ self.stub.set_config_folder(connpy_pb2.StringRequest(value=folder))
+
+
+
+
+def update_setting(self, key, value)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def update_setting(self, key, value):
+ self.stub.update_setting(connpy_pb2.UpdateRequest(key=key, value=to_value(value)))
+
+
+
+
+
+
+class ExecutionStub
+(channel, remote_host, config=None, node_stub=None)
+
+-
+
+
+Expand source code
+
+class ExecutionStub:
+ def __init__(self, channel, remote_host, config=None, node_stub=None):
+ self.stub = connpy_pb2_grpc.ExecutionServiceStub(channel)
+ self.remote_host = remote_host
+ self.config = config
+ self.node_stub = node_stub
+
+ def _get_context_service(self):
+ if not getattr(self.config, "_enforce_context", True):
+ return None
+ if not isinstance(getattr(self.config, "config", None), dict):
+ return None
+ from ..services.context_service import ContextService
+
+ return ContextService(self.config)
+
+ def _filter_candidates_by_filter_str(self, candidates: list[str], nodes_filter: str) -> list[str]:
+ if not nodes_filter:
+ return list(candidates)
+ cfg_dict = getattr(self.config, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ flags = 0 if case else re.IGNORECASE
+ return [c for c in candidates if re.search(nodes_filter, c, flags)]
+
+ def _resolve_remote_batches(self, nodes_filter):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ if isinstance(nodes_filter, (list, tuple)):
+ permitted = ctx_svc.filter_node_list(result=list(nodes_filter))
+ else:
+ candidates = (
+ self.node_stub.list_nodes(filter_str=nodes_filter)
+ if self.node_stub is not None
+ else []
+ )
+ candidates = self._filter_candidates_by_filter_str(candidates, nodes_filter)
+ permitted = ctx_svc.filter_node_list(result=candidates)
+ if not permitted:
+ raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
+ patterns = [f"^{re.escape(n)}$" for n in permitted]
+ return [
+ patterns[i : i + MAX_REMOTE_FILTER_NODES]
+ for i in range(0, len(patterns), MAX_REMOTE_FILTER_NODES)
+ ]
+ return [[nodes_filter] if isinstance(nodes_filter, str) else list(nodes_filter)]
+
+ @handle_errors
+ def run_commands(self, nodes_filter, commands, variables=None, parallel=10, timeout=10, folder=None, prompt=None, **kwargs):
+ batches = self._resolve_remote_batches(nodes_filter)
+ final_results = {}
+ on_complete = kwargs.get("on_node_complete")
+
+ for nodes_list in batches:
+ req = connpy_pb2.RunRequest(
+ nodes=nodes_list,
+ commands=commands,
+ folder=folder or "",
+ prompt=prompt or "",
+ parallel=parallel,
+ timeout=timeout,
+ name=kwargs.get("name", "")
+ )
+ if variables is not None:
+ req.vars.CopyFrom(to_struct(variables))
+
+ for response in self.stub.run_commands(req):
+ if on_complete:
+ on_complete(response.unique_id, response.output, response.status)
+ final_results[response.unique_id] = {
+ "output": response.output,
+ "status": response.status
+ }
+
+ return final_results
+
+ @handle_errors
+ def test_commands(self, nodes_filter, commands, expected, variables=None, parallel=10, timeout=10, prompt=None, **kwargs):
+ batches = self._resolve_remote_batches(nodes_filter)
+ final_results = {}
+ on_complete = kwargs.get("on_node_complete")
+
+ for nodes_list in batches:
+ req = connpy_pb2.TestRequest(
+ nodes=nodes_list,
+ commands=commands,
+ expected=expected if isinstance(expected, list) else [expected],
+ folder=kwargs.get("folder", ""),
+ prompt=prompt or "",
+ parallel=parallel,
+ timeout=timeout,
+ name=kwargs.get("name", "")
+ )
+ if variables is not None:
+ req.vars.CopyFrom(to_struct(variables))
+
+ for response in self.stub.test_commands(req):
+ result_dict = from_struct(response.test_result) if response.HasField("test_result") else {}
+ if on_complete:
+ on_complete(response.unique_id, response.output, response.status, result_dict)
+ final_results[response.unique_id] = result_dict
+
+ return final_results
+
+ @handle_errors
+ def run_cli_script(self, nodes_filter, script_path, parallel=10):
+ ctx_svc = self._get_context_service()
+ effective_filter = nodes_filter
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ candidates = (
+ self.node_stub.list_nodes(filter_str=nodes_filter)
+ if self.node_stub is not None
+ else []
+ )
+ if isinstance(nodes_filter, str):
+ candidates = self._filter_candidates_by_filter_str(candidates, nodes_filter)
+ permitted = ctx_svc.filter_node_list(result=candidates)
+ if not permitted:
+ raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
+ effective_filter = "|".join(f"^{re.escape(n)}$" for n in permitted)
+ req = connpy_pb2.ScriptRequest(param1=effective_filter, param2=script_path, parallel=parallel)
+ return from_struct(self.stub.run_cli_script(req).data)
+
+
+Methods
+
+
+def run_cli_script(self, nodes_filter, script_path, parallel=10)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def run_cli_script(self, nodes_filter, script_path, parallel=10):
+ ctx_svc = self._get_context_service()
+ effective_filter = nodes_filter
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ candidates = (
+ self.node_stub.list_nodes(filter_str=nodes_filter)
+ if self.node_stub is not None
+ else []
+ )
+ if isinstance(nodes_filter, str):
+ candidates = self._filter_candidates_by_filter_str(candidates, nodes_filter)
+ permitted = ctx_svc.filter_node_list(result=candidates)
+ if not permitted:
+ raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
+ effective_filter = "|".join(f"^{re.escape(n)}$" for n in permitted)
+ req = connpy_pb2.ScriptRequest(param1=effective_filter, param2=script_path, parallel=parallel)
+ return from_struct(self.stub.run_cli_script(req).data)
+
+
+
+
+def run_commands(self,
nodes_filter,
commands,
variables=None,
parallel=10,
timeout=10,
folder=None,
prompt=None,
**kwargs)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def run_commands(self, nodes_filter, commands, variables=None, parallel=10, timeout=10, folder=None, prompt=None, **kwargs):
+ batches = self._resolve_remote_batches(nodes_filter)
+ final_results = {}
+ on_complete = kwargs.get("on_node_complete")
+
+ for nodes_list in batches:
+ req = connpy_pb2.RunRequest(
+ nodes=nodes_list,
+ commands=commands,
+ folder=folder or "",
+ prompt=prompt or "",
+ parallel=parallel,
+ timeout=timeout,
+ name=kwargs.get("name", "")
+ )
+ if variables is not None:
+ req.vars.CopyFrom(to_struct(variables))
+
+ for response in self.stub.run_commands(req):
+ if on_complete:
+ on_complete(response.unique_id, response.output, response.status)
+ final_results[response.unique_id] = {
+ "output": response.output,
+ "status": response.status
+ }
+
+ return final_results
+
+
+
+
+def test_commands(self,
nodes_filter,
commands,
expected,
variables=None,
parallel=10,
timeout=10,
prompt=None,
**kwargs)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def test_commands(self, nodes_filter, commands, expected, variables=None, parallel=10, timeout=10, prompt=None, **kwargs):
+ batches = self._resolve_remote_batches(nodes_filter)
+ final_results = {}
+ on_complete = kwargs.get("on_node_complete")
+
+ for nodes_list in batches:
+ req = connpy_pb2.TestRequest(
+ nodes=nodes_list,
+ commands=commands,
+ expected=expected if isinstance(expected, list) else [expected],
+ folder=kwargs.get("folder", ""),
+ prompt=prompt or "",
+ parallel=parallel,
+ timeout=timeout,
+ name=kwargs.get("name", "")
+ )
+ if variables is not None:
+ req.vars.CopyFrom(to_struct(variables))
+
+ for response in self.stub.test_commands(req):
+ result_dict = from_struct(response.test_result) if response.HasField("test_result") else {}
+ if on_complete:
+ on_complete(response.unique_id, response.output, response.status, result_dict)
+ final_results[response.unique_id] = result_dict
+
+ return final_results
+
+
+
+
+
+
+class ImportExportStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class ImportExportStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.ImportExportServiceStub(channel)
+ self.remote_host = remote_host
+
+ @handle_errors
+ def export_to_file(self, file_path, folders=None):
+ req = connpy_pb2.ExportRequest(file_path=file_path, folders=folders or [])
+ self.stub.export_to_file(req)
+
+ @handle_errors
+ def import_from_file(self, file_path):
+ with open(file_path, "r") as f:
+ content = f.read()
+ # Marker to tell the server this is content, not a path
+ marker_content = f"---YAML---\n{content}"
+ self.stub.import_from_file(connpy_pb2.StringRequest(value=marker_content))
+
+ @handle_errors
+ def set_reserved_names(self, names):
+ self.stub.set_reserved_names(connpy_pb2.ListRequest(items=names))
+
+
+Methods
+
+
+def export_to_file(self, file_path, folders=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def export_to_file(self, file_path, folders=None):
+ req = connpy_pb2.ExportRequest(file_path=file_path, folders=folders or [])
+ self.stub.export_to_file(req)
+
+
+
+
+def import_from_file(self, file_path)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def import_from_file(self, file_path):
+ with open(file_path, "r") as f:
+ content = f.read()
+ # Marker to tell the server this is content, not a path
+ marker_content = f"---YAML---\n{content}"
+ self.stub.import_from_file(connpy_pb2.StringRequest(value=marker_content))
+
+
+
+
+def set_reserved_names(self, names)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def set_reserved_names(self, names):
+ self.stub.set_reserved_names(connpy_pb2.ListRequest(items=names))
+
+
+
+
+
+
+class NodeStub
+(channel, remote_host, config=None)
+
+-
+
+
+Expand source code
+
+class NodeStub:
+ def __init__(self, channel, remote_host, config=None):
+ self.stub = connpy_pb2_grpc.NodeServiceStub(channel)
+ self.remote_host = remote_host
+ self.config = config
+
+ def _get_context_service(self):
+ if not getattr(self.config, "_enforce_context", True):
+ return None
+ if not isinstance(getattr(self.config, "config", None), dict):
+ return None
+ from ..services.context_service import ContextService
+
+ return ContextService(self.config)
+
+ def _ensure_in_active_context(
+ self, unique_id: str, *, is_folder: bool = False, not_found_msg: str | None = None
+ ) -> None:
+ ctx_svc = self._get_context_service()
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(unique_id)
+ ):
+ if not_found_msg is not None:
+ raise NodeNotFoundError(not_found_msg)
+ label = "Folder" if is_folder else "Node"
+ raise NodeNotFoundError(f"{label} '{unique_id}' not found.")
+
+ @handle_errors
+ def _get_raw_nodes(self) -> list[str]:
+ req = connpy_pb2.FilterRequest(filter_str="", format_str="")
+ return from_value(self.stub.list_nodes(req).data) or []
+
+ @handle_errors
+ def _get_raw_folders(self) -> list[str]:
+ req = connpy_pb2.FilterRequest(filter_str="")
+ return from_value(self.stub.list_folders(req).data) or []
+
+ def _handle_remote_copilot(self, res, request_queue, response_queue, client_buffer_bytes, pause_generator, resume_generator, old_tty):
+ import asyncio
+ import json
+ import os
+ import sys
+ import termios
+ import tty
+
+ from ..cli.terminal_ui import CopilotInterface
+ from ..core import copilot_terminal_mode
+ from . import connpy_pb2
+
+ pause_generator()
+
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+
+ node_info = json.loads(res.copilot_node_info_json) if res.copilot_node_info_json else {}
+ blocks = node_info.get("context_blocks", [])
+
+ interface = CopilotInterface(
+ self.config,
+ history=getattr(self, 'copilot_history', None),
+ session_state=getattr(self, 'copilot_state', None)
+ )
+ self.copilot_history = interface.history
+ self.copilot_state = interface.session_state
+ interface.session_state['banner_shown'] = False
+
+ async def on_ai_call_remote(active_buffer, question, chunk_callback, merged_node_info):
+ # Send request to server
+ request_queue.put(connpy_pb2.InteractRequest(
+ copilot_question=question,
+ copilot_context_buffer=active_buffer,
+ copilot_node_info_json=json.dumps(merged_node_info)
+ ))
+ # Wait for chunks from server
+ while True:
+ try:
+ chunk_res = response_queue.get(timeout=0.1)
+ if chunk_res is None: return {"error": "Server disconnected"}
+ if chunk_res.copilot_stream_chunk:
+ chunk_callback(chunk_res.copilot_stream_chunk)
+ elif chunk_res.copilot_response_json:
+ return json.loads(chunk_res.copilot_response_json)
+ except queue.Empty:
+ await asyncio.sleep(0.05)
+
+ # Wrap in async loop
+ async def run_remote_copilot():
+ nonlocal blocks, node_info
+ while True:
+ action, commands, custom_cmd = await interface.run_session(
+ raw_bytes=bytes(client_buffer_bytes),
+ node_info=node_info,
+ on_ai_call=on_ai_call_remote,
+ blocks=blocks
+ )
+
+ if action == "continue":
+ # Send continue signal to server to loop back for another question
+ request_queue.put(connpy_pb2.InteractRequest(copilot_action="continue"))
+ continue
+
+ if action in ("send_all", "custom"):
+ action_sent = "cancel"
+ if action == "send_all" and commands:
+ action_sent = f"custom:{chr(10).join(commands)}"
+ elif action == "custom" and custom_cmd:
+ action_sent = f"custom:{chr(10).join(custom_cmd)}"
+ request_queue.put(connpy_pb2.InteractRequest(copilot_action=action_sent))
+
+ print("\r\n\033[2m [Remote] Ejecutando comandos y esperando al prompt...\033[0m\r\n", flush=True)
+ while True:
+ try:
+ prompt_res = response_queue.get(timeout=0.1)
+ if prompt_res is None:
+ return "cancel", None, None
+ if prompt_res.stdout_data:
+ os.write(sys.stdout.fileno(), prompt_res.stdout_data)
+ client_buffer_bytes.extend(prompt_res.stdout_data)
+ if prompt_res.copilot_prompt:
+ if prompt_res.copilot_node_info_json:
+ node_info = json.loads(prompt_res.copilot_node_info_json)
+ blocks = node_info.get("context_blocks", [])
+ break
+ except queue.Empty:
+ await asyncio.sleep(0.05)
+ continue
+
+ return action, commands, custom_cmd
+
+ with copilot_terminal_mode():
+ action, commands, custom_cmd = asyncio.run(run_remote_copilot())
+
+ print("\033[2m Returning to session...\033[0m", flush=True)
+ # Prepare final action for server
+ request_queue.put(connpy_pb2.InteractRequest(copilot_action="cancel"))
+ resume_generator()
+ tty.setraw(sys.stdin.fileno())
+
+ @handle_errors
+ def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ import sys
+ import select
+ import tty
+ import termios
+ import queue
+ import os
+ import threading
+
+ request_queue = queue.Queue()
+ client_buffer_bytes = bytearray()
+ pause_stdin = [False]
+ wake_r, wake_w = os.pipe()
+
+ def pause_generator():
+ pause_stdin[0] = True
+ os.write(wake_w, b'\x00')
+
+ def resume_generator():
+ pause_stdin[0] = False
+
+ def request_generator():
+ cols, rows = 80, 24
+ try:
+ size = os.get_terminal_size()
+ cols, rows = size.columns, size.lines
+ except OSError:
+ pass
+
+ yield connpy_pb2.InteractRequest(
+ id=unique_id, sftp=sftp, debug=debug, cols=cols, rows=rows
+ )
+
+ while True:
+ try:
+ while True:
+ req = request_queue.get_nowait()
+ if req is None:
+ return
+ yield req
+ except queue.Empty:
+ pass
+
+ if pause_stdin[0]:
+ import time
+ time.sleep(0.05)
+ continue
+
+ r, _, _ = select.select([sys.stdin.fileno(), wake_r], [], [], 0.05)
+ if wake_r in r:
+ os.read(wake_r, 1)
+ continue
+ if sys.stdin.fileno() in r and not pause_stdin[0]:
+ try:
+ data = os.read(sys.stdin.fileno(), 1024)
+ if not data:
+ break
+ yield connpy_pb2.InteractRequest(stdin_data=data)
+ except OSError:
+ break
+
+ # Fetch node details for the connection message
+ try:
+ node_details = self.get_node_details(unique_id)
+ host = node_details.get("host", "unknown")
+ port = str(node_details.get("port", ""))
+ protocol = "sftp" if sftp else node_details.get("protocol", "ssh")
+ port_str = f":{port}" if port and protocol not in ["ssm", "kubectl", "docker"] else ""
+ conn_msg = f"Connected to {unique_id} at {host}{port_str} via: {protocol}"
+ except Exception:
+ conn_msg = f"Connected to {unique_id}"
+
+ old_tty = termios.tcgetattr(sys.stdin)
+ try:
+ import time
+ tty.setraw(sys.stdin.fileno())
+ response_iterator = self.stub.interact_node(request_generator())
+
+ import queue
+ response_queue = queue.Queue()
+
+ def response_consumer():
+ try:
+ for r in response_iterator:
+ response_queue.put(r)
+ except Exception:
+ pass
+ response_queue.put(None)
+
+ t_consumer = threading.Thread(target=response_consumer, daemon=True)
+ t_consumer.start()
+
+ # First phase: Wait for connection status, print early data
+ try:
+ while True:
+ res = response_queue.get()
+ if res is None:
+ return
+ if res.stdout_data:
+ data = res.stdout_data
+ if debug:
+ data = data.replace(b'\x1b[H\x1b[2J', b'').replace(b'\x1bc', b'').replace(b'\x1b[3J', b'')
+ os.write(sys.stdout.fileno(), data)
+
+ if res.success:
+ # Connection established on server, show success message
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.success(conn_msg)
+ pause_stdin[0] = False
+ tty.setraw(sys.stdin.fileno())
+ break
+
+ if res.error_message:
+ # Connection failed on server
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.error(f"Connection failed: {res.error_message}")
+ return
+ except queue.Empty:
+ return
+
+ # Second phase: Stream active session
+ # Clear screen filter is only applied before success (Phase 1).
+ # Once the user has a prompt, Ctrl+L must work normally.
+ while True:
+ res = response_queue.get()
+ if res is None:
+ break
+ if res.copilot_prompt:
+ self._handle_remote_copilot(
+ res, request_queue, response_queue,
+ client_buffer_bytes,
+ pause_generator, resume_generator, old_tty
+ )
+ continue
+
+ if res.stdout_data:
+ os.write(sys.stdout.fileno(), res.stdout_data)
+ client_buffer_bytes.extend(res.stdout_data)
+ finally:
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ os.close(wake_r)
+ os.close(wake_w)
+
+ @handle_errors
+ def connect_dynamic(self, connection_params, debug=False):
+ import sys
+ import select
+ import tty
+ import termios
+ import queue
+ import os
+ import json
+
+ params_json = json.dumps(connection_params)
+ request_queue = queue.Queue()
+ client_buffer_bytes = bytearray()
+ pause_stdin = [False]
+ wake_r, wake_w = os.pipe()
+
+ def pause_generator():
+ pause_stdin[0] = True
+ os.write(wake_w, b'\x00')
+
+ def resume_generator():
+ pause_stdin[0] = False
+
+ def request_generator():
+ cols, rows = 80, 24
+ try:
+ size = os.get_terminal_size()
+ cols, rows = size.columns, size.lines
+ except OSError:
+ pass
+
+ yield connpy_pb2.InteractRequest(
+ id="dynamic", debug=debug, cols=cols, rows=rows,
+ connection_params_json=params_json
+ )
+
+ while True:
+ try:
+ while True:
+ req = request_queue.get_nowait()
+ if req is None:
+ return
+ yield req
+ except queue.Empty:
+ pass
+
+ if pause_stdin[0]:
+ import time
+ time.sleep(0.05)
+ continue
+
+ r, _, _ = select.select([sys.stdin.fileno(), wake_r], [], [], 0.05)
+ if wake_r in r:
+ os.read(wake_r, 1)
+ continue
+ if sys.stdin.fileno() in r and not pause_stdin[0]:
+ try:
+ data = os.read(sys.stdin.fileno(), 1024)
+ if not data:
+ break
+ yield connpy_pb2.InteractRequest(stdin_data=data)
+ except OSError:
+ break
+
+ # Prepare connection message
+ try:
+ node_name = connection_params.get("name", "dynamic@remote")
+ host = connection_params.get("host", "dynamic")
+ port = str(connection_params.get("port", ""))
+ protocol = connection_params.get("protocol", "ssh")
+ port_str = f":{port}" if port and protocol not in ["ssm", "kubectl", "docker"] else ""
+ conn_msg = f"Connected to {node_name} at {host}{port_str} via: {protocol}"
+ except Exception:
+ node_name = connection_params.get("name", "dynamic@remote") if isinstance(connection_params, dict) else "dynamic@remote"
+ conn_msg = f"Connected to {node_name}"
+
+ old_tty = termios.tcgetattr(sys.stdin)
+ try:
+ import time
+ tty.setraw(sys.stdin.fileno())
+ response_iterator = self.stub.interact_node(request_generator())
+
+ import queue
+ response_queue = queue.Queue()
+
+ def response_consumer():
+ try:
+ for r in response_iterator:
+ response_queue.put(r)
+ except Exception:
+ pass
+ response_queue.put(None)
+
+ t_consumer = threading.Thread(target=response_consumer, daemon=True)
+ t_consumer.start()
+
+ # First phase: Wait for connection status, print early data
+ try:
+ while True:
+ res = response_queue.get()
+ if res is None:
+ return
+ if res.stdout_data:
+ data = res.stdout_data
+ if debug:
+ data = data.replace(b'\x1b[H\x1b[2J', b'').replace(b'\x1bc', b'').replace(b'\x1b[3J', b'')
+ os.write(sys.stdout.fileno(), data)
+
+ if res.success:
+ # Connection established on server, show success message
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.success(conn_msg)
+ pause_stdin[0] = False
+ tty.setraw(sys.stdin.fileno())
+ break
+
+ if res.error_message:
+ # Connection failed on server
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.error(f"Connection failed: {res.error_message}")
+ return
+ except queue.Empty:
+ return
+
+ # Second phase: Stream active session
+ while True:
+ res = response_queue.get()
+ if res is None:
+ break
+ if res.copilot_prompt:
+ self._handle_remote_copilot(
+ res, request_queue, response_queue,
+ client_buffer_bytes,
+ pause_generator, resume_generator, old_tty
+ )
+ continue
+
+ if res.stdout_data:
+ os.write(sys.stdout.fileno(), res.stdout_data)
+ client_buffer_bytes.extend(res.stdout_data)
+ finally:
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ os.close(wake_r)
+ os.close(wake_w)
+
+ @MethodHook
+ @handle_errors
+ def list_nodes(self, filter_str=None, format_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "", format_str=format_str or "")
+ nodes = from_value(self.stub.list_nodes(req).data) or []
+ if not format_str:
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+ return nodes
+
+ @MethodHook
+ @handle_errors
+ def list_folders(self, filter_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "")
+ folders = from_value(self.stub.list_folders(req).data) or []
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
+ return folders
+
+ @handle_errors
+ def get_node_details(self, unique_id):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ return from_struct(self.stub.get_node_details(connpy_pb2.IdRequest(id=unique_id)).data)
+
+ @handle_errors
+ def explode_unique(self, unique_id):
+ return from_value(self.stub.explode_unique(connpy_pb2.IdRequest(id=unique_id)).data)
+
+ @handle_errors
+ def validate_parent_folder(self, unique_id, is_folder=False):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if not is_folder:
+ self.stub.validate_parent_folder(connpy_pb2.IdRequest(id=unique_id))
+
+ @handle_errors
+ def generate_cache(self, nodes=None, folders=None, profiles=None):
+ # 1. Update remote cache on server
+ self.stub.generate_cache(Empty())
+
+ # 2. Update local fzf/text cache files
+ # If no data provided, we fetch it all from remote to sync local files
+ if nodes is None and folders is None and profiles is None:
+ nodes = self.list_nodes()
+ folders = self.list_folders()
+ # We don't have direct access to ProfileStub here, but usually
+ # node cache is what matters for fzf. We'll fetch profiles if we can.
+ # For now, let's sync what we have.
+
+ if self.config is not None and (nodes is not None or folders is not None or profiles is not None):
+ self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)
+
+ def _trigger_local_cache_sync(self):
+ """Helper to fetch remote data and update local fzf cache files after a change."""
+ try:
+ nodes = self.list_nodes()
+ folders = self.list_folders()
+ self.generate_cache(nodes=nodes, folders=folders)
+ except Exception:
+ # Failure to sync cache shouldn't break the main operation's success feedback
+ pass
+
+ @handle_errors
+ def add_node(self, unique_id, data, is_folder=False):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ req = connpy_pb2.NodeRequest(id=unique_id, data=to_struct(data), is_folder=is_folder)
+ self.stub.add_node(req)
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def update_node(self, unique_id, data, save=True):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ req = connpy_pb2.NodeRequest(id=unique_id, data=to_struct(data), is_folder=False)
+ self.stub.update_node(req)
+ if save:
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def delete_node(self, unique_id, is_folder=False, save=True):
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
+ req = connpy_pb2.DeleteRequest(id=unique_id, is_folder=is_folder)
+ self.stub.delete_node(req)
+ if save:
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def move_node(self, src_id, dst_id, copy=False):
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ req = connpy_pb2.MoveRequest(src_id=src_id, dst_id=dst_id, copy=copy)
+ self.stub.move_node(req)
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def bulk_add(self, ids, hosts, common_data):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ for uid in ids:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ req = connpy_pb2.BulkRequest(ids=ids, hosts=hosts, common_data=to_struct(common_data))
+ self.stub.bulk_add(req)
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def set_reserved_names(self, names):
+ self.stub.set_reserved_names(connpy_pb2.ListRequest(items=names))
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def full_replace(self, connections, profiles):
+ req = connpy_pb2.FullReplaceRequest(
+ connections=to_struct(connections),
+ profiles=to_struct(profiles)
+ )
+ self.stub.full_replace(req)
+ self._trigger_local_cache_sync()
+
+ @handle_errors
+ def get_inventory(self):
+ resp = self.stub.get_inventory(Empty())
+ return {
+ "connections": from_struct(resp.connections),
+ "profiles": from_struct(resp.profiles)
+ }
+
+
+Methods
+
+
+def add_node(self, unique_id, data, is_folder=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def add_node(self, unique_id, data, is_folder=False):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ req = connpy_pb2.NodeRequest(id=unique_id, data=to_struct(data), is_folder=is_folder)
+ self.stub.add_node(req)
+ self._trigger_local_cache_sync()
+
+
+
+
+def bulk_add(self, ids, hosts, common_data)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def bulk_add(self, ids, hosts, common_data):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ for uid in ids:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ req = connpy_pb2.BulkRequest(ids=ids, hosts=hosts, common_data=to_struct(common_data))
+ self.stub.bulk_add(req)
+ self._trigger_local_cache_sync()
+
+
+
+
+def connect_dynamic(self, connection_params, debug=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def connect_dynamic(self, connection_params, debug=False):
+ import sys
+ import select
+ import tty
+ import termios
+ import queue
+ import os
+ import json
+
+ params_json = json.dumps(connection_params)
+ request_queue = queue.Queue()
+ client_buffer_bytes = bytearray()
+ pause_stdin = [False]
+ wake_r, wake_w = os.pipe()
+
+ def pause_generator():
+ pause_stdin[0] = True
+ os.write(wake_w, b'\x00')
+
+ def resume_generator():
+ pause_stdin[0] = False
+
+ def request_generator():
+ cols, rows = 80, 24
+ try:
+ size = os.get_terminal_size()
+ cols, rows = size.columns, size.lines
+ except OSError:
+ pass
+
+ yield connpy_pb2.InteractRequest(
+ id="dynamic", debug=debug, cols=cols, rows=rows,
+ connection_params_json=params_json
+ )
+
+ while True:
+ try:
+ while True:
+ req = request_queue.get_nowait()
+ if req is None:
+ return
+ yield req
+ except queue.Empty:
+ pass
+
+ if pause_stdin[0]:
+ import time
+ time.sleep(0.05)
+ continue
+
+ r, _, _ = select.select([sys.stdin.fileno(), wake_r], [], [], 0.05)
+ if wake_r in r:
+ os.read(wake_r, 1)
+ continue
+ if sys.stdin.fileno() in r and not pause_stdin[0]:
+ try:
+ data = os.read(sys.stdin.fileno(), 1024)
+ if not data:
+ break
+ yield connpy_pb2.InteractRequest(stdin_data=data)
+ except OSError:
+ break
+
+ # Prepare connection message
+ try:
+ node_name = connection_params.get("name", "dynamic@remote")
+ host = connection_params.get("host", "dynamic")
+ port = str(connection_params.get("port", ""))
+ protocol = connection_params.get("protocol", "ssh")
+ port_str = f":{port}" if port and protocol not in ["ssm", "kubectl", "docker"] else ""
+ conn_msg = f"Connected to {node_name} at {host}{port_str} via: {protocol}"
+ except Exception:
+ node_name = connection_params.get("name", "dynamic@remote") if isinstance(connection_params, dict) else "dynamic@remote"
+ conn_msg = f"Connected to {node_name}"
+
+ old_tty = termios.tcgetattr(sys.stdin)
+ try:
+ import time
+ tty.setraw(sys.stdin.fileno())
+ response_iterator = self.stub.interact_node(request_generator())
+
+ import queue
+ response_queue = queue.Queue()
+
+ def response_consumer():
+ try:
+ for r in response_iterator:
+ response_queue.put(r)
+ except Exception:
+ pass
+ response_queue.put(None)
+
+ t_consumer = threading.Thread(target=response_consumer, daemon=True)
+ t_consumer.start()
+
+ # First phase: Wait for connection status, print early data
+ try:
+ while True:
+ res = response_queue.get()
+ if res is None:
+ return
+ if res.stdout_data:
+ data = res.stdout_data
+ if debug:
+ data = data.replace(b'\x1b[H\x1b[2J', b'').replace(b'\x1bc', b'').replace(b'\x1b[3J', b'')
+ os.write(sys.stdout.fileno(), data)
+
+ if res.success:
+ # Connection established on server, show success message
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.success(conn_msg)
+ pause_stdin[0] = False
+ tty.setraw(sys.stdin.fileno())
+ break
+
+ if res.error_message:
+ # Connection failed on server
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.error(f"Connection failed: {res.error_message}")
+ return
+ except queue.Empty:
+ return
+
+ # Second phase: Stream active session
+ while True:
+ res = response_queue.get()
+ if res is None:
+ break
+ if res.copilot_prompt:
+ self._handle_remote_copilot(
+ res, request_queue, response_queue,
+ client_buffer_bytes,
+ pause_generator, resume_generator, old_tty
+ )
+ continue
+
+ if res.stdout_data:
+ os.write(sys.stdout.fileno(), res.stdout_data)
+ client_buffer_bytes.extend(res.stdout_data)
+ finally:
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ os.close(wake_r)
+ os.close(wake_w)
+
+
+
+
+def connect_node(self, unique_id, sftp=False, debug=False, logger=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ import sys
+ import select
+ import tty
+ import termios
+ import queue
+ import os
+ import threading
+
+ request_queue = queue.Queue()
+ client_buffer_bytes = bytearray()
+ pause_stdin = [False]
+ wake_r, wake_w = os.pipe()
+
+ def pause_generator():
+ pause_stdin[0] = True
+ os.write(wake_w, b'\x00')
+
+ def resume_generator():
+ pause_stdin[0] = False
+
+ def request_generator():
+ cols, rows = 80, 24
+ try:
+ size = os.get_terminal_size()
+ cols, rows = size.columns, size.lines
+ except OSError:
+ pass
+
+ yield connpy_pb2.InteractRequest(
+ id=unique_id, sftp=sftp, debug=debug, cols=cols, rows=rows
+ )
+
+ while True:
+ try:
+ while True:
+ req = request_queue.get_nowait()
+ if req is None:
+ return
+ yield req
+ except queue.Empty:
+ pass
+
+ if pause_stdin[0]:
+ import time
+ time.sleep(0.05)
+ continue
+
+ r, _, _ = select.select([sys.stdin.fileno(), wake_r], [], [], 0.05)
+ if wake_r in r:
+ os.read(wake_r, 1)
+ continue
+ if sys.stdin.fileno() in r and not pause_stdin[0]:
+ try:
+ data = os.read(sys.stdin.fileno(), 1024)
+ if not data:
+ break
+ yield connpy_pb2.InteractRequest(stdin_data=data)
+ except OSError:
+ break
+
+ # Fetch node details for the connection message
+ try:
+ node_details = self.get_node_details(unique_id)
+ host = node_details.get("host", "unknown")
+ port = str(node_details.get("port", ""))
+ protocol = "sftp" if sftp else node_details.get("protocol", "ssh")
+ port_str = f":{port}" if port and protocol not in ["ssm", "kubectl", "docker"] else ""
+ conn_msg = f"Connected to {unique_id} at {host}{port_str} via: {protocol}"
+ except Exception:
+ conn_msg = f"Connected to {unique_id}"
+
+ old_tty = termios.tcgetattr(sys.stdin)
+ try:
+ import time
+ tty.setraw(sys.stdin.fileno())
+ response_iterator = self.stub.interact_node(request_generator())
+
+ import queue
+ response_queue = queue.Queue()
+
+ def response_consumer():
+ try:
+ for r in response_iterator:
+ response_queue.put(r)
+ except Exception:
+ pass
+ response_queue.put(None)
+
+ t_consumer = threading.Thread(target=response_consumer, daemon=True)
+ t_consumer.start()
+
+ # First phase: Wait for connection status, print early data
+ try:
+ while True:
+ res = response_queue.get()
+ if res is None:
+ return
+ if res.stdout_data:
+ data = res.stdout_data
+ if debug:
+ data = data.replace(b'\x1b[H\x1b[2J', b'').replace(b'\x1bc', b'').replace(b'\x1b[3J', b'')
+ os.write(sys.stdout.fileno(), data)
+
+ if res.success:
+ # Connection established on server, show success message
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.success(conn_msg)
+ pause_stdin[0] = False
+ tty.setraw(sys.stdin.fileno())
+ break
+
+ if res.error_message:
+ # Connection failed on server
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ printer.error(f"Connection failed: {res.error_message}")
+ return
+ except queue.Empty:
+ return
+
+ # Second phase: Stream active session
+ # Clear screen filter is only applied before success (Phase 1).
+ # Once the user has a prompt, Ctrl+L must work normally.
+ while True:
+ res = response_queue.get()
+ if res is None:
+ break
+ if res.copilot_prompt:
+ self._handle_remote_copilot(
+ res, request_queue, response_queue,
+ client_buffer_bytes,
+ pause_generator, resume_generator, old_tty
+ )
+ continue
+
+ if res.stdout_data:
+ os.write(sys.stdout.fileno(), res.stdout_data)
+ client_buffer_bytes.extend(res.stdout_data)
+ finally:
+ termios.tcsetattr(sys.stdin, termios.TCSADRAIN, old_tty)
+ os.close(wake_r)
+ os.close(wake_w)
+
+
+
+
+def delete_node(self, unique_id, is_folder=False, save=True)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def delete_node(self, unique_id, is_folder=False, save=True):
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
+ req = connpy_pb2.DeleteRequest(id=unique_id, is_folder=is_folder)
+ self.stub.delete_node(req)
+ if save:
+ self._trigger_local_cache_sync()
+
+
+
+
+def explode_unique(self, unique_id)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def explode_unique(self, unique_id):
+ return from_value(self.stub.explode_unique(connpy_pb2.IdRequest(id=unique_id)).data)
+
+
+
+
+def full_replace(self, connections, profiles)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def full_replace(self, connections, profiles):
+ req = connpy_pb2.FullReplaceRequest(
+ connections=to_struct(connections),
+ profiles=to_struct(profiles)
+ )
+ self.stub.full_replace(req)
+ self._trigger_local_cache_sync()
+
+
+
+
+def generate_cache(self, nodes=None, folders=None, profiles=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def generate_cache(self, nodes=None, folders=None, profiles=None):
+ # 1. Update remote cache on server
+ self.stub.generate_cache(Empty())
+
+ # 2. Update local fzf/text cache files
+ # If no data provided, we fetch it all from remote to sync local files
+ if nodes is None and folders is None and profiles is None:
+ nodes = self.list_nodes()
+ folders = self.list_folders()
+ # We don't have direct access to ProfileStub here, but usually
+ # node cache is what matters for fzf. We'll fetch profiles if we can.
+ # For now, let's sync what we have.
+
+ if self.config is not None and (nodes is not None or folders is not None or profiles is not None):
+ self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)
+
+
+
+
+def get_inventory(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_inventory(self):
+ resp = self.stub.get_inventory(Empty())
+ return {
+ "connections": from_struct(resp.connections),
+ "profiles": from_struct(resp.profiles)
+ }
+
+
+
+
+def get_node_details(self, unique_id)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_node_details(self, unique_id):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ return from_struct(self.stub.get_node_details(connpy_pb2.IdRequest(id=unique_id)).data)
+
+
+
+
+def list_folders(self, filter_str=None)
+
+-
+
+
+Expand source code
+
+@MethodHook
+@handle_errors
+def list_folders(self, filter_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "")
+ folders = from_value(self.stub.list_folders(req).data) or []
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
+ return folders
+
+
+
+
+def list_nodes(self, filter_str=None, format_str=None)
+
+-
+
+
+Expand source code
+
+@MethodHook
+@handle_errors
+def list_nodes(self, filter_str=None, format_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "", format_str=format_str or "")
+ nodes = from_value(self.stub.list_nodes(req).data) or []
+ if not format_str:
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+ return nodes
+
+
+
+
+def move_node(self, src_id, dst_id, copy=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def move_node(self, src_id, dst_id, copy=False):
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ req = connpy_pb2.MoveRequest(src_id=src_id, dst_id=dst_id, copy=copy)
+ self.stub.move_node(req)
+ self._trigger_local_cache_sync()
+
+
+
+
+def set_reserved_names(self, names)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def set_reserved_names(self, names):
+ self.stub.set_reserved_names(connpy_pb2.ListRequest(items=names))
+ self._trigger_local_cache_sync()
+
+
+
+
+def update_node(self, unique_id, data, save=True)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def update_node(self, unique_id, data, save=True):
+ self._ensure_in_active_context(unique_id, is_folder=False)
+ req = connpy_pb2.NodeRequest(id=unique_id, data=to_struct(data), is_folder=False)
+ self.stub.update_node(req)
+ if save:
+ self._trigger_local_cache_sync()
+
+
+
+
+def validate_parent_folder(self, unique_id, is_folder=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def validate_parent_folder(self, unique_id, is_folder=False):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if not is_folder:
+ self.stub.validate_parent_folder(connpy_pb2.IdRequest(id=unique_id))
+
+
+
+
+
+
+class PluginStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class PluginStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.PluginServiceStub(channel)
+ self.remote_stub = remote_plugin_pb2_grpc.RemotePluginServiceStub(channel)
+ self.remote_host = remote_host
+
+ @handle_errors
+ def list_plugins(self):
+ return from_value(self.stub.list_plugins(Empty()).data)
+
+ @handle_errors
+ def add_plugin(self, name, source_file, update=False):
+ # Read the local file content to send it to the server
+ with open(source_file, "r") as f:
+ content = f.read()
+
+ # Use source_file as a marker for "content-inside"
+ marker_content = f"---CONTENT---\n{content}"
+ req = connpy_pb2.PluginRequest(name=name, source_file=marker_content, update=update)
+ self.stub.add_plugin(req)
+
+ @handle_errors
+ def delete_plugin(self, name):
+ self.stub.delete_plugin(connpy_pb2.IdRequest(id=name))
+
+ @handle_errors
+ def enable_plugin(self, name):
+ self.stub.enable_plugin(connpy_pb2.IdRequest(id=name))
+
+ @handle_errors
+ def disable_plugin(self, name):
+ self.stub.disable_plugin(connpy_pb2.IdRequest(id=name))
+
+ @handle_errors
+ def get_plugin_source(self, name):
+ resp = self.remote_stub.get_plugin_source(remote_plugin_pb2.IdRequest(id=name))
+ return resp.value
+
+ @handle_errors
+ def invoke_plugin(self, name, args_namespace):
+ import json
+ args_dict = {k: v for k, v in vars(args_namespace).items()
+ if isinstance(v, (str, int, float, bool, list, type(None)))}
+ if hasattr(args_namespace, "func") and hasattr(args_namespace.func, "__name__"):
+ args_dict["__func_name__"] = args_namespace.func.__name__
+
+ req = remote_plugin_pb2.PluginInvokeRequest(name=name, args_json=json.dumps(args_dict))
+ for chunk in self.remote_stub.invoke_plugin(req):
+ yield chunk.text
+
+
+Methods
+
+
+def add_plugin(self, name, source_file, update=False)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def add_plugin(self, name, source_file, update=False):
+ # Read the local file content to send it to the server
+ with open(source_file, "r") as f:
+ content = f.read()
+
+ # Use source_file as a marker for "content-inside"
+ marker_content = f"---CONTENT---\n{content}"
+ req = connpy_pb2.PluginRequest(name=name, source_file=marker_content, update=update)
+ self.stub.add_plugin(req)
+
+
+
+
+def delete_plugin(self, name)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def delete_plugin(self, name):
+ self.stub.delete_plugin(connpy_pb2.IdRequest(id=name))
+
+
+
+
+def disable_plugin(self, name)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def disable_plugin(self, name):
+ self.stub.disable_plugin(connpy_pb2.IdRequest(id=name))
+
+
+
+
+def enable_plugin(self, name)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def enable_plugin(self, name):
+ self.stub.enable_plugin(connpy_pb2.IdRequest(id=name))
+
+
+
+
+def get_plugin_source(self, name)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_plugin_source(self, name):
+ resp = self.remote_stub.get_plugin_source(remote_plugin_pb2.IdRequest(id=name))
+ return resp.value
+
+
+
+
+def invoke_plugin(self, name, args_namespace)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def invoke_plugin(self, name, args_namespace):
+ import json
+ args_dict = {k: v for k, v in vars(args_namespace).items()
+ if isinstance(v, (str, int, float, bool, list, type(None)))}
+ if hasattr(args_namespace, "func") and hasattr(args_namespace.func, "__name__"):
+ args_dict["__func_name__"] = args_namespace.func.__name__
+
+ req = remote_plugin_pb2.PluginInvokeRequest(name=name, args_json=json.dumps(args_dict))
+ for chunk in self.remote_stub.invoke_plugin(req):
+ yield chunk.text
+
+
+
+
+def list_plugins(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def list_plugins(self):
+ return from_value(self.stub.list_plugins(Empty()).data)
+
+
+
+
+
+
+class ProfileStub
+(channel, remote_host, node_stub=None)
+
+-
+
+
+Expand source code
+
+class ProfileStub:
+ def __init__(self, channel, remote_host, node_stub=None):
+ self.stub = connpy_pb2_grpc.ProfileServiceStub(channel)
+ self.remote_host = remote_host
+ self.node_stub = node_stub
+
+ @handle_errors
+ def list_profiles(self, filter_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "")
+ return from_value(self.stub.list_profiles(req).data) or []
+
+ @handle_errors
+ def get_profile(self, name, resolve=True):
+ req = connpy_pb2.ProfileRequest(name=name, resolve=resolve)
+ return from_struct(self.stub.get_profile(req).data)
+
+ @handle_errors
+ def add_profile(self, name, data):
+ req = connpy_pb2.NodeRequest(id=name, data=to_struct(data))
+ self.stub.add_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+ @handle_errors
+ def resolve_node_data(self, node_data):
+ req = connpy_pb2.StructRequest(data=to_struct(node_data))
+ return from_struct(self.stub.resolve_node_data(req).data)
+
+ @handle_errors
+ def delete_profile(self, name):
+ req = connpy_pb2.IdRequest(id=name)
+ self.stub.delete_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+ @handle_errors
+ def update_profile(self, name, data):
+ req = connpy_pb2.NodeRequest(id=name, data=to_struct(data))
+ self.stub.update_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+
+Methods
+
+
+def add_profile(self, name, data)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def add_profile(self, name, data):
+ req = connpy_pb2.NodeRequest(id=name, data=to_struct(data))
+ self.stub.add_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+
+
+
+def delete_profile(self, name)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def delete_profile(self, name):
+ req = connpy_pb2.IdRequest(id=name)
+ self.stub.delete_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+
+
+
+def get_profile(self, name, resolve=True)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_profile(self, name, resolve=True):
+ req = connpy_pb2.ProfileRequest(name=name, resolve=resolve)
+ return from_struct(self.stub.get_profile(req).data)
+
+
+
+
+def list_profiles(self, filter_str=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def list_profiles(self, filter_str=None):
+ req = connpy_pb2.FilterRequest(filter_str=filter_str or "")
+ return from_value(self.stub.list_profiles(req).data) or []
+
+
+
+
+def resolve_node_data(self, node_data)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def resolve_node_data(self, node_data):
+ req = connpy_pb2.StructRequest(data=to_struct(node_data))
+ return from_struct(self.stub.resolve_node_data(req).data)
+
+
+
+
+def update_profile(self, name, data)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def update_profile(self, name, data):
+ req = connpy_pb2.NodeRequest(id=name, data=to_struct(data))
+ self.stub.update_profile(req)
+ if self.node_stub:
+ self.node_stub._trigger_local_cache_sync()
+
+
+
+
+
+
+class SystemStub
+(channel, remote_host)
+
+-
+
+
+Expand source code
+
+class SystemStub:
+ def __init__(self, channel, remote_host):
+ self.stub = connpy_pb2_grpc.SystemServiceStub(channel)
+ self.remote_host = remote_host
+
+ @handle_errors
+ def start_api(self, port=None):
+ self.stub.start_api(connpy_pb2.IntRequest(value=port or 8048))
+
+ @handle_errors
+ def debug_api(self, port=None):
+ self.stub.debug_api(connpy_pb2.IntRequest(value=port or 8048))
+
+ @handle_errors
+ def stop_api(self):
+ self.stub.stop_api(Empty())
+
+ @handle_errors
+ def restart_api(self, port=None):
+ self.stub.restart_api(connpy_pb2.IntRequest(value=port or 8048))
+
+ @handle_errors
+ def get_api_status(self):
+ return self.stub.get_api_status(Empty()).value
+
+
+Methods
+
+
+def debug_api(self, port=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def debug_api(self, port=None):
+ self.stub.debug_api(connpy_pb2.IntRequest(value=port or 8048))
+
+
+
+
+def get_api_status(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def get_api_status(self):
+ return self.stub.get_api_status(Empty()).value
+
+
+
+
+def restart_api(self, port=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def restart_api(self, port=None):
+ self.stub.restart_api(connpy_pb2.IntRequest(value=port or 8048))
+
+
+
+
+def start_api(self, port=None)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def start_api(self, port=None):
+ self.stub.start_api(connpy_pb2.IntRequest(value=port or 8048))
+
+
+
+
+def stop_api(self)
+
+-
+
+
+Expand source code
+
+@handle_errors
+def stop_api(self):
+ self.stub.stop_api(Empty())
+
+
+
+
+
+
AIStubAuthClientInterceptorAuthStubConfigStubExecutionStubImportExportStubNodeStubPluginStubProfileStubSystemStubclass ContextService(BaseService):
"""Business logic for managing and applying regex-based contexts locally."""
+ @staticmethod
+ def _validate_regexes(regexes: Any) -> None:
+ if not isinstance(regexes, list) or not (1 <= len(regexes) <= MAX_CONTEXT_REGEXES):
+ raise ValueError(
+ f"Context regexes must be a list of 1 to {MAX_CONTEXT_REGEXES} patterns"
+ )
+ for pat in regexes:
+ if not isinstance(pat, str) or not (1 <= len(pat) <= MAX_CONTEXT_PATTERN_LEN):
+ raise ValueError(
+ f"Each context regex must be a non-empty string up to {MAX_CONTEXT_PATTERN_LEN} characters"
+ )
+ try:
+ re.compile(pat)
+ except re.error as exc:
+ raise ValueError(f"Invalid context regex {pat!r}: {exc}") from None
+
@property
- def contexts(self) -> Dict[str, List[str]]:
+ def contexts(self) -> dict[str, list[str]]:
return self.config.config.get("contexts", {"all": [".*"]})
@property
def current_context(self) -> str:
return self.config.config.get("current_context", "all")
- def list_contexts(self) -> List[Dict[str, Any]]:
+ def list_contexts(self) -> list[dict[str, Any]]:
result = []
for name in self.contexts.keys():
result.append({
@@ -76,27 +92,29 @@ el.replaceWith(d);
})
return result
- def add_context(self, name: str, regexes: List[str]):
+ def add_context(self, name: str, regexes: list[str]):
if not name.isalnum():
raise ValueError("Context name must be alphanumeric")
-
+ self._validate_regexes(regexes)
+
ctxs = self.contexts
if name in ctxs:
raise ValueError(f"Context '{name}' already exists")
-
- ctxs[name] = regexes
+
+ ctxs[name] = list(regexes)
self.config.config["contexts"] = ctxs
self.config._saveconfig(self.config.file)
- def update_context(self, name: str, regexes: List[str]):
+ def update_context(self, name: str, regexes: list[str]):
if name == "all":
raise ValueError("Cannot modify default context 'all'")
-
+ self._validate_regexes(regexes)
+
ctxs = self.contexts
if name not in ctxs:
raise ValueError(f"Context '{name}' does not exist")
-
- ctxs[name] = regexes
+
+ ctxs[name] = list(regexes)
self.config.config["contexts"] = ctxs
self.config._saveconfig(self.config.file)
@@ -117,16 +135,48 @@ el.replaceWith(d);
def set_active_context(self, name: str):
if name not in self.contexts:
raise ValueError(f"Context '{name}' does not exist")
-
+
+ prev_context = self.current_context
self.config.config["current_context"] = name
self.config._saveconfig(self.config.file)
+ can_refresh = (
+ self.config._is_context_filtering_enabled_unlocked()
+ if (
+ not hasattr(self.config, "assert_called")
+ and callable(getattr(self.config, "_is_context_filtering_enabled_unlocked", None))
+ )
+ else getattr(self.config, "_enforce_context", True)
+ )
+ if (
+ name == "all"
+ and prev_context != "all"
+ and can_refresh
+ and hasattr(self.config, "_generate_nodes_cache")
+ ):
+ self.config._generate_nodes_cache()
- def get_active_regexes(self) -> List[re.Pattern]:
- patterns = self.contexts.get(self.current_context, [".*"])
- return [re.compile(p) for p in patterns]
+ def get_active_regexes(self) -> list[re.Pattern]:
+ return compile_active_context_patterns(getattr(self.config, "config", None))
- def _match_any(self, node_name: str, patterns: List[re.Pattern]) -> bool:
- return any(p.match(node_name) for p in patterns)
+ def _match_any(self, node_name: str, patterns: list[re.Pattern]) -> bool:
+ return match_active_context_patterns(node_name, patterns)
+
+ def is_default_all_context(self) -> bool:
+ return is_default_all_context_cfg(getattr(self.config, "config", None))
+
+ def matches_active_context(self, name: str) -> bool:
+ if self.is_default_all_context():
+ return isinstance(name, str) and bool(name)
+ if not isinstance(name, str) or not name:
+ return False
+ return match_active_context_patterns(name, self.get_active_regexes())
+
+ def validate_in_active_context(self, unique_id: str, is_folder: bool = False) -> None:
+ if not self.is_default_all_context() and not self.matches_active_context(unique_id):
+ label = "Folder" if is_folder else "Node"
+ raise InvalidConfigurationError(
+ f"{label} '{unique_id}' does not match active context '{self.current_context}'."
+ )
# Hook handlers for filtering
def filter_node_list(self, *args, **kwargs):
@@ -151,14 +201,14 @@ el.replaceWith(d);
Instance variables
-prop contexts : Dict[str, List[str]]
+prop contexts : dict[str, list[str]]
-
Expand source code
@property
-def contexts(self) -> Dict[str, List[str]]:
+def contexts(self) -> dict[str, list[str]]:
return self.config.config.get("contexts", {"all": [".*"]})
@@ -179,22 +229,23 @@ def current_context(self) -> str:
Methods
-def add_context(self, name: str, regexes: List[str])
+def add_context(self, name: str, regexes: list[str])
-
Expand source code
-def add_context(self, name: str, regexes: List[str]):
+def add_context(self, name: str, regexes: list[str]):
if not name.isalnum():
raise ValueError("Context name must be alphanumeric")
-
+ self._validate_regexes(regexes)
+
ctxs = self.contexts
if name in ctxs:
raise ValueError(f"Context '{name}' already exists")
-
- ctxs[name] = regexes
+
+ ctxs[name] = list(regexes)
self.config.config["contexts"] = ctxs
self.config._saveconfig(self.config.file)
@@ -253,28 +304,40 @@ def current_context(self) -> str:
-def get_active_regexes(self) ‑> List[re.Pattern]
+def get_active_regexes(self) ‑> list[re.Pattern]
-
Expand source code
-def get_active_regexes(self) -> List[re.Pattern]:
- patterns = self.contexts.get(self.current_context, [".*"])
- return [re.compile(p) for p in patterns]
+def get_active_regexes(self) -> list[re.Pattern]:
+ return compile_active_context_patterns(getattr(self.config, "config", None))
+
+
+
+
+def is_default_all_context(self) ‑> bool
+
+-
+
+
+Expand source code
+
+def is_default_all_context(self) -> bool:
+ return is_default_all_context_cfg(getattr(self.config, "config", None))
-def list_contexts(self) ‑> List[Dict[str, Any]]
+def list_contexts(self) ‑> list[dict[str, typing.Any]]
-
Expand source code
-def list_contexts(self) -> List[Dict[str, Any]]:
+def list_contexts(self) -> list[dict[str, Any]]:
result = []
for name in self.contexts.keys():
result.append({
@@ -286,6 +349,23 @@ def current_context(self) -> str:
+
+def matches_active_context(self, name: str) ‑> bool
+
+-
+
+
+Expand source code
+
+def matches_active_context(self, name: str) -> bool:
+ if self.is_default_all_context():
+ return isinstance(name, str) and bool(name)
+ if not isinstance(name, str) or not name:
+ return False
+ return match_active_context_patterns(name, self.get_active_regexes())
+
+
+
def set_active_context(self, name: str)
@@ -297,34 +377,68 @@ def current_context(self) -> str:
def set_active_context(self, name: str):
if name not in self.contexts:
raise ValueError(f"Context '{name}' does not exist")
-
+
+ prev_context = self.current_context
self.config.config["current_context"] = name
- self.config._saveconfig(self.config.file)
+ self.config._saveconfig(self.config.file)
+ can_refresh = (
+ self.config._is_context_filtering_enabled_unlocked()
+ if (
+ not hasattr(self.config, "assert_called")
+ and callable(getattr(self.config, "_is_context_filtering_enabled_unlocked", None))
+ )
+ else getattr(self.config, "_enforce_context", True)
+ )
+ if (
+ name == "all"
+ and prev_context != "all"
+ and can_refresh
+ and hasattr(self.config, "_generate_nodes_cache")
+ ):
+ self.config._generate_nodes_cache()
-def update_context(self, name: str, regexes: List[str])
+def update_context(self, name: str, regexes: list[str])
def update_context(self, name: str, regexes: List[str]):
+def update_context(self, name: str, regexes: list[str]):
if name == "all":
raise ValueError("Cannot modify default context 'all'")
-
+ self._validate_regexes(regexes)
+
ctxs = self.contexts
if name not in ctxs:
raise ValueError(f"Context '{name}' does not exist")
-
- ctxs[name] = regexes
+
+ ctxs[name] = list(regexes)
self.config.config["contexts"] = ctxs
self.config._saveconfig(self.config.file)
+def validate_in_active_context(self, unique_id: str, is_folder: bool = False) ‑> None
+def validate_in_active_context(self, unique_id: str, is_folder: bool = False) -> None:
+ if not self.is_default_all_context() and not self.matches_active_context(unique_id):
+ label = "Folder" if is_folder else "Node"
+ raise InvalidConfigurationError(
+ f"{label} '{unique_id}' does not match active context '{self.current_context}'."
+ )
+ContextServiceadd_contextcontextscurrent_contextfilter_node_dictfilter_node_listget_active_regexesis_default_all_contextlist_contextsmatches_active_contextset_active_contextupdate_contextvalidate_in_active_context
class ExecutionService
-(config=None, remote_stub=None, attempt_tracker=None)
+(config=None, remote_stub=None, attempt_tracker=None, enforce_context: bool = True)
class ExecutionService(BaseService):
"""Business logic for executing commands on nodes and running automation scripts."""
- def __init__(self, config=None, remote_stub=None, attempt_tracker=None):
+ def __init__(
+ self,
+ config=None,
+ remote_stub=None,
+ attempt_tracker=None,
+ enforce_context: bool = True,
+ ):
super().__init__(config)
self.remote_stub = remote_stub
self.attempt_tracker = (
attempt_tracker if attempt_tracker is not None else AuthAttemptTracker()
)
+ self.enforce_context = bool(enforce_context)
self.last_fallback_used: dict[str, bool] = {}
+ def _get_context_service(self):
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(self.config, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(self.config, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(self.config)
+
def _is_remote_backend(self) -> bool:
"""Return True when execution is configured to run against a remote gRPC backend."""
if getattr(self, "remote_stub", None) is not None:
@@ -84,10 +103,7 @@ el.replaceWith(d);
"connect_timeout and auth_timeout overrides are not supported in remote gRPC mode"
)
- def _get_remote_stub(self):
- """Return the configured or lazily constructed ExecutionStub for remote gRPC mode."""
- if getattr(self, "remote_stub", None) is not None:
- return self.remote_stub
+ def _get_remote_channel(self):
cfg = getattr(self.config, "config", None)
remote_host = cfg.get("remote_host") if isinstance(cfg, dict) else None
if not remote_host:
@@ -95,7 +111,7 @@ el.replaceWith(d);
import grpc
- from connpy.grpc_layer.stubs import AuthClientInterceptor, ExecutionStub
+ from connpy.grpc_layer.stubs import AuthClientInterceptor
def get_token():
env_token = os.environ.get("CONNPY_TOKEN")
@@ -111,8 +127,81 @@ el.replaceWith(d);
channel = grpc.insecure_channel(remote_host)
channel = grpc.intercept_channel(channel, AuthClientInterceptor(get_token))
+ return channel, remote_host
+
+ def _get_remote_stub(self):
+ """Return the configured or lazily constructed ExecutionStub for remote gRPC mode."""
+ if getattr(self, "remote_stub", None) is not None:
+ return self.remote_stub
+ from connpy.grpc_layer.stubs import ExecutionStub
+
+ channel, remote_host = self._get_remote_channel()
return ExecutionStub(channel, remote_host=remote_host)
+ def _filter_remote_nodes_filter(self, nodes_filter):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is None or ctx_svc.is_default_all_context():
+ return nodes_filter
+
+ if isinstance(nodes_filter, (list, tuple)):
+ permitted = ctx_svc.filter_node_list(result=list(nodes_filter))
+ else:
+ if self.remote_stub is not None and callable(
+ getattr(self.remote_stub, "list_nodes", None)
+ ):
+ candidates = self.remote_stub.list_nodes(filter_str=nodes_filter)
+ elif self.remote_stub is not None and callable(
+ getattr(getattr(self.remote_stub, "node_stub", None), "list_nodes", None)
+ ):
+ candidates = self.remote_stub.node_stub.list_nodes(filter_str=nodes_filter)
+ elif self.remote_stub is None:
+ from connpy.grpc_layer.stubs import NodeStub
+
+ channel, remote_host = self._get_remote_channel()
+ node_stub = NodeStub(channel, remote_host=remote_host, config=self.config)
+ candidates = node_stub.list_nodes(filter_str=nodes_filter)
+ else:
+ candidates = (
+ self.config._getallnodes(nodes_filter)
+ if hasattr(self.config, "_getallnodes")
+ else []
+ )
+ if nodes_filter:
+ cfg_dict = getattr(self.config, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ flags = 0 if case else re.IGNORECASE
+ candidates = [c for c in candidates if re.search(nodes_filter, c, flags)]
+ permitted = ctx_svc.filter_node_list(result=candidates)
+
+ if not permitted:
+ raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
+ return [f"^{re.escape(n)}$" for n in permitted]
+
+ def _build_remote_filter_batches(self, nodes_filter):
+ filtered = self._filter_remote_nodes_filter(nodes_filter)
+ if isinstance(filtered, list):
+ return [
+ filtered[i : i + MAX_REMOTE_FILTER_NODES]
+ for i in range(0, len(filtered), MAX_REMOTE_FILTER_NODES)
+ ]
+ return [filtered]
+
+ @staticmethod
+ def _aggregate_remote_results(batch_results):
+ if len(batch_results) == 1:
+ return batch_results[0]
+ if all(isinstance(r, dict) for r in batch_results):
+ merged: dict[str, Any] = {}
+ for r in batch_results:
+ merged.update(r)
+ return merged
+ if all(isinstance(r, list) for r in batch_results):
+ merged_list: list[Any] = []
+ for r in batch_results:
+ merged_list.extend(r)
+ return merged_list
+ return batch_results[-1]
+
def run_commands(
self,
nodes_filter: str,
@@ -136,21 +225,29 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.run_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder,
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.run_commands(
+ nodes_filter=batch,
+ commands=commands,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder,
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -224,22 +321,30 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.test_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- expected=expected,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder or "",
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.test_commands(
+ nodes_filter=batch,
+ commands=commands,
+ expected=expected,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder or "",
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -361,21 +466,29 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.run_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder,
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.run_commands(
+ nodes_filter=batch,
+ commands=commands,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder,
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -459,22 +572,30 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.test_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- expected=expected,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder or "",
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.test_commands(
+ nodes_filter=batch,
+ commands=commands,
+ expected=expected,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder or "",
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
diff --git a/docs/connpy/services/import_export_service.html b/docs/connpy/services/import_export_service.html
index 090869b..ef218bc 100644
--- a/docs/connpy/services/import_export_service.html
+++ b/docs/connpy/services/import_export_service.html
@@ -48,7 +48,7 @@ el.replaceWith(d);
class ImportExportService
-(config=None)
+(config=None, enforce_context: bool = True)
-
@@ -58,6 +58,44 @@ el.replaceWith(d);
class ImportExportService(BaseService):
"""Business logic for YAML/JSON inventory import and export."""
+ def __init__(self, config=None, enforce_context: bool = True):
+ super().__init__(config)
+ self.enforce_context = bool(enforce_context)
+
+ def _get_context_service(self, cfg=None):
+ target_cfg = cfg or self.config
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(target_cfg, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(target_cfg, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(target_cfg)
+
+ def _get_raw_folders(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallfolders_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallfolders_unlocked()
+ return target_cfg._getallfolders()
+
+ def _folder_exists(self, folder_id: str, raw_folders: list[str], cfg=None) -> bool:
+ target_cfg = cfg or self.config
+ cfg_dict = getattr(target_cfg, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ if case:
+ return folder_id in raw_folders
+ return folder_id.lower() in {f.lower() for f in raw_folders}
+
def export_to_file(self, file_path, folders=None):
"""Export nodes/folders to a YAML file."""
if os.path.exists(file_path):
@@ -72,46 +110,72 @@ el.replaceWith(d);
def export_to_dict(self, folders=None):
"""Export nodes/folders to a dictionary."""
- if not folders:
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+
+ if not folders and not ctx_active:
return deepcopy(self.config.connections)
- else:
- # Validate folders exist
+
+ raw_folders = self._get_raw_folders()
+ if folders:
for f in folders:
- if f != "@" and f not in self.config._getallfolders():
+ if f != "@" and (
+ not self._folder_exists(f, raw_folders)
+ or (ctx_active and not ctx_svc.matches_active_context(f))
+ ):
raise NodeNotFoundError(f"Folder '{f}' not found.")
-
flat = self.config._getallnodesfull(folders, extract=False)
- nested = {}
- for k, v in flat.items():
- uniques = self.config._explode_unique(k)
- if not uniques:
- continue
-
- if "folder" in uniques and "subfolder" in uniques:
- f_name = uniques["folder"]
- s_name = uniques["subfolder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
- if s_name not in nested[f_name]:
- nested[f_name][s_name] = {"type": "subfolder"}
-
- nested[f_name][s_name][i_name] = v
-
- elif "folder" in uniques:
- f_name = uniques["folder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
-
- nested[f_name][i_name] = v
- else:
- i_name = uniques["id"]
- nested[i_name] = v
-
- return nested
+ allowed_folders = []
+ else:
+ allowed_folders = ctx_svc.filter_node_list(result=raw_folders)
+ flat = self.config._getallnodesfull(extract=False)
+
+ if ctx_active:
+ flat = ctx_svc.filter_node_dict(result=flat)
+
+ nested = {}
+ for folder_id in allowed_folders:
+ uniques = self.config._explode_unique(folder_id)
+ if not uniques or "folder" not in uniques:
+ continue
+ f_name = uniques["folder"]
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if "subfolder" in uniques:
+ s_name = uniques["subfolder"]
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ for k, v in flat.items():
+ uniques = self.config._explode_unique(k)
+ if not uniques:
+ continue
+
+ if "folder" in uniques and "subfolder" in uniques:
+ f_name = uniques["folder"]
+ s_name = uniques["subfolder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ nested[f_name][s_name][i_name] = v
+
+ elif "folder" in uniques:
+ f_name = uniques["folder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+
+ nested[f_name][i_name] = v
+ else:
+ i_name = uniques["id"]
+ nested[i_name] = v
+
+ return nested
def import_from_file(self, file_path):
"""Import nodes/folders from a YAML file."""
@@ -126,42 +190,94 @@ el.replaceWith(d);
raise InvalidConfigurationError(f"Failed to read/parse import file: {e}")
def import_from_dict(self, data):
- """Import nodes/folders from a dictionary."""
+ """Import nodes/folders from a dictionary atomically with context pre-validation."""
if not isinstance(data, dict):
- raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
+ raise InvalidConfigurationError(
+ "Invalid import data format: expected a dictionary of nodes."
+ )
- def _traverse_import(node_data, current_folder='', current_subfolder=''):
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+ raw_folders = self._get_raw_folders() if ctx_active else []
+ planned_ops = []
+
+ def _plan_import(node_data, current_folder="", current_subfolder=""):
for k, v in node_data.items():
- if k == "type":
+ if k == "type" or not isinstance(v, dict):
continue
- if isinstance(v, dict):
- node_type = v.get("type", "connection")
- if node_type == "folder":
- self.config._folder_add(folder=k)
- _traverse_import(v, current_folder=k, current_subfolder='')
- elif node_type == "subfolder":
- self.config._folder_add(folder=current_folder, subfolder=k)
- _traverse_import(v, current_folder=current_folder, current_subfolder=k)
- elif node_type == "connection":
- unique_id = k
- if current_subfolder:
- unique_id = f"{k}@{current_subfolder}@{current_folder}"
- elif current_folder:
- unique_id = f"{k}@{current_folder}"
- self._validate_node_name(unique_id)
-
- kwargs = deepcopy(v)
- kwargs['id'] = k
- kwargs['folder'] = current_folder
- kwargs['subfolder'] = current_subfolder
-
- self.config._connections_add(**kwargs)
- else:
- # Invalid format skip
- pass
+ node_type = v.get("type", "connection")
+ if node_type == "folder":
+ folder_id = f"@{k}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", k, ""))
+ _plan_import(v, current_folder=k, current_subfolder="")
+ elif node_type == "subfolder":
+ folder_id = f"@{k}@{current_folder}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", current_folder, k))
+ _plan_import(v, current_folder=current_folder, current_subfolder=k)
+ elif node_type == "connection":
+ unique_id = k
+ if current_subfolder:
+ unique_id = f"{k}@{current_subfolder}@{current_folder}"
+ elif current_folder:
+ unique_id = f"{k}@{current_folder}"
+ self._validate_node_name(unique_id)
+ NodeService._validate_node_payload(v)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=False)
- _traverse_import(data)
- self.config._saveconfig(self.config.file)
+ kwargs = deepcopy(v)
+ kwargs["id"] = k
+ kwargs["folder"] = current_folder
+ kwargs["subfolder"] = current_subfolder
+ planned_ops.append(("connection", kwargs))
+
+ _plan_import(data)
+
+ if _supports_transactional_update(self.config):
+ def _mut(cfg):
+ for op in planned_ops:
+ if op[0] == "folder":
+ cfg._folder_add_unlocked(folder=op[1], subfolder=op[2])
+ else:
+ cfg._connections_add_unlocked(**op[1])
+
+ self.config.transactional_update(_mut)
+ return
+
+ snap_connections = deepcopy(self.config.connections)
+ try:
+ for op in planned_ops:
+ if op[0] == "folder":
+ self.config._folder_add(folder=op[1], subfolder=op[2])
+ else:
+ self.config._connections_add(**op[1])
+ self.config._saveconfig(self.config.file)
+ except BaseException:
+ self.config.connections.clear()
+ self.config.connections.update(snap_connections)
+ raise
Business logic for YAML/JSON inventory import and export.
Initialize the service.
@@ -187,46 +303,72 @@ el.replaceWith(d);def export_to_dict(self, folders=None):
"""Export nodes/folders to a dictionary."""
- if not folders:
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+
+ if not folders and not ctx_active:
return deepcopy(self.config.connections)
- else:
- # Validate folders exist
+
+ raw_folders = self._get_raw_folders()
+ if folders:
for f in folders:
- if f != "@" and f not in self.config._getallfolders():
+ if f != "@" and (
+ not self._folder_exists(f, raw_folders)
+ or (ctx_active and not ctx_svc.matches_active_context(f))
+ ):
raise NodeNotFoundError(f"Folder '{f}' not found.")
-
flat = self.config._getallnodesfull(folders, extract=False)
- nested = {}
- for k, v in flat.items():
- uniques = self.config._explode_unique(k)
- if not uniques:
- continue
-
- if "folder" in uniques and "subfolder" in uniques:
- f_name = uniques["folder"]
- s_name = uniques["subfolder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
- if s_name not in nested[f_name]:
- nested[f_name][s_name] = {"type": "subfolder"}
-
- nested[f_name][s_name][i_name] = v
-
- elif "folder" in uniques:
- f_name = uniques["folder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
-
- nested[f_name][i_name] = v
- else:
- i_name = uniques["id"]
- nested[i_name] = v
-
- return nested
+ allowed_folders = []
+ else:
+ allowed_folders = ctx_svc.filter_node_list(result=raw_folders)
+ flat = self.config._getallnodesfull(extract=False)
+
+ if ctx_active:
+ flat = ctx_svc.filter_node_dict(result=flat)
+
+ nested = {}
+ for folder_id in allowed_folders:
+ uniques = self.config._explode_unique(folder_id)
+ if not uniques or "folder" not in uniques:
+ continue
+ f_name = uniques["folder"]
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if "subfolder" in uniques:
+ s_name = uniques["subfolder"]
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ for k, v in flat.items():
+ uniques = self.config._explode_unique(k)
+ if not uniques:
+ continue
+
+ if "folder" in uniques and "subfolder" in uniques:
+ f_name = uniques["folder"]
+ s_name = uniques["subfolder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ nested[f_name][s_name][i_name] = v
+
+ elif "folder" in uniques:
+ f_name = uniques["folder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+
+ nested[f_name][i_name] = v
+ else:
+ i_name = uniques["id"]
+ nested[i_name] = v
+
+ return nested
Export nodes/folders to a dictionary.
def import_from_dict(self, data):
- """Import nodes/folders from a dictionary."""
+ """Import nodes/folders from a dictionary atomically with context pre-validation."""
if not isinstance(data, dict):
- raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
+ raise InvalidConfigurationError(
+ "Invalid import data format: expected a dictionary of nodes."
+ )
- def _traverse_import(node_data, current_folder='', current_subfolder=''):
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+ raw_folders = self._get_raw_folders() if ctx_active else []
+ planned_ops = []
+
+ def _plan_import(node_data, current_folder="", current_subfolder=""):
for k, v in node_data.items():
- if k == "type":
+ if k == "type" or not isinstance(v, dict):
continue
- if isinstance(v, dict):
- node_type = v.get("type", "connection")
- if node_type == "folder":
- self.config._folder_add(folder=k)
- _traverse_import(v, current_folder=k, current_subfolder='')
- elif node_type == "subfolder":
- self.config._folder_add(folder=current_folder, subfolder=k)
- _traverse_import(v, current_folder=current_folder, current_subfolder=k)
- elif node_type == "connection":
- unique_id = k
- if current_subfolder:
- unique_id = f"{k}@{current_subfolder}@{current_folder}"
- elif current_folder:
- unique_id = f"{k}@{current_folder}"
- self._validate_node_name(unique_id)
-
- kwargs = deepcopy(v)
- kwargs['id'] = k
- kwargs['folder'] = current_folder
- kwargs['subfolder'] = current_subfolder
-
- self.config._connections_add(**kwargs)
- else:
- # Invalid format skip
- pass
+ node_type = v.get("type", "connection")
+ if node_type == "folder":
+ folder_id = f"@{k}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", k, ""))
+ _plan_import(v, current_folder=k, current_subfolder="")
+ elif node_type == "subfolder":
+ folder_id = f"@{k}@{current_folder}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", current_folder, k))
+ _plan_import(v, current_folder=current_folder, current_subfolder=k)
+ elif node_type == "connection":
+ unique_id = k
+ if current_subfolder:
+ unique_id = f"{k}@{current_subfolder}@{current_folder}"
+ elif current_folder:
+ unique_id = f"{k}@{current_folder}"
+ self._validate_node_name(unique_id)
+ NodeService._validate_node_payload(v)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=False)
- _traverse_import(data)
- self.config._saveconfig(self.config.file)
+ kwargs = deepcopy(v)
+ kwargs["id"] = k
+ kwargs["folder"] = current_folder
+ kwargs["subfolder"] = current_subfolder
+ planned_ops.append(("connection", kwargs))
+
+ _plan_import(data)
+
+ if _supports_transactional_update(self.config):
+ def _mut(cfg):
+ for op in planned_ops:
+ if op[0] == "folder":
+ cfg._folder_add_unlocked(folder=op[1], subfolder=op[2])
+ else:
+ cfg._connections_add_unlocked(**op[1])
+
+ self.config.transactional_update(_mut)
+ return
+
+ snap_connections = deepcopy(self.config.connections)
+ try:
+ for op in planned_ops:
+ if op[0] == "folder":
+ self.config._folder_add(folder=op[1], subfolder=op[2])
+ else:
+ self.config._connections_add(**op[1])
+ self.config._saveconfig(self.config.file)
+ except BaseException:
+ self.config.connections.clear()
+ self.config.connections.update(snap_connections)
+ raise
-Import nodes/folders from a dictionary.
Import nodes/folders from a dictionary atomically with context pre-validation.
def import_from_file(self, file_path)
diff --git a/docs/connpy/services/index.html b/docs/connpy/services/index.html
index 894d3ef..aadbb88 100644
--- a/docs/connpy/services/index.html
+++ b/docs/connpy/services/index.html
@@ -1288,7 +1288,7 @@ el.replaceWith(d);
class ExecutionService
-(config=None, remote_stub=None, attempt_tracker=None)
+(config=None, remote_stub=None, attempt_tracker=None, enforce_context: bool = True)
-
@@ -1298,14 +1298,33 @@ el.replaceWith(d);
class ExecutionService(BaseService):
"""Business logic for executing commands on nodes and running automation scripts."""
- def __init__(self, config=None, remote_stub=None, attempt_tracker=None):
+ def __init__(
+ self,
+ config=None,
+ remote_stub=None,
+ attempt_tracker=None,
+ enforce_context: bool = True,
+ ):
super().__init__(config)
self.remote_stub = remote_stub
self.attempt_tracker = (
attempt_tracker if attempt_tracker is not None else AuthAttemptTracker()
)
+ self.enforce_context = bool(enforce_context)
self.last_fallback_used: dict[str, bool] = {}
+ def _get_context_service(self):
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(self.config, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(self.config, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(self.config)
+
def _is_remote_backend(self) -> bool:
"""Return True when execution is configured to run against a remote gRPC backend."""
if getattr(self, "remote_stub", None) is not None:
@@ -1324,10 +1343,7 @@ el.replaceWith(d);
"connect_timeout and auth_timeout overrides are not supported in remote gRPC mode"
)
- def _get_remote_stub(self):
- """Return the configured or lazily constructed ExecutionStub for remote gRPC mode."""
- if getattr(self, "remote_stub", None) is not None:
- return self.remote_stub
+ def _get_remote_channel(self):
cfg = getattr(self.config, "config", None)
remote_host = cfg.get("remote_host") if isinstance(cfg, dict) else None
if not remote_host:
@@ -1335,7 +1351,7 @@ el.replaceWith(d);
import grpc
- from connpy.grpc_layer.stubs import AuthClientInterceptor, ExecutionStub
+ from connpy.grpc_layer.stubs import AuthClientInterceptor
def get_token():
env_token = os.environ.get("CONNPY_TOKEN")
@@ -1351,8 +1367,81 @@ el.replaceWith(d);
channel = grpc.insecure_channel(remote_host)
channel = grpc.intercept_channel(channel, AuthClientInterceptor(get_token))
+ return channel, remote_host
+
+ def _get_remote_stub(self):
+ """Return the configured or lazily constructed ExecutionStub for remote gRPC mode."""
+ if getattr(self, "remote_stub", None) is not None:
+ return self.remote_stub
+ from connpy.grpc_layer.stubs import ExecutionStub
+
+ channel, remote_host = self._get_remote_channel()
return ExecutionStub(channel, remote_host=remote_host)
+ def _filter_remote_nodes_filter(self, nodes_filter):
+ ctx_svc = self._get_context_service()
+ if ctx_svc is None or ctx_svc.is_default_all_context():
+ return nodes_filter
+
+ if isinstance(nodes_filter, (list, tuple)):
+ permitted = ctx_svc.filter_node_list(result=list(nodes_filter))
+ else:
+ if self.remote_stub is not None and callable(
+ getattr(self.remote_stub, "list_nodes", None)
+ ):
+ candidates = self.remote_stub.list_nodes(filter_str=nodes_filter)
+ elif self.remote_stub is not None and callable(
+ getattr(getattr(self.remote_stub, "node_stub", None), "list_nodes", None)
+ ):
+ candidates = self.remote_stub.node_stub.list_nodes(filter_str=nodes_filter)
+ elif self.remote_stub is None:
+ from connpy.grpc_layer.stubs import NodeStub
+
+ channel, remote_host = self._get_remote_channel()
+ node_stub = NodeStub(channel, remote_host=remote_host, config=self.config)
+ candidates = node_stub.list_nodes(filter_str=nodes_filter)
+ else:
+ candidates = (
+ self.config._getallnodes(nodes_filter)
+ if hasattr(self.config, "_getallnodes")
+ else []
+ )
+ if nodes_filter:
+ cfg_dict = getattr(self.config, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ flags = 0 if case else re.IGNORECASE
+ candidates = [c for c in candidates if re.search(nodes_filter, c, flags)]
+ permitted = ctx_svc.filter_node_list(result=candidates)
+
+ if not permitted:
+ raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
+ return [f"^{re.escape(n)}$" for n in permitted]
+
+ def _build_remote_filter_batches(self, nodes_filter):
+ filtered = self._filter_remote_nodes_filter(nodes_filter)
+ if isinstance(filtered, list):
+ return [
+ filtered[i : i + MAX_REMOTE_FILTER_NODES]
+ for i in range(0, len(filtered), MAX_REMOTE_FILTER_NODES)
+ ]
+ return [filtered]
+
+ @staticmethod
+ def _aggregate_remote_results(batch_results):
+ if len(batch_results) == 1:
+ return batch_results[0]
+ if all(isinstance(r, dict) for r in batch_results):
+ merged: dict[str, Any] = {}
+ for r in batch_results:
+ merged.update(r)
+ return merged
+ if all(isinstance(r, list) for r in batch_results):
+ merged_list: list[Any] = []
+ for r in batch_results:
+ merged_list.extend(r)
+ return merged_list
+ return batch_results[-1]
+
def run_commands(
self,
nodes_filter: str,
@@ -1376,21 +1465,29 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.run_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder,
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.run_commands(
+ nodes_filter=batch,
+ commands=commands,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder,
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -1464,22 +1561,30 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.test_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- expected=expected,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder or "",
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.test_commands(
+ nodes_filter=batch,
+ commands=commands,
+ expected=expected,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder or "",
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -1601,21 +1706,29 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.run_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder,
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.run_commands(
+ nodes_filter=batch,
+ commands=commands,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder,
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -1699,22 +1812,30 @@ el.replaceWith(d);
)
if self._is_remote_backend():
+ batches = self._build_remote_filter_batches(nodes_filter)
stub = self._get_remote_stub()
- return stub.test_commands(
- nodes_filter=nodes_filter,
- commands=commands,
- expected=expected,
- variables=variables,
- parallel=parallel,
- timeout=timeout if timeout is not None else 20,
- folder=folder or "",
- prompt=prompt,
- on_node_complete=on_node_complete,
- logger=logger,
- name=name or "",
- )
+ batch_results = [
+ stub.test_commands(
+ nodes_filter=batch,
+ commands=commands,
+ expected=expected,
+ variables=variables,
+ parallel=parallel,
+ timeout=timeout if timeout is not None else 20,
+ folder=folder or "",
+ prompt=prompt,
+ on_node_complete=on_node_complete,
+ logger=logger,
+ name=name or "",
+ )
+ for batch in batches
+ ]
+ return self._aggregate_remote_results(batch_results)
matched_names = self.config._getallnodes(nodes_filter)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ matched_names = ctx_svc.filter_node_list(result=matched_names)
if not matched_names:
raise ConnpyError(f"No nodes found matching filter: {nodes_filter}")
@@ -1769,7 +1890,7 @@ el.replaceWith(d);
class ImportExportService
-(config=None)
+(config=None, enforce_context: bool = True)
-
@@ -1779,6 +1900,44 @@ el.replaceWith(d);
class ImportExportService(BaseService):
"""Business logic for YAML/JSON inventory import and export."""
+ def __init__(self, config=None, enforce_context: bool = True):
+ super().__init__(config)
+ self.enforce_context = bool(enforce_context)
+
+ def _get_context_service(self, cfg=None):
+ target_cfg = cfg or self.config
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(target_cfg, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(target_cfg, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(target_cfg)
+
+ def _get_raw_folders(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallfolders_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallfolders_unlocked()
+ return target_cfg._getallfolders()
+
+ def _folder_exists(self, folder_id: str, raw_folders: list[str], cfg=None) -> bool:
+ target_cfg = cfg or self.config
+ cfg_dict = getattr(target_cfg, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ if case:
+ return folder_id in raw_folders
+ return folder_id.lower() in {f.lower() for f in raw_folders}
+
def export_to_file(self, file_path, folders=None):
"""Export nodes/folders to a YAML file."""
if os.path.exists(file_path):
@@ -1793,46 +1952,72 @@ el.replaceWith(d);
def export_to_dict(self, folders=None):
"""Export nodes/folders to a dictionary."""
- if not folders:
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+
+ if not folders and not ctx_active:
return deepcopy(self.config.connections)
- else:
- # Validate folders exist
+
+ raw_folders = self._get_raw_folders()
+ if folders:
for f in folders:
- if f != "@" and f not in self.config._getallfolders():
+ if f != "@" and (
+ not self._folder_exists(f, raw_folders)
+ or (ctx_active and not ctx_svc.matches_active_context(f))
+ ):
raise NodeNotFoundError(f"Folder '{f}' not found.")
-
flat = self.config._getallnodesfull(folders, extract=False)
- nested = {}
- for k, v in flat.items():
- uniques = self.config._explode_unique(k)
- if not uniques:
- continue
-
- if "folder" in uniques and "subfolder" in uniques:
- f_name = uniques["folder"]
- s_name = uniques["subfolder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
- if s_name not in nested[f_name]:
- nested[f_name][s_name] = {"type": "subfolder"}
-
- nested[f_name][s_name][i_name] = v
-
- elif "folder" in uniques:
- f_name = uniques["folder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
-
- nested[f_name][i_name] = v
- else:
- i_name = uniques["id"]
- nested[i_name] = v
-
- return nested
+ allowed_folders = []
+ else:
+ allowed_folders = ctx_svc.filter_node_list(result=raw_folders)
+ flat = self.config._getallnodesfull(extract=False)
+
+ if ctx_active:
+ flat = ctx_svc.filter_node_dict(result=flat)
+
+ nested = {}
+ for folder_id in allowed_folders:
+ uniques = self.config._explode_unique(folder_id)
+ if not uniques or "folder" not in uniques:
+ continue
+ f_name = uniques["folder"]
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if "subfolder" in uniques:
+ s_name = uniques["subfolder"]
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ for k, v in flat.items():
+ uniques = self.config._explode_unique(k)
+ if not uniques:
+ continue
+
+ if "folder" in uniques and "subfolder" in uniques:
+ f_name = uniques["folder"]
+ s_name = uniques["subfolder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ nested[f_name][s_name][i_name] = v
+
+ elif "folder" in uniques:
+ f_name = uniques["folder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+
+ nested[f_name][i_name] = v
+ else:
+ i_name = uniques["id"]
+ nested[i_name] = v
+
+ return nested
def import_from_file(self, file_path):
"""Import nodes/folders from a YAML file."""
@@ -1847,42 +2032,94 @@ el.replaceWith(d);
raise InvalidConfigurationError(f"Failed to read/parse import file: {e}")
def import_from_dict(self, data):
- """Import nodes/folders from a dictionary."""
+ """Import nodes/folders from a dictionary atomically with context pre-validation."""
if not isinstance(data, dict):
- raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
+ raise InvalidConfigurationError(
+ "Invalid import data format: expected a dictionary of nodes."
+ )
- def _traverse_import(node_data, current_folder='', current_subfolder=''):
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+ raw_folders = self._get_raw_folders() if ctx_active else []
+ planned_ops = []
+
+ def _plan_import(node_data, current_folder="", current_subfolder=""):
for k, v in node_data.items():
- if k == "type":
+ if k == "type" or not isinstance(v, dict):
continue
- if isinstance(v, dict):
- node_type = v.get("type", "connection")
- if node_type == "folder":
- self.config._folder_add(folder=k)
- _traverse_import(v, current_folder=k, current_subfolder='')
- elif node_type == "subfolder":
- self.config._folder_add(folder=current_folder, subfolder=k)
- _traverse_import(v, current_folder=current_folder, current_subfolder=k)
- elif node_type == "connection":
- unique_id = k
- if current_subfolder:
- unique_id = f"{k}@{current_subfolder}@{current_folder}"
- elif current_folder:
- unique_id = f"{k}@{current_folder}"
- self._validate_node_name(unique_id)
-
- kwargs = deepcopy(v)
- kwargs['id'] = k
- kwargs['folder'] = current_folder
- kwargs['subfolder'] = current_subfolder
-
- self.config._connections_add(**kwargs)
- else:
- # Invalid format skip
- pass
+ node_type = v.get("type", "connection")
+ if node_type == "folder":
+ folder_id = f"@{k}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", k, ""))
+ _plan_import(v, current_folder=k, current_subfolder="")
+ elif node_type == "subfolder":
+ folder_id = f"@{k}@{current_folder}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", current_folder, k))
+ _plan_import(v, current_folder=current_folder, current_subfolder=k)
+ elif node_type == "connection":
+ unique_id = k
+ if current_subfolder:
+ unique_id = f"{k}@{current_subfolder}@{current_folder}"
+ elif current_folder:
+ unique_id = f"{k}@{current_folder}"
+ self._validate_node_name(unique_id)
+ NodeService._validate_node_payload(v)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=False)
- _traverse_import(data)
- self.config._saveconfig(self.config.file)
+ kwargs = deepcopy(v)
+ kwargs["id"] = k
+ kwargs["folder"] = current_folder
+ kwargs["subfolder"] = current_subfolder
+ planned_ops.append(("connection", kwargs))
+
+ _plan_import(data)
+
+ if _supports_transactional_update(self.config):
+ def _mut(cfg):
+ for op in planned_ops:
+ if op[0] == "folder":
+ cfg._folder_add_unlocked(folder=op[1], subfolder=op[2])
+ else:
+ cfg._connections_add_unlocked(**op[1])
+
+ self.config.transactional_update(_mut)
+ return
+
+ snap_connections = deepcopy(self.config.connections)
+ try:
+ for op in planned_ops:
+ if op[0] == "folder":
+ self.config._folder_add(folder=op[1], subfolder=op[2])
+ else:
+ self.config._connections_add(**op[1])
+ self.config._saveconfig(self.config.file)
+ except BaseException:
+ self.config.connections.clear()
+ self.config.connections.update(snap_connections)
+ raise
Business logic for YAML/JSON inventory import and export.
Initialize the service.
@@ -1908,46 +2145,72 @@ el.replaceWith(d);def export_to_dict(self, folders=None):
"""Export nodes/folders to a dictionary."""
- if not folders:
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+
+ if not folders and not ctx_active:
return deepcopy(self.config.connections)
- else:
- # Validate folders exist
+
+ raw_folders = self._get_raw_folders()
+ if folders:
for f in folders:
- if f != "@" and f not in self.config._getallfolders():
+ if f != "@" and (
+ not self._folder_exists(f, raw_folders)
+ or (ctx_active and not ctx_svc.matches_active_context(f))
+ ):
raise NodeNotFoundError(f"Folder '{f}' not found.")
-
flat = self.config._getallnodesfull(folders, extract=False)
- nested = {}
- for k, v in flat.items():
- uniques = self.config._explode_unique(k)
- if not uniques:
- continue
-
- if "folder" in uniques and "subfolder" in uniques:
- f_name = uniques["folder"]
- s_name = uniques["subfolder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
- if s_name not in nested[f_name]:
- nested[f_name][s_name] = {"type": "subfolder"}
-
- nested[f_name][s_name][i_name] = v
-
- elif "folder" in uniques:
- f_name = uniques["folder"]
- i_name = uniques["id"]
-
- if f_name not in nested:
- nested[f_name] = {"type": "folder"}
-
- nested[f_name][i_name] = v
- else:
- i_name = uniques["id"]
- nested[i_name] = v
-
- return nested
+ allowed_folders = []
+ else:
+ allowed_folders = ctx_svc.filter_node_list(result=raw_folders)
+ flat = self.config._getallnodesfull(extract=False)
+
+ if ctx_active:
+ flat = ctx_svc.filter_node_dict(result=flat)
+
+ nested = {}
+ for folder_id in allowed_folders:
+ uniques = self.config._explode_unique(folder_id)
+ if not uniques or "folder" not in uniques:
+ continue
+ f_name = uniques["folder"]
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if "subfolder" in uniques:
+ s_name = uniques["subfolder"]
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ for k, v in flat.items():
+ uniques = self.config._explode_unique(k)
+ if not uniques:
+ continue
+
+ if "folder" in uniques and "subfolder" in uniques:
+ f_name = uniques["folder"]
+ s_name = uniques["subfolder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+ if s_name not in nested[f_name]:
+ nested[f_name][s_name] = {"type": "subfolder"}
+
+ nested[f_name][s_name][i_name] = v
+
+ elif "folder" in uniques:
+ f_name = uniques["folder"]
+ i_name = uniques["id"]
+
+ if f_name not in nested:
+ nested[f_name] = {"type": "folder"}
+
+ nested[f_name][i_name] = v
+ else:
+ i_name = uniques["id"]
+ nested[i_name] = v
+
+ return nested
Export nodes/folders to a dictionary.
def import_from_dict(self, data):
- """Import nodes/folders from a dictionary."""
+ """Import nodes/folders from a dictionary atomically with context pre-validation."""
if not isinstance(data, dict):
- raise InvalidConfigurationError("Invalid import data format: expected a dictionary of nodes.")
+ raise InvalidConfigurationError(
+ "Invalid import data format: expected a dictionary of nodes."
+ )
- def _traverse_import(node_data, current_folder='', current_subfolder=''):
+ ctx_svc = self._get_context_service()
+ ctx_active = ctx_svc is not None and not ctx_svc.is_default_all_context()
+ raw_folders = self._get_raw_folders() if ctx_active else []
+ planned_ops = []
+
+ def _plan_import(node_data, current_folder="", current_subfolder=""):
for k, v in node_data.items():
- if k == "type":
+ if k == "type" or not isinstance(v, dict):
continue
- if isinstance(v, dict):
- node_type = v.get("type", "connection")
- if node_type == "folder":
- self.config._folder_add(folder=k)
- _traverse_import(v, current_folder=k, current_subfolder='')
- elif node_type == "subfolder":
- self.config._folder_add(folder=current_folder, subfolder=k)
- _traverse_import(v, current_folder=current_folder, current_subfolder=k)
- elif node_type == "connection":
- unique_id = k
- if current_subfolder:
- unique_id = f"{k}@{current_subfolder}@{current_folder}"
- elif current_folder:
- unique_id = f"{k}@{current_folder}"
- self._validate_node_name(unique_id)
-
- kwargs = deepcopy(v)
- kwargs['id'] = k
- kwargs['folder'] = current_folder
- kwargs['subfolder'] = current_subfolder
-
- self.config._connections_add(**kwargs)
- else:
- # Invalid format skip
- pass
+ node_type = v.get("type", "connection")
+ if node_type == "folder":
+ folder_id = f"@{k}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", k, ""))
+ _plan_import(v, current_folder=k, current_subfolder="")
+ elif node_type == "subfolder":
+ folder_id = f"@{k}@{current_folder}"
+ has_children = any(
+ isinstance(cv, dict) for ck, cv in v.items() if ck != "type"
+ )
+ if ctx_active and (
+ not has_children
+ or (
+ not ctx_svc.matches_active_context(folder_id)
+ and not self._folder_exists(folder_id, raw_folders)
+ )
+ ):
+ ctx_svc.validate_in_active_context(folder_id, is_folder=True)
+ planned_ops.append(("folder", current_folder, k))
+ _plan_import(v, current_folder=current_folder, current_subfolder=k)
+ elif node_type == "connection":
+ unique_id = k
+ if current_subfolder:
+ unique_id = f"{k}@{current_subfolder}@{current_folder}"
+ elif current_folder:
+ unique_id = f"{k}@{current_folder}"
+ self._validate_node_name(unique_id)
+ NodeService._validate_node_payload(v)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=False)
- _traverse_import(data)
- self.config._saveconfig(self.config.file)
+ kwargs = deepcopy(v)
+ kwargs["id"] = k
+ kwargs["folder"] = current_folder
+ kwargs["subfolder"] = current_subfolder
+ planned_ops.append(("connection", kwargs))
+
+ _plan_import(data)
+
+ if _supports_transactional_update(self.config):
+ def _mut(cfg):
+ for op in planned_ops:
+ if op[0] == "folder":
+ cfg._folder_add_unlocked(folder=op[1], subfolder=op[2])
+ else:
+ cfg._connections_add_unlocked(**op[1])
+
+ self.config.transactional_update(_mut)
+ return
+
+ snap_connections = deepcopy(self.config.connections)
+ try:
+ for op in planned_ops:
+ if op[0] == "folder":
+ self.config._folder_add(folder=op[1], subfolder=op[2])
+ else:
+ self.config._connections_add(**op[1])
+ self.config._saveconfig(self.config.file)
+ except BaseException:
+ self.config.connections.clear()
+ self.config.connections.update(snap_connections)
+ raise
-Import nodes/folders from a dictionary.
Import nodes/folders from a dictionary atomically with context pre-validation.
def import_from_file(self, file_path)
@@ -2118,7 +2433,7 @@ el.replaceWith(d);
class NodeService
-(config=None)
+(config=None, enforce_context: bool = True)
-
@@ -2143,8 +2458,104 @@ el.replaceWith(d);
"type",
})
- def __init__(self, config=None):
+ def __init__(self, config=None, enforce_context: bool = True):
super().__init__(config)
+ self.enforce_context = bool(enforce_context)
+
+ def _get_context_service(self, cfg=None):
+ target_cfg = cfg or self.config
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(target_cfg, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(target_cfg, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(target_cfg)
+
+ def _get_raw_folders(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallfolders_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallfolders_unlocked()
+ return target_cfg._getallfolders()
+
+ def _get_raw_nodes(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallnodes_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallnodes_unlocked()
+ return target_cfg._getallnodes()
+
+ def _derive_parent_folder(self, cfg, unique_id: str, is_folder: bool) -> str | None:
+ explode_fn = (
+ cfg._explode_unique_unlocked
+ if (
+ not hasattr(cfg, "assert_called")
+ and callable(getattr(cfg, "_explode_unique_unlocked", None))
+ )
+ else cfg._explode_unique
+ )
+ uniques = explode_fn(unique_id)
+ if is_folder:
+ if (
+ not isinstance(unique_id, str)
+ or not unique_id.startswith("@")
+ or not isinstance(uniques, dict)
+ or "folder" not in uniques
+ ):
+ raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
+ if "subfolder" in uniques:
+ return f"@{uniques['folder']}"
+ return None
+ if (
+ not isinstance(unique_id, str)
+ or unique_id.startswith("@")
+ or not isinstance(uniques, dict)
+ or not uniques.get("id")
+ ):
+ raise InvalidConfigurationError(f"Invalid node name '{unique_id}'.")
+ if "subfolder" in uniques and "folder" in uniques:
+ return f"@{uniques['subfolder']}@{uniques['folder']}"
+ if "folder" in uniques:
+ return f"@{uniques['folder']}"
+ return None
+
+ def _folder_exists(self, parent_folder: str, raw_folders: list[str], cfg=None) -> bool:
+ target_cfg = cfg or self.config
+ cfg_dict = getattr(target_cfg, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ if case:
+ return parent_folder in raw_folders
+ return parent_folder.lower() in {f.lower() for f in raw_folders}
+
+ def _ensure_in_active_context(
+ self, unique_id: str, *, is_folder: bool = False, not_found_msg: str | None = None
+ ) -> None:
+ ctx_svc = self._get_context_service()
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(unique_id)
+ ):
+ if not_found_msg is not None:
+ raise NodeNotFoundError(not_found_msg)
+ label = "Folder" if is_folder else "Node"
+ raise NodeNotFoundError(f"{label} '{unique_id}' not found.")
@staticmethod
def _validate_node_payload(data):
@@ -2182,7 +2593,11 @@ el.replaceWith(d);
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)]
-
+
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+
if not format_str:
return nodes
@@ -2239,10 +2654,14 @@ el.replaceWith(d);
else:
flags = re.IGNORECASE if not case_sensitive else 0
folders = [f for f in folders if re.search(filter_str, f, flags)]
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
return folders
def get_node_details(self, unique_id):
"""Return full configuration dictionary for a specific node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
try:
details = self.config.getitem(unique_id)
if not details:
@@ -2260,50 +2679,45 @@ el.replaceWith(d);
self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)
def validate_parent_folder(self, unique_id, is_folder=False):
- """Check if parent folder exists for a given node unique ID."""
- if is_folder:
- uniques = self.config._explode_unique(unique_id)
- if uniques and "subfolder" in uniques and "folder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in self.config._getallfolders():
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
- else:
- 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.")
-
+ """Check if unique_id is in active context and its parent folder exists."""
+ parent_folder = self._derive_parent_folder(self.config, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, self._get_raw_folders(), self.config
+ ):
+ 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)
self._validate_node_payload(data)
+ self.validate_parent_folder(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config):
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
all_folders = cfg._getallfolders_unlocked()
+ parent_folder = self._derive_parent_folder(cfg, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service(cfg)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if is_folder:
if unique_id in all_folders:
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
uniques = cfg._explode_unique_unlocked(unique_id)
if not uniques:
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
- if "subfolder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
cfg._folder_add_unlocked(**uniques)
else:
if unique_id in all_nodes:
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
- node_folder = unique_id.partition("@")[2]
- if node_folder:
- parent_folder = f"@{node_folder}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
payload = deepcopy(data)
if "id" not in payload:
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -2360,6 +2774,7 @@ el.replaceWith(d);
def update_node(self, unique_id, data, save=True):
"""Explicitly update an existing node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
@@ -2386,6 +2801,7 @@ el.replaceWith(d);
def delete_node(self, unique_id, is_folder=False, save=True):
"""Logic for deleting a node or folder."""
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -2416,6 +2832,7 @@ el.replaceWith(d);
def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
"""Interact with a node directly."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
from connpy.core import node
from ..auth_utils import resolve_fallback_entries
@@ -2452,10 +2869,28 @@ el.replaceWith(d);
def move_node(self, src_id, dst_id, copy=False):
"""Move or copy a node."""
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
self._validate_node_name(dst_id)
+ self.validate_parent_folder(dst_id, is_folder=False)
if _supports_transactional_update(self.config):
def _mut(cfg):
+ ctx_svc = self._get_context_service(cfg)
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(src_id)
+ ):
+ raise NodeNotFoundError(f"Source node '{src_id}' not found.")
+ parent_folder = self._derive_parent_folder(cfg, dst_id, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, cfg._getallfolders_unlocked(), cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
try:
node_data = cfg.getitem_unlocked(src_id)
except (KeyError, TypeError):
@@ -2502,12 +2937,23 @@ el.replaceWith(d);
def bulk_add(self, ids, hosts, common_data):
"""Add multiple nodes with shared common configuration."""
self._validate_node_payload(common_data)
+ for uid in ids:
+ self.validate_parent_folder(uid, is_folder=False)
if _supports_transactional_update(self.config):
def _build_entries(cfg):
all_nodes = cfg._getallnodes_unlocked()
+ all_folders = cfg._getallfolders_unlocked()
+ ctx_svc = self._get_context_service(cfg)
planned = []
for i, uid in enumerate(ids):
+ parent_folder = self._derive_parent_folder(cfg, uid, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if uid in all_nodes:
continue
try:
@@ -2625,30 +3071,30 @@ el.replaceWith(d);
if not is_folder:
self._validate_node_name(unique_id)
self._validate_node_payload(data)
+ self.validate_parent_folder(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config):
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
all_folders = cfg._getallfolders_unlocked()
+ parent_folder = self._derive_parent_folder(cfg, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service(cfg)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if is_folder:
if unique_id in all_folders:
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
uniques = cfg._explode_unique_unlocked(unique_id)
if not uniques:
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
- if "subfolder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
cfg._folder_add_unlocked(**uniques)
else:
if unique_id in all_nodes:
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
- node_folder = unique_id.partition("@")[2]
- if node_folder:
- parent_folder = f"@{node_folder}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
payload = deepcopy(data)
if "id" not in payload:
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -2702,12 +3148,23 @@ el.replaceWith(d);
def bulk_add(self, ids, hosts, common_data):
"""Add multiple nodes with shared common configuration."""
self._validate_node_payload(common_data)
+ for uid in ids:
+ self.validate_parent_folder(uid, is_folder=False)
if _supports_transactional_update(self.config):
def _build_entries(cfg):
all_nodes = cfg._getallnodes_unlocked()
+ all_folders = cfg._getallfolders_unlocked()
+ ctx_svc = self._get_context_service(cfg)
planned = []
for i, uid in enumerate(ids):
+ parent_folder = self._derive_parent_folder(cfg, uid, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if uid in all_nodes:
continue
try:
@@ -2782,6 +3239,7 @@ el.replaceWith(d);
def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
"""Interact with a node directly."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
from connpy.core import node
from ..auth_utils import resolve_fallback_entries
@@ -2828,6 +3286,7 @@ el.replaceWith(d);
def delete_node(self, unique_id, is_folder=False, save=True):
"""Logic for deleting a node or folder."""
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -2944,6 +3403,7 @@ el.replaceWith(d);
def get_node_details(self, unique_id):
"""Return full configuration dictionary for a specific node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
try:
details = self.config.getitem(unique_id)
if not details:
@@ -2976,6 +3436,9 @@ el.replaceWith(d);
else:
flags = re.IGNORECASE if not case_sensitive else 0
folders = [f for f in folders if re.search(filter_str, f, flags)]
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
return folders
Return all unique folders, optionally filtered by regex.
@@ -2996,7 +3459,11 @@ el.replaceWith(d);
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)]
-
+
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+
if not format_str:
return nodes
@@ -3051,10 +3518,28 @@ el.replaceWith(d);
def move_node(self, src_id, dst_id, copy=False):
"""Move or copy a node."""
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
self._validate_node_name(dst_id)
+ self.validate_parent_folder(dst_id, is_folder=False)
if _supports_transactional_update(self.config):
def _mut(cfg):
+ ctx_svc = self._get_context_service(cfg)
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(src_id)
+ ):
+ raise NodeNotFoundError(f"Source node '{src_id}' not found.")
+ parent_folder = self._derive_parent_folder(cfg, dst_id, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, cfg._getallfolders_unlocked(), cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
try:
node_data = cfg.getitem_unlocked(src_id)
except (KeyError, TypeError):
@@ -3110,6 +3595,7 @@ el.replaceWith(d);
def update_node(self, unique_id, data, save=True):
"""Explicitly update an existing node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
@@ -3145,21 +3631,17 @@ el.replaceWith(d);
Expand source code
def validate_parent_folder(self, unique_id, is_folder=False):
- """Check if parent folder exists for a given node unique ID."""
- if is_folder:
- uniques = self.config._explode_unique(unique_id)
- if uniques and "subfolder" in uniques and "folder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in self.config._getallfolders():
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
- else:
- 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.")
+ """Check if unique_id is in active context and its parent folder exists."""
+ parent_folder = self._derive_parent_folder(self.config, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, self._get_raw_folders(), self.config
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
-Check if parent folder exists for a given node unique ID.
+Check if unique_id is in active context and its parent folder exists.
Inherited members
@@ -4102,18 +4584,13 @@ el.replaceWith(d);
resolved = deepcopy(node_data)
auth_referenced_profiles = []
- other_referenced_profiles = []
- for key, value in resolved.items():
- if key == "fallback":
- continue
- target_refs = (
- auth_referenced_profiles if key in ("user", "password") else other_referenced_profiles
- )
+ for key in ("user", "password"):
+ value = resolved.get(key)
if isinstance(value, str):
if not is_compose_expression(value) and value.startswith("@"):
ref = value[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
elif isinstance(value, (list, tuple)):
for item in value:
if (
@@ -4123,7 +4600,7 @@ el.replaceWith(d);
):
ref = item[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
def _get_resolved_ref(prof_name):
if prof_name in _visited or _depth >= MAX_PROFILE_DEPTH:
@@ -4188,15 +4665,16 @@ el.replaceWith(d);
resolved_list.append(item)
resolved[key] = resolved_list
- ordered_profiles = list(dict.fromkeys(auth_referenced_profiles + other_referenced_profiles))
- for base_profile_name in ordered_profiles:
+ dedup_auth_profiles = list(dict.fromkeys(auth_referenced_profiles))
+ for base_profile_name in dedup_auth_profiles:
with suppress(ProfileNotFoundError):
base_profile = _get_resolved_ref(base_profile_name)
- for key, value in base_profile.items():
- if (key not in resolved or resolved[key] in ("", [], None)) and (
- value not in ("", [], None) or key not in resolved
- ):
- resolved[key] = deepcopy(value)
+ for key in ("user", "password", "fallback"):
+ val = base_profile.get(key)
+ if (
+ key not in resolved or resolved[key] in ("", [], None)
+ ) and val not in ("", [], None):
+ resolved[key] = deepcopy(val)
if resolved.get("protocol") in ("", None):
try:
@@ -4429,18 +4907,13 @@ el.replaceWith(d);
resolved = deepcopy(node_data)
auth_referenced_profiles = []
- other_referenced_profiles = []
- for key, value in resolved.items():
- if key == "fallback":
- continue
- target_refs = (
- auth_referenced_profiles if key in ("user", "password") else other_referenced_profiles
- )
+ for key in ("user", "password"):
+ value = resolved.get(key)
if isinstance(value, str):
if not is_compose_expression(value) and value.startswith("@"):
ref = value[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
elif isinstance(value, (list, tuple)):
for item in value:
if (
@@ -4450,7 +4923,7 @@ el.replaceWith(d);
):
ref = item[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
def _get_resolved_ref(prof_name):
if prof_name in _visited or _depth >= MAX_PROFILE_DEPTH:
@@ -4515,15 +4988,16 @@ el.replaceWith(d);
resolved_list.append(item)
resolved[key] = resolved_list
- ordered_profiles = list(dict.fromkeys(auth_referenced_profiles + other_referenced_profiles))
- for base_profile_name in ordered_profiles:
+ dedup_auth_profiles = list(dict.fromkeys(auth_referenced_profiles))
+ for base_profile_name in dedup_auth_profiles:
with suppress(ProfileNotFoundError):
base_profile = _get_resolved_ref(base_profile_name)
- for key, value in base_profile.items():
- if (key not in resolved or resolved[key] in ("", [], None)) and (
- value not in ("", [], None) or key not in resolved
- ):
- resolved[key] = deepcopy(value)
+ for key in ("user", "password", "fallback"):
+ val = base_profile.get(key)
+ if (
+ key not in resolved or resolved[key] in ("", [], None)
+ ) and val not in ("", [], None):
+ resolved[key] = deepcopy(val)
if resolved.get("protocol") in ("", None):
try:
diff --git a/docs/connpy/services/node_service.html b/docs/connpy/services/node_service.html
index ca3182f..aa2eb79 100644
--- a/docs/connpy/services/node_service.html
+++ b/docs/connpy/services/node_service.html
@@ -48,7 +48,7 @@ el.replaceWith(d);
class NodeService
-(config=None)
+(config=None, enforce_context: bool = True)
-
@@ -73,8 +73,104 @@ el.replaceWith(d);
"type",
})
- def __init__(self, config=None):
+ def __init__(self, config=None, enforce_context: bool = True):
super().__init__(config)
+ self.enforce_context = bool(enforce_context)
+
+ def _get_context_service(self, cfg=None):
+ target_cfg = cfg or self.config
+ if (
+ not getattr(self, "enforce_context", True)
+ or not getattr(target_cfg, "_enforce_context", True)
+ or (len(sys.argv) > 1 and sys.argv[1] == "api")
+ or not isinstance(getattr(target_cfg, "config", None), dict)
+ ):
+ return None
+ from .context_service import ContextService
+
+ return ContextService(target_cfg)
+
+ def _get_raw_folders(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallfolders_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallfolders_unlocked()
+ return target_cfg._getallfolders()
+
+ def _get_raw_nodes(self, cfg=None) -> list[str]:
+ target_cfg = cfg or self.config
+ if target_cfg is None:
+ return []
+ if (
+ not hasattr(target_cfg, "assert_called")
+ and callable(getattr(target_cfg, "_getallnodes_unlocked", None))
+ and hasattr(target_cfg, "_mutation_lock")
+ ):
+ with target_cfg._mutation_lock:
+ return target_cfg._getallnodes_unlocked()
+ return target_cfg._getallnodes()
+
+ def _derive_parent_folder(self, cfg, unique_id: str, is_folder: bool) -> str | None:
+ explode_fn = (
+ cfg._explode_unique_unlocked
+ if (
+ not hasattr(cfg, "assert_called")
+ and callable(getattr(cfg, "_explode_unique_unlocked", None))
+ )
+ else cfg._explode_unique
+ )
+ uniques = explode_fn(unique_id)
+ if is_folder:
+ if (
+ not isinstance(unique_id, str)
+ or not unique_id.startswith("@")
+ or not isinstance(uniques, dict)
+ or "folder" not in uniques
+ ):
+ raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
+ if "subfolder" in uniques:
+ return f"@{uniques['folder']}"
+ return None
+ if (
+ not isinstance(unique_id, str)
+ or unique_id.startswith("@")
+ or not isinstance(uniques, dict)
+ or not uniques.get("id")
+ ):
+ raise InvalidConfigurationError(f"Invalid node name '{unique_id}'.")
+ if "subfolder" in uniques and "folder" in uniques:
+ return f"@{uniques['subfolder']}@{uniques['folder']}"
+ if "folder" in uniques:
+ return f"@{uniques['folder']}"
+ return None
+
+ def _folder_exists(self, parent_folder: str, raw_folders: list[str], cfg=None) -> bool:
+ target_cfg = cfg or self.config
+ cfg_dict = getattr(target_cfg, "config", None)
+ case = cfg_dict.get("case", False) if isinstance(cfg_dict, dict) else False
+ if case:
+ return parent_folder in raw_folders
+ return parent_folder.lower() in {f.lower() for f in raw_folders}
+
+ def _ensure_in_active_context(
+ self, unique_id: str, *, is_folder: bool = False, not_found_msg: str | None = None
+ ) -> None:
+ ctx_svc = self._get_context_service()
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(unique_id)
+ ):
+ if not_found_msg is not None:
+ raise NodeNotFoundError(not_found_msg)
+ label = "Folder" if is_folder else "Node"
+ raise NodeNotFoundError(f"{label} '{unique_id}' not found.")
@staticmethod
def _validate_node_payload(data):
@@ -112,7 +208,11 @@ el.replaceWith(d);
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)]
-
+
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+
if not format_str:
return nodes
@@ -169,10 +269,14 @@ el.replaceWith(d);
else:
flags = re.IGNORECASE if not case_sensitive else 0
folders = [f for f in folders if re.search(filter_str, f, flags)]
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
return folders
def get_node_details(self, unique_id):
"""Return full configuration dictionary for a specific node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
try:
details = self.config.getitem(unique_id)
if not details:
@@ -190,50 +294,45 @@ el.replaceWith(d);
self.config._generate_nodes_cache(nodes=nodes, folders=folders, profiles=profiles)
def validate_parent_folder(self, unique_id, is_folder=False):
- """Check if parent folder exists for a given node unique ID."""
- if is_folder:
- uniques = self.config._explode_unique(unique_id)
- if uniques and "subfolder" in uniques and "folder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in self.config._getallfolders():
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
- else:
- 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.")
-
+ """Check if unique_id is in active context and its parent folder exists."""
+ parent_folder = self._derive_parent_folder(self.config, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, self._get_raw_folders(), self.config
+ ):
+ 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)
self._validate_node_payload(data)
+ self.validate_parent_folder(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config):
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
all_folders = cfg._getallfolders_unlocked()
+ parent_folder = self._derive_parent_folder(cfg, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service(cfg)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if is_folder:
if unique_id in all_folders:
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
uniques = cfg._explode_unique_unlocked(unique_id)
if not uniques:
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
- if "subfolder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
cfg._folder_add_unlocked(**uniques)
else:
if unique_id in all_nodes:
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
- node_folder = unique_id.partition("@")[2]
- if node_folder:
- parent_folder = f"@{node_folder}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
payload = deepcopy(data)
if "id" not in payload:
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -290,6 +389,7 @@ el.replaceWith(d);
def update_node(self, unique_id, data, save=True):
"""Explicitly update an existing node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
@@ -316,6 +416,7 @@ el.replaceWith(d);
def delete_node(self, unique_id, is_folder=False, save=True):
"""Logic for deleting a node or folder."""
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -346,6 +447,7 @@ el.replaceWith(d);
def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
"""Interact with a node directly."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
from connpy.core import node
from ..auth_utils import resolve_fallback_entries
@@ -382,10 +484,28 @@ el.replaceWith(d);
def move_node(self, src_id, dst_id, copy=False):
"""Move or copy a node."""
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
self._validate_node_name(dst_id)
+ self.validate_parent_folder(dst_id, is_folder=False)
if _supports_transactional_update(self.config):
def _mut(cfg):
+ ctx_svc = self._get_context_service(cfg)
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(src_id)
+ ):
+ raise NodeNotFoundError(f"Source node '{src_id}' not found.")
+ parent_folder = self._derive_parent_folder(cfg, dst_id, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, cfg._getallfolders_unlocked(), cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
try:
node_data = cfg.getitem_unlocked(src_id)
except (KeyError, TypeError):
@@ -432,12 +552,23 @@ el.replaceWith(d);
def bulk_add(self, ids, hosts, common_data):
"""Add multiple nodes with shared common configuration."""
self._validate_node_payload(common_data)
+ for uid in ids:
+ self.validate_parent_folder(uid, is_folder=False)
if _supports_transactional_update(self.config):
def _build_entries(cfg):
all_nodes = cfg._getallnodes_unlocked()
+ all_folders = cfg._getallfolders_unlocked()
+ ctx_svc = self._get_context_service(cfg)
planned = []
for i, uid in enumerate(ids):
+ parent_folder = self._derive_parent_folder(cfg, uid, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if uid in all_nodes:
continue
try:
@@ -555,30 +686,30 @@ el.replaceWith(d);
if not is_folder:
self._validate_node_name(unique_id)
self._validate_node_payload(data)
+ self.validate_parent_folder(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config):
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
all_folders = cfg._getallfolders_unlocked()
+ parent_folder = self._derive_parent_folder(cfg, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service(cfg)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if is_folder:
if unique_id in all_folders:
raise NodeAlreadyExistsError(f"Folder '{unique_id}' already exists.")
uniques = cfg._explode_unique_unlocked(unique_id)
if not uniques:
raise InvalidConfigurationError(f"Invalid folder name '{unique_id}'.")
- if "subfolder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
cfg._folder_add_unlocked(**uniques)
else:
if unique_id in all_nodes:
raise NodeAlreadyExistsError(f"Node '{unique_id}' already exists.")
- node_folder = unique_id.partition("@")[2]
- if node_folder:
- parent_folder = f"@{node_folder}"
- if parent_folder not in all_folders:
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
payload = deepcopy(data)
if "id" not in payload:
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -632,12 +763,23 @@ el.replaceWith(d);
def bulk_add(self, ids, hosts, common_data):
"""Add multiple nodes with shared common configuration."""
self._validate_node_payload(common_data)
+ for uid in ids:
+ self.validate_parent_folder(uid, is_folder=False)
if _supports_transactional_update(self.config):
def _build_entries(cfg):
all_nodes = cfg._getallnodes_unlocked()
+ all_folders = cfg._getallfolders_unlocked()
+ ctx_svc = self._get_context_service(cfg)
planned = []
for i, uid in enumerate(ids):
+ parent_folder = self._derive_parent_folder(cfg, uid, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(uid, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, all_folders, cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
if uid in all_nodes:
continue
try:
@@ -712,6 +854,7 @@ el.replaceWith(d);
def connect_node(self, unique_id, sftp=False, debug=False, logger=None):
"""Interact with a node directly."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
from connpy.core import node
from ..auth_utils import resolve_fallback_entries
@@ -758,6 +901,7 @@ el.replaceWith(d);
def delete_node(self, unique_id, is_folder=False, save=True):
"""Logic for deleting a node or folder."""
+ self._ensure_in_active_context(unique_id, is_folder=is_folder)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
uniques = cfg._explode_unique_unlocked(unique_id)
@@ -874,6 +1018,7 @@ el.replaceWith(d);
def get_node_details(self, unique_id):
"""Return full configuration dictionary for a specific node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
try:
details = self.config.getitem(unique_id)
if not details:
@@ -906,6 +1051,9 @@ el.replaceWith(d);
else:
flags = re.IGNORECASE if not case_sensitive else 0
folders = [f for f in folders if re.search(filter_str, f, flags)]
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ folders = ctx_svc.filter_node_list(result=folders)
return folders
Return all unique folders, optionally filtered by regex.
@@ -926,7 +1074,11 @@ el.replaceWith(d);
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)]
-
+
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None and not ctx_svc.is_default_all_context():
+ nodes = ctx_svc.filter_node_list(result=nodes)
+
if not format_str:
return nodes
@@ -981,10 +1133,28 @@ el.replaceWith(d);
def move_node(self, src_id, dst_id, copy=False):
"""Move or copy a node."""
+ self._ensure_in_active_context(
+ src_id, is_folder=False, not_found_msg=f"Source node '{src_id}' not found."
+ )
self._validate_node_name(dst_id)
+ self.validate_parent_folder(dst_id, is_folder=False)
if _supports_transactional_update(self.config):
def _mut(cfg):
+ ctx_svc = self._get_context_service(cfg)
+ if (
+ ctx_svc is not None
+ and not ctx_svc.is_default_all_context()
+ and not ctx_svc.matches_active_context(src_id)
+ ):
+ raise NodeNotFoundError(f"Source node '{src_id}' not found.")
+ parent_folder = self._derive_parent_folder(cfg, dst_id, is_folder=False)
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(dst_id, is_folder=False)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, cfg._getallfolders_unlocked(), cfg
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
try:
node_data = cfg.getitem_unlocked(src_id)
except (KeyError, TypeError):
@@ -1040,6 +1210,7 @@ el.replaceWith(d);
def update_node(self, unique_id, data, save=True):
"""Explicitly update an existing node."""
+ self._ensure_in_active_context(unique_id, is_folder=False)
if _supports_transactional_update(self.config) and save:
def _mut(cfg):
all_nodes = cfg._getallnodes_unlocked()
@@ -1075,21 +1246,17 @@ el.replaceWith(d);
Expand source code
def validate_parent_folder(self, unique_id, is_folder=False):
- """Check if parent folder exists for a given node unique ID."""
- if is_folder:
- uniques = self.config._explode_unique(unique_id)
- if uniques and "subfolder" in uniques and "folder" in uniques:
- parent_folder = f"@{uniques['folder']}"
- if parent_folder not in self.config._getallfolders():
- raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
- else:
- 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.")
+ """Check if unique_id is in active context and its parent folder exists."""
+ parent_folder = self._derive_parent_folder(self.config, unique_id, is_folder=is_folder)
+ ctx_svc = self._get_context_service()
+ if ctx_svc is not None:
+ ctx_svc.validate_in_active_context(unique_id, is_folder=is_folder)
+ if parent_folder is not None and not self._folder_exists(
+ parent_folder, self._get_raw_folders(), self.config
+ ):
+ raise NodeNotFoundError(f"Folder '{parent_folder}' not found.")
-Check if parent folder exists for a given node unique ID.
+Check if unique_id is in active context and its parent folder exists.
Inherited members
diff --git a/docs/connpy/services/profile_service.html b/docs/connpy/services/profile_service.html
index c04d659..0cfe56c 100644
--- a/docs/connpy/services/profile_service.html
+++ b/docs/connpy/services/profile_service.html
@@ -176,18 +176,13 @@ el.replaceWith(d);
resolved = deepcopy(node_data)
auth_referenced_profiles = []
- other_referenced_profiles = []
- for key, value in resolved.items():
- if key == "fallback":
- continue
- target_refs = (
- auth_referenced_profiles if key in ("user", "password") else other_referenced_profiles
- )
+ for key in ("user", "password"):
+ value = resolved.get(key)
if isinstance(value, str):
if not is_compose_expression(value) and value.startswith("@"):
ref = value[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
elif isinstance(value, (list, tuple)):
for item in value:
if (
@@ -197,7 +192,7 @@ el.replaceWith(d);
):
ref = item[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
def _get_resolved_ref(prof_name):
if prof_name in _visited or _depth >= MAX_PROFILE_DEPTH:
@@ -262,15 +257,16 @@ el.replaceWith(d);
resolved_list.append(item)
resolved[key] = resolved_list
- ordered_profiles = list(dict.fromkeys(auth_referenced_profiles + other_referenced_profiles))
- for base_profile_name in ordered_profiles:
+ dedup_auth_profiles = list(dict.fromkeys(auth_referenced_profiles))
+ for base_profile_name in dedup_auth_profiles:
with suppress(ProfileNotFoundError):
base_profile = _get_resolved_ref(base_profile_name)
- for key, value in base_profile.items():
- if (key not in resolved or resolved[key] in ("", [], None)) and (
- value not in ("", [], None) or key not in resolved
- ):
- resolved[key] = deepcopy(value)
+ for key in ("user", "password", "fallback"):
+ val = base_profile.get(key)
+ if (
+ key not in resolved or resolved[key] in ("", [], None)
+ ) and val not in ("", [], None):
+ resolved[key] = deepcopy(val)
if resolved.get("protocol") in ("", None):
try:
@@ -503,18 +499,13 @@ el.replaceWith(d);
resolved = deepcopy(node_data)
auth_referenced_profiles = []
- other_referenced_profiles = []
- for key, value in resolved.items():
- if key == "fallback":
- continue
- target_refs = (
- auth_referenced_profiles if key in ("user", "password") else other_referenced_profiles
- )
+ for key in ("user", "password"):
+ value = resolved.get(key)
if isinstance(value, str):
if not is_compose_expression(value) and value.startswith("@"):
ref = value[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
elif isinstance(value, (list, tuple)):
for item in value:
if (
@@ -524,7 +515,7 @@ el.replaceWith(d);
):
ref = item[1:]
if key != "password" or ref in profiles:
- target_refs.append(ref)
+ auth_referenced_profiles.append(ref)
def _get_resolved_ref(prof_name):
if prof_name in _visited or _depth >= MAX_PROFILE_DEPTH:
@@ -589,15 +580,16 @@ el.replaceWith(d);
resolved_list.append(item)
resolved[key] = resolved_list
- ordered_profiles = list(dict.fromkeys(auth_referenced_profiles + other_referenced_profiles))
- for base_profile_name in ordered_profiles:
+ dedup_auth_profiles = list(dict.fromkeys(auth_referenced_profiles))
+ for base_profile_name in dedup_auth_profiles:
with suppress(ProfileNotFoundError):
base_profile = _get_resolved_ref(base_profile_name)
- for key, value in base_profile.items():
- if (key not in resolved or resolved[key] in ("", [], None)) and (
- value not in ("", [], None) or key not in resolved
- ):
- resolved[key] = deepcopy(value)
+ for key in ("user", "password", "fallback"):
+ val = base_profile.get(key)
+ if (
+ key not in resolved or resolved[key] in ("", [], None)
+ ) and val not in ("", [], None):
+ resolved[key] = deepcopy(val)
if resolved.get("protocol") in ("", None):
try:
diff --git a/docs/connpy/services/provider.html b/docs/connpy/services/provider.html
index 997ed9f..e5f1db4 100644
--- a/docs/connpy/services/provider.html
+++ b/docs/connpy/services/provider.html
@@ -65,7 +65,7 @@ el.replaceWith(d);
class ServiceProvider
-(config, mode='local', remote_host=None)
+(config, mode='local', remote_host=None, enforce_context: bool = True)
-
@@ -75,26 +75,41 @@ el.replaceWith(d);
class ServiceProvider:
"""Dynamic service backend. Transparently provides local or remote services."""
- def __init__(self, config, mode="local", remote_host=None):
+ def __init__(self, config, mode="local", remote_host=None, enforce_context: bool = True):
from ..auth_utils import AuthAttemptTracker
self.mode = mode
self.config = config
self.remote_host = remote_host
+ self.enforce_context = bool(enforce_context)
self.auth_tracker = AuthAttemptTracker()
+ self.nodes = None
self._system = None
self._execution = None
self._import_export = None
self._sync = None
self._users = None
self._ai = None
-
+ self.set_enforce_context(self.enforce_context)
+
if mode == "local":
self._init_local()
elif mode == "remote":
self._init_remote()
else:
raise ValueError(f"Unknown service mode: {mode}")
+
+ def set_enforce_context(self, enforce_context: bool) -> None:
+ self.enforce_context = bool(enforce_context)
+ if self.config is not None and not hasattr(self.config, "assert_called"):
+ self.config._enforce_context = self.enforce_context
+ for svc in (
+ getattr(self, "nodes", None),
+ self._execution,
+ self._import_export,
+ ):
+ if svc is not None and hasattr(svc, "enforce_context"):
+ svc.enforce_context = self.enforce_context
def _init_local(self):
from .config_service import ConfigService
@@ -103,7 +118,7 @@ el.replaceWith(d);
from .plugin_service import PluginService
from .profile_service import ProfileService
- self.nodes = NodeService(self.config)
+ self.nodes = NodeService(self.config, enforce_context=self.enforce_context)
self.profiles = ProfileService(self.config)
self.config_svc = ConfigService(self.config)
self.plugins = PluginService(self.config)
@@ -161,7 +176,12 @@ el.replaceWith(d);
self.plugins = PluginStub(channel, remote_host=self.remote_host)
self.ai = AIStub(channel, remote_host=self.remote_host)
self.system = SystemStub(channel, remote_host=self.remote_host)
- self.execution = ExecutionStub(channel, remote_host=self.remote_host)
+ self.execution = ExecutionStub(
+ channel,
+ remote_host=self.remote_host,
+ config=self.config,
+ node_stub=self.nodes,
+ )
self.import_export = ImportExportStub(channel, remote_host=self.remote_host)
self.auth = AuthStub(channel, remote_host=self.remote_host)
@@ -180,10 +200,13 @@ el.replaceWith(d);
def execution(self):
if self._execution is None and self.mode == "local":
from .execution_service import ExecutionService
- if "attempt_tracker" in inspect.signature(ExecutionService.__init__).parameters:
- self._execution = ExecutionService(self.config, attempt_tracker=self.auth_tracker)
- else:
- self._execution = ExecutionService(self.config)
+ params = inspect.signature(ExecutionService.__init__).parameters
+ kwargs = {}
+ if "attempt_tracker" in params:
+ kwargs["attempt_tracker"] = self.auth_tracker
+ if "enforce_context" in params:
+ kwargs["enforce_context"] = self.enforce_context
+ self._execution = ExecutionService(self.config, **kwargs)
return self._execution
@execution.setter
@@ -194,7 +217,13 @@ el.replaceWith(d);
def import_export(self):
if self._import_export is None and self.mode == "local":
from .import_export_service import ImportExportService
- self._import_export = ImportExportService(self.config)
+ params = inspect.signature(ImportExportService.__init__).parameters
+ if "enforce_context" in params:
+ self._import_export = ImportExportService(
+ self.config, enforce_context=self.enforce_context
+ )
+ else:
+ self._import_export = ImportExportService(self.config)
return self._import_export
@import_export.setter
@@ -262,10 +291,13 @@ def ai(self):
def execution(self):
if self._execution is None and self.mode == "local":
from .execution_service import ExecutionService
- if "attempt_tracker" in inspect.signature(ExecutionService.__init__).parameters:
- self._execution = ExecutionService(self.config, attempt_tracker=self.auth_tracker)
- else:
- self._execution = ExecutionService(self.config)
+ params = inspect.signature(ExecutionService.__init__).parameters
+ kwargs = {}
+ if "attempt_tracker" in params:
+ kwargs["attempt_tracker"] = self.auth_tracker
+ if "enforce_context" in params:
+ kwargs["enforce_context"] = self.enforce_context
+ self._execution = ExecutionService(self.config, **kwargs)
return self._execution
@@ -280,7 +312,13 @@ def execution(self):
def import_export(self):
if self._import_export is None and self.mode == "local":
from .import_export_service import ImportExportService
- self._import_export = ImportExportService(self.config)
+ params = inspect.signature(ImportExportService.__init__).parameters
+ if "enforce_context" in params:
+ self._import_export = ImportExportService(
+ self.config, enforce_context=self.enforce_context
+ )
+ else:
+ self._import_export = ImportExportService(self.config)
return self._import_export
@@ -331,6 +369,31 @@ def users(self):
+
+def set_enforce_context(self, enforce_context: bool) ‑> None
+def set_enforce_context(self, enforce_context: bool) -> None:
+ self.enforce_context = bool(enforce_context)
+ if self.config is not None and not hasattr(self.config, "assert_called"):
+ self.config._enforce_context = self.enforce_context
+ for svc in (
+ getattr(self, "nodes", None),
+ self._execution,
+ self._import_export,
+ ):
+ if svc is not None and hasattr(svc, "enforce_context"):
+ svc.enforce_context = self.enforce_context
+aiexecutionimport_exportset_enforce_contextsyncsystemusers