xulbux 1.7.1__py3-none-any.whl → 1.7.2__py3-none-any.whl

xulbux/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.7.1"
+__version__ = "1.7.2"
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"
 __license__ = "MIT"

xulbux/_consts_.py

@@ -94,8 +94,6 @@ class ANSI:
     """The separator between ANSI escape sequence parts."""
     END = end = "m"
     """The end of an ANSI escape sequence."""
-    default_color_modifiers: dict[str, str] = {"lighten": "+l", "darken": "-d"}
-    """Characters to modify the lightness of the default color with."""
 
     @classmethod
     def seq(cls, parts: int = 1) -> FormattableString:
@@ -107,7 +105,7 @@ class ANSI:
     seq_bg_color: FormattableString = CHAR + START + "48" + SEP + "2" + SEP + "{}" + SEP + "{}" + SEP + "{}" + END
     """The ANSI escape sequence for setting the background RGB color."""
 
-    color_map: list[str] = [
+    color_map: tuple[str, ...] = (
         ########### DEFAULT CONSOLE COLOR NAMES ############
         "black",
         "red",
@@ -117,7 +115,7 @@ class ANSI:
         "magenta",
         "cyan",
         "white",
-    ]
+    )
     """The console default color names."""
 
     codes_map: dict[str | tuple[str, ...], int] = {

xulbux/xx_code.py

@@ -53,7 +53,7 @@ class Code:
         return list(Data.remove_duplicates(funcs + nested_func_calls))
 
     @staticmethod
-    def is_js(code: str, funcs: list = ["__", "$t", "$lang"]) -> bool:
+    def is_js(code: str, funcs: list[str] = ["__", "$t", "$lang"]) -> bool:
         """Will check if the code is very likely to be JavaScript."""
         if not code or len(code.strip()) < 3:
             return False

xulbux/xx_console.py

@@ -25,20 +25,29 @@ import os as _os
 class _ConsoleWidth:
 
     def __get__(self, obj, owner=None):
-        return _os.get_terminal_size().columns
+        try:
+            return _os.get_terminal_size().columns
+        except OSError:
+            return 80
 
 
 class _ConsoleHeight:
 
     def __get__(self, obj, owner=None):
-        return _os.get_terminal_size().lines
+        try:
+            return _os.get_terminal_size().lines
+        except OSError:
+            return 24
 
 
 class _ConsoleSize:
 
     def __get__(self, obj, owner=None):
-        size = _os.get_terminal_size()
-        return (size.columns, size.lines)
+        try:
+            size = _os.get_terminal_size()
+            return (size.columns, size.lines)
+        except OSError:
+            return (80, 24)
 
 
 class _ConsoleUser:
@@ -231,13 +240,13 @@ class Console:
         exit_code: int = 0,
         reset_ansi: bool = False,
     ) -> None:
-        """Will print the `last_prompt` and then pause the program if `pause` is set
+        """Will print the `prompt` and then pause the program if `pause` is set
         to `True` and after the pause, exit the program if `exit` is set to `True`."""
         print(prompt, end="", flush=True)
         if reset_ansi:
             FormatCodes.print("[_]", end="")
         if pause:
-            _keyboard.read_event()
+            _keyboard.read_key(suppress=True)
         if exit:
             _sys.exit(exit_code)
 
@@ -344,8 +353,8 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.yellow,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.yellow,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = False,
     ) -> None:
@@ -362,8 +371,8 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.blue,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.blue,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = False,
     ) -> None:
@@ -378,8 +387,8 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.teal,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.teal,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = False,
     ) -> None:
@@ -394,8 +403,8 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.orange,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.orange,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = False,
     ) -> None:
@@ -410,11 +419,11 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.red,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.red,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = True,
-        reset_ansi=True,
+        reset_ansi: bool = True,
     ) -> None:
         """A preset for `log()`: `FAIL` log message with the options to pause
         at the message and exit the program after the message was printed."""
@@ -427,11 +436,11 @@ class Console:
         format_linebreaks: bool = True,
         start: str = "",
         end: str = "\n",
-        title_bg_color: Rgba | Hexa = COLOR.magenta,
-        default_color: Rgba | Hexa = COLOR.text,
+        title_bg_color: Optional[Rgba | Hexa] = COLOR.magenta,
+        default_color: Optional[Rgba | Hexa] = COLOR.text,
         pause: bool = False,
         exit: bool = True,
-        reset_ansi=True,
+        reset_ansi: bool = True,
     ) -> None:
         """A preset for `log()`: `EXIT` log message with the options to pause
         at the message and exit the program after the message was printed."""
@@ -443,8 +452,8 @@ class Console:
         *values: object,
         start: str = "",
         end: str = "\n",
-        box_bg_color: Rgba | Hexa = "green",
-        default_color: Rgba | Hexa = "#000",
+        box_bg_color: str | Rgba | Hexa = "green",
+        default_color: Optional[Rgba | Hexa] = None,
         w_padding: int = 2,
         w_full: bool = False,
     ) -> None:
@@ -494,6 +503,7 @@ class Console:
         - `start` -⠀something to print before the log box is printed (e.g. `\\n`)
         - `end` -⠀something to print after the log box is printed (e.g. `\\n`)
         - `border_type` -⠀one of the predefined border character sets
+        - `border_style` -⠀the style of the border (special formatting codes)
         - `default_color` -⠀the default text color of the `*values`
         - `w_padding` -⠀the horizontal padding (in chars) to the box content
         - `w_full` -⠀whether to make the box be the full console width or not
@@ -559,7 +569,7 @@ class Console:
         prompt: object = "Do you want to continue?",
         start="",
         end="\n",
-        default_color: Rgba | Hexa = COLOR.cyan,
+        default_color: Optional[Rgba | Hexa] = COLOR.cyan,
         default_is_yes: bool = True,
     ) -> bool:
         """Ask a yes/no question.\n
@@ -569,7 +579,7 @@ class Console:
         confirmed = input(
             FormatCodes.to_ansi(
                 f'{start}  {str(prompt)} [_|dim](({"Y" if default_is_yes else "y"}/{"n" if default_is_yes else "N"}):  )',
-                default_color,
+                default_color=default_color,
             )
         ).strip().lower() in (("", "y", "yes") if default_is_yes else ("y", "yes"))
         if end:
@@ -581,7 +591,7 @@ class Console:
         prompt: object = "",
         start="",
         end="\n",
-        default_color: Rgba | Hexa = COLOR.cyan,
+        default_color: Optional[Rgba | Hexa] = COLOR.cyan,
         show_keybindings=True,
         input_prefix=" ⮡ ",
         reset_ansi=True,
@@ -616,7 +626,7 @@ class Console:
         prompt: object = "",
         start="",
         end="\n",
-        default_color: Rgba | Hexa = COLOR.cyan,
+        default_color: Optional[Rgba | Hexa] = COLOR.cyan,
         allowed_chars: str = CHARS.all,  # type: ignore[assignment]
         min_len: Optional[int] = None,
         max_len: Optional[int] = None,
@@ -720,7 +730,7 @@ class Console:
         prompt: object = "Password: ",
         start="",
         end="\n",
-        default_color: Rgba | Hexa = COLOR.cyan,
+        default_color: Optional[Rgba | Hexa] = COLOR.cyan,
         allowed_chars: str = CHARS.standard_ascii,
         min_len: Optional[int] = None,
         max_len: Optional[int] = None,

xulbux/xx_format_codes.py

@@ -133,10 +133,13 @@ the formatting code:
 #### Additional Formatting Codes when a `default_color` is set
 
 1. `[*]` resets everything, just like `[_]`, but the text color will remain in `default_color`
-  (*if no `default_color` it resets everything, including the text color*)
+  (if no `default_color` is set, it resets everything, exactly like `[_]`)
 2. `[*color]` `[*c]` will reset the text color, just like `[_color]`, but then also make it `default_color`
+  (if no `default_color` is set, both are treated as invalid formatting codes)
 3. `[default]` will just color the text in `default_color`
+  (if no `default_color` is set, it's treated as an invalid formatting code)
 4. `[background:default]` `[BG:default]` will color the background in `default_color`
+  (if no `default_color` is set, both are treated as invalid formatting codes)\n
 
 Unlike the standard console colors, the default color can be changed by using the following modifiers:
 
@@ -149,6 +152,7 @@ Unlike the standard console colors, the default color can be changed by using th
 - `[ddd]` will darken the `default_color` text by `3 × brightness_steps`%
 - ... etc.
 Per default, you can also use `+` and `-` to get lighter and darker `default_color` versions.
+All of these lighten/darken formatting codes are treated as invalid if no `default_color` is set.
 """
 
 from ._consts_ import ANSI
@@ -165,6 +169,11 @@ import re as _re
 
 _CONSOLE_ANSI_CONFIGURED: bool = False
 
+_ANSI_SEQ_1: str = ANSI.seq(1)
+_DEFAULT_COLOR_MODS: dict[str, str] = {
+    "lighten": "+l",
+    "darken": "-d",
+}
 _PREFIX: dict[str, set[str]] = {
     "BG": {"background", "bg"},
     "BR": {"bright", "br"},
@@ -190,7 +199,7 @@ _COMPILED: dict[str, Pattern] = {  # PRECOMPILE REGULAR EXPRESSIONS
     "modifier": _re.compile(
         r"(?i)((?:BG\s*:)?)\s*("
         + "|".join(
-            [f"{_re.escape(m)}+" for m in ANSI.default_color_modifiers["lighten"] + ANSI.default_color_modifiers["darken"]]
+            [f"{_re.escape(m)}+" for m in _DEFAULT_COLOR_MODS["lighten"] + _DEFAULT_COLOR_MODS["darken"]]
         )
         + r")$"
     ),
@@ -247,6 +256,7 @@ class FormatCodes:
         default_color: Optional[Rgba | Hexa] = None,
         brightness_steps: int = 20,
         _default_start: bool = True,
+        _validate_default: bool = True,
     ) -> str:
         """Convert the formatting codes inside a string to ANSI formatting.\n
         -------------------------------------------------------------------------
@@ -254,16 +264,20 @@ class FormatCodes:
         `xx_format_codes` module documentation."""
         if not isinstance(string, str):
             string = str(string)
-        if default_color and Color.is_valid_rgba(default_color, False):
-            use_default = True
-        elif default_color and Color.is_valid_hexa(default_color, False):
-            use_default, default_color = True, Color.to_rgba(default_color)
+        use_default, default_specified = False, default_color is not None
+        if _validate_default and default_specified:
+            if Color.is_valid_rgba(default_color, False):
+                use_default = True
+            elif Color.is_valid_hexa(default_color, False):
+                use_default, default_color = True, Color.to_rgba(default_color)  # type: ignore[assignment]
         else:
-            use_default = False
-        default_color = cast(rgba, default_color) if use_default else None
+            use_default = default_specified
+        default_color = cast(Optional[rgba], default_color)
         if use_default:
             string = _COMPILED["*"].sub(r"[\1_|default\2]", string)  # REPLACE `[…|*|…]` WITH `[…|_|default|…]`
-            string = _COMPILED["*color"].sub(r"[\1default\2]", string)  # REPLACE `[…|*color|…]` OR `[…|*c|…]` WITH `[…|default|…]`
+            string = _COMPILED["*color"].sub(
+                r"[\1default\2]", string
+            )  # REPLACE `[…|*color|…]` OR `[…|*c|…]` WITH `[…|default|…]`
         else:
             string = _COMPILED["*"].sub(r"[\1_\2]", string)  # REPLACE `[…|*|…]` WITH `[…|_|…]`
 
@@ -277,11 +291,23 @@ class FormatCodes:
             if formats_escaped := bool(_COMPILED["escape_char_cond"].match(match.group(0))):
                 _formats = formats = _COMPILED["escape_char"].sub(r"\1", formats)  # REMOVE / OR \\
             if auto_reset_txt and auto_reset_txt.count("[") > 0 and auto_reset_txt.count("]") > 0:
-                auto_reset_txt = FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, False)
+                auto_reset_txt = FormatCodes.to_ansi(
+                    auto_reset_txt,
+                    default_color,
+                    brightness_steps,
+                    _default_start=False,
+                    _validate_default=False,
+                )
             if not formats:
                 return match.group(0)
             if formats.count("[") > 0 and formats.count("]") > 0:
-                formats = FormatCodes.to_ansi(formats, default_color, brightness_steps, False)
+                formats = FormatCodes.to_ansi(
+                    formats,
+                    default_color,
+                    brightness_steps,
+                    _default_start=False,
+                    _validate_default=False,
+                )
             format_keys = [k.strip() for k in formats.split("|") if k.strip()]
             ansi_formats = [
                 r if (r := FormatCodes.__get_replacement(k, default_color, brightness_steps)) != k else f"[{k}]"
@@ -323,13 +349,13 @@ class FormatCodes:
             else:
                 return (
                     "".join(ansi_formats) + (
-                        f"({FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, False)})"
+                        f"({FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, _default_start=False, _validate_default=False)})"
                         if auto_reset_escaped and auto_reset_txt else auto_reset_txt if auto_reset_txt else ""
                     ) + ("" if auto_reset_escaped else "".join(ansi_resets))
                 )
 
         string = "\n".join(_COMPILED["formatting"].sub(replace_keys, line) for line in string.split("\n"))
-        return (((FormatCodes.__get_default_ansi(default_color.values()) or "") if _default_start else "")
+        return (((FormatCodes.__get_default_ansi(default_color) or "") if _default_start else "")
                 + string) if default_color is not None else string
 
     @staticmethod
@@ -399,19 +425,21 @@ class FormatCodes:
 
     @staticmethod
     def __get_default_ansi(
-        default_color: tuple[int, int, int],
+        default_color: rgba,
         format_key: Optional[str] = None,
         brightness_steps: Optional[int] = None,
-        _modifiers: tuple[str, str] = (ANSI.default_color_modifiers["lighten"], ANSI.default_color_modifiers["darken"]),
+        _modifiers: tuple[str, str] = (_DEFAULT_COLOR_MODS["lighten"], _DEFAULT_COLOR_MODS["darken"]),
     ) -> Optional[str]:
         """Get the `default_color` and lighter/darker versions of it as ANSI code."""
-        if not brightness_steps or (format_key and _COMPILED["bg?_default"].search(format_key)):
+        if not isinstance(default_color, rgba):
+            return None
+        _default_color: tuple[int, int, int] = tuple(default_color)[:3]
+        if brightness_steps is None or (format_key and _COMPILED["bg?_default"].search(format_key)):
             return (ANSI.seq_bg_color if format_key and _COMPILED["bg_default"].search(format_key) else ANSI.seq_color).format(
-                *default_color[:3]
+                *_default_color
             )
         if format_key is None or not (format_key in _modifiers[0] or format_key in _modifiers[1]):
             return None
-        assert format_key is not None
         match = _COMPILED["modifier"].match(format_key)
         if not match:
             return None
@@ -422,7 +450,7 @@ class FormatCodes:
             if adjust and adjust > 0:
                 modifiers = mod
                 break
-        new_rgb = default_color
+        new_rgb = _default_color
         if adjust == 0:
             return None
         elif modifiers in _modifiers[0]:
@@ -436,15 +464,13 @@ class FormatCodes:
         """Gives you the corresponding ANSI code for the given format key.
         If `default_color` is not `None`, the text color will be `default_color` if all formats
         are reset or you can get lighter or darker version of `default_color` (also as BG)"""
-        use_default = default_color and Color.is_valid_rgba(default_color, False)
-        _default_color = tuple(Color.to_rgba(default_color)) if default_color is not None else tuple()
         _format_key, format_key = format_key, FormatCodes.__normalize_key(format_key)  # NORMALIZE KEY AND SAVE ORIGINAL
-        if use_default:
-            if new_default_color := FormatCodes.__get_default_ansi(_default_color, format_key, brightness_steps):
-                return new_default_color
+        if default_color and (new_default_color := FormatCodes.__get_default_ansi(default_color, format_key,
+                                                                                  brightness_steps)):
+            return new_default_color
         for map_key in ANSI.codes_map:
             if (isinstance(map_key, tuple) and format_key in map_key) or format_key == map_key:
-                return ANSI.seq().format(
+                return _ANSI_SEQ_1.format(
                     next((
                         v for k, v in ANSI.codes_map.items() if format_key == k or (isinstance(k, tuple) and format_key in k)
                     ), None)

{xulbux-1.7.1.dist-info → xulbux-1.7.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xulbux
-Version: 1.7.1
+Version: 1.7.2
 Summary: A Python library which includes lots of helpful classes, types and functions aiming to make common programming tasks simpler.
 Author-email: XulbuX <xulbux.real@gmail.com>
 License-Expression: MIT

{xulbux-1.7.1.dist-info → xulbux-1.7.2.dist-info}/RECORD

@@ -1,21 +1,21 @@
-xulbux/__init__.py,sha256=4qceHbARrYX-ui-kl5bufH3BlEvMwJpsXG1TQsbNHgA,815
+xulbux/__init__.py,sha256=vd8y5L0AwqnxqXm_IAJ5grbfm8ZkcSHJx36n1KUQTlc,815
 xulbux/_cli_.py,sha256=J4vfJHLJEYxCZzA_VJUB46w2WGShfdYFoetsLG5PfKo,3428
-xulbux/_consts_.py,sha256=AuYTTmqrP2lawyVGlPLUaP1syxOoPA-ejJGH7WlwFzk,6314
-xulbux/xx_code.py,sha256=w9yO-GPMeaE-xDi-L3VtpPpWpu5jOwagfMsG93aXANE,6106
+xulbux/_consts_.py,sha256=4CLJE-YH3si2YQ-IHcjsT5PW0D7vGvm8ZH13rUoG5cE,6166
+xulbux/xx_code.py,sha256=b8MJId-BmZOsBH38z-h055op7qIICdsTT3rFJ7SWkiE,6111
 xulbux/xx_color.py,sha256=Thj7fFTc8x-VmYyULI3HQW0uCk9dIihwrGUwuXGn83s,49744
-xulbux/xx_console.py,sha256=mruEcbehVceXuDhIMV_WoFec8MxXf2orvlNQWkdI-zE,34367
+xulbux/xx_console.py,sha256=c61EXVGQo_OL_MUWb4oXbIr6EKesm1v-FwxBIe47ZTg,34866
 xulbux/xx_data.py,sha256=nEfVwK6-ILaL3K-bLezKpG1G7117CY5ZgC3BGwANrUE,30886
 xulbux/xx_env_path.py,sha256=x56mKK4lSvU5yMCAs8k0RVIqXWUJcpcHYz5HoZ_RklM,4160
 xulbux/xx_file.py,sha256=KerXOvKS93zIoAt36YTYuZboSmxVFVf2WcOrDcdwXfE,2627
-xulbux/xx_format_codes.py,sha256=NihbRkPjDSWJCL2itZBlvhbO0bWx8Mm2P-LpSeaG3po,23732
+xulbux/xx_format_codes.py,sha256=-tSsgy1tRelmU5x5ZS7ujaiXntyRqk1sm759tyvVIyU,24698
 xulbux/xx_json.py,sha256=V7vdfpvSe9wpktR_c8zG_Meix7x9IRmn66k5nB3HUyo,7457
 xulbux/xx_path.py,sha256=lLAEVZrW0TAwCewlONFVQcQ_8tVn9LTJZVOZpeGvE5s,7673
 xulbux/xx_regex.py,sha256=_BtMHRDNcD9zF4SL87dQuUVZcYGfZx9H5YNSDiEtzm8,8059
 xulbux/xx_string.py,sha256=QaTo0TQ9m_2USNgQNaVw5ivQt-A1E-e5x8OpIB3xIlY,5561
 xulbux/xx_system.py,sha256=Tsx4wgztUg46KloqcGeiFkarDoM3EgJLXw3XNxgHBmU,6460
-xulbux-1.7.1.dist-info/licenses/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
-xulbux-1.7.1.dist-info/METADATA,sha256=rMdO8mHMOtT-oLsysIUup9myW_B93Z2UdG1Gvasu_rA,9209
-xulbux-1.7.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xulbux-1.7.1.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
-xulbux-1.7.1.dist-info/top_level.txt,sha256=FkK4EZajwfP36fnlrPaR98OrEvZpvdEOdW1T5zTj6og,7
-xulbux-1.7.1.dist-info/RECORD,,
+xulbux-1.7.2.dist-info/licenses/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
+xulbux-1.7.2.dist-info/METADATA,sha256=vlIkVkj97ZLjiFajkGrSZ5O0GDrzuIunJ1E1iqY-QTA,9209
+xulbux-1.7.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xulbux-1.7.2.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
+xulbux-1.7.2.dist-info/top_level.txt,sha256=FkK4EZajwfP36fnlrPaR98OrEvZpvdEOdW1T5zTj6og,7
+xulbux-1.7.2.dist-info/RECORD,,