xulbux 1.7.3__py3-none-any.whl → 1.8.1__py3-none-any.whl

xulbux/__init__.py

@@ -1,25 +1,23 @@
-__version__ = "1.7.3"
+__version__ = "1.8.1"
+
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"
 __license__ = "MIT"
 __copyright__ = "Copyright (c) 2024 XulbuX"
 __url__ = "https://github.com/XulbuX/PythonLibraryXulbuX"
-__description__ = "A library which includes a lot of really helpful functions."
-__all__ = [
-    "_consts_", "xx_code", "xx_color", "xx_console", "xx_data", "xx_env_path", "xx_file", "xx_format_codes", "xx_json",
-    "xx_path", "xx_regex", "xx_string", "xx_system"
-]
+__description__ = "A Python library which includes lots of helpful classes, types, and functions aiming to make common programming tasks simpler."
+
+__all__ = ["Code", "Color", "Console", "Data", "EnvPath", "File", "FormatCodes", "Json", "Path", "Regex", "String", "System"]
 
-from ._consts_ import *
-from .xx_code import *
-from .xx_color import *
-from .xx_console import *
-from .xx_data import *
-from .xx_env_path import *
-from .xx_file import *
-from .xx_format_codes import *
-from .xx_json import *
-from .xx_path import *
-from .xx_regex import *
-from .xx_string import *
-from .xx_system import *
+from .code import Code
+from .color import Color
+from .console import Console
+from .data import Data
+from .env_path import EnvPath
+from .file import File
+from .format_codes import FormatCodes
+from .json import Json
+from .path import Path
+from .regex import Regex
+from .string import String
+from .system import System

xulbux/{_consts_.py → base/consts.py}

@@ -1,4 +1,3 @@
-from dataclasses import dataclass
 from typing import TypeAlias
 
 
@@ -6,85 +5,79 @@ 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 @@ class ANSI:
         """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 @@ class ANSI:
     )
     """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,

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/{xx_code.py → code.py}

@@ -1,6 +1,6 @@
-from .xx_string import String
-from .xx_regex import Regex
-from .xx_data import Data
+from .string import String
+from .regex import Regex
+from .data import Data
 
 import regex as _rx
 

xulbux/{xx_color.py → color.py}

@@ -31,7 +31,7 @@ The `Color` class, which contains all sorts of different color-related methods:
     - saturation
 """
 
-from .xx_regex import Regex
+from .regex import Regex
 
 from typing import Annotated, TypeAlias, Iterator, Optional, Literal, Union, Any, cast
 import re as _re