multiSSH3 6.16__tar.gz → 6.18__tar.gz

{multissh3-6.16 → multissh3-6.18}/PKG-INFO

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

{multissh3-6.16 → multissh3-6.18}/multiSSH3.egg-info/PKG-INFO

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

{multissh3-6.16 → multissh3-6.18}/multiSSH3.py

@@ -34,20 +34,114 @@ from collections import Counter, defaultdict, deque
 from itertools import count, product
 from pprint import pformat
 
-__curses_available = False
-__resource_lib_available = False
-try:
-	import curses
-	import curses.panel
-	__curses_available = True
-except ImportError:
-	pass
-try:
-	import resource
-	__resource_lib_available = True
-except ImportError:
-	pass
 
+version = '6.18'
+VERSION = version
+__version__ = version
+COMMIT_DATE = '2026-04-09'
+# TODO: Add terminal TUI
+
+CONFIG_FILE_CHAIN = ['./multiSSH3.config.json',
+					 '~/multiSSH3.config.json',
+					 '~/.multiSSH3.config.json',
+					 '~/.config/multiSSH3/multiSSH3.config.json',
+					 '/etc/multiSSH3.d/multiSSH3.config.json',
+					 '/etc/multiSSH3.config.json'] # The first one has the highest priority
+
+ERRORS = []
+
+#%% ------------ User Defined Global Variables ----------------
+AUTHOR = 'Yufei Pan'
+AUTHOR_EMAIL = 'pan@zopyr.us'
+DEFAULT_HOSTS = 'all'
+DEFAULT_USERNAME = None
+DEFAULT_PASSWORD = ''
+DEFAULT_IDENTITY_FILE = None
+DEFAULT_SSH_KEY_SEARCH_PATH = '~/.ssh/'
+DEFAULT_USE_KEY = False
+DEFAULT_EXTRA_ARGS = None
+DEFAULT_ONE_ON_ONE = False
+DEFAULT_SCP = False
+DEFAULT_FILE_SYNC = False
+DEFAULT_TIMEOUT = 50
+DEFAULT_CLI_TIMEOUT = 0
+DEFAULT_UNAVAILABLE_HOST_EXPIRY = 600
+DEFAULT_REPEAT = 1
+DEFAULT_INTERVAL = 0
+DEFAULT_IPMI = False
+DEFAULT_IPMI_INTERFACE_IP_PREFIX = ''
+DEFAULT_INTERFACE_IP_PREFIX = None
+DEFAULT_IPMI_USERNAME = 'ADMIN'
+DEFAULT_IPMI_PASSWORD = ''
+DEAFULT_IPMI_ARGS=''
+DEFAULT_NO_WATCH = False
+DEFAULT_WINDOW_WIDTH = 40
+DEFAULT_WINDOW_HEIGHT = 1
+DEFAULT_SINGLE_WINDOW = False
+DEFAULT_ERROR_ONLY = False
+DEFAULT_NO_OUTPUT = False
+DEFAULT_RETURN_ZERO = False
+DEFAULT_NO_ENV = False
+DEFAULT_ENV_FILE = ''
+DEFAULT_ENV_FILES = ['/etc/profile.d/hosts.sh',
+					 '~/.bashrc',
+					 '~/.zshrc',
+					 '~/host.env',
+					 '~/hosts.env',
+					 '.env',
+					 'host.env',
+					 'hosts.env',
+					 ]
+DEFAULT_NO_HISTORY = False
+DEFAULT_HISTORY_FILE = '~/.mssh_history'
+DEFAULT_MAX_CONNECTIONS = 4 * os.cpu_count()
+DEFAULT_JSON_MODE = False
+DEFAULT_PRINT_SUCCESS_HOSTS = False
+DEFAULT_GREPPABLE_MODE = False
+DEFAULT_SKIP_UNREACHABLE = True
+DEFAULT_SKIP_HOSTS = ''
+DEFAULT_HOST_FILE = '/etc/hosts'
+DEFAULT_ENCODING = 'utf-8'
+DEFAULT_DIFF_DISPLAY_THRESHOLD = 0.9
+SSH_STRICT_HOST_KEY_CHECKING = False
+FORCE_TRUECOLOR = False
+ERROR_MESSAGES_TO_IGNORE = [
+	'Pseudo-terminal will not be allocated because stdin is not a terminal',
+	'Connection to .* closed',
+	'Warning: Permanently added',
+	'mux_client_request_session',
+	'disabling multiplexing',
+	'Killed by signal',
+	'Connection reset by peer',
+]
+POSSIBLE_SSH_KEY_FILES = ['id_ed25519','id_ed25519_sk','id_ecdsa','id_ecdsa_sk','id_rsa','id_dsa']
+__DEFAULT_COLOR_PALETTE = {
+	'cyan': (86, 173, 188),
+	'green': (114, 180, 43),
+	'magenta': (140, 107, 200),
+	'red': (196, 38, 94),
+	'white': (227, 227, 221),
+	'yellow': (179, 180, 43),
+	'blue': (106, 126, 200),
+	'bright_black': (102, 102, 102),
+	'bright_blue': (129, 154, 255),
+	'bright_cyan': (102, 217, 239),
+	'bright_green': (126, 226, 46),
+	'bright_magenta': (174, 129, 255),
+	'bright_red': (249, 38, 114),
+	'bright_white': (248, 248, 242),
+	'bright_yellow': (226, 226, 46),
+}
+COLOR_PALETTE = __DEFAULT_COLOR_PALETTE.copy()
+_DEFAULT_CALLED = True
+_DEFAULT_RETURN_UNFINISHED = False
+_DEFAULT_UPDATE_UNREACHABLE_HOSTS = True
+_DEFAULT_NO_START = False
+_etc_hosts = {}
+__ERROR_MESSAGES_TO_IGNORE_REGEX =None
+__DEBUG_MODE = False
+
+#%% ------------ Pre Helper Functions ----------------
 try:
 	# Check if functiools.cache is available
 	# cache_decorator = functools.cache
@@ -85,23 +179,7 @@ except Exception:
 	print('Warning: functools.lru_cache is not available, multiSSH3 will run slower without cache.',file=sys.stderr)
 	def cache_decorator(func):
 		return func
-version = '6.16'
-VERSION = version
-__version__ = version
-COMMIT_DATE = '2026-03-16'
-
-CONFIG_FILE_CHAIN = ['./multiSSH3.config.json',
-					 '~/multiSSH3.config.json',
-					 '~/.multiSSH3.config.json',
-					 '~/.config/multiSSH3/multiSSH3.config.json',
-					 '/etc/multiSSH3.d/multiSSH3.config.json',
-					 '/etc/multiSSH3.config.json'] # The first one has the highest priority
-
-ERRORS = []
-
-# TODO: Add terminal TUI
 
-#%% ------------ Pre Helper Functions ----------------
 def eprint(*args, **kwargs):
 	global ERRORS
 	try:
@@ -245,76 +323,6 @@ def _get_i():
 	'''
 	return next(_i_counter)
 
-#%% ------------ Host Object ----------------
-class Host:
-	def __init__(self, name, command, files = None,ipmi = False,interface_ip_prefix = None,scp=False,extraargs=None,gatherMode=False,identity_file=None,shell=False,i = -1,uuid=uuid.uuid4(),ip = None):
-		self.name = name # the name of the host (hostname or IP address)
-		self.command = command # the command to run on the host
-		self.returncode = None # the return code of the command
-		self.output = [] # the output of the command for curses
-		self.stdout = [] # the stdout of the command
-		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
-		self.interface_ip_prefix = interface_ip_prefix # the prefix of the ip address of the interface to be used to connect to the host
-		self.scp = scp # whether to use scp to copy files to the host
-		self.gatherMode = gatherMode # whether the host is in gather mode
-		self.extraargs = extraargs # extra arguments to be passed to ssh
-		self.resolvedName = None # the resolved IP address of the host
-		# also store a globally unique integer i from 0
-		self.i = i if i != -1 else _get_i()
-		self.uuid = uuid
-		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()
-		self.thread = None
-
-	def __iter__(self):
-		return zip(['name', 'command', 'returncode', 'stdout', 'stderr'], [self.name, self.command, self.returncode, self.stdout, self.stderr])
-	def __repr__(self):
-		return f"Host(\n{pformat(self.__dict__)}\n)"
-	def __str__(self):
-		return f"Host(\n{pformat(dict(self))}\n)"
-	def get_output_hash(self):
-		return hash((
-			self.command,
-			tuple(self.stdout),
-			tuple(self.stderr),
-			self.returncode
-		))
-	def copy(self):
-		newHost = Host(
-			name=self.name,
-			command=self.command,
-			files=self.files,
-			ipmi=self.ipmi,
-			interface_ip_prefix=self.interface_ip_prefix,
-			scp=self.scp,
-			extraargs=self.extraargs,
-			gatherMode=self.gatherMode,
-			identity_file=self.identity_file,
-			shell=self.shell,
-			i=self.i,
-			uuid=self.uuid,
-			ip=self.ip
-		)
-		newHost.returncode = self.returncode
-		newHost.output = self.output.copy()
-		newHost.stdout = self.stdout.copy()
-		newHost.stderr = self.stderr.copy()
-		newHost.lineNumToPrintSet = self.lineNumToPrintSet.copy()
-		newHost.lastUpdateTime = self.lastUpdateTime
-		newHost.lastPrintedUpdateTime = self.lastPrintedUpdateTime
-		newHost.current_color_pair = self.current_color_pair.copy()
-		return newHost
-
 #%% ------------ Load Defaults ( Config ) File ----------------
 def load_config_file(config_file):
 	'''
@@ -336,96 +344,6 @@ def load_config_file(config_file):
 		return {}
 	return config
 
-#%% ------------ Global Variables ----------------
-AUTHOR = 'Yufei Pan'
-AUTHOR_EMAIL = 'pan@zopyr.us'
-DEFAULT_HOSTS = 'all'
-DEFAULT_USERNAME = None
-DEFAULT_PASSWORD = ''
-DEFAULT_IDENTITY_FILE = None
-DEFAULT_SSH_KEY_SEARCH_PATH = '~/.ssh/'
-DEFAULT_USE_KEY = False
-DEFAULT_EXTRA_ARGS = None
-DEFAULT_ONE_ON_ONE = False
-DEFAULT_SCP = False
-DEFAULT_FILE_SYNC = False
-DEFAULT_TIMEOUT = 50
-DEFAULT_CLI_TIMEOUT = 0
-DEFAULT_UNAVAILABLE_HOST_EXPIRY = 600
-DEFAULT_REPEAT = 1
-DEFAULT_INTERVAL = 0
-DEFAULT_IPMI = False
-DEFAULT_IPMI_INTERFACE_IP_PREFIX = ''
-DEFAULT_INTERFACE_IP_PREFIX = None
-DEFAULT_IPMI_USERNAME = 'ADMIN'
-DEFAULT_IPMI_PASSWORD = ''
-DEAFULT_IPMI_ARGS=''
-DEFAULT_NO_WATCH = False
-DEFAULT_WINDOW_WIDTH = 40
-DEFAULT_WINDOW_HEIGHT = 1
-DEFAULT_SINGLE_WINDOW = False
-DEFAULT_ERROR_ONLY = False
-DEFAULT_NO_OUTPUT = False
-DEFAULT_RETURN_ZERO = False
-DEFAULT_NO_ENV = False
-DEFAULT_ENV_FILE = ''
-DEFAULT_ENV_FILES = ['/etc/profile.d/hosts.sh',
-					 '~/.bashrc',
-					 '~/.zshrc',
-					 '~/host.env',
-					 '~/hosts.env',
-					 '.env',
-					 'host.env',
-					 'hosts.env',
-					 ]
-DEFAULT_NO_HISTORY = False
-DEFAULT_HISTORY_FILE = '~/.mssh_history'
-DEFAULT_MAX_CONNECTIONS = 4 * os.cpu_count()
-DEFAULT_JSON_MODE = False
-DEFAULT_PRINT_SUCCESS_HOSTS = False
-DEFAULT_GREPPABLE_MODE = False
-DEFAULT_SKIP_UNREACHABLE = True
-DEFAULT_SKIP_HOSTS = ''
-DEFAULT_HOST_FILE = '/etc/hosts'
-DEFAULT_ENCODING = 'utf-8'
-DEFAULT_DIFF_DISPLAY_THRESHOLD = 0.6
-SSH_STRICT_HOST_KEY_CHECKING = False
-FORCE_TRUECOLOR = False
-ERROR_MESSAGES_TO_IGNORE = [
-	'Pseudo-terminal will not be allocated because stdin is not a terminal',
-	'Connection to .* closed',
-	'Warning: Permanently added',
-	'mux_client_request_session',
-	'disabling multiplexing',
-	'Killed by signal',
-	'Connection reset by peer',
-]
-__DEFAULT_COLOR_PALETTE = {
-	'cyan': (86, 173, 188),
-	'green': (114, 180, 43),
-	'magenta': (140, 107, 200),
-	'red': (196, 38, 94),
-	'white': (227, 227, 221),
-	'yellow': (179, 180, 43),
-	'blue': (106, 126, 200),
-	'bright_black': (102, 102, 102),
-	'bright_blue': (129, 154, 255),
-	'bright_cyan': (102, 217, 239),
-	'bright_green': (126, 226, 46),
-	'bright_magenta': (174, 129, 255),
-	'bright_red': (249, 38, 114),
-	'bright_white': (248, 248, 242),
-	'bright_yellow': (226, 226, 46),
-}
-COLOR_PALETTE = __DEFAULT_COLOR_PALETTE.copy()
-_DEFAULT_CALLED = True
-_DEFAULT_RETURN_UNFINISHED = False
-_DEFAULT_UPDATE_UNREACHABLE_HOSTS = True
-_DEFAULT_NO_START = False
-_etc_hosts = {}
-__ERROR_MESSAGES_TO_IGNORE_REGEX =None
-__DEBUG_MODE = False
-
 #%% Load Config Based Default Global variables
 __configs_from_file = {}
 for config_file in reversed(CONFIG_FILE_CHAIN.copy()):
@@ -467,12 +385,42 @@ __control_master_string = '''Host *
   ControlPath /run/user/%i/ssh_sockets_%C
   ControlPersist 3600
 '''
+__curses_available = False
+__resource_lib_available = False
+try:
+	import curses
+	import curses.panel
+	__curses_available = True
+except ImportError:
+	pass
+try:
+	import resource
+	__resource_lib_available = True
+except ImportError:
+	pass
 if __resource_lib_available:
 	# Get the current limits
 	_, __system_nofile_limit = resource.getrlimit(resource.RLIMIT_NOFILE)
 	# Set the soft limit to the hard limit
 	resource.setrlimit(resource.RLIMIT_NOFILE, (__system_nofile_limit, __system_nofile_limit))
 	__max_connections_nofile_limit_supported = int((__system_nofile_limit - 10) / 3)
+_binPaths = {}
+_binCalled = set(['sshpass', 'ssh', 'scp', 'ipmitool','rsync','sh','ssh-copy-id'])
+def check_path(program_name):
+	global __configs_from_file
+	global _binPaths
+	config_key = f'_{program_name}Path'
+	program_path = (
+		__configs_from_file.get(config_key) or
+		globals().get(config_key) or
+		shutil.which(program_name)
+	)
+	if program_path:
+		_binPaths[program_name] = program_path
+		return True
+	return False
+
+[check_path(program) for program in _binCalled]
 
 #%% Mapping of ANSI 4-bit colors to curses colors
 if __curses_available:
@@ -494,26 +442,78 @@ if __curses_available:
 		96: curses.COLOR_CYAN,    # Bright Cyan
 		97: curses.COLOR_WHITE    # Bright White
 	}
-#%% ------------ Exportable Help Functions ----------------
-# check if command sshpass is available
-_binPaths = {}
-_binCalled = set(['sshpass', 'ssh', 'scp', 'ipmitool','rsync','sh','ssh-copy-id'])
-def check_path(program_name):
-	global __configs_from_file
-	global _binPaths
-	config_key = f'_{program_name}Path'
-	program_path = (
-		__configs_from_file.get(config_key) or
-		globals().get(config_key) or
-		shutil.which(program_name)
-	)
-	if program_path:
-		_binPaths[program_name] = program_path
-		return True
-	return False
 
-[check_path(program) for program in _binCalled]
+#%% ------------ Host Object ----------------
+class Host:
+	def __init__(self, name, command, files = None,ipmi = False,interface_ip_prefix = None,scp=False,extraargs=None,gatherMode=False,identity_file=None,shell=False,i = -1,uuid=uuid.uuid4(),ip = None):
+		self.name = name # the name of the host (hostname or IP address)
+		self.command = command # the command to run on the host
+		self.returncode = None # the return code of the command
+		self.output = [] # the output of the command for curses
+		self.stdout = [] # the stdout of the command
+		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
+		self.interface_ip_prefix = interface_ip_prefix # the prefix of the ip address of the interface to be used to connect to the host
+		self.scp = scp # whether to use scp to copy files to the host
+		self.gatherMode = gatherMode # whether the host is in gather mode
+		self.extraargs = extraargs # extra arguments to be passed to ssh
+		self.resolvedName = None # the resolved IP address of the host
+		# also store a globally unique integer i from 0
+		self.i = i if i != -1 else _get_i()
+		self.uuid = uuid
+		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()
+		self.thread = None
+
+	def __iter__(self):
+		return zip(['name', 'command', 'returncode', 'stdout', 'stderr'], [self.name, self.command, self.returncode, self.stdout, self.stderr])
+	def __repr__(self):
+		return f"Host(\n{pformat(self.__dict__)}\n)"
+	def __str__(self):
+		return f"Host(\n{pformat(dict(self))}\n)"
+	def get_output_hash(self):
+		return hash((
+			self.command,
+			tuple(self.stdout),
+			tuple(self.stderr),
+			self.returncode
+		))
+	def copy(self):
+		newHost = Host(
+			name=self.name,
+			command=self.command,
+			files=self.files,
+			ipmi=self.ipmi,
+			interface_ip_prefix=self.interface_ip_prefix,
+			scp=self.scp,
+			extraargs=self.extraargs,
+			gatherMode=self.gatherMode,
+			identity_file=self.identity_file,
+			shell=self.shell,
+			i=self.i,
+			uuid=self.uuid,
+			ip=self.ip
+		)
+		newHost.returncode = self.returncode
+		newHost.output = self.output.copy()
+		newHost.stdout = self.stdout.copy()
+		newHost.stderr = self.stderr.copy()
+		newHost.lineNumToPrintSet = self.lineNumToPrintSet.copy()
+		newHost.lastUpdateTime = self.lastUpdateTime
+		newHost.lastPrintedUpdateTime = self.lastPrintedUpdateTime
+		newHost.current_color_pair = self.current_color_pair.copy()
+		return newHost
 
+#%% ------------ Exportable Help Functions ----------------
 def find_ssh_key_file(searchPath = DEFAULT_SSH_KEY_SEARCH_PATH):
 	'''
 	Find the ssh public key file
@@ -528,8 +528,7 @@ def find_ssh_key_file(searchPath = DEFAULT_SSH_KEY_SEARCH_PATH):
 		sshKeyPath = searchPath
 	else:
 		sshKeyPath ='~/.ssh'
-	possibleSshKeyFiles = ['id_ed25519','id_ed25519_sk','id_ecdsa','id_ecdsa_sk','id_rsa','id_dsa']
-	for sshKeyFile in possibleSshKeyFiles:
+	for sshKeyFile in POSSIBLE_SSH_KEY_FILES:
 		if os.path.exists(os.path.expanduser(os.path.join(sshKeyPath,sshKeyFile))):
 			return os.path.join(sshKeyPath,sshKeyFile)
 	return None
@@ -3357,7 +3356,6 @@ def processRunOnHosts(timeout, password, max_connections, hosts, return_unfinish
 
 
 #%% ------------ Stringfy Block ----------------
-
 def formHostStr(host) -> str:
 	"""
 	Forms a comma-separated string of hosts.
@@ -3896,6 +3894,7 @@ def generate_default_config(args):
 		'SSH_STRICT_HOST_KEY_CHECKING': SSH_STRICT_HOST_KEY_CHECKING,
 		'ERROR_MESSAGES_TO_IGNORE': ERROR_MESSAGES_TO_IGNORE,
 		'FORCE_TRUECOLOR': args.force_truecolor,
+		'POSSIBLE_SSH_KEY_FILES': POSSIBLE_SSH_KEY_FILES,
 	}
 
 def write_default_config(args,CONFIG_FILE = None, force = False):
@@ -3939,9 +3938,17 @@ def write_default_config(args,CONFIG_FILE = None, force = False):
 
 #%% ------------ Argument Processing -----------------
 def get_parser():
-	global _binPaths
-	parser = argparse.ArgumentParser(description='Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command.',
-								  epilog=f'Found bins: {list(_binPaths.values())}\n Missing bins: {_binCalled - set(_binPaths.keys())}\n Terminal color capability: {get_terminal_color_capability()}\nConfig file chain: {CONFIG_FILE_CHAIN!r}',)
+	parser = argparse.ArgumentParser(
+		description='Run a command on multiple hosts, Use #HOST# or #HOSTNAME# to replace the host name in the command.',
+		epilog=(
+			f"Terminal color capability: {get_terminal_color_capability()}\n"
+			f"Found bins: \n{pformat(set(_binPaths.values()))}\n"
+			f"Missing bins: \n{pformat(_binCalled - set(_binPaths.keys()))}\n"
+			f"Config file chain: \n{pformat(CONFIG_FILE_CHAIN)}\n"
+			f"Hosts Env files searched:\n{pformat(DEFAULT_ENV_FILES)}"
+		),
+		formatter_class=argparse.RawTextHelpFormatter,
+	)
 	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)
 	parser.add_argument('commands', metavar='commands', type=str, nargs='*',default=None,help='the command to run on the hosts / the destination of the files #HOST# or #HOSTNAME# will be replaced with the host name.')
 	parser.add_argument('-u','--username', type=str,help=f'The general username to use to connect to the hosts. Will get overwrote by individual username@host if specified. (default: {DEFAULT_USERNAME})',default=DEFAULT_USERNAME)