update 1.8.0

Author: xulbux

CHANGELOG.md

@@ -20,12 +20,12 @@
   new, instead of flags, you can also once use the literal `"before"` and once `"after"`, which corresponds to all non-flagged values before or after all flagged values
 * changed the default `default_color` for all `Console` class input methods to `None`
 * the method `Console.restricted_input()` now returns an empty string instead of `None` if the user didn't input anything
-* fixed several small bugs for `Console.restricted_input()` regarding the ANSI formatting of the input prompt and the input text in the console
 * completely rewrote `Console.restricted_input()`, so now it's actually usable, and renamed it to just `Console.input()`
 * removed method `Console.pwd_input()`, since you can now simply use `Console.input(mask_char="*")` instead, which does the exact same thing
 * removed the CLI command `xx-help`, since it was redundant because there's already the CLI command `xulbux-help`
 * removed the `xx_` from all the library modules since it's redundant, and without it the imports look more professional and cleaner
 * renamed the previously internal module `_consts_` to `consts` and made it accessible via `from xulbux.base.consts import …`, since you should be able to use library constants without them being "internal"
+* the constants form inside the `consts` module are now all uppercase (*except the class methods*), to make clear that they're constants
 * removed the wildcard imports from the `__init__.py` file, so now you can only access the main classes directly with `from xulbux import …` and for the rest you have to import the specific module first
 
 ## 29.07.2025 `v1.7.3`

README.md

@@ -31,6 +31,15 @@ pip install --upgrade xulbux
 
 <br>
 
+## CLI Commands
+
+When the library is installed, the following commands are available in the console:
+| Command          | Description                                      |
+| :--------------- | :----------------------------------------------- |
+| `xulbux-help`    | shows some information about the library         |
+
+<br>
+
 ## Usage
 
 Import the full library under the alias `xx`, so its constants, classes, methods, and types are accessible with `xx.CONSTANT.value`, `xx.Class.method()`, `xx.type()`:
@@ -39,12 +48,12 @@ import xulbux as xx
 ```
 So you don't have to import the full library under an alias, you can also import only certain parts of the library's contents:
 ```python
-# CONSTANTS
-from xulbux import COLOR, CHARS, ANSI
-# Classes
+# LIBRARY CONSTANTS
+from xulbux.base.consts import COLOR, CHARS, ANSI
+# Main Classes
 from xulbux import Code, Color, Console, ...
-# types
-from xulbux import rgba, hsla, hexa
+# module specific imports
+from xulbux.color import rgba, hsla, hexa
 ```
 
 <br>
@@ -71,26 +80,30 @@ from xulbux import rgba, hsla, hexa
 
 ## Example Usage
 
-This is what it could look like using this library for a simple but very nice looking color converter:
+This is what it could look like using this library for a simple but ultra good-looking color converter:
 ```python
-from xulbux import COLOR                 # CONSTANTS
-from xulbux import FormatCodes, Console  # Classes
-from xulbux import hexa                  # types
+from xulbux.base.consts import COLOR, CHARS
+from xulbux.color import hexa
+from xulbux import Console
 
 
 def main() -> None:
 
     # LET THE USER ENTER A HEXA COLOR IN ANY HEXA FORMAT
-    input_clr = FormatCodes.input(
-        "\n[b](Enter a HEXA color in any format) [dim](>) "
+    input_clr = Console.input(
+        "[b](Enter a HEXA color in any format) > ",
+        start="\n",
+        placeholder="#7075FF",
+        max_len=7,
+        allowed_chars=CHARS.HEX_DIGITS,
     )
 
     # ANNOUNCE INDEXING THE INPUT COLOR
     Console.log(
         "INDEX",
         "Indexing the input HEXA color...",
         start="\n",
-        title_bg_color=COLOR.blue,
+        title_bg_color=COLOR.BLUE,
     )
 
     try:
@@ -109,7 +122,7 @@ def main() -> None:
     Console.log(
         "CONVERT",
         "Converting the HEXA color into different types...",
-        title_bg_color=COLOR.tangerine,
+        title_bg_color=COLOR.TANGERINE,
     )
 
     # CONVERT THE HEXA COLOR INTO THE TWO OTHER COLOR TYPES

src/xulbux/_cli_.py

@@ -7,31 +7,31 @@
 def help_command():
     """Show some info about the library, with a brief explanation of how to use it."""
     color = {
-        "class": COLOR.tangerine,
-        "const": COLOR.red,
-        "func": COLOR.cyan,
-        "import": COLOR.neongreen,
-        "lib": COLOR.orange,
-        "punctuators": COLOR.darkgray,
-        "code_border": COLOR.gray,
+        "class": COLOR.TANGERINE,
+        "const": COLOR.RED,
+        "func": COLOR.CYAN,
+        "import": COLOR.NEON_GREEN,
+        "lib": COLOR.ORANGE,
+        "punctuators": COLOR.DARK_GRAY,
+        "code_border": COLOR.GRAY,
     }
     FormatCodes.print(
         rf"""  [_|b|#7075FF]               __  __
   [b|#7075FF]  _  __ __  __/ / / /_  __  ___  __
   [b|#7075FF] | |/ // / / / / / __ \/ / / | |/ /
   [b|#7075FF] > , </ /_/ / /_/ /_/ / /_/ /> , <
-  [b|#7075FF]/_/|_|\____/\__/\____/\____//_/|_|  [*|BG:{COLOR.gray}|#000] v[b]{__version__} [*]
+  [b|#7075FF]/_/|_|\____/\__/\____/\____//_/|_|  [*|BG:{COLOR.GRAY}|#000] v[b]{__version__} [*]
 
-  [i|{COLOR.coral}]A TON OF COOL FUNCTIONS, YOU NEED![*]
+  [i|{COLOR.CORAL}]A TON OF COOL FUNCTIONS, YOU NEED![*]
 
   [b|#FCFCFF]Usage:[*]
   [dim|{color['code_border']}](╭────────────────────────────────────────────────────╮)
-  [dim|{color['code_border']}](│) [{color['punctuators']}]# CONSTANTS[*]                                        [dim|{color['code_border']}](│)
-  [dim|{color['code_border']}](│) [{color['import']}]from [{color['lib']}]xulbux [{color['import']}]import [{color['const']}]COLOR[{color['punctuators']}], [{color['const']}]CHARS[{color['punctuators']}], [{color['const']}]ANSI[*]              [dim|{color['code_border']}](│)
-  [dim|{color['code_border']}](│) [{color['punctuators']}]# Classes[*]                                          [dim|{color['code_border']}](│)
+  [dim|{color['code_border']}](│) [{color['punctuators']}]# LIBRARY CONSTANTS[*]                                [dim|{color['code_border']}](│)
+  [dim|{color['code_border']}](│) [{color['import']}]from [{color['lib']}]xulbux[{color['punctuators']}].[{color['lib']}]base[{color['punctuators']}].[{color['lib']}]consts [{color['import']}]import [{color['const']}]COLOR[{color['punctuators']}], [{color['const']}]CHARS[{color['punctuators']}], [{color['const']}]ANSI[*]  [dim|{color['code_border']}](│)
+  [dim|{color['code_border']}](│) [{color['punctuators']}]# Main Classes[*]                                     [dim|{color['code_border']}](│)
   [dim|{color['code_border']}](│) [{color['import']}]from [{color['lib']}]xulbux [{color['import']}]import [{color['class']}]Code[{color['punctuators']}], [{color['class']}]Color[{color['punctuators']}], [{color['class']}]Console[{color['punctuators']}], ...[*]       [dim|{color['code_border']}](│)
-  [dim|{color['code_border']}](│) [{color['punctuators']}]# types[*]                                            [dim|{color['code_border']}](│)
-  [dim|{color['code_border']}](│) [{color['import']}]from [{color['lib']}]xulbux [{color['import']}]import [{color['func']}]rgba[{color['punctuators']}], [{color['func']}]hsla[{color['punctuators']}], [{color['func']}]hexa[*]                [dim|{color['code_border']}](│)
+  [dim|{color['code_border']}](│) [{color['punctuators']}]# module specific imports[*]                          [dim|{color['code_border']}](│)
+  [dim|{color['code_border']}](│) [{color['import']}]from [{color['lib']}]xulbux[{color['punctuators']}].[{color['lib']}]color [{color['import']}]import [{color['func']}]rgba[{color['punctuators']}], [{color['func']}]hsla[{color['punctuators']}], [{color['func']}]hexa[*]          [dim|{color['code_border']}](│)
   [dim|{color['code_border']}](╰────────────────────────────────────────────────────╯)
   [b|#FCFCFF]Documentation:[*]
   [dim|{color['code_border']}](╭────────────────────────────────────────────────────╮)
@@ -40,7 +40,6 @@ def help_command():
   [dim|{color['code_border']}](╰────────────────────────────────────────────────────╯)
   [_]
   [dim](Press any key to exit...)
-  """,
-        default_color=COLOR.text
+  """
     )
     Console.pause_exit(pause=True)

src/xulbux/base/consts.py

@@ -1,90 +1,83 @@
-from dataclasses import dataclass
 from typing import TypeAlias
 
 
 FormattableString: TypeAlias = str
 """A `str` object that is made to be formatted with the `.format()` method."""
 
 
-@dataclass
 class COLOR:
-    """Color presets used in the `xulbux` library."""
-
-    text = "#A5D6FF"
-    """The default text color used in the `xulbux` library."""
-
-    white = "#F1F2FF"
-    lightgray = "#B6B7C0"
-    gray = "#7B7C8D"
-    darkgray = "#67686C"
-    black = "#202125"
-    red = "#FF606A"
-    coral = "#FF7069"
-    orange = "#FF876A"
-    tangerine = "#FF9962"
-    gold = "#FFAF60"
-    yellow = "#FFD260"
-    lime = "#C9F16E"
-    green = "#7EE787"
-    neongreen = "#4CFF85"
-    teal = "#50EAAF"
-    cyan = "#3EDEE6"
-    ice = "#77DBEF"
-    lightblue = "#60AAFF"
-    blue = "#8085FF"
-    lavender = "#9B7DFF"
-    purple = "#AD68FF"
-    magenta = "#C860FF"
-    pink = "#F162EF"
-    rose = "#FF609F"
-
-
-class _AllTextCharacters:
-    pass
-
-
-@dataclass
+    """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."""
 
-    all = _AllTextCharacters
+    class _AllTextChars:
+        pass
+
+    ALL = _AllTextChars
     """Code to signal that all characters are allowed."""
 
-    digits: str = "0123456789"
+    DIGITS = "0123456789"
     """Digits: `0`-`9`"""
-    float_digits: str = digits + "."
+    FLOAT_DIGITS = DIGITS + "."
     """Digits: `0`-`9` with decimal point `.`"""
-    hex_digits: str = digits + "#abcdefABCDEF"
+    HEX_DIGITS = DIGITS + "#abcdefABCDEF"
     """Digits: `0`-`9` Letters: `a`-`f` `A`-`F` and a hashtag `#`"""
 
-    lowercase: str = "abcdefghijklmnopqrstuvwxyz"
+    LOWERCASE = "abcdefghijklmnopqrstuvwxyz"
     """Lowercase letters `a`-`z`"""
-    lowercase_extended: str = lowercase + "äëïöüÿàèìòùáéíóúýâêîôûãñõåæç"
+    LOWERCASE_EXTENDED = LOWERCASE + "äëïöüÿàèìòùáéíóúýâêîôûãñõåæç"
     """Lowercase letters `a`-`z` with all lowercase diacritic letters."""
-    uppercase: str = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    UPPERCASE = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
     """Uppercase letters `A`-`Z`"""
-    uppercase_extended: str = uppercase + "ÄËÏÖÜÀÈÌÒÙÁÉÍÓÚÝÂÊÎÔÛÃÑÕÅÆÇß"
+    UPPERCASE_EXTENDED = UPPERCASE + "ÄËÏÖÜÀÈÌÒÙÁÉÍÓÚÝÂÊÎÔÛÃÑÕÅÆÇß"
     """Uppercase letters `A`-`Z` with all uppercase diacritic letters."""
 
-    letters: str = lowercase + uppercase
+    LETTERS = LOWERCASE + UPPERCASE
     """Lowercase and uppercase letters `a`-`z` and `A`-`Z`"""
-    letters_extended: str = lowercase_extended + uppercase_extended
+    LETTERS_EXTENDED = LOWERCASE_EXTENDED + UPPERCASE_EXTENDED
     """Lowercase and uppercase letters `a`-`z` `A`-`Z` and all diacritic letters."""
 
-    special_ascii: str = " !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
+    SPECIAL_ASCII = " !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
     """All ASCII special characters."""
-    special_ascii_extended: str = special_ascii + "ø£Ø׃ªº¿®¬½¼¡«»░▒▓│┤©╣║╗╝¢¥┐└┴┬├─┼╚╔╩╦╠═╬¤ðÐı┘┌█▄¦▀µþÞ¯´≡­±‗¾¶§÷¸°¨·¹³²■ "
+    SPECIAL_ASCII_EXTENDED = SPECIAL_ASCII + "ø£Ø׃ªº¿®¬½¼¡«»░▒▓│┤©╣║╗╝¢¥┐└┴┬├─┼╚╔╩╦╠═╬¤ðÐı┘┌█▄¦▀µþÞ¯´≡­±‗¾¶§÷¸°¨·¹³²■ "
     """All ASCII special characters with the extended ASCII special characters."""
-    standard_ascii: str = special_ascii + digits + letters
+    STANDARD_ASCII = SPECIAL_ASCII + DIGITS + LETTERS
     """All standard ASCII characters."""
-    full_ascii: str = special_ascii_extended + digits + letters_extended
+    FULL_ASCII = SPECIAL_ASCII_EXTENDED + DIGITS + LETTERS_EXTENDED
     """All characters in the ASCII table."""
 
 
 class ANSI:
-    """Constants and class-methods for use of ANSI escape codes."""
+    """Constants and methods for use of ANSI escape codes"""
 
-    escaped_char: str = "\\x1b"
+    ESCAPED_CHAR = "\\x1b"
     """The printable ANSI escape character."""
     CHAR = char = "\x1b"
     """The ANSI escape character."""
@@ -100,12 +93,12 @@ 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
+    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
+    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, ...] = (
+    COLOR_MAP: tuple[str, ...] = (
         ########### DEFAULT CONSOLE COLOR NAMES ############
         "black",
         "red",
@@ -118,7 +111,7 @@ def seq(cls, parts: int = 1) -> FormattableString:
     )
     """The console default color names."""
 
-    codes_map: dict[str | tuple[str, ...], int] = {
+    CODES_MAP: dict[str | tuple[str, ...], int] = {
         ################# SPECIFIC RESETS ##################
         "_": 0,
         ("_bold", "_b"): 22,