multiSSH3 5.36__py3-none-any.whl → 5.40__py3-none-any.whl

{multiSSH3-5.36.dist-info → multiSSH3-5.40.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: multiSSH3
-Version: 5.36
+Version: 5.40
 Summary: Run commands on multiple hosts via SSH
 Home-page: https://github.com/yufei-pan/multiSSH3
 Author: Yufei Pan
@@ -13,6 +13,15 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: argparse
 Requires-Dist: ipaddress
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 # multiSSH3
 A script that is able to issue commands to multiple hosts while monitoring their progress.
@@ -43,6 +52,15 @@ mssh --store_config_file
 
 You can modify the json file directly after generation and multissh will read from it for loading defaults. 
 
+```bash
+mssh --ipmi_interface_ip_prefix 192 --store_config_file
+```
+will store 
+```json
+"DEFAULT_IPMI_INTERFACE_IP_PREFIX": "192"
+```
+into the json file.
+
 Note:
 
 If you want to store password, it will be a plain text password in this config file. This will be better to supply it everytime as a CLI argument but you should really consider setting up priv-pub key setup.
@@ -53,15 +71,6 @@ On some systems, scp / rsync will require you use a priv-pub key to work
 
 This option can also be used to store cli options into the config files. For example.
 
-```bash
-mssh --ipmi_interface_ip_prefix 192 --store_config_file
-```
-will store 
-```json
-"DEFAULT_IPMI_INTERFACE_IP_PREFIX": "192"
-```
-into the json file.
-
 By defualt reads bash env variables for hostname aliases. Also able to read
 ```bash
 DEFAULT_ENV_FILE = '/etc/profile.d/hosts.sh'
@@ -77,7 +86,7 @@ us_east='100.100.0.1-3,us_east_prod_[1-5]'
 us_central=""
 us_west="100.101.0.1-2,us_west_prod_[a-c]_[1-3]"
 us="$us_east,$us_central,$us_west"
-asia="100.90.0-1,1-9"
+asia="100.90.0-1.1-9"
 eu=''
 rhel8="$asia,$us_east"
 all="$us,$asia,$eu"

multiSSH3-5.40.dist-info/RECORD

@@ -0,0 +1,7 @@
+multiSSH3.py,sha256=X9lJZNiWAuiNtEnSjBkqSgbgGMWhxB5MZIjS_ejpj14,137577
+multiSSH3-5.40.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+multiSSH3-5.40.dist-info/METADATA,sha256=pJGmT8HeakwctZYc4uW54_Z-v2Q1liCL1TjD7xddV5E,18366
+multiSSH3-5.40.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+multiSSH3-5.40.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
+multiSSH3-5.40.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
+multiSSH3-5.40.dist-info/RECORD,,

{multiSSH3-5.36.dist-info → multiSSH3-5.40.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.6.0)
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

multiSSH3.py

@@ -1,13 +1,21 @@
 #!/usr/bin/env python3
 __curses_available = False
+__resource_lib_available = False
 try:
 	import curses
 	__curses_available = True
 except ImportError:
 	pass
+try:
+	import resource
+	__resource_lib_available = True
+except ImportError:
+	pass
+
 import subprocess
 import threading
-import time,os
+import time
+import os
 import argparse
 from itertools import product
 import re
@@ -37,7 +45,7 @@ except AttributeError:
 		# If neither is available, use a dummy decorator
 		def cache_decorator(func):
 			return func
-version = '5.36'
+version = '5.40'
 VERSION = version
 
 CONFIG_FILE = '/etc/multiSSH3.config.json'	
@@ -158,7 +166,7 @@ def _get_i():
 
 # ------------ 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,bash=False,i = _get_i(),uuid=uuid.uuid4(),ip = None):
+	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 = _get_i(),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
@@ -170,7 +178,7 @@ class Host:
 		self.lastUpdateTime = time.time() # the last time the output was updated
 		self.files = files # the files to be copied to the host
 		self.ipmi = ipmi # whether to use ipmi to connect to the host
-		self.bash = bash # whether to use bash to run the command
+		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
@@ -272,7 +280,7 @@ __build_in_default_config = {
 	'_scpPath': None,
 	'_ipmitoolPath': None,
 	'_rsyncPath': None,
-	'_bashPath': None,
+	'_shellPath': None,
 	'__ERROR_MESSAGES_TO_IGNORE_REGEX':None,
 	'__DEBUG_MODE': False,
 }
@@ -352,26 +360,34 @@ if True:
 	__curses_current_color_pair_index = 2  # Start from 1, as 0 is the default color pair
 	__curses_color_table = {}
 	__curses_current_color_index = 10
+	__max_connections_nofile_limit_supported = 0
+	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 - 5) / 4.6)
 
 # Mapping of ANSI 4-bit colors to curses colors
-ANSI_TO_CURSES_COLOR = {
-	30: curses.COLOR_BLACK,
-	31: curses.COLOR_RED,
-	32: curses.COLOR_GREEN,
-	33: curses.COLOR_YELLOW,
-	34: curses.COLOR_BLUE,
-	35: curses.COLOR_MAGENTA,
-	36: curses.COLOR_CYAN,
-	37: curses.COLOR_WHITE,
-	90: curses.COLOR_BLACK,   # Bright Black (usually gray)
-	91: curses.COLOR_RED,     # Bright Red
-	92: curses.COLOR_GREEN,   # Bright Green
-	93: curses.COLOR_YELLOW,  # Bright Yellow
-	94: curses.COLOR_BLUE,    # Bright Blue
-	95: curses.COLOR_MAGENTA, # Bright Magenta
-	96: curses.COLOR_CYAN,    # Bright Cyan
-	97: curses.COLOR_WHITE    # Bright White
-}
+if __curses_available:
+	ANSI_TO_CURSES_COLOR = {
+		30: curses.COLOR_BLACK,
+		31: curses.COLOR_RED,
+		32: curses.COLOR_GREEN,
+		33: curses.COLOR_YELLOW,
+		34: curses.COLOR_BLUE,
+		35: curses.COLOR_MAGENTA,
+		36: curses.COLOR_CYAN,
+		37: curses.COLOR_WHITE,
+		90: curses.COLOR_BLACK,   # Bright Black (usually gray)
+		91: curses.COLOR_RED,     # Bright Red
+		92: curses.COLOR_GREEN,   # Bright Green
+		93: curses.COLOR_YELLOW,  # Bright Yellow
+		94: curses.COLOR_BLUE,    # Bright Blue
+		95: curses.COLOR_MAGENTA, # Bright Magenta
+		96: curses.COLOR_CYAN,    # Bright Cyan
+		97: curses.COLOR_WHITE    # Bright White
+	}
 # ------------ Exportable Help Functions ----------------
 # check if command sshpass is available
 _binPaths = {}
@@ -390,7 +406,7 @@ def check_path(program_name):
 		return True
 	return False
 
-[check_path(program) for program in ['sshpass', 'ssh', 'scp', 'ipmitool','rsync','bash','ssh-copy-id']]
+[check_path(program) for program in ['sshpass', 'ssh', 'scp', 'ipmitool','rsync','sh','ssh-copy-id']]
 
 def find_ssh_key_file(searchPath = DEDAULT_SSH_KEY_SEARCH_PATH):
 	'''
@@ -472,6 +488,7 @@ def replace_magic_strings(string,keys,value,case_sensitive=False):
 	return string
 
 def pretty_format_table(data):
+	version = 1.0
 	if not data:
 		return ''
 	if type(data) == str:
@@ -488,7 +505,6 @@ def pretty_format_table(data):
 			data = [[key] + list(value) for key, value in data.items()]
 	elif type(data) != list:
 		data = list(data)
-	# TODO : add support for list of dictionaries
 	# format the list into 2d list of list of strings
 	if isinstance(data[0], dict):
 		tempData = [data[0].keys()]
@@ -833,7 +849,7 @@ def __compact_hostnames(Hostnames):
 			rtnSet.add(''.join(hostnameList))
 	return frozenset(rtnSet)
 
-def compact_hostnames(Hostnames):
+def compact_hostnames(Hostnames,verify = True):
 	"""
 	Compact a list of hostnames.
 	Compact numeric numbers into ranges.
@@ -864,10 +880,11 @@ def compact_hostnames(Hostnames):
 	else:
 		hostSet = Hostnames
 	compact_hosts = __compact_hostnames(hostSet)
-	if set(expand_hostnames(compact_hosts)) != set(expand_hostnames(hostSet)):
-		if not __global_suppress_printout:
-			eprint(f"Error compacting hostnames: {hostSet} -> {compact_hosts}")
-		compact_hosts = hostSet
+	if verify:
+		if set(expand_hostnames(compact_hosts)) != set(expand_hostnames(hostSet)):
+			if not __global_suppress_printout:
+				eprint(f"Error compacting hostnames: {hostSet} -> {compact_hosts}")
+			compact_hosts = hostSet
 	return compact_hosts
 
 # ------------ Expanding Hostnames ----------------
@@ -883,7 +900,6 @@ def __validate_expand_hostname(hostname):
 		list: A list of valid hostnames
 	'''
 	global _no_env
-	# maybe it is just defined in ./target_files/hosts.sh and exported to the environment
 	# we will try to get the valid host name from the environment
 	hostname = hostname.strip().strip('$')
 	if getIP(hostname,local=True):
@@ -1018,6 +1034,8 @@ def __expand_hostnames(hosts) -> dict:
 		dict: A dictionary of expanded hostnames with key: hostname, value: resolved IP address
 	'''
 	expandedhosts = {}
+	if isinstance(hosts, str):
+		hosts = [hosts]
 	for host in hosts:
 		host = host.strip()
 		if not host:
@@ -1220,12 +1238,12 @@ def run_command(host, sem, timeout=60,passwds=None):
 					host.username = 'admin'
 				if not host.command:
 					host.command = 'power status'
-				if 'bash' in _binPaths:
+				if 'sh' in _binPaths:
 					if passwds:
-						formatedCMD = [_binPaths['bash'],'-c',f'ipmitool -H {host.address} -U {host.username} -P {passwds} {" ".join(extraargs)} {host.command}']
+						formatedCMD = [_binPaths['sh'],'-c',f'ipmitool -H {host.address} -U {host.username} -P {passwds} {" ".join(extraargs)} {host.command}']
 					else:
 						host.output.append('Warning: Password not provided for ipmi! Using a default password `admin`.')
-						formatedCMD = [_binPaths['bash'],'-c',f'ipmitool -H {host.address} -U {host.username} -P admin {" ".join(extraargs)} {host.command}']
+						formatedCMD = [_binPaths['sh'],'-c',f'ipmitool -H {host.address} -U {host.username} -P admin {" ".join(extraargs)} {host.command}']
 				else:
 					if passwds:
 						formatedCMD = [_binPaths['ipmitool'],f'-H {host.address}',f'-U {host.username}',f'-P {passwds}'] + extraargs + [host.command]
@@ -1249,17 +1267,17 @@ def run_command(host, sem, timeout=60,passwds=None):
 				host.stderr.append('Ipmitool not found on the local machine! Please install ipmitool to use ipmi mode.')
 				host.returncode = 1
 				return
-		elif host.bash:
-			if 'bash' in _binPaths:
-				host.output.append('Running command in bash mode, ignoring the hosts...')
+		elif host.shell:
+			if 'sh' in _binPaths:
+				host.output.append('Running command in shell mode, ignoring the hosts...')
 				if __DEBUG_MODE:
-					host.stderr.append('Running command in bash mode, ignoring the hosts...')
-				formatedCMD = [_binPaths['bash'],'-c',host.command]
+					host.stderr.append('Running command in shell mode, ignoring the hosts...')
+				formatedCMD = [_binPaths['sh'],'-c',host.command]
 			else:
-				host.output.append('Bash not found on the local machine! Using ssh localhost instead...')
+				host.output.append('shell not found on the local machine! Using ssh localhost instead...')
 				if __DEBUG_MODE:
-					host.stderr.append('Bash not found on the local machine! Using ssh localhost instead...')
-				host.bash = False
+					host.stderr.append('shell not found on the local machine! Using ssh localhost instead...')
+				host.shell = False
 				host.name = 'localhost'
 				run_command(host,sem,timeout,passwds)
 		else:
@@ -1547,6 +1565,7 @@ def __get_curses_color_pair(fg, bg):
 		if __curses_current_color_pair_index >= curses.COLOR_PAIRS:
 			print("Warning: Maximum number of color pairs reached, wrapping around.")
 			__curses_current_color_pair_index = 1
+		# TODO: avoid initializing the same fg and bg color
 		curses.init_pair(__curses_current_color_pair_index, fg, bg)
 		__curses_global_color_pairs[(fg, bg)] = __curses_current_color_pair_index
 		__curses_current_color_pair_index += 1
@@ -1725,8 +1744,8 @@ def _curses_add_string_to_window(window, line = '', y = 0, x = 0, number_of_char
 	# process centering
 	if centered:
 		fill_length = numChar - len(lead_str) - len(trail_str) - sum([len(segment) for segment in segments if not segment.startswith("\x1b[")])
-		window.addnstr(y, x + charsWritten, fill_char * (fill_length // 2), numChar - charsWritten, boxAttr)
-		charsWritten += min(fill_length // 2, numChar - charsWritten)
+		window.addnstr(y, x + charsWritten, fill_char * (fill_length // 2 // len(fill_char)), numChar - charsWritten, boxAttr)
+		charsWritten += min(len(fill_char * (fill_length // 2)), numChar - charsWritten)
 	# add the segments
 	for segment in segments:
 		if not segment:
@@ -1741,7 +1760,7 @@ def _curses_add_string_to_window(window, line = '', y = 0, x = 0, number_of_char
 				charsWritten += min(len(segment), numChar - charsWritten)
 	# if we have finished printing segments but we still have space, we will fill it with fill_char
 	if charsWritten + len(trail_str) < numChar:
-		fillStr = fill_char * (numChar - charsWritten - len(trail_str))
+		fillStr = fill_char * ((numChar - charsWritten - len(trail_str))//len(fill_char))
 		#fillStr = f'{color_pair_list}'
 		window.addnstr(y, x + charsWritten, fillStr + trail_str, numChar - charsWritten, boxAttr)
 		charsWritten += numChar - charsWritten
@@ -2319,7 +2338,7 @@ def __formCommandArgStr(oneonone = DEFAULT_ONE_ON_ONE, timeout = DEFAULT_TIMEOUT
 	if gather_mode: argsList.append('--gather_mode' if not shortend else '-gm')
 	if username and username != DEFAULT_USERNAME: argsList.append(f'--username="{username}"' if not shortend else f'-u="{username}"')
 	if extraargs and extraargs != DEFAULT_EXTRA_ARGS: argsList.append(f'--extraargs="{extraargs}"' if not shortend else f'-ea="{extraargs}"')
-	if skipUnreachable: argsList.append('--skipUnreachable' if not shortend else '-su')
+	if skipUnreachable: argsList.append('--skip_unreachable' if not shortend else '-su')
 	if no_env: argsList.append('--no_env')
 	if greppable: argsList.append('--greppable' if not shortend else '-g')
 	if error_only: argsList.append('--error_only' if not shortend else '-eo')
@@ -2434,9 +2453,12 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 	if not max_connections:
 		max_connections = 4 * os.cpu_count()
 	elif max_connections == 0:
-		max_connections = 1048576
+		max_connections = __max_connections_nofile_limit_supported
 	elif max_connections < 0:
 		max_connections = (-max_connections) * os.cpu_count()
+	if __max_connections_nofile_limit_supported > 0 and max_connections > __max_connections_nofile_limit_supported:
+		eprint(f"Warning: The number of maximum connections {max_connections} is larger than estimated limit {__max_connections_nofile_limit_supported} from ulimit nofile limit {__system_nofile_limit}, setting the maximum connections to {__max_connections_nofile_limit_supported}.")
+		max_connections = __max_connections_nofile_limit_supported
 	if not commands:
 		commands = []
 	else:
@@ -2506,7 +2528,7 @@ def run_command_on_hosts(hosts = DEFAULT_HOSTS,commands = None,oneonone = DEFAUL
 				command = f"{command}{host}"
 				if password and 'sshpass' in _binPaths:
 					command = f"{_binPaths['sshpass']} -p {password} {command}"
-					hosts.append(Host(host, command,identity_file=identity_file,bash=True,ip = targetHostDic[host]))
+					hosts.append(Host(host, command,identity_file=identity_file,shell=True,ip = targetHostDic[host]))
 				else:
 					eprint(f"> {command}")
 					os.system(command)

multiSSH3-5.36.dist-info/RECORD

@@ -1,7 +0,0 @@
-multiSSH3.py,sha256=p7sWcedLIzM45ZRIFFkBo1vOzNlO-9im-He-RsTjb5E,136470
-multiSSH3-5.36.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-multiSSH3-5.36.dist-info/METADATA,sha256=YfVb3R1lsmqPW7pIuOXQpkGHSnu6R2WgDhwF_0CyD5E,18160
-multiSSH3-5.36.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-multiSSH3-5.36.dist-info/entry_points.txt,sha256=xi2rWWNfmHx6gS8Mmx0rZL2KZz6XWBYP3DWBpWAnnZ0,143
-multiSSH3-5.36.dist-info/top_level.txt,sha256=tUwttxlnpLkZorSsroIprNo41lYSxjd2ASuL8-EJIJw,10
-multiSSH3-5.36.dist-info/RECORD,,