xulbux 1.8.0__tar.gz → 1.8.1__tar.gz

{xulbux-1.8.0/src/xulbux.egg-info → xulbux-1.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xulbux
-Version: 1.8.0
+Version: 1.8.1
 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>
 Maintainer-email: XulbuX <xulbux.real@gmail.com>

{xulbux-1.8.0 → xulbux-1.8.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xulbux"
-version = "1.8.0"
+version = "1.8.1"
 authors = [{ name = "XulbuX", email = "xulbux.real@gmail.com" }]
 maintainers = [{ name = "XulbuX", email = "xulbux.real@gmail.com" }]
 description = "A Python library which includes lots of helpful classes, types and functions aiming to make common programming tasks simpler."
@@ -143,9 +143,11 @@ extend-ignore = ["E203", "E266", "W503"]
 per-file-ignores = ["__init__.py:F403,F405"]
 
 [tool.setuptools]
-packages = ["xulbux"]
 package-dir = { "" = "src" }
 
+[tool.setuptools.packages.find]
+where = ["src"]
+
 [tool.pytest.ini_options]
 minversion = "7.0"
 addopts = "-ra -q"

{xulbux-1.8.0 → xulbux-1.8.1}/src/xulbux/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.8.0"
+__version__ = "1.8.1"
 
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"

xulbux-1.8.1/src/xulbux/base/consts.py

@@ -0,0 +1,173 @@
+from typing import TypeAlias
+
+
+FormattableString: TypeAlias = str
+"""A `str` object that is made to be formatted with the `.format()` method."""
+
+
+class COLOR:
+    """Hexa color presets."""
+
+    WHITE = "#F1F2FF"
+    LIGHT_GRAY = "#B6B7C0"
+    GRAY = "#7B7C8D"
+    DARK_GRAY = "#67686C"
+    BLACK = "#202125"
+    RED = "#FF606A"
+    CORAL = "#FF7069"
+    ORANGE = "#FF876A"
+    TANGERINE = "#FF9962"
+    GOLD = "#FFAF60"
+    YELLOW = "#FFD260"
+    LIME = "#C9F16E"
+    GREEN = "#7EE787"
+    NEON_GREEN = "#4CFF85"
+    TEAL = "#50EAAF"
+    CYAN = "#3EDEE6"
+    ICE = "#77DBEF"
+    LIGHT_BLUE = "#60AAFF"
+    BLUE = "#8085FF"
+    LAVENDER = "#9B7DFF"
+    PURPLE = "#AD68FF"
+    MAGENTA = "#C860FF"
+    PINK = "#F162EF"
+    ROSE = "#FF609F"
+
+
+class CHARS:
+    """Text character sets."""
+
+    class _AllTextChars:
+        pass
+
+    ALL = _AllTextChars
+    """Code to signal that all characters are allowed."""
+
+    DIGITS = "0123456789"
+    """Digits: `0`-`9`"""
+    FLOAT_DIGITS = DIGITS + "."
+    """Digits: `0`-`9` with decimal point `.`"""
+    HEX_DIGITS = DIGITS + "#abcdefABCDEF"
+    """Digits: `0`-`9` Letters: `a`-`f` `A`-`F` and a hashtag `#`"""
+
+    LOWERCASE = "abcdefghijklmnopqrstuvwxyz"
+    """Lowercase letters `a`-`z`"""
+    LOWERCASE_EXTENDED = LOWERCASE + "äëïöüÿàèìòùáéíóúýâêîôûãñõåæç"
+    """Lowercase letters `a`-`z` with all lowercase diacritic letters."""
+    UPPERCASE = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    """Uppercase letters `A`-`Z`"""
+    UPPERCASE_EXTENDED = UPPERCASE + "ÄËÏÖÜÀÈÌÒÙÁÉÍÓÚÝÂÊÎÔÛÃÑÕÅÆÇß"
+    """Uppercase letters `A`-`Z` with all uppercase diacritic letters."""
+
+    LETTERS = LOWERCASE + UPPERCASE
+    """Lowercase and uppercase letters `a`-`z` and `A`-`Z`"""
+    LETTERS_EXTENDED = LOWERCASE_EXTENDED + UPPERCASE_EXTENDED
+    """Lowercase and uppercase letters `a`-`z` `A`-`Z` and all diacritic letters."""
+
+    SPECIAL_ASCII = " !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+    """All ASCII special characters."""
+    SPECIAL_ASCII_EXTENDED = SPECIAL_ASCII + "ø£Ø׃ªº¿®¬½¼¡«»░▒▓│┤©╣║╗╝¢¥┐└┴┬├─┼╚╔╩╦╠═╬¤ðÐı┘┌█▄¦▀µþÞ¯´≡­±‗¾¶§÷¸°¨·¹³²■ "
+    """All ASCII special characters with the extended ASCII special characters."""
+    STANDARD_ASCII = SPECIAL_ASCII + DIGITS + LETTERS
+    """All standard ASCII characters."""
+    FULL_ASCII = SPECIAL_ASCII_EXTENDED + DIGITS + LETTERS_EXTENDED
+    """All characters in the ASCII table."""
+
+
+class ANSI:
+    """Constants and methods for use of ANSI escape codes"""
+
+    ESCAPED_CHAR = "\\x1b"
+    """The printable ANSI escape character."""
+    CHAR = char = "\x1b"
+    """The ANSI escape character."""
+    START = start = "["
+    """The start of an ANSI escape sequence."""
+    SEP = sep = ";"
+    """The separator between ANSI escape sequence parts."""
+    END = end = "m"
+    """The end of an ANSI escape sequence."""
+
+    @classmethod
+    def seq(cls, parts: int = 1) -> FormattableString:
+        """Generate an ANSI sequence with `parts` amount of placeholders."""
+        return cls.CHAR + cls.START + cls.SEP.join(["{}" for _ in range(parts)]) + cls.END
+
+    SEQ_COLOR: FormattableString = CHAR + START + "38" + SEP + "2" + SEP + "{}" + SEP + "{}" + SEP + "{}" + END
+    """The ANSI escape sequence for setting the text RGB color."""
+    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: tuple[str, ...] = (
+        ########### DEFAULT CONSOLE COLOR NAMES ############
+        "black",
+        "red",
+        "green",
+        "yellow",
+        "blue",
+        "magenta",
+        "cyan",
+        "white",
+    )
+    """The console default color names."""
+
+    CODES_MAP: dict[str | tuple[str, ...], int] = {
+        ################# SPECIFIC RESETS ##################
+        "_": 0,
+        ("_bold", "_b"): 22,
+        ("_dim", "_d"): 22,
+        ("_italic", "_i"): 23,
+        ("_underline", "_u"): 24,
+        ("_double-underline", "_du"): 24,
+        ("_inverse", "_invert", "_in"): 27,
+        ("_hidden", "_hide", "_h"): 28,
+        ("_strikethrough", "_s"): 29,
+        ("_color", "_c"): 39,
+        ("_background", "_bg"): 49,
+        ################### TEXT STYLES ####################
+        ("bold", "b"): 1,
+        ("dim", "d"): 2,
+        ("italic", "i"): 3,
+        ("underline", "u"): 4,
+        ("inverse", "invert", "in"): 7,
+        ("hidden", "hide", "h"): 8,
+        ("strikethrough", "s"): 9,
+        ("double-underline", "du"): 21,
+        ################## DEFAULT COLORS ##################
+        "black": 30,
+        "red": 31,
+        "green": 32,
+        "yellow": 33,
+        "blue": 34,
+        "magenta": 35,
+        "cyan": 36,
+        "white": 37,
+        ############## BRIGHT DEFAULT COLORS ###############
+        "br:black": 90,
+        "br:red": 91,
+        "br:green": 92,
+        "br:yellow": 93,
+        "br:blue": 94,
+        "br:magenta": 95,
+        "br:cyan": 96,
+        "br:white": 97,
+        ############ DEFAULT BACKGROUND COLORS #############
+        "bg:black": 40,
+        "bg:red": 41,
+        "bg:green": 42,
+        "bg:yellow": 43,
+        "bg:blue": 44,
+        "bg:magenta": 45,
+        "bg:cyan": 46,
+        "bg:white": 47,
+        ######### BRIGHT DEFAULT BACKGROUND COLORS #########
+        "bg:br:black": 100,
+        "bg:br:red": 101,
+        "bg:br:green": 102,
+        "bg:br:yellow": 103,
+        "bg:br:blue": 104,
+        "bg:br:magenta": 105,
+        "bg:br:cyan": 106,
+        "bg:br:white": 107,
+    }
+    """All custom format keys and their corresponding ANSI format number codes."""

xulbux-1.8.1/src/xulbux/cli/help.py

@@ -0,0 +1,45 @@
+from .. import __version__
+from ..base.consts import COLOR
+from ..format_codes import FormatCodes
+from ..console import Console
+
+
+CLR = {
+    "class": COLOR.TANGERINE,
+    "const": COLOR.RED,
+    "func": COLOR.CYAN,
+    "import": COLOR.NEON_GREEN,
+    "lib": COLOR.ORANGE,
+    "punctuators": COLOR.DARK_GRAY,
+    "code_border": COLOR.GRAY,
+}
+HELP = FormatCodes.to_ansi(
+    rf"""  [_|b|#7075FF]               __  __
+  [b|#7075FF]  _  __ __  __/ / / /_  __  ___  __
+  [b|#7075FF] | |/ // / / / / / __ \/ / / | |/ /
+  [b|#7075FF] > , </ /_/ / /_/ /_/ / /_/ /> , <
+  [b|#7075FF]/_/|_|\____/\__/\____/\____//_/|_|  [*|BG:{COLOR.GRAY}|#000] v[b]{__version__} [*]
+
+  [i|{COLOR.CORAL}]A TON OF COOL FUNCTIONS, YOU NEED![*]
+
+  [b|#FCFCFF]Usage:[*]
+  [dim|{CLR['code_border']}](╭────────────────────────────────────────────────────╮)
+  [dim|{CLR['code_border']}](│) [{CLR['punctuators']}]# LIBRARY CONSTANTS[*]                                [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [{CLR['import']}]from [{CLR['lib']}]xulbux[{CLR['punctuators']}].[{CLR['lib']}]base[{CLR['punctuators']}].[{CLR['lib']}]consts [{CLR['import']}]import [{CLR['const']}]COLOR[{CLR['punctuators']}], [{CLR['const']}]CHARS[{CLR['punctuators']}], [{CLR['const']}]ANSI[*]  [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [{CLR['punctuators']}]# Main Classes[*]                                     [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [{CLR['import']}]from [{CLR['lib']}]xulbux [{CLR['import']}]import [{CLR['class']}]Code[{CLR['punctuators']}], [{CLR['class']}]Color[{CLR['punctuators']}], [{CLR['class']}]Console[{CLR['punctuators']}], ...[*]       [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [{CLR['punctuators']}]# module specific imports[*]                          [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [{CLR['import']}]from [{CLR['lib']}]xulbux[{CLR['punctuators']}].[{CLR['lib']}]color [{CLR['import']}]import [{CLR['func']}]rgba[{CLR['punctuators']}], [{CLR['func']}]hsla[{CLR['punctuators']}], [{CLR['func']}]hexa[*]          [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](╰────────────────────────────────────────────────────╯)
+  [b|#FCFCFF]Documentation:[*]
+  [dim|{CLR['code_border']}](╭────────────────────────────────────────────────────╮)
+  [dim|{CLR['code_border']}](│) [#DADADD]For more information see the GitHub page.          [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](│) [u|#8085FF](https://github.com/XulbuX/PythonLibraryXulbuX/wiki) [dim|{CLR['code_border']}](│)
+  [dim|{CLR['code_border']}](╰────────────────────────────────────────────────────╯)
+  [_]"""
+)
+
+
+def show_help() -> None:
+    print(HELP)
+    Console.pause_exit(pause=True, prompt="  [dim](Press any key to exit...)\n\n")

{xulbux-1.8.0 → xulbux-1.8.1}/src/xulbux/console.py

@@ -366,9 +366,12 @@ class Console:
         end: str = "\n",
         title_bg_color: Optional[Rgba | Hexa] = None,
         default_color: Optional[Rgba | Hexa] = None,
-        _console_tabsize: int = 8,
+        tab_size: int = 8,
+        title_px: int = 1,
+        title_mx: int = 2,
     ) -> None:
-        """Will print a formatted log message:
+        """Prints a nicely formatted log message.\n
+        -------------------------------------------------------------------------------------------
         - `title` -⠀the title of the log message (e.g. `DEBUG`, `WARN`, `FAIL`, etc.)
         - `prompt` -⠀the log message
         - `format_linebreaks` -⠀whether to format (indent after) the line breaks or not
@@ -376,38 +379,40 @@ class Console:
         - `end` -⠀something to print after the log is printed (e.g. `\\n`)
         - `title_bg_color` -⠀the background color of the `title`
         - `default_color` -⠀the default text color of the `prompt`
-        - `_console_tabsize` -⠀the tab size of the console (default is 8)\n
-        -----------------------------------------------------------------------------------
+        - `tab_size` -⠀the tab size used for the log (default is 8 like console tabs)
+        - `title_px` -⠀the horizontal padding (in chars) to the title (if `title_bg_color` is set)
+        - `title_mx` -⠀the horizontal margin (in chars) to the title\n
+        -------------------------------------------------------------------------------------------
         The log message can be formatted with special formatting codes. For more detailed
         information about formatting codes, see `format_codes` module documentation."""
+        has_title_bg = title_bg_color is not None and Color.is_valid(title_bg_color)
         title = "" if title is None else title.strip().upper()
-        title_len, tab_len = len(title) + 4, _console_tabsize - ((len(title) + 4) % _console_tabsize)
-        if title_bg_color is not None and Color.is_valid(title_bg_color):
-            title_bg_color = Color.to_hexa(title_bg_color)
-            title_color = Color.text_color_for_on_bg(title_bg_color)
-        else:
-            title_color = "_color" if title_bg_color is None else "#000"
+        title_fg = Color.text_color_for_on_bg(
+            Color.to_hexa(title_bg_color)  # type: ignore[assignment]
+        ) if has_title_bg else "_color"
+        px, mx = (" " * title_px) if has_title_bg else "", " " * title_mx
+        tab = " " * (tab_size - 1 - ((len(mx) + (title_len := len(title) + 2 * len(px))) % tab_size))
         if format_linebreaks:
             clean_prompt, removals = FormatCodes.remove_formatting(str(prompt), get_removals=True, _ignore_linebreaks=True)
-            prompt_lst = (String.split_count(l, Console.w - (title_len + tab_len)) for l in str(clean_prompt).splitlines())
+            prompt_lst = (
+                String.split_count(l, Console.w - (title_len + len(tab) + 2 * len(mx))) for l in str(clean_prompt).splitlines()
+            )
             prompt_lst = (
                 item for lst in prompt_lst for item in ([""] if lst == [] else (lst if isinstance(lst, list) else [lst]))
             )
-            prompt = f"\n{' ' * title_len}\t".join(
+            prompt = f"\n{mx}{' ' * title_len}{mx}{tab}".join(
                 Console.__add_back_removed_parts(list(prompt_lst), cast(tuple[tuple[int, str], ...], removals))
             )
-        else:
-            prompt = str(prompt)
         if title == "":
             FormatCodes.print(
-                f'{start}  {f"[{default_color}]" if default_color else ""}{str(prompt)}[_]',
+                f'{start}  {f"[{default_color}]" if default_color else ""}{prompt}[_]',
                 default_color=default_color,
                 end=end,
             )
         else:
             FormatCodes.print(
-                f'{start}  [bold][{title_color}]{f"[BG:{title_bg_color}]" if title_bg_color else ""} {title} [_]'
-                + f'\t{f"[{default_color}]" if default_color else ""}{prompt}[_]',
+                f"{start}{mx}[bold][{title_fg}]{f'[BG:{title_bg_color}]' if title_bg_color else ''}{px}{title}{px}[_]{mx}"
+                + f"{tab}{f'[{default_color}]' if default_color else ''}{prompt}[_]",
                 default_color=default_color,
                 end=end,
             )

{xulbux-1.8.0 → xulbux-1.8.1/src/xulbux.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xulbux
-Version: 1.8.0
+Version: 1.8.1
 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>
 Maintainer-email: XulbuX <xulbux.real@gmail.com>

{xulbux-1.8.0 → xulbux-1.8.1}/src/xulbux.egg-info/SOURCES.txt

@@ -1,4 +1,3 @@
-LICENSE
 README.md
 pyproject.toml
 src/xulbux/__init__.py
@@ -20,6 +19,8 @@ src/xulbux.egg-info/dependency_links.txt
 src/xulbux.egg-info/entry_points.txt
 src/xulbux.egg-info/requires.txt
 src/xulbux.egg-info/top_level.txt
+src/xulbux/base/consts.py
+src/xulbux/cli/help.py
 tests/test_code.py
 tests/test_color.py
 tests/test_color_types.py

xulbux-1.8.0/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 XulbuX
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.