Function as_table

archinstall/lib/utils/format.py:89–148

variant of as_table (subtly different code) which has two additional parameters filter which is a list of fields which will be shown class_formatter a special method to format the outgoing data A general comment, the format selected for the output (a string where every data record is separated b

(
	obj: list[Any],
	class_formatter: str | Callable | None = None,  # type: ignore[type-arg]
	filter_list: list[str] = [],
	capitalize: bool = False,
)

def as_table(
	obj: list[Any],
	class_formatter: str | Callable | None = None,  # type: ignore[type-arg]
	filter_list: list[str] = [],
	capitalize: bool = False,
) -> str:
	"""variant of as_table (subtly different code) which has two additional parameters
	filter which is a list of fields which will be shown
	class_formatter a special method to format the outgoing data

	A general comment, the format selected for the output (a string where every data record is separated by newline)
	is for compatibility with a print statement
	As_table_filter can be a drop in replacement for as_table
	"""
	raw_data = [_get_values(o, class_formatter, filter_list) for o in obj]

	# determine the maximum column size
	column_width: dict[str, int] = {}
	for o in raw_data:
		for k, v in o.items():
			if not filter_list or k in filter_list:
				column_width.setdefault(k, 0)
				column_width[k] = max([column_width[k], len(str(v)), len(k)])

	if not filter_list:
		filter_list = list(column_width.keys())

	# create the header lines
	output = ''
	key_list = []
	for key in filter_list:
		width = column_width[key]
		key = key.replace('!', '').replace('_', ' ')

		if capitalize:
			key = key.capitalize()

		key_list.append(unicode_ljust(key, width))

	output += ' | '.join(key_list) + '\n'
	output += '-' * len(output) + '\n'

	# create the data lines
	for record in raw_data:
		obj_data = []
		for key in filter_list:
			width = column_width.get(key, len(key))
			value = record.get(key, '')

			if '!' in key:
				value = '*' * len(value)

			if isinstance(value, (int, float)) or (isinstance(value, str) and value.isnumeric()):
				obj_data.append(unicode_rjust(str(value), width))
			else:
				obj_data.append(unicode_ljust(str(value), width))

		output += ' | '.join(obj_data) + '\n'