xulbux 1.5.7__py3-none-any.whl → 1.5.8__py3-none-any.whl

xulbux/xx_env_path.py

@@ -0,0 +1,113 @@
+"""
+Functions for modifying and checking the systems environment-variables:
+- `EnvPath.paths()`
+- `EnvPath.has_path()`
+- `EnvPath.add_path()`
+- `EnvPath.remove_path()`
+"""
+
+from .xx_path import Path
+
+import os as _os
+import sys as _sys
+
+
+class EnvPath:
+
+    @staticmethod
+    def paths(as_list: bool = False) -> str | list:
+        """Get the PATH environment variable."""
+        paths = _os.environ.get("PATH", "")
+        return paths.split(_os.pathsep) if as_list else paths
+
+    @staticmethod
+    def has_path(path: str = None, cwd: bool = False, base_dir: bool = False) -> bool:
+        """Check if a path is present in the PATH environment variable."""
+        if cwd:
+            path = _os.getcwd()
+        elif base_dir:
+            path = Path.get(base_dir=True)
+        elif path is None:
+            raise ValueError("A path must be provided or either 'cwd' or 'base_dir' must be True.")
+        paths = EnvPath.paths(as_list=True)
+        return _os.path.normpath(path) in [_os.path.normpath(p) for p in paths]
+
+    @staticmethod
+    def add_path(
+        path: str = None,
+        cwd: bool = False,
+        base_dir: bool = False,
+    ) -> None:
+        """Add a path to the PATH environment variable."""
+        path = EnvPath.__get(path, cwd, base_dir)
+        if not EnvPath.has_path(path):
+            EnvPath.__persistent(path, add=True)
+
+    @staticmethod
+    def remove_path(
+        path: str = None,
+        cwd: bool = False,
+        base_dir: bool = False,
+    ) -> None:
+        """Remove a path from the PATH environment variable."""
+        path = EnvPath.__get(path, cwd, base_dir)
+        if EnvPath.has_path(path):
+            EnvPath.__persistent(path, remove=True)
+
+    @staticmethod
+    def __get(
+        path: str = None,
+        cwd: bool = False,
+        base_dir: bool = False,
+    ) -> list:
+        """Get and/or normalize the paths.<br>
+        Raise an error if no path is provided and<br>
+        neither `cwd` or `base_dir` is `True`."""
+        if cwd:
+            path = _os.getcwd()
+        elif base_dir:
+            path = Path.get(base_dir=True)
+        elif path is None:
+            raise ValueError("A path must be provided or either 'cwd' or 'base_dir' must be True.")
+        return _os.path.normpath(path)
+
+    @staticmethod
+    def __persistent(path: str, add: bool = False, remove: bool = False) -> None:
+        """Add or remove a path from PATH persistently across sessions as well as the current session."""
+        if add == remove:
+            raise ValueError("Either add or remove must be True, but not both.")
+        current_paths = EnvPath.paths(as_list=True)
+        path = _os.path.normpath(path)
+        if remove:
+            current_paths = [p for p in current_paths if _os.path.normpath(p) != _os.path.normpath(path)]
+        elif add:
+            current_paths.append(path)
+        _os.environ["PATH"] = new_path = _os.pathsep.join(sorted(set(filter(bool, current_paths))))
+        if _sys.platform == "win32":  # Windows
+            try:
+                import winreg as _winreg
+
+                key = _winreg.OpenKey(
+                    _winreg.HKEY_CURRENT_USER,
+                    "Environment",
+                    0,
+                    _winreg.KEY_ALL_ACCESS,
+                )
+                _winreg.SetValueEx(key, "PATH", 0, _winreg.REG_EXPAND_SZ, new_path)
+                _winreg.CloseKey(key)
+            except ImportError:
+                print("Warning: Unable to make persistent changes on Windows.")
+        else:  # UNIX-like (Linux/macOS)
+            shell_rc_file = _os.path.expanduser(
+                "~/.bashrc" if _os.path.exists(_os.path.expanduser("~/.bashrc")) else "~/.zshrc"
+            )
+            with open(shell_rc_file, "r+") as f:
+                content = f.read()
+                f.seek(0)
+                if remove:
+                    new_content = [line for line in content.splitlines() if not line.endswith(f':{path}"')]
+                    f.write("\n".join(new_content))
+                else:
+                    f.write(f'{content.rstrip()}\n# Added by XulbuX\nexport PATH="{new_path}"\n')
+                f.truncate()
+            _os.system(f"source {shell_rc_file}")

xulbux/xx_file.py

@@ -1,5 +1,5 @@
-from .xx_string import *
-from .xx_path import *
+from .xx_string import String
+from .xx_path import Path
 
 import os as _os
 

xulbux/xx_format_codes.py

@@ -68,10 +68,9 @@ Per default, you can also use `+` and `-` to get lighter and darker `default_col
 """
 
 from ._consts_ import ANSI
-from .xx_string import *
-from .xx_regex import *
+from .xx_string import String
+from .xx_regex import Regex
 from .xx_color import *
-from .xx_data import *
 
 from functools import lru_cache
 import ctypes as _ctypes

xulbux/xx_json.py

@@ -1,5 +1,5 @@
-from .xx_data import *
-from .xx_file import *
+from .xx_data import Data
+from .xx_file import File
 
 import json as _json
 import os as _os

xulbux/xx_regex.py

@@ -69,7 +69,7 @@ class Regex:
         return r"(?<=\b)(" + (func_name if func_name else r"[\w_]+") + r")\s*" + Regex.brackets("(", ")", is_group=True)
 
     @staticmethod
-    def rgba_str(fix_sep: str = ",", allow_alpha: bool = False) -> str:
+    def rgba_str(fix_sep: str = ",", allow_alpha: bool = True) -> str:
         """Matches an RGBA color inside a string.\n
         --------------------------------------------------------------------------------
         The RGBA color can be in the formats (for `fix_sep = ','`):<br>
@@ -87,7 +87,7 @@ class Regex:
         `a` 0-1 (float: opacity)\n
         --------------------------------------------------------------------------------
         If the `fix_sep` is set to nothing, any char that is not a letter or number<br>
-        can be used to separate the RGB values, including just a space."""
+        can be used to separate the RGBA values, including just a space."""
         if fix_sep in (None, ""):
             fix_sep = r"[^0-9A-Z]"
         else:
@@ -105,7 +105,7 @@ class Regex:
         )
 
     @staticmethod
-    def hsla_str(fix_sep: str = ",", allow_alpha: bool = False) -> str:
+    def hsla_str(fix_sep: str = ",", allow_alpha: bool = True) -> str:
         """Matches a HSLA color inside a string.\n
         --------------------------------------------------------------------------------
         The HSLA color can be in the formats (for `fix_sep = ','`):<br>
@@ -123,7 +123,7 @@ class Regex:
         `a` 0-1 (float: opacity)\n
         --------------------------------------------------------------------------------
         If the `fix_sep` is set to nothing, any char that is not a letter or number<br>
-        can be used to separate the HSL values, including just a space."""
+        can be used to separate the HSLA values, including just a space."""
         if fix_sep in (None, ""):
             fix_sep = r"[^0-9A-Z]"
         else:
@@ -139,3 +139,21 @@ class Regex:
             if allow_alpha
             else rf"(?ix)(?:hsl|hsla)?\s*(?:\(?\s*{hsl_part}\s*\)?)"
         )
+
+    @staticmethod
+    def hexa_str(allow_alpha: bool = True) -> str:
+        """Matches a HEXA color inside a string.\n
+        --------------------------------------------------------------------------
+        The HEXA color can be in the formats (prefix `#`, `0x` or no prefix):<br>
+        `RGB`<br>
+        `RGBA` (if `allow_alpha=True`)<br>
+        `RRGGBB`<br>
+        `RRGGBBAA` (if `allow_alpha=True`)\n
+        --------------------------------------------------------------------------
+        ### Valid ranges:<br>
+        each channel from 0-9 and A-F (*case insensitive*)"""
+        return (
+            r"(?i)^(?:#|0x)?[0-9A-F]{8}|[0-9A-F]{6}|[0-9A-F]{4}|[0-9A-F]{3}$"
+            if allow_alpha
+            else r"(?i)^(?:#|0x)?[0-9A-F]{6}|[0-9A-F]{3}$"
+        )

xulbux/xx_string.py

@@ -55,6 +55,35 @@ class String:
             .replace("\u200A", " ")
         )
 
+    @staticmethod
+    def escape(string: str, str_quotes: str = '"') -> str:
+        """Escapes the special characters and quotes inside a string.\n
+        ----------------------------------------------------------------------------
+        `str_quotes` can be either `"` or `'` and should match the quotes,<br>
+        the string will be put inside of. So if your string will be `"string"`,<br>
+        you should pass `"` to the parameter `str_quotes`.<br>
+        That way, if the string includes the same quotes, they will be escaped."""
+        string = (
+            string.replace("\\", r"\\")
+            .replace("\n", r"\n")
+            .replace("\r", r"\r")
+            .replace("\t", r"\t")
+            .replace("\b", r"\b")
+            .replace("\f", r"\f")
+            .replace("\a", r"\a")
+        )
+        if str_quotes == '"':
+            string = string.replace(r"\\'", "'").replace(r'"', r"\"")
+        elif str_quotes == "'":
+            string = string.replace(r'\\"', '"').replace(r"'", r"\'")
+        return string
+
+    @staticmethod
+    def is_empty(string: str, spaces_are_empty: bool = False):
+        """Returns `True` if the string is empty and `False` otherwise.<br>
+        If `spaces_are_empty` is true, it will also return `True` if the string is only spaces."""
+        return (string in (None, "")) or (spaces_are_empty and isinstance(string, str) and not string.strip())
+
     @staticmethod
     def single_char_repeats(string: str, char: str) -> int | bool:
         """If the string consists of only the same `char`, it returns the number of times it is present.<br>

{xulbux-1.5.7.dist-info → xulbux-1.5.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
-Name: XulbuX
-Version: 1.5.7
+Name: xulbux
+Version: 1.5.8
 Summary: A library which includes a lot of really helpful functions.
 Project-URL: Homepage, https://github.com/XulbuX-dev/PythonLibraryXulbuX
 Project-URL: Bug Reports, https://github.com/XulbuX-dev/PythonLibraryXulbuX/issues
@@ -62,7 +62,7 @@ For precise information about the library, see the library's [Wiki page](https:/
 
 On all operating systems, run the following command:
 ```bash
-pip install XulbuX
+pip install xulbux
 ```
 
 
@@ -70,9 +70,9 @@ pip install XulbuX
 
 ```python
 # GENERAL LIBRARY
-import XulbuX as xx
+import xulbux as xx
 # CUSTOM TYPES
-from XulbuX import rgba, hsla, hexa
+from xulbux import rgba, hsla, hexa
 ```
 The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with above imported types*) contains the following modules:
 ```python
@@ -84,12 +84,12 @@ The library **$\color{#8085FF}\textsf{XulbuX}$** (*below used as* `xx` *with abo
   • FILE OPERATIONS          xx.File
   • JSON FILE OPERATIONS     xx.Json
   • SYSTEM ACTIONS           xx.System
-  • MANAGE ENVIRONMENT VARS  xx.EnvVars
-  • CMD LOG AND ACTIONS      xx.Cmd
-  • PRETTY PRINTING          xx.FormatCodes
-  • COLOR OPERATIONS         xx.Color
+  • MANAGE THE ENV PATH VAR  xx.EnvPath
+  • CONSOLE LOG AND ACTIONS  xx.Console
+  • EASY PRETTY PRINTING     xx.FormatCodes
+  • WORKING WITH COLORS      xx.Color
   • DATA OPERATIONS          xx.Data
-  • STR OPERATIONS           xx.String
+  • STRING OPERATIONS        xx.String
   • CODE STRING OPERATIONS   xx.Code
   • REGEX PATTERN TEMPLATES  xx.Regex
 ```

xulbux-1.5.8.dist-info/RECORD

@@ -0,0 +1,20 @@
+xulbux/__init__.py,sha256=yhdvShCcbcLeBfKckjurNcrkCHIj1wWEezgtQPbytGI,1672
+xulbux/_cli_.py,sha256=zCa4dROOwJ3TPIH8ed1gezRj309ljGOAapICRqq4OKs,3464
+xulbux/_consts_.py,sha256=HqBCzFYSk9LS2TrxPCQBQcEjEB8McLodH4ZGZ8yP3Ec,4858
+xulbux/xx_code.py,sha256=v3fhHelqxFXtp2RI7sY7mXusRKdiyOEzy_rmrC3N-Os,5158
+xulbux/xx_color.py,sha256=Ib_jVAYHl3uVUvWUv1jE_QHScNvIPgm9KxEl2xSJfQo,45019
+xulbux/xx_console.py,sha256=Xzl73_LTyt9AW09KAV9tsGdEdiltxPJwJq9nZChWrUQ,15482
+xulbux/xx_data.py,sha256=cwjJeQHwf-b9yE6UTI0DO7US-hWtgTmIdvwKH5KKtmI,25969
+xulbux/xx_env_path.py,sha256=ITdJ4DKh1zAvZrV5kph1z0jUDBhwEtOP4u1OKW0hMts,4309
+xulbux/xx_file.py,sha256=Zhlx7TZ0u2wcl_7khgpMCoqlrcfsbiOh03sj4nsuPaQ,2616
+xulbux/xx_format_codes.py,sha256=hRQ4Vecw2TTa-g5pKshLP-pep_Da7iy38o879McCrOc,13547
+xulbux/xx_json.py,sha256=Sz-UicwU2vdTud4itMV-ljqePzpNByu5WgnX4lEUVRc,5056
+xulbux/xx_path.py,sha256=KB1HGYCxFB3_T97RVACajy3-QiksbviZVIW9-iQcr4s,4558
+xulbux/xx_regex.py,sha256=ce-K62uk1nvayOvLAtMQSD-IwKiVu2IATj0s1C1u6pM,7956
+xulbux/xx_string.py,sha256=cQOvektdBKKe4CuBw6VOoxTElayghk0SQPuLdMILn9A,7650
+xulbux/xx_system.py,sha256=yehO57ggWDRJbeFoTE1VisW4QrbkqZzAyjKoL3xHx9k,3935
+xulbux-1.5.8.dist-info/METADATA,sha256=B95tctbGYaeyy-_nvGssLk08OJNWaFUF1JeTD5_wi2A,4340
+xulbux-1.5.8.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+xulbux-1.5.8.dist-info/entry_points.txt,sha256=a3womfLIMZKnOFiyy-xnVb4g2qkZsHR5FbKKkljcGns,94
+xulbux-1.5.8.dist-info/licenses/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
+xulbux-1.5.8.dist-info/RECORD,,

xulbux-1.5.8.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+xulbux-help = xulbux._cli_:help_command
+xx-help = xulbux._cli_:help_command

xulbux/xx_env_vars.py

@@ -1,73 +0,0 @@
-"""
-Functions for modifying and checking the systems environment-variables:
-- `EnvVars.get_paths()`
-- `EnvVars.has_path()`
-- `EnvVars.add_path()`
-"""
-
-from .xx_data import *
-from .xx_path import *
-
-import os as _os
-
-
-class EnvVars:
-
-    @staticmethod
-    def get_paths(as_list: bool = False) -> str | list:
-        paths = _os.environ.get("PATH")
-        return paths.split(_os.pathsep) if as_list else paths
-
-    @staticmethod
-    def has_path(path: str = None, cwd: bool = False, base_dir: bool = False) -> bool:
-        if cwd:
-            path = _os.getcwd()
-        if base_dir:
-            path = Path.get(base_dir=True)
-        paths = EnvVars.get_paths()
-        return path in paths
-
-    @staticmethod
-    def __add_sort_paths(add_path: str, current_paths: str) -> str:
-        final_paths = Data.remove_empty_items(Data.remove_duplicates(f"{add_path};{current_paths}".split(_os.pathsep)))
-        final_paths.sort()
-        return f"{_os.pathsep.join(final_paths)};"
-
-    @staticmethod
-    def add_path(
-        add_path: str = None,
-        cwd: bool = False,
-        base_dir: bool = False,
-        persistent: bool = True,
-    ) -> None:
-        if cwd:
-            add_path = _os.getcwd()
-        if base_dir:
-            add_path = Path.get(base_dir=True)
-        if not EnvVars.has_path(add_path):
-            final_paths = EnvVars.__add_sort_paths(add_path, EnvVars.get_paths())
-            _os.environ["PATH"] = final_paths
-            if persistent:
-                if _os.name == "nt":  # Windows
-                    try:
-                        import winreg as _winreg
-
-                        key = _winreg.OpenKey(
-                            _winreg.HKEY_CURRENT_USER,
-                            "Environment",
-                            0,
-                            _winreg.KEY_ALL_ACCESS,
-                        )
-                        _winreg.SetValueEx(key, "PATH", 0, _winreg.REG_EXPAND_SZ, final_paths)
-                        _winreg.CloseKey(key)
-                    except ImportError:
-                        raise ImportError("Unable to make persistent changes on Windows.")
-                else:  # UNIX-LIKE (Linux/macOS)
-                    shell_rc_file = _os.path.expanduser(
-                        "~/.bashrc" if _os.path.exists(_os.path.expanduser("~/.bashrc")) else "~/.zshrc"
-                    )
-                    with open(shell_rc_file, "a") as f:
-                        f.write(f'\n# Added by XulbuX\nexport PATH="$PATH:{add_path}"\n')
-                    _os.system(f"source {shell_rc_file}")
-        else:
-            raise ValueError(f"{add_path} is already in PATH.")

xulbux-1.5.7.dist-info/RECORD

@@ -1,20 +0,0 @@
-xulbux/__init__.py,sha256=h6v5Ld_jy1LeTD8hZLfOZUIljUScCRu1FnHRJP1Dp54,1660
-xulbux/_cli_.py,sha256=W6qLGAY5F17bVDCkgtU-XOwqe_UyXBxBonW8e0Gso74,3437
-xulbux/_consts_.py,sha256=HqBCzFYSk9LS2TrxPCQBQcEjEB8McLodH4ZGZ8yP3Ec,4858
-xulbux/xx_cmd.py,sha256=K8U96QSAbLgDG65zIQdniSFtJUqUgKoaHhxgyaq5qBQ,15315
-xulbux/xx_code.py,sha256=PDZi1HNzGfEfoI646N5FQOAL3nZ7cE8eETmW6pl-szA,5146
-xulbux/xx_color.py,sha256=sUZKZdx6dMNL48G5o_SHYMnYPx3sbGoGiu6NpeJkPSw,44053
-xulbux/xx_data.py,sha256=2lYt0kiZxgqqA0e8u8k6VQr8juVzrZRAgio4ehUteSc,27876
-xulbux/xx_env_vars.py,sha256=nJQtddsfDo2HDG1vzmcmz2h79N3jV-J-fLayGpASRUE,2706
-xulbux/xx_file.py,sha256=pQrTsTvaa8tBHOrN9pu2r7qxi8Wzon5V43TfVGitxko,2608
-xulbux/xx_format_codes.py,sha256=OqzegaaiLJ09id6LI842bH4oyXOXbVrBM5q5jh6-z7I,13562
-xulbux/xx_json.py,sha256=wAIwC5IO8oepsYoF1tN5c4DOjSBvT2HZakUxmA-F3BE,5050
-xulbux/xx_path.py,sha256=KB1HGYCxFB3_T97RVACajy3-QiksbviZVIW9-iQcr4s,4558
-xulbux/xx_regex.py,sha256=yTGtNtuW2Cng714iuwxWz9wDN3Bw06rzXfPUVvfiXvk,7159
-xulbux/xx_string.py,sha256=znfeRrAu8OA3Dd0cmMsOm2zXZKzudS4ZuH2Pny2ulEw,6212
-xulbux/xx_system.py,sha256=yehO57ggWDRJbeFoTE1VisW4QrbkqZzAyjKoL3xHx9k,3935
-xulbux-1.5.7.dist-info/METADATA,sha256=dLdhkqGBSyklBIzk_A4zgViiXfxTKoPlYuWigz_rr-0,4336
-xulbux-1.5.7.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-xulbux-1.5.7.dist-info/entry_points.txt,sha256=KX2dtQr5OW5WdHcNqgj6rxFTqliIBNcNQq_FBOGS-0A,94
-xulbux-1.5.7.dist-info/licenses/LICENSE,sha256=6NflEcvzFEe8_JFVNCPVwZBwBhlLLd4vqQi8WiX_Xk4,1084
-xulbux-1.5.7.dist-info/RECORD,,

xulbux-1.5.7.dist-info/entry_points.txt

@@ -1,3 +0,0 @@
-[console_scripts]
-xulbux-help = XulbuX._cli_:help_command
-xx-help = XulbuX._cli_:help_command