multiSSH3 5.77__tar.gz → 5.80__tar.gz

{multissh3-5.77 → multissh3-5.80}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multiSSH3
-Version: 5.77
+Version: 5.80
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan

{multissh3-5.77 → multissh3-5.80}/multiSSH3.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multiSSH3
-Version: 5.77
+Version: 5.80
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan

{multissh3-5.77 → multissh3-5.80}/multiSSH3.py

@@ -55,10 +55,10 @@ except AttributeError:
 		# If neither is available, use a dummy decorator
 		def cache_decorator(func):
 			return func
-version = '5.77'
+version = '5.80'
 VERSION = version
 __version__ = version
-COMMIT_DATE = '2025-06-25'
+COMMIT_DATE = '2025-07-09'
 
 CONFIG_FILE_CHAIN = ['./multiSSH3.config.json',
 					 '~/multiSSH3.config.json',
@@ -246,6 +246,7 @@ class Host:
 		self.stderr = [] # the stderr of the command
 		self.lineNumToPrintSet = set() # line numbers to reprint
 		self.lastUpdateTime = time.monotonic() # the last time the output was updated
+		self.lastPrintedUpdateTime = 0 # the last time the output was printed
 		self.files = files # the files to be copied to the host
 		self.ipmi = ipmi # whether to use ipmi to connect to the host
 		self.shell = shell # whether to use shell to run the command
@@ -260,6 +261,9 @@ class Host:
 		self.identity_file = identity_file
 		self.ip = ip if ip else getIP(name)
 		self.current_color_pair = [-1, -1, 1]
+		self.output_buffer = io.BytesIO()
+		self.stdout_buffer = io.BytesIO()
+		self.stderr_buffer = io.BytesIO()
 
 	def __iter__(self):
 		return zip(['name', 'command', 'returncode', 'stdout', 'stderr'], [self.name, self.command, self.returncode, self.stdout, self.stderr])
@@ -1133,7 +1137,7 @@ def expand_hostnames(hosts):
 
 
 #%% ------------ Run Command Block ----------------
-def __handle_reading_stream(stream,target, host):
+def __handle_reading_stream(stream,target, host,buffer:io.BytesIO):
 	'''
 	Read the stream and append the lines to the target list
 
@@ -1146,50 +1150,63 @@ def __handle_reading_stream(stream,target, host):
 		None
 	'''
 	global _encoding
-	def add_line(current_line,target, host, keepLastLine=True):
-		if not keepLastLine:
-			target.pop()
-			host.output.pop()
-		current_line_str = current_line.decode(_encoding,errors='backslashreplace')
+	def add_line(buffer,target, host):
+		current_line_str = buffer.getvalue().decode(_encoding,errors='backslashreplace')
 		target.append(current_line_str)
 		host.output.append(current_line_str)
 		host.lineNumToPrintSet.add(len(host.output)-1)
-		host.lastUpdateTime = time.monotonic()
-	current_line = bytearray()
-	lastLineCommited = True
-	curser_position = 0
-	previousUpdateTime = time.monotonic()
+		buffer.seek(0)
+		buffer.truncate(0)
+		host.output_buffer.seek(0)
+		host.output_buffer.truncate(0)
+
 	for char in iter(lambda:stream.read(1), b''):
+		host.lastUpdateTime = time.monotonic()
 		if char == b'\n':
-			add_line(current_line,target, host, keepLastLine=lastLineCommited)
-			current_line = bytearray()
-			lastLineCommited = True
-			curser_position = 0
-			previousUpdateTime = time.monotonic()
+			add_line(buffer,target, host)
 			continue
 		elif char == b'\r':
-			curser_position = 0
+			buffer.seek(0)
+			host.output_buffer.seek(0)
 		elif char == b'\x08':
 			# backspace
-			if curser_position > 0:
-				curser_position -= 1
+			if buffer.tell() > 0:
+				buffer.seek(buffer.tell() - 1)
+				buffer.truncate()
+			if host.output_buffer.tell() > 0:
+				host.output_buffer.seek(host.output_buffer.tell() - 1)
+				host.output_buffer.truncate()
 		else:
-			# over write the character if the curser is not at the end of the line
-			if curser_position < len(current_line):
-				current_line[curser_position] = char[0]
-			elif curser_position == len(current_line):
-				current_line.append(char[0])
-			else:
-				# curser is bigger than the length of the line
-				current_line += b' '*(curser_position - len(current_line)) + char[0]
-			curser_position += 1
-		if time.monotonic() - previousUpdateTime > 0.1:
-			# if the time since the last update is more than 10ms, we update the output
-			add_line(current_line,target, host, keepLastLine=lastLineCommited)
-			lastLineCommited = False
-			previousUpdateTime = time.monotonic()
-	if current_line:
-		add_line(current_line,target, host, keepLastLine=lastLineCommited)
+			# normal character
+			buffer.write(char)
+			host.output_buffer.write(char)
+		# if the length of the buffer is greater than 100, we try to decode the buffer to find if there are any unicode line change chars
+		if buffer.tell() % 100 == 0 and buffer.tell() > 0:
+			try:
+				# try to decode the buffer to find if there are any unicode line change chars
+				decodedLine = buffer.getvalue().decode(_encoding,errors='backslashreplace')
+				lines = decodedLine.splitlines()
+				if len(lines) > 1:
+					# if there are multiple lines, we add them to the target
+					for line in lines[:-1]:
+						# for all lines except the last one, we add them to the target
+						target.append(line)
+						host.output.append(line)
+						host.lineNumToPrintSet.add(len(host.output)-1)
+					# we keep the last line in the buffer
+					buffer.seek(0)
+					buffer.truncate(0)
+					buffer.write(lines[-1].encode(_encoding,errors='backslashreplace'))
+					host.output_buffer.seek(0)
+					host.output_buffer.truncate(0)
+					host.output_buffer.write(lines[-1].encode(_encoding,errors='backslashreplace'))
+				
+			except UnicodeDecodeError:
+				# if there is a unicode decode error, we just skip this character
+				continue
+	if buffer.tell() > 0:
+		# if there is still some data in the buffer, we add it to the target
+		add_line(buffer,target, host)
 
 def __handle_writing_stream(stream,stop_event,host):
 	'''
@@ -1208,28 +1225,28 @@ def __handle_writing_stream(stream,stop_event,host):
 	# __keyPressesIn is a list of lists. 
 	# Each list is a list of characters to be sent to the stdin of the process at once. 
 	# We do not send the last line as it may be incomplete.
-	sentInput = 0
+	sentInputPos = 0
 	while not stop_event.is_set():
-		if sentInput < len(__keyPressesIn) - 1 :
-			stream.write(''.join(__keyPressesIn[sentInput]).encode(encoding=_encoding,errors='backslashreplace'))
+		if sentInputPos < len(__keyPressesIn) - 1 :
+			stream.write(''.join(__keyPressesIn[sentInputPos]).encode(encoding=_encoding,errors='backslashreplace'))
 			stream.flush()
-			line = '> ' + ''.join(__keyPressesIn[sentInput]).encode(encoding=_encoding,errors='backslashreplace').decode(encoding=_encoding,errors='backslashreplace').replace('\n', '↵')
+			line = '> ' + ''.join(__keyPressesIn[sentInputPos]).encode(encoding=_encoding,errors='backslashreplace').decode(encoding=_encoding,errors='backslashreplace').replace('\n', '↵')
 			host.output.append(line)
 			host.stdout.append(line)
 			host.lineNumToPrintSet.add(len(host.output)-1)
-			sentInput += 1
+			sentInputPos += 1
 			host.lastUpdateTime = time.monotonic()
 		else:
 			time.sleep(0.01) # sleep for 10ms
-	if sentInput < len(__keyPressesIn) - 1 :
-		eprint(f"Warning: {len(__keyPressesIn)-sentInput} lines of key presses are not sent before the process is terminated!")
+	if sentInputPos < len(__keyPressesIn) - 1 :
+		eprint(f"Warning: {len(__keyPressesIn)-sentInputPos} lines of key presses are not sent before the process is terminated!")
 	# # send the last line
 	# if __keyPressesIn and __keyPressesIn[-1]:
 	#     stream.write(''.join(__keyPressesIn[-1]).encode())
 	#     stream.flush()
 	#     host.output.append(' $ ' + ''.join(__keyPressesIn[-1]).encode().decode().replace('\n', '↵'))
 	#     host.stdout.append(' $ ' + ''.join(__keyPressesIn[-1]).encode().decode().replace('\n', '↵'))
-	return sentInput
+	return sentInputPos
 	
 def run_command(host, sem, timeout=60,passwds=None, retry_limit = 5):
 	'''
@@ -1382,7 +1399,7 @@ def run_command(host, sem, timeout=60,passwds=None, retry_limit = 5):
 				else:
 					fileArgs = host.files + [f'{host.resolvedName}:{host.command}']
 				if useScp:
-					formatedCMD = [_binPaths['scp'],'-rpB'] + localExtraArgs + extraargs +['--']+fileArgs
+					formatedCMD = [_binPaths['scp'],'-rp'] + localExtraArgs + extraargs +['--']+fileArgs
 				else:
 					formatedCMD = [_binPaths['rsync'],'-ahlX','--partial','--inplace', '--info=name'] + rsyncLocalExtraArgs + extraargs +['--']+fileArgs	
 			else:
@@ -1415,11 +1432,11 @@ def run_command(host, sem, timeout=60,passwds=None, retry_limit = 5):
 			#host.stdout = []
 			proc = subprocess.Popen(formatedCMD,stdout=subprocess.PIPE,stderr=subprocess.PIPE,stdin=subprocess.PIPE)
 			# create a thread to handle stdout
-			stdout_thread = threading.Thread(target=__handle_reading_stream, args=(proc.stdout,host.stdout, host), daemon=True)
+			stdout_thread = threading.Thread(target=__handle_reading_stream, args=(proc.stdout,host.stdout, host,host.stdout_buffer), daemon=True)
 			stdout_thread.start()
 			# create a thread to handle stderr
 			#host.stderr = []
-			stderr_thread = threading.Thread(target=__handle_reading_stream, args=(proc.stderr,host.stderr, host), daemon=True)
+			stderr_thread = threading.Thread(target=__handle_reading_stream, args=(proc.stderr,host.stderr, host,host.stderr_buffer), daemon=True)
 			stderr_thread.start()
 			# create a thread to handle stdin
 			stdin_stop_event = threading.Event()
@@ -1479,9 +1496,9 @@ def run_command(host, sem, timeout=60,passwds=None, retry_limit = 5):
 				except subprocess.TimeoutExpired:
 					pass
 				if stdout:
-					__handle_reading_stream(io.BytesIO(stdout),host.stdout, host)
+					__handle_reading_stream(io.BytesIO(stdout),host.stdout, host,host.stdout_buffer)
 				if stderr:
-					__handle_reading_stream(io.BytesIO(stderr),host.stderr, host)
+					__handle_reading_stream(io.BytesIO(stderr),host.stderr, host,host.stderr_buffer)
 				# if the last line in host.stderr is Connection to * closed., we will remove it
 			host.returncode = proc.poll()
 			if host.returncode is None:
@@ -2174,6 +2191,7 @@ def __generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min
 					for i in range(host_window_height - 1):
 						_curses_add_string_to_window(window=host_window, color_pair_list=[-1, -1, 1], y=i + 1,lead_str='│',keep_top_n_lines=1,box_ansi_color=box_ansi_color)
 					host.lineNumToPrintSet.update(range(len(host.output)))
+					host.lastPrintedUpdateTime = 0
 				# for i in range(host.printedLines, len(host.output)):
 				# 	_curses_add_string_to_window(window=host_window, y=i + 1, line=host.output[i], color_pair_list=host.current_color_pair,lead_str='│',keep_top_n_lines=1,box_ansi_color=box_ansi_color)
 				# host.printedLines = len(host.output)
@@ -2193,7 +2211,12 @@ def __generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min
 						# print(traceback.format_exc().strip())
 						if org_dim != stdscr.getmaxyx():
 							return (lineToDisplay,curserPosition , min_char_len, min_line_len, single_window, 'Terminal resize detected')
+				if host.lastPrintedUpdateTime != host.lastUpdateTime and host.output_buffer.tell() > 0:
+					# this means there is still output in the buffer, we will print it
+					# we will print the output in the window
+					_curses_add_string_to_window(window=host_window, y=len(host.output) + 1, line=host.output_buffer.getvalue().decode(_encoding,errors='backslashreplace'), color_pair_list=host.current_color_pair,lead_str='│',keep_top_n_lines=1,box_ansi_color=box_ansi_color,fill_char='')
 				host_window.noutrefresh()
+				host.lastPrintedUpdateTime = host.lastUpdateTime
 			hosts_to_display, host_stats,rearrangedHosts = _get_hosts_to_display(hosts, max_num_hosts,hosts_to_display, indexOffset)
 			curses.doupdate()
 			last_refresh_time = time.perf_counter()
@@ -2420,7 +2443,7 @@ def processRunOnHosts(timeout, password, max_connections, hosts, returnUnfinishe
 			# check for the old content, only update if the new content is different
 			if not os.path.exists(os.path.join(tempfile.gettempdir(),f'__{getpass.getuser()}_multiSSH3_UNAVAILABLE_HOSTS.csv')):
 				with open(os.path.join(tempfile.gettempdir(),f'__{getpass.getuser()}_multiSSH3_UNAVAILABLE_HOSTS.csv'),'w') as f:
-					f.writelines(f'{host},{expTime}' for host,expTime in unavailableHosts.values())
+					f.writelines(f'{host},{expTime}' for host,expTime in unavailableHosts.items())
 			else:
 				oldDic = {}
 				try:
@@ -2545,7 +2568,7 @@ def getStrCommand(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAULT_ONE_O
 						 history_file = history_file, env_file = env_file,
 						 repeat = repeat,interval = interval,
 						 shortend = shortend)
-	commands = [command.replace('"', '\\"') for command in commands]
+	commands = [command.replace('"', '\\"').replace('\n', '\\n').replace('\t', '\\t') for command in commands]
 	commandStr = '"' + '" "'.join(commands) + '"' if commands else ''
 	filePath = os.path.abspath(__file__)
 	programName = filePath if filePath else 'mssh'
@@ -2985,23 +3008,9 @@ def write_default_config(args,CONFIG_FILE = None):
 		eprint(f'Printing the config file to stdout:')
 		print(json.dumps(__configs_from_file, indent=4))
 
-#%% ------------ Wrapper Block ----------------
-def main():
-	global _emo
-	global __global_suppress_printout
-	global __mainReturnCode
-	global __failedHosts
-	global __ipmiiInterfaceIPPrefix
+#%% ------------ Argument Processing -----------------
+def get_parser():
 	global _binPaths
-	global _env_file
-	global __DEBUG_MODE
-	global __configs_from_file
-	global _encoding
-	global __returnZero
-	_emo = False
-	# We handle the signal
-	signal.signal(signal.SIGINT, signal_handler)
-	# We parse the arguments
 	parser = argparse.ArgumentParser(description=f'Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command. Config file chain: {CONFIG_FILE_CHAIN!r}',
 								  epilog=f'Found bins: {list(_binPaths.values())}\n Missing bins: {_binCalled - set(_binPaths.keys())}')
 	parser.add_argument('hosts', metavar='hosts', type=str, nargs='?', help=f'Hosts to run the command on, use "," to seperate hosts. (default: {DEFAULT_HOSTS})',default=DEFAULT_HOSTS)
@@ -3052,18 +3061,20 @@ def main():
 	parser.add_argument('--script', action='store_true', help='Run the command in script mode, short for -SCRIPT or --no_watch --skip_unreachable --no_env --no_history --greppable --error_only')
 	parser.add_argument('-e','--encoding', type=str, help=f'The encoding to use for the output. (default: {DEFAULT_ENCODING})', default=DEFAULT_ENCODING)
 	parser.add_argument("-V","--version", action='version', version=f'%(prog)s {version} @ {COMMIT_DATE} with [ {", ".join(_binPaths.keys())} ] by {AUTHOR} ({AUTHOR_EMAIL})')
-	
-	# parser.add_argument('-u', '--user', metavar='user', type=str, nargs=1,
-	#                     help='the user to use to connect to the hosts')
-	#args = parser.parse_args()
+	return parser
 
+def process_args(args = None):
+	parser = get_parser()
+	# We handle the signal
+	signal.signal(signal.SIGINT, signal_handler)
+	# We parse the arguments
 	# if python version is 3.7 or higher, use parse_intermixed_args
 	try:
-		args = parser.parse_intermixed_args()
+		args = parser.parse_intermixed_args(args)
 	except Exception :
 		#eprint(f"Error while parsing arguments: {e!r}")
 		# try to parse the arguments using parse_known_args
-		args, unknown = parser.parse_known_args()
+		args, unknown = parser.parse_known_args(args)
 		# if there are unknown arguments, we will try to parse them again using parse_args
 		if unknown:
 			eprint(f"Warning: Unknown arguments, treating all as commands: {unknown!r}")
@@ -3076,10 +3087,14 @@ def main():
 		args.no_history = True
 		args.greppable = True
 		args.error_only = True
-	
-	if args.return_zero:
-		__returnZero = True
 
+	if args.unavailable_host_expiry <= 0:
+		eprint(f"Warning: The unavailable host expiry time {args.unavailable_host_expiry} is less than 0, setting it to 10 seconds.")
+		args.unavailable_host_expiry = 10
+	return args
+
+def process_config_file(args):
+	global __configs_from_file
 	if args.generate_config_file or args.store_config_file:
 		if args.store_config_file:
 			configFileToWriteTo = args.store_config_file
@@ -3101,11 +3116,12 @@ def main():
 			__configs_from_file.update(load_config_file(os.path.expanduser(args.config_file)))
 		else:
 			eprint(f"Warning: Config file {args.config_file!r} not found, ignoring it.")
+	return args
 
-	_env_file = args.env_file
-	__DEBUG_MODE = args.debug
 	# if there are more than 1 commands, and every command only consists of one word,
 	# we will ask the user to confirm if they want to run multiple commands or just one command.
+
+def process_commands(args):
 	if not args.file and len(args.commands) > 1 and all([len(command.split()) == 1 for command in args.commands]):
 		eprint(f"Multiple one word command detected, what to do? (1/m/n)")
 		eprint(f"1:  Run 1 command [{' '.join(args.commands)}] on all hosts ( default )")
@@ -3119,7 +3135,9 @@ def main():
 			eprint(f"\nRunning multiple commands: {', '.join(args.commands)!r} on all hosts")
 		else:
 			_exit_with_code(0, "Aborted by user, no commands to run")
+	return args
 
+def process_keys(args):
 	if args.key or args.use_key:
 		if not args.key:
 			args.key = find_ssh_key_file()
@@ -3128,23 +3146,43 @@ def main():
 				args.key = find_ssh_key_file(args.key)
 			elif not os.path.exists(args.key):
 				eprint(f"Warning: Identity file {args.key!r} not found. Passing to ssh anyway. Proceed with caution.")
+	return args
+
 
+def set_global_with_args(args):
+	global _emo
+	global __ipmiiInterfaceIPPrefix
+	global _env_file
+	global __DEBUG_MODE
+	global __configs_from_file
+	global _encoding
+	global __returnZero
+	_emo = False
 	__ipmiiInterfaceIPPrefix = args.ipmi_interface_ip_prefix
+	_env_file = args.env_file
+	__DEBUG_MODE = args.debug
+	_encoding = args.encoding
+	if args.return_zero:
+		__returnZero = True
 
-	if args.no_output:
-		__global_suppress_printout = True
-	
-	if args.unavailable_host_expiry <= 0:
-		eprint(f"Warning: The unavailable host expiry time {args.unavailable_host_expiry} is less than 0, setting it to 10 seconds.")
-		args.unavailable_host_expiry = 10
+#%% ------------ Wrapper Block ----------------
+def main():
+	global __global_suppress_printout
+	global __mainReturnCode
+	global __failedHosts
+	args = process_args()
+	args = process_config_file(args)
+	args = process_commands(args)
+	args = process_keys(args)
+	set_global_with_args(args)
 	
 	if args.use_script_timeout:
 		# set timeout to the default script timeout if timeout is not set
 		if args.timeout == DEFAULT_CLI_TIMEOUT:
 			args.timeout = DEFAULT_TIMEOUT
 	
-	_encoding = args.encoding
-
+	if args.no_output:
+		__global_suppress_printout = True
 	if not __global_suppress_printout:
 		cmdStr = getStrCommand(args.hosts,args.commands,
 						 oneonone=args.oneonone,timeout=args.timeout,password=args.password,
@@ -3176,9 +3214,7 @@ def main():
 							 history_file = args.history_file,
 							 )
 		#print('*'*80)
-
 		#if not __global_suppress_printout: eprint('-'*80)
-	
 	succeededHosts = set()
 	for host in hosts:
 		if host.returncode and host.returncode != 0: