bugfix & linting

Author: xulbux

CHANGELOG.md

@@ -22,6 +22,7 @@
 * Removed unnecessary character escaping in the precompiled regex patterns in the `console` module.
 * Removed all the runtime type-checks that can also be checked using static type-checking tools, since you're supposed to use type checkers in modern python anyway, and to improve performance.
 * Renamed the internal class method `FormatCodes.__config_console()` to `FormatCodes._config_console()` to make it callable, but still indicate that it's internal.
+* Fixed a small bug where `Console.log_box_…()` would sometimes raise an exception due to an issue in the internal method `__prepare_log_box()`.
 
 **BREAKING CHANGES:**
 * The arguments when calling `Console.get_args()` are no longer specified in a single dictionary, but now each argument is passed as a separate keyword argument.<br>

src/xulbux/console.py

@@ -709,11 +709,11 @@ def log_box_filled(
         pady = " " * (Console.w if w_full else max_line_len + (2 * w_padding))
         pad_w_full = (Console.w - (max_line_len + (2 * w_padding))) if w_full else 0
 
-        lines = [
+        lines = [( \
             f"{spaces_l}[bg:{box_bg_color}]{' ' * w_padding}"
-            + _FC_PATTERNS.formatting.sub(lambda m: f"{m.group(0)}[bg:{box_bg_color}]", line) +
-            (" " * ((w_padding + max_line_len - len(unfmt)) + pad_w_full)) + "[*]" for line, unfmt in zip(lines, unfmt_lines)
-        ]
+            + _FC_PATTERNS.formatting.sub(lambda m: f"{m.group(0)}[bg:{box_bg_color}]", line)
+            + (" " * ((w_padding + max_line_len - len(unfmt)) + pad_w_full)) + "[*]"
+        ) for line, unfmt in zip(lines, unfmt_lines)]
 
         FormatCodes.print(
             f"{start}{spaces_l}[bg:{box_bg_color}]{pady}[*]\n" + "\n".join(lines)
@@ -804,13 +804,19 @@ def log_box_bordered(
 
         h_rule = f"{spaces_l}[{border_style}]{border_chars[8]}{border_chars[9] * (Console.w - (len(border_chars[9] * 2)) if w_full else max_line_len + (2 * w_padding))}{border_chars[10]}[_]"
 
-        lines = [
-            h_rule if _PATTERNS.hr.match(line) else f"{spaces_l}{border_l}{' ' * w_padding}{line}[_]" + " " *
-            ((w_padding + max_line_len - len(unfmt)) + pad_w_full) + border_r for line, unfmt in zip(lines, unfmt_lines)
-        ]
+        lines = [( \
+            h_rule if _PATTERNS.hr.match(line) else f"{spaces_l}{border_l}{' ' * w_padding}{line}[_]"
+            + " " * ((w_padding + max_line_len - len(unfmt)) + pad_w_full)
+            + border_r
+        ) for line, unfmt in zip(lines, unfmt_lines)]
 
         FormatCodes.print(
-            f"{start}{border_t}[_]\n" + "\n".join(lines) + f"\n{border_b}[_]",
+            ( \
+                f"{start}{border_t}[_]\n"
+                + "\n".join(lines)
+                + ("\n" if len(lines) > 0 else "")
+                + f"{border_b}[_]"
+            ),
             default_color=default_color,
             sep="\n",
             end=end,
@@ -857,7 +863,7 @@ def __prepare_log_box(
             lines = [line for val in values for line in str(val).splitlines()]
 
         unfmt_lines = [FormatCodes.remove(line, default_color) for line in lines]
-        max_line_len = max(len(line) for line in unfmt_lines)
+        max_line_len = max(len(line) for line in unfmt_lines) if unfmt_lines else 0
         return lines, cast(list[tuple[str, tuple[tuple[int, str], ...]]], unfmt_lines), max_line_len
 
     @staticmethod
@@ -1261,8 +1267,10 @@ def show_progress(self, current: int, total: int, label: Optional[str] = None) -
         - `label` -⠀an optional label which is inserted at the `{label}` or `{l}` placeholder"""
         # THROTTLE UPDATES (UNLESS IT'S THE FIRST/FINAL UPDATE)
         current_time = _time.time()
-        if not (self._last_update_time == 0.0 or current >= total or current < 0) \
-            and (current_time - self._last_update_time) < self._min_update_interval:
+        if (
+            not (self._last_update_time == 0.0 or current >= total or current < 0) \
+            and (current_time - self._last_update_time) < self._min_update_interval
+        ):
             return
         self._last_update_time = current_time
 

src/xulbux/format_codes.py

@@ -455,7 +455,7 @@ def remove(
         --------------------------------------------------------------------------------------------------------
         - `string` -⠀the string that contains the formatting codes to remove
         - `default_color` -⠀the default text color to use if no other text color was applied
-        - `get_removals` -⠀if true, additionally to the cleaned string, a list of tuples will be returned, 
+        - `get_removals` -⠀if true, additionally to the cleaned string, a list of tuples will be returned,
           where each tuple contains the position of the removed formatting code and the removed formatting code
         - `_ignore_linebreaks` -⠀whether to ignore line breaks for the removal positions"""
         return FormatCodes.remove_ansi(
@@ -473,7 +473,7 @@ def remove_ansi(
         """Removes all ANSI codes from the string with optional tracking of removed codes.\n
         ---------------------------------------------------------------------------------------------------
         - `ansi_string` -⠀the string that contains the ANSI codes to remove
-        - `get_removals` -⠀if true, additionally to the cleaned string, a list of tuples will be returned, 
+        - `get_removals` -⠀if true, additionally to the cleaned string, a list of tuples will be returned,
           where each tuple contains the position of the removed ansi code and the removed ansi code
         - `_ignore_linebreaks` -⠀whether to ignore line breaks for the removal positions"""
         if get_removals: