rename class properties

Author: xulbux

CHANGELOG.md

@@ -26,6 +26,8 @@
 **BREAKING CHANGES:**
 * Made the value input into the params `bar_format` and `limited_bar_format` of `ProgressBar` be a list/tuple of strings instead of a single string, so the user can define multiple formats for different console widths.
 * Added a new param <code>sep: str = " "</code> to the `ProgressBar` class, which is used to join multiple bar-format strings.
+* Renamed the class property `Console.wh` to `Console.size`, since it describes the property better.
+* Renamed the class property `Console.usr` to `Console.user`, since it describes the property better.
 
 <span id="v1-9-0" />
 

src/xulbux/console.py

@@ -188,9 +188,9 @@ class Console:
     """The width of the console in characters."""
     h: int = _ConsoleHeight()  # type: ignore[assignment]
     """The height of the console in lines."""
-    wh: tuple[int, int] = _ConsoleSize()  # type: ignore[assignment]
+    size: tuple[int, int] = _ConsoleSize()  # type: ignore[assignment]
     """A tuple with the width and height of the console in characters and lines."""
-    usr: str = _ConsoleUser()  # type: ignore[assignment]
+    user: str = _ConsoleUser()  # type: ignore[assignment]
     """The name of the current user."""
 
     @staticmethod
@@ -913,7 +913,7 @@ def log_box_bordered(
 
     @staticmethod
     def __prepare_log_box(
-        values: tuple[object, ...],
+        values: list[object] | tuple[object, ...],
         default_color: Optional[Rgba | Hexa] = None,
         has_rules: bool = False,
     ) -> tuple[list[str], list[tuple[str, tuple[tuple[int, str], ...]]], int]:

tests/test_console.py

@@ -42,7 +42,7 @@ def mock_prompt_toolkit(monkeypatch):
 
 
 def test_console_user():
-    user_output = Console.usr
+    user_output = Console.user
     assert isinstance(user_output, str)
     assert user_output != ""
 
@@ -60,7 +60,7 @@ def test_console_height(mock_terminal_size):
 
 
 def test_console_size(mock_terminal_size):
-    size_output = Console.wh
+    size_output = Console.size
     assert isinstance(size_output, tuple)
     assert len(size_output) == 2
     assert size_output[0] == 80