xulbux 1.8.0__tar.gz → 1.8.2__tar.gz

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

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: xulbux
-Version: 1.8.0
-Summary: A Python library which includes lots of helpful classes, types and functions aiming to make common programming tasks simpler.
+Version: 1.8.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>
 Maintainer-email: XulbuX <xulbux.real@gmail.com>
 License-Expression: MIT

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

@@ -4,10 +4,10 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "xulbux"
-version = "1.8.0"
+version = "1.8.2"
 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."
+description = "A Python library which includes lots of helpful classes, types, and functions aiming to make common programming tasks simpler."
 readme = "README.md"
 license = "MIT"
 license-files = ["LICEN[CS]E.*"]
@@ -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"
@@ -161,5 +163,7 @@ testpaths = [
   "tests/test_format_codes.py",
   "tests/test_json.py",
   "tests/test_path.py",
+  "tests/test_regex.py",
   "tests/test_string.py",
+  "tests/test_system.py",
 ]

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

@@ -1,4 +1,4 @@
-__version__ = "1.8.0"
+__version__ = "1.8.2"
 
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"
@@ -7,11 +7,26 @@ __copyright__ = "Copyright (c) 2024 XulbuX"
 __url__ = "https://github.com/XulbuX/PythonLibraryXulbuX"
 __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"]
+__all__ = [
+    "Code",
+    "Color",
+    "Console",
+    "Data",
+    "EnvPath",
+    "File",
+    "FormatCodes",
+    "Json",
+    "Path",
+    "ProgressBar",
+    "Regex",
+    "String",
+    "System",
+]
 
 from .code import Code
 from .color import Color
 from .console import Console
+from .console import ProgressBar
 from .data import Data
 from .env_path import EnvPath
 from .file import File

xulbux-1.8.2/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.2/src/xulbux/cli/help.py

@@ -0,0 +1,73 @@
+from .. import __version__
+from ..base.consts import COLOR
+from ..format_codes import FormatCodes
+from ..console import Console
+
+from urllib.error import HTTPError
+from typing import Optional
+import urllib.request as _request
+import json as _json
+
+
+def get_latest_version() -> Optional[str]:
+    with _request.urlopen(URL) as response:
+        if response.status == 200:
+            data = _json.load(response)
+            return data["info"]["version"]
+        else:
+            raise HTTPError(URL, response.status, "Failed to fetch latest version info", response.headers, None)
+
+
+def is_latest_version() -> Optional[bool]:
+    try:
+        latest = get_latest_version()
+        if latest in ("", None): return None
+        latest_v_parts = tuple(int(part) for part in latest.lower().lstrip("v").split('.'))
+        installed_v_parts = tuple(int(part) for part in __version__.lower().lstrip("v").split('.'))
+        return latest_v_parts <= installed_v_parts
+    except Exception:
+        return None
+
+
+URL = "https://pypi.org/pypi/xulbux/json"
+IS_LATEST_VERSION = is_latest_version()
+CLR = {
+    "class": COLOR.TANGERINE,
+    "code_border": COLOR.GRAY,
+    "const": COLOR.RED,
+    "func": COLOR.CYAN,
+    "import": COLOR.NEON_GREEN,
+    "lib": COLOR.ORANGE,
+    "notice": COLOR.YELLOW,
+    "punctuators": COLOR.DARK_GRAY,
+}
+HELP = FormatCodes.to_ansi(
+    rf"""  [_|b|#7075FF]               __  __
+  [b|#7075FF]  _  __ __  __/ / / /_  __  ___  __
+  [b|#7075FF] | |/ // / / / / / __ \/ / / | |/ /
+  [b|#7075FF] > , </ /_/ / /_/ /_/ / /_/ /> , <
+  [b|#7075FF]/_/|_|\____/\__/\____/\____//_/|_|  [*|BG:{COLOR.GRAY}|#000] v[b]{__version__} [*|dim|{CLR['notice']}]({'' if IS_LATEST_VERSION else ' (newer available)'})[*]
+
+  [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.2}/src/xulbux/color.py

@@ -92,9 +92,13 @@ class rgba:
 
     def __init__(self, r: int, g: int, b: int, a: Optional[float] = None, _validate: bool = True):
         self.r: int
+        """The red channel (`0`–`255`)"""
         self.g: int
+        """The green channel (`0`–`255`)"""
         self.b: int
+        """The blue channel (`0`–`255`)"""
         self.a: Optional[float]
+        """The alpha channel (`0.0`–`1.0`) or `None` if not set"""
         if not _validate:
             self.r, self.g, self.b, self.a = r, g, b, a
             return
@@ -291,9 +295,13 @@ class hsla:
 
     def __init__(self, h: int, s: int, l: int, a: Optional[float] = None, _validate: bool = True):
         self.h: int
+        """The hue channel (`0`–`360`)"""
         self.s: int
+        """The saturation channel (`0`–`100`)"""
         self.l: int
+        """The lightness channel (`0`–`100`)"""
         self.a: Optional[float]
+        """The alpha channel (`0.0`–`1.0`) or `None` if not set"""
         if not _validate:
             self.h, self.s, self.l, self.a = h, s, l, a
             return
@@ -496,9 +504,13 @@ class hexa:
         _a: Optional[float] = None,
     ):
         self.r: int
+        """The red channel (`0`–`255`)"""
         self.g: int
+        """The green channel (`0`–`255`)"""
         self.b: int
+        """The blue channel (`0`–`255`)"""
         self.a: Optional[float]
+        """The alpha channel (`0.0`–`1.0`) or `None` if not set"""
         if all(x is not None for x in (_r, _g, _b)):
             self.r, self.g, self.b, self.a = cast(int, _r), cast(int, _g), cast(int, _b), _a
             return