sshscript 4.0.2__py3-none-any.whl → 6.0.0__py3-none-any.whl

sshscript/__init__.py

@@ -59,6 +59,7 @@ run_file = sshscript.run_file
 check_file = sshscript.check_file
 run_script = sshscript.run_script
 Session = session.Session
+ScriptResult = session.ScriptResult
 CommandResult = session.CommandResult
 CommandJob = session.CommandJob
 CommandTimeoutError = session.CommandTimeoutError
@@ -89,6 +90,7 @@ __all__ = [
     'run_script',
     'Session',
     'CommandResult',
+    'ScriptResult',
     'CommandJob',
     'CommandTimeoutError',
     'JobResult',

sshscript/__init__.pyi

@@ -1,6 +1,7 @@
 from typing import Any, ContextManager
 from os import PathLike
 from .session import Session as Session
+from .scriptcontrol import ScriptResult as ScriptResult
 from .commandresult import CommandResult as CommandResult
 from .commandjob import CommandJob as CommandJob, JobResult as JobResult, CommandTimeoutError as CommandTimeoutError
 from .errorutils import SSHScriptException as SSHScriptException
@@ -9,7 +10,7 @@ __version__: str
 
 def check_file(script_path: str | PathLike[str]) -> int: ...
 def run_file(script_path: str | PathLike[str], vars: dict[str, Any] | None = ..., showScript: bool = ...) -> int: ...
-def run_script(script: str, varGlobals: dict[str, Any] | None = ..., showScript: bool = ...) -> dict[str, Any]: ...
+def run_script(script: str, varGlobals: dict[str, Any] | None = ..., showScript: bool = ...) -> ScriptResult: ...
 def spy_imports() -> ContextManager[None]: ...
 def get_logger() -> Any: ...
 def set_logger(userlogger: Any = ..., logname: str | None = ...) -> Any: ...

sshscript/_version.py

@@ -1,3 +1,3 @@
 """Single source of the SSHScript package version."""
 
-__version__ = "4.0.2"
+__version__ = "6.0.0"

sshscript/channelgeneric.py

@@ -1492,6 +1492,11 @@ class GenericChannel(object):
         Existing newlines are retained. Use send() to write exact text instead.
         A readiness/silence status does not establish command success.
         """
+        return self._input_text(text, timeout=timeout, append_newline=True)
+
+    def _input_text(self, text, timeout=60, *, append_newline=True):
+        """Shared interactive protocol for lines and raw terminal control bytes."""
+        payload = text + ('\n' if append_newline else '') if isinstance(text, str) else text
         if not isinstance(text, str):
             raise TypeError('input text must be str')
 
@@ -1504,7 +1509,7 @@ class GenericChannel(object):
             )
 
         if not self.hijacked:
-            return self.send(text + '\n', timeout=timeout)
+            return self.send(payload, timeout=timeout)
 
         deadline = time.monotonic() + timeout
         executing_lock = self.executing_lock
@@ -1555,7 +1560,7 @@ class GenericChannel(object):
                 stderr.set_callback(prompt_found, current_prompt)
 
             self.send(
-                text + '\n',
+                payload,
                 timeout=self._remaining(deadline),
             )
 

sshscript/dollarparser.py

@@ -138,7 +138,7 @@ def _token_syntax_error(error, script_path, spyscript):
     return _source_syntax_error(synthetic, script_path, spyscript)
 
 
-def parse(script_path, spyscript):
+def parse(script_path, spyscript, *, preprocess=None):
     """Return a transformed AST whose locations still refer to *spyscript*."""
     _cache_source(script_path, spyscript)
     try:
@@ -156,6 +156,8 @@ def parse(script_path, spyscript):
         raise _source_syntax_error(error, script_path, spyscript) from None
 
     try:
+        if preprocess is not None:
+            tree = preprocess.visit(tree)
         py_tree = DollarChanger().visit(tree)
         return ast.fix_missing_locations(py_tree)
     except Exception as error:

sshscript/errorutils.py

@@ -32,13 +32,6 @@ class SSHScriptException(Exception):
     def __str__(self):
         return f'{self.message}(#{self.errno})'
 
-class SSHScriptBreak(SSHScriptException):
-    """Control-flow signal for $.break(status), handled by the script runner."""
-    pass
-
-class SSHScriptExit(SSHScriptException):
-    """Control-flow signal for $.exit(status), propagated to the command-line runner."""
-    pass
 
 def dumpScript(source,tb_lineno=None,linerange=10):
     """Print source with line numbers and optional error-line context."""