multiSSH3 5.74__py3-none-any.whl → 5.76__py3-none-any.whl

multiSSH3.py

@@ -55,10 +55,10 @@ except AttributeError:
 		# If neither is available, use a dummy decorator
 		def cache_decorator(func):
 			return func
-version = '5.74'
+version = '5.76'
 VERSION = version
 __version__ = version
-COMMIT_DATE = '2025-06-03'
+COMMIT_DATE = '2025-06-25'
 
 CONFIG_FILE_CHAIN = ['./multiSSH3.config.json',
 					 '~/multiSSH3.config.json',
@@ -78,6 +78,24 @@ def eprint(*args, **kwargs):
 		print(f"Error: Cannot print to stderr: {e}")
 		print(*args, **kwargs)
 
+def _exit_with_code(code, message=None):
+	'''
+	Exit the program with a specific code and print a message
+
+	Args:
+		code (int): The exit code
+		message (str, optional): The message to print. Defaults to None.
+
+	Returns:
+		None
+	'''
+	global __returnZero
+	if message:
+		eprint('Exiting: '+ message)
+	if __returnZero:
+		code = 0
+	sys.exit(code)
+
 def signal_handler(sig, frame):
 	'''
 	Handle the Ctrl C signal
@@ -98,7 +116,7 @@ def signal_handler(sig, frame):
 		# wait for 0.1 seconds to allow the threads to exit
 		time.sleep(0.1)
 		os.system(f'pkill -ef {os.path.basename(__file__)}')
-		sys.exit(0)
+		_exit_with_code(1, 'Exiting immediately due to Ctrl C')
 
 # def input_with_timeout_and_countdown(timeout, prompt='Please enter your selection'):
 # 	"""
@@ -303,6 +321,7 @@ DEFAULT_CURSES_MINIMUM_LINE_LEN = 1
 DEFAULT_SINGLE_WINDOW = False
 DEFAULT_ERROR_ONLY = False
 DEFAULT_NO_OUTPUT = False
+DEFAULT_RETURN_ZERO = False
 DEFAULT_NO_ENV = False
 DEFAULT_ENV_FILE = '/etc/profile.d/hosts.sh'
 DEFAULT_NO_HISTORY = False
@@ -313,6 +332,7 @@ DEFAULT_PRINT_SUCCESS_HOSTS = False
 DEFAULT_GREPPABLE_MODE = False
 DEFAULT_SKIP_UNREACHABLE = True
 DEFAULT_SKIP_HOSTS = ''
+DEFAULT_ENCODING = 'utf-8'
 SSH_STRICT_HOST_KEY_CHECKING = False
 ERROR_MESSAGES_TO_IGNORE = [
 	'Pseudo-terminal will not be allocated because stdin is not a terminal',
@@ -360,6 +380,8 @@ __curses_color_table = {}
 __curses_current_color_index = 10
 __max_connections_nofile_limit_supported = 0
 __thread_start_delay = 0
+_encoding = DEFAULT_ENCODING
+__returnZero = DEFAULT_RETURN_ZERO
 if __resource_lib_available:
 	# Get the current limits
 	_, __system_nofile_limit = resource.getrlimit(resource.RLIMIT_NOFILE)
@@ -1123,11 +1145,12 @@ def __handle_reading_stream(stream,target, host):
 	Returns:
 		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('utf-8',errors='backslashreplace')
+		current_line_str = current_line.decode(_encoding,errors='backslashreplace')
 		target.append(current_line_str)
 		host.output.append(current_line_str)
 		host.lineNumToPrintSet.add(len(host.output)-1)
@@ -1158,7 +1181,7 @@ def __handle_reading_stream(stream,target, host):
 				current_line.append(char[0])
 			else:
 				# curser is bigger than the length of the line
-				current_line += b' '*(curser_position - len(current_line)) + char
+				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
@@ -1181,15 +1204,16 @@ def __handle_writing_stream(stream,stop_event,host):
 		None
 	'''
 	global __keyPressesIn
+	global _encoding
 	# __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
 	while not stop_event.is_set():
 		if sentInput < len(__keyPressesIn) - 1 :
-			stream.write(''.join(__keyPressesIn[sentInput]).encode())
+			stream.write(''.join(__keyPressesIn[sentInput]).encode(encoding=_encoding,errors='backslashreplace'))
 			stream.flush()
-			line = '> ' + ''.join(__keyPressesIn[sentInput]).encode().decode().replace('\n', '↵')
+			line = '> ' + ''.join(__keyPressesIn[sentInput]).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)
@@ -1866,6 +1890,7 @@ def _get_hosts_to_display (hosts, max_num_hosts, hosts_to_display = None, indexO
 	return new_hosts_to_display , {'running':len(running_hosts), 'failed':len(failed_hosts), 'finished':len(finished_hosts), 'waiting':len(waiting_hosts)}, rearrangedHosts
 
 def __generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min_char_len = DEFAULT_CURSES_MINIMUM_CHAR_LEN, min_line_len = DEFAULT_CURSES_MINIMUM_LINE_LEN,single_window=DEFAULT_SINGLE_WINDOW, config_reason = 'New Configuration'):
+	global _encoding
 	_ = config_reason
 	try:
 		box_ansi_color = None
@@ -2101,7 +2126,7 @@ def __generate_display(stdscr, hosts, lineToDisplay = -1,curserPosition = 0, min
 				stats = f"Total: {len(hosts)} Running: {host_stats['running']} Failed: {host_stats['failed']} Finished: {host_stats['finished']} Waiting: {host_stats['waiting']}  ww: {min_char_len} wh:{min_line_len} i:{indexOffset} "
 			else:
 				# we use the stat bar to display the key presses
-				encodedLine = ''.join(__keyPressesIn[lineToDisplay]).encode().decode().strip('\n') + ' '
+				encodedLine = ''.join(__keyPressesIn[lineToDisplay]).encode(encoding=_encoding,errors='backslashreplace').decode(encoding=_encoding,errors='backslashreplace').strip('\n') + ' '
 				#stats = '┍'+ f"Send CMD: {encodedLine}"[:max_x - 2].center(max_x - 2, "━")
 				# format the stats line with chracter at curser position inverted using ansi escape sequence
 				# displayCurserPosition is needed as the curserPosition can be larger than the length of the encodedLine. This is wanted to keep scrolling through the history less painful
@@ -2253,6 +2278,7 @@ def curses_print(stdscr, hosts, threads, min_char_len = DEFAULT_CURSES_MINIMUM_C
 def generate_output(hosts, usejson = False, greppable = False):
 	global __keyPressesIn
 	global __global_suppress_printout
+	global __encoding
 	if __global_suppress_printout:
 		# remove hosts with returncode 0
 		hosts = [dict(host) for host in hosts if host.returncode != 0]
@@ -2286,7 +2312,7 @@ def generate_output(hosts, usejson = False, greppable = False):
 		rtnStr += pretty_format_table(rtnList)
 		rtnStr += '*'*80+'\n'
 		if __keyPressesIn[-1]:
-			CMDsOut = [''.join(cmd).encode('unicode_escape').decode().replace('\\n', '↵') for cmd in __keyPressesIn if cmd]
+			CMDsOut = [''.join(cmd).encode(encoding=_encoding,errors='backslashreplace').decode(encoding=_encoding,errors='backslashreplace').replace('\\n', '↵') for cmd in __keyPressesIn if cmd]
 			rtnStr += 'User Inputs: '+ '\nUser Inputs: '.join(CMDsOut)
 			#rtnStr += '\n'
 	else:
@@ -2317,7 +2343,7 @@ def generate_output(hosts, usejson = False, greppable = False):
 		if not __global_suppress_printout or outputs:
 			rtnStr += '*'*80+'\n'
 		if __keyPressesIn[-1]:
-			CMDsOut = [''.join(cmd).encode('unicode_escape').decode().replace('\\n', '↵') for cmd in __keyPressesIn if cmd]
+			CMDsOut = [''.join(cmd).encode(encoding=_encoding,errors='backslashreplace').decode(encoding=_encoding,errors='backslashreplace').replace('\\n', '↵') for cmd in __keyPressesIn if cmd]
 			#rtnStr += f"Key presses: {''.join(__keyPressesIn).encode('unicode_escape').decode()}\n"
 			#rtnStr += f"Key presses: {__keyPressesIn}\n"
 			rtnStr += "User Inputs: \n  "
@@ -2755,7 +2781,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 		else:
 			eprint(f"Warning: ssh-copy-id not found in {_binPaths} , skipping copy id to the hosts")
 		if not commands:
-			sys.exit(0)
+			_exit_with_code(0, "Copy id finished, no commands to run")
 	if files and not commands:
 		# if files are specified but not target dir, we default to file sync mode
 		file_sync = True
@@ -2772,8 +2798,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 				except:
 					pathSet.update(glob.glob(file,recursive=True))
 			if not pathSet:
-				eprint(f'Warning: No source files at {files!r} are found after resolving globs!')
-				sys.exit(66)
+				_exit_with_code(66, f'No source files at {files!r} are found after resolving globs!')
 		else:
 			pathSet = set(files)
 		if file_sync:
@@ -2790,7 +2815,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 			eprint("Error: the number of commands must be the same as the number of hosts")
 			eprint(f"Number of commands: {len(commands)}")
 			eprint(f"Number of hosts: {len(set(targetHostDic) - set(skipHostSet))}")
-			sys.exit(255)
+			_exit_with_code(255, "Number of commands and hosts do not match")
 		if not __global_suppress_printout:
 			eprint('-'*80)
 			eprint("Running in one on one mode")
@@ -2905,6 +2930,7 @@ def generate_default_config(args):
 		'DEFAULT_SINGLE_WINDOW': args.single_window,
 		'DEFAULT_ERROR_ONLY': args.error_only,
 		'DEFAULT_NO_OUTPUT': args.no_output,
+		'DEFAULT_RETURN_ZERO': args.return_zero,
 		'DEFAULT_NO_ENV': args.no_env,
 		'DEFAULT_ENV_FILE': args.env_file,
 		'DEFAULT_NO_HISTORY': args.no_history,
@@ -2915,6 +2941,7 @@ def generate_default_config(args):
 		'DEFAULT_GREPPABLE_MODE': args.greppable,
 		'DEFAULT_SKIP_UNREACHABLE': args.skip_unreachable,
 		'DEFAULT_SKIP_HOSTS': args.skip_hosts,
+		'DEFAULT_ENCODING': args.encoding,
 		'SSH_STRICT_HOST_KEY_CHECKING': SSH_STRICT_HOST_KEY_CHECKING,
 		'ERROR_MESSAGES_TO_IGNORE': ERROR_MESSAGES_TO_IGNORE,
 	}
@@ -2938,8 +2965,7 @@ def write_default_config(args,CONFIG_FILE = None):
 		elif inStr.lower().strip().startswith('o'):
 			backup = False
 		else:
-			eprint("Aborted")
-			sys.exit(1)
+			_exit_with_code(0, "Aborted by user, no config file written")
 	try:
 		if backup and os.path.exists(CONFIG_FILE):
 			os.rename(CONFIG_FILE,CONFIG_FILE+'.bak')
@@ -2948,8 +2974,7 @@ def write_default_config(args,CONFIG_FILE = None):
 		eprint(f"Do you want to continue writing the new config file to {CONFIG_FILE!r}? (y/n)")
 		inStr = input_with_timeout_and_countdown(10)
 		if not inStr or not inStr.lower().strip().startswith('y'):
-			eprint("Aborted")
-			sys.exit(1)
+			_exit_with_code(0, "Aborted by user, no config file written")
 	try:
 		with open(CONFIG_FILE,'w') as f:
 			json.dump(__configs_from_file,f,indent=4)
@@ -2970,6 +2995,8 @@ def main():
 	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)
@@ -3002,6 +3029,7 @@ def main():
 	parser.add_argument('-B','-sw','--single_window', action='store_true', help=f'Use a single window for all hosts. (default: {DEFAULT_SINGLE_WINDOW})', default=DEFAULT_SINGLE_WINDOW)
 	parser.add_argument('-R','-eo','--error_only', action='store_true', help=f'Only print the error output. (default: {DEFAULT_ERROR_ONLY})', default=DEFAULT_ERROR_ONLY)
 	parser.add_argument('-Q',"-no","--no_output", action='store_true', help=f"Do not print the output. (default: {DEFAULT_NO_OUTPUT})", default=DEFAULT_NO_OUTPUT)
+	parser.add_argument('-Z','-rz','--return_zero', action='store_true', help=f"Return 0 even if there are errors. (default: {DEFAULT_RETURN_ZERO})", default=DEFAULT_RETURN_ZERO)
 	parser.add_argument('-C','--no_env', action='store_true', help=f'Do not load the command line environment variables. (default: {DEFAULT_NO_ENV})', default=DEFAULT_NO_ENV)
 	parser.add_argument("--env_file", type=str, help=f"The file to load the mssh file based environment variables from. ( Still work with --no_env ) (default: {DEFAULT_ENV_FILE})", default=DEFAULT_ENV_FILE)
 	parser.add_argument("-m","--max_connections", type=int, help=f"Max number of connections to use (default: 4 * cpu_count)", default=DEFAULT_MAX_CONNECTIONS)
@@ -3021,6 +3049,7 @@ def main():
 	parser.add_argument('-I','-nh','--no_history', action='store_true', help=f'Do not record the command to history. Default: {DEFAULT_NO_HISTORY}', default=DEFAULT_NO_HISTORY)
 	parser.add_argument('-hf','--history_file', type=str, help=f'The file to store the history. (default: {DEFAULT_HISTORY_FILE})', default=DEFAULT_HISTORY_FILE)
 	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,
@@ -3046,7 +3075,10 @@ def main():
 		args.no_history = True
 		args.greppable = True
 		args.error_only = True
-			
+	
+	if args.return_zero:
+		__returnZero = True
+
 	if args.generate_config_file or args.store_config_file:
 		if args.store_config_file:
 			configFileToWriteTo = args.store_config_file
@@ -3062,7 +3094,7 @@ def main():
 			if configFileToWriteTo:
 				with open(configFileToWriteTo,'r') as f:
 					eprint(f"Config file content: \n{f.read()}")
-			sys.exit(0)
+			_exit_with_code(0)
 	if args.config_file:
 		if os.path.exists(args.config_file):
 			__configs_from_file.update(load_config_file(os.path.expanduser(args.config_file)))
@@ -3085,7 +3117,7 @@ def main():
 		elif inStr.lower().strip().startswith('m'):
 			eprint(f"\nRunning multiple commands: {', '.join(args.commands)!r} on all hosts")
 		else:
-			sys.exit(0)
+			_exit_with_code(0, "Aborted by user, no commands to run")
 
 	if args.key or args.use_key:
 		if not args.key:
@@ -3109,6 +3141,8 @@ def main():
 		# 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 not __global_suppress_printout:
 		cmdStr = getStrCommand(args.hosts,args.commands,
@@ -3168,7 +3202,7 @@ def main():
 		# os.system(f'pkill -ef  {os.path.basename(__file__)}')
 		# os._exit(mainReturnCode)
 	
-	sys.exit(__mainReturnCode)
+	_exit_with_code(__mainReturnCode)
 
 if __name__ == "__main__":
 	main()

{multissh3-5.74.dist-info → multissh3-5.76.dist-info}/METADATA

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

multissh3-5.76.dist-info/RECORD

@@ -0,0 +1,6 @@
+multiSSH3.py,sha256=ioUj2vZW1RiOyXRm_yJizPp751_ggMZeVtDrM6Lvvjk,150851
+multissh3-5.76.dist-info/METADATA,sha256=VYwjn_-6fQHyubKyY6M0cuh6DNJaI4hIkDh4RV0qE5k,18093
+multissh3-5.76.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+multissh3-5.76.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
+multissh3-5.76.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
+multissh3-5.76.dist-info/RECORD,,

multissh3-5.74.dist-info/RECORD

@@ -1,6 +0,0 @@
-multiSSH3.py,sha256=h8FnoCjcZGOjyPypzJ7H4XLOhMIKU2I-kN-m6PGdjJY,149182
-multissh3-5.74.dist-info/METADATA,sha256=ErFNVhzY6qUCJAiI2-paOpyfNiLJKJayjXCYiQRHJPg,18093
-multissh3-5.74.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-multissh3-5.74.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
-multissh3-5.74.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
-multissh3-5.74.dist-info/RECORD,,