PyPI - xulbux - Versions diffs - 1.6.7__tar.gz → 1.6.8__tar.gz - Mend

xulbux 1.6.7tar.gz → 1.6.8tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of xulbux might be problematic. Click here for more details.

Files changed (32) hide show

{xulbux-1.6.7/src/xulbux.egg-info → xulbux-1.6.8}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: xulbux
-Version: 1.6.7
+Version: 1.6.8
 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>
 License: MIT License
@@ -31,7 +31,7 @@ Project-URL: Documentation, https://github.com/XulbuX/PythonLibraryXulbuX/wiki
 Project-URL: Homepage, https://github.com/XulbuX/PythonLibraryXulbuX
 Project-URL: License, https://github.com/XulbuX/PythonLibraryXulbuX/blob/main/LICENSE
 Project-URL: Source Code, https://github.com/XulbuX/PythonLibraryXulbuX/tree/main/src
-Keywords: xulbux,python,library,utility,helper,functions,tools,classes,types,methods,cmd,console,constants,code,color,data,structures,env,environment,file,format,json,path,regex,string,system,operations,presets
+Keywords: args,arguments,attributes,classes,cmd,client,code,codes,color,commands,console,consts,constants,convert,conversion,data,debug,easier,env,environment,error,file,format,formatting,functions,helper,hex,hexa,hsl,hsla,info,input,json,library,log,logging,methods,nice,operations,path,presets,pretty,printing,properties,python,re,regex,rgb,rgba,string,structures,system,tools,types,utility,warn,warning,xulbux
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -102,8 +102,8 @@ from xulbux import rgba, hsla, hexa
 ## Modules
-| | |
-| :--------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
+| Module                                                                                           | Short Description                                                                                  |
+| :----------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
 | <h3>[`xx_code`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_code)</h3>                 | advanced code-string operations (*changing the indent, finding function calls, ...*)               |
 | <h3>[`xx_color`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_color)</h3>               | everything around colors (*converting, blending, searching colors in strings, ...*)                |
 | <h3>[`xx_console`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_console)</h3>           | advanced actions related to the console (*pretty logging, advanced inputs, ...*)                   |
@@ -111,11 +111,11 @@ from xulbux import rgba, hsla, hexa
 | <h3>[`xx_env_path`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_env_path)</h3>         | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)               |
 | <h3>[`xx_file`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_file)</h3>                 | advanced working with files (*create files, rename file-extensions, ...*)                          |
 | <h3>[`xx_format_codes`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_format_codes)</h3> | easy pretty printing with custom format codes (*print, inputs, custom format codes to ANSI, ...*)  |
-| <h3>`xx_json`</h3>                                                                                   | advanced working with json files (*read, create, update, ...*)                                     |
-| <h3>`xx_path`</h3>                                                                                   | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
-| <h3>`xx_regex`</h3>                                                                                  | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
+| <h3>`xx_json`</h3>                                                                               | advanced working with json files (*read, create, update, ...*)                                     |
+| <h3>`xx_path`</h3>                                                                               | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
+| <h3>`xx_regex`</h3>                                                                              | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
 | <h3>[`xx_string`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_string)</h3>             | helpful actions when working with strings. (*normalize, escape, decompose, ...*)                   |
-| <h3>`xx_system`</h3>                                                                                 | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
+| <h3>`xx_system`</h3>                                                                             | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
 <br>

{xulbux-1.6.7 → xulbux-1.6.8}/README.md RENAMED Viewed

@@ -45,8 +45,8 @@ from xulbux import rgba, hsla, hexa
 ## Modules
-| | |
-| :--------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
+| Module                                                                                           | Short Description                                                                                  |
+| :----------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
 | <h3>[`xx_code`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_code)</h3>                 | advanced code-string operations (*changing the indent, finding function calls, ...*)               |
 | <h3>[`xx_color`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_color)</h3>               | everything around colors (*converting, blending, searching colors in strings, ...*)                |
 | <h3>[`xx_console`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_console)</h3>           | advanced actions related to the console (*pretty logging, advanced inputs, ...*)                   |
@@ -54,11 +54,11 @@ from xulbux import rgba, hsla, hexa
 | <h3>[`xx_env_path`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_env_path)</h3>         | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)               |
 | <h3>[`xx_file`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_file)</h3>                 | advanced working with files (*create files, rename file-extensions, ...*)                          |
 | <h3>[`xx_format_codes`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_format_codes)</h3> | easy pretty printing with custom format codes (*print, inputs, custom format codes to ANSI, ...*)  |
-| <h3>`xx_json`</h3>                                                                                   | advanced working with json files (*read, create, update, ...*)                                     |
-| <h3>`xx_path`</h3>                                                                                   | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
-| <h3>`xx_regex`</h3>                                                                                  | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
+| <h3>`xx_json`</h3>                                                                               | advanced working with json files (*read, create, update, ...*)                                     |
+| <h3>`xx_path`</h3>                                                                               | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
+| <h3>`xx_regex`</h3>                                                                              | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
 | <h3>[`xx_string`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_string)</h3>             | helpful actions when working with strings. (*normalize, escape, decompose, ...*)                   |
-| <h3>`xx_system`</h3>                                                                                 | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
+| <h3>`xx_system`</h3>                                                                             | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
 <br>

{xulbux-1.6.7 → xulbux-1.6.8}/pyproject.toml RENAMED Viewed

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "xulbux"
-version = "1.6.7"
+version = "1.6.8"
 authors = [{ 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."
 readme = "README.md"
@@ -35,34 +35,64 @@ classifiers = [
   "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 keywords = [
-  "xulbux",
-  "python",
-  "library",
-  "utility",
-  "helper",
-  "functions",
-  "tools",
+  "args",
+  "arguments",
+  "attributes",
   "classes",
-  "types",
-  "methods",
   "cmd",
-  "console",
-  "constants",
+  "client",
   "code",
+  "codes",
   "color",
+  "commands",
+  "console",
+  "consts",
+  "constants",
+  "convert",
+  "conversion",
   "data",
-  "structures",
+  "debug",
+  "easier",
   "env",
   "environment",
+  "error",
   "file",
   "format",
+  "formatting",
+  "functions",
+  "helper",
+  "hex",
+  "hexa",
+  "hsl",
+  "hsla",
+  "info",
+  "input",
   "json",
+  "library",
+  "log",
+  "logging",
+  "methods",
+  "nice",
+  "operations",
   "path",
+  "presets",
+  "pretty",
+  "printing",
+  "properties",
+  "python",
+  "re",
   "regex",
+  "rgb",
+  "rgba",
   "string",
+  "structures",
   "system",
-  "operations",
-  "presets",
+  "tools",
+  "types",
+  "utility",
+  "warn",
+  "warning",
+  "xulbux",
 ]
 [project.urls]

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/__init__.py RENAMED Viewed

@@ -19,7 +19,7 @@
   • REGEX PATTERN TEMPLATES  xx.Regex
 """
-__version__ = "1.6.7"
+__version__ = "1.6.8"
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"
 __license__ = "MIT"

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_code.py RENAMED Viewed

@@ -21,14 +21,13 @@ class Code:
         non_zero_indents = [i for i in indents if i > 0]
         return min(non_zero_indents) if non_zero_indents else 0
-    @staticmethod
-    def change_tab_size(code: str, new_tab_size: int, remove_empty_lines: bool = False) -> str:
+    def change_tab_size(self, code: str, new_tab_size: int, remove_empty_lines: bool = False) -> str:
         """Replaces all tabs with `new_tab_size` spaces.\n
         ----------------------------------------------------------------------------------
         If `remove_empty_lines` is `True`, empty lines will be removed in the process."""
         code_lines = String.get_lines(code, remove_empty_lines=True)
         lines = code_lines if remove_empty_lines else String.get_lines(code)
-        tab_spaces = Code.get_tab_spaces(code)
+        tab_spaces = self.get_tab_spaces(code)
         if (tab_spaces == new_tab_size) or tab_spaces == 0:
             if remove_empty_lines:
                 return "\n".join(code_lines)

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_console.py RENAMED Viewed

@@ -46,14 +46,39 @@ class ArgResult:
     def __init__(self, exists: bool, value: any):
         self.exists = exists
         self.value = value
+    def __bool__(self):
+        return self.exists
 class Args:
-    """Stores arguments under their aliases with their results."""
+    """Stores found command arguments under their aliases with their results."""
     def __init__(self, **kwargs):
         for key, value in kwargs.items():
             if not key.isidentifier():
                 raise TypeError(f"Argument alias '{key}' is invalid. It must be a valid Python variable name.")
             setattr(self, key, ArgResult(**value))
+    def __len__(self):
+        return len(vars(self))
+    def __contains__(self, key):
+        return hasattr(self, key)
+    def __getitem__(self, key):
+        if isinstance(key, int):
+            return list(self.__iter__())[key]
+        return getattr(self, key)
+    def __iter__(self):
+        for key, value in vars(self).items():
+            yield (key, {"exists": value.exists, "value": value.value})
+    def dict(self) -> dict[str, dict[str, any]]:
+        """Returns the arguments as a dictionary."""
+        return {k: {"exists": v.exists, "value": v.value} for k, v in vars(self).items()}
+    def keys(self):
+        """Returns the argument aliases as `dict_keys([...])`."""
+        return vars(self).keys()
+    def values(self):
+        """Returns the argument results as `dict_values([...])`."""
+        return vars(self).values()
+    def items(self):
+        """Returns the argument aliases and results as `dict_items([...])`."""
+        return vars(self).items()
 # YAPF: enable
@@ -70,7 +95,7 @@ class Console:
     """The name of the current user."""
     @staticmethod
-    def get_args(find_args: dict[str, list[str] | tuple[str, ...]]) -> Args:
+    def get_args(find_args: dict[str, list[str] | tuple[str, ...]], allow_spaces: bool = False) -> Args:
         """Will search for the specified arguments in the command line
         arguments and return the results as a special `Args` object.\n
         ----------------------------------------------------------------
@@ -96,20 +121,39 @@ class Console:
         - `Args.<arg_alias>.exists` is `True` if any of the specified
             args were found and `False` if not
         - `Args.<arg_alias>.value` the value from behind the found arg,
-            `None` if no value was found"""
+            `None` if no value was found\n
+        ----------------------------------------------------------------
+        Normally if `allow_spaces` is false, it will take a space as
+        the end of an args value. If it is true, it will take spaces as
+        part of the value until the next arg is found.
+        (Multiple spaces will become one space in the value.)"""
         args = _sys.argv[1:]
-        results = {}
+        args_len = len(args)
+        arg_lookup = {}
         for arg_key, arg_group in find_args.items():
-            value = None
-            exists = False
             for arg in arg_group:
-                if arg in args:
-                    exists = True
-                    arg_index = args.index(arg)
-                    if arg_index + 1 < len(args) and not args[arg_index + 1].startswith("-"):
-                        value = String.to_type(args[arg_index + 1])
-                    break
-            results[arg_key] = {"exists": exists, "value": value}
+                arg_lookup[arg] = arg_key
+        results = {key: {"exists": False, "value": None} for key in find_args}
+        i = 0
+        while i < args_len:
+            arg = args[i]
+            arg_key = arg_lookup.get(arg)
+            if arg_key:
+                results[arg_key]["exists"] = True
+                if i + 1 < args_len and not args[i + 1].startswith("-"):
+                    if not allow_spaces:
+                        results[arg_key]["value"] = String.to_type(args[i + 1])
+                        i += 1
+                    else:
+                        value_parts = []
+                        j = i + 1
+                        while j < args_len and not args[j].startswith("-"):
+                            value_parts.append(args[j])
+                            j += 1
+                        if value_parts:
+                            results[arg_key]["value"] = String.to_type(" ".join(value_parts))
+                            i = j - 1
+            i += 1
         return Args(**results)
     @staticmethod
@@ -166,9 +210,10 @@ class Console:
         title_len, tab_len = len(title) + 4, _console_tabsize - ((len(title) + 4) % _console_tabsize)
         title_color = "_color" if not title_bg_color else Color.text_color_for_on_bg(title_bg_color)
         if format_linebreaks:
-            prompt_lst = (String.split_count(l, Console.w - (title_len + tab_len)) for l in str(prompt).splitlines())
+            clean_prompt, removals = FormatCodes.remove_formatting(str(prompt), get_removals=True)
+            prompt_lst = (String.split_count(l, Console.w - (title_len + tab_len)) for l in str(clean_prompt).splitlines())
             prompt_lst = (item for lst in prompt_lst for item in (lst if isinstance(lst, list) else [lst]))
-            prompt = f"\n{' ' * title_len}\t".join(prompt_lst)
+            prompt = f"\n{' ' * title_len}\t".join(Console.__add_back_removed_parts(list(prompt_lst), removals))
         else:
             prompt = str(prompt)
         if title == "":
@@ -185,6 +230,38 @@ class Console:
                 end=end,
             )
+    @staticmethod
+    def __add_back_removed_parts(split_string: list[str], removals: tuple[tuple[int, str], ...]) -> list[str]:
+        """Adds back the removed parts into the split string parts at their original positions."""
+        lengths, cumulative_pos = [len(s) for s in split_string], [0]
+        for length in lengths:
+            cumulative_pos.append(cumulative_pos[-1] + length)
+        result, offset_adjusts = split_string.copy(), [0] * len(split_string)
+        last_idx, total_length = len(split_string) - 1, cumulative_pos[-1]
+        def find_string_part(pos: int) -> int:
+            left, right = 0, len(cumulative_pos) - 1
+            while left < right:
+                mid = (left + right) // 2
+                if cumulative_pos[mid] <= pos < cumulative_pos[mid + 1]:
+                    return mid
+                elif pos < cumulative_pos[mid]:
+                    right = mid
+                else:
+                    left = mid + 1
+            return left
+        for pos, removal in removals:
+            if pos >= total_length:
+                result[last_idx] = result[last_idx] + removal
+                continue
+            i = find_string_part(pos)
+            adjusted_pos = (pos - cumulative_pos[i]) + offset_adjusts[i]
+            parts = [result[i][:adjusted_pos], removal, result[i][adjusted_pos:]]
+            result[i] = ''.join(parts)
+            offset_adjusts[i] += len(removal)
+        return result
     @staticmethod
     def debug(
         prompt: object = "Point in program reached.",

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_env_path.py RENAMED Viewed

@@ -29,33 +29,21 @@ class EnvPath:
         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:
+    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:
+    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:
+    def __get(path: str = None, cwd: bool = False, base_dir: bool = False) -> list:
         """Get and/or normalize the paths.\n
         ------------------------------------------------------------------------------------
         Raise an error if no path is provided and neither `cwd` or `base_dir` is `True`."""

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_file.py RENAMED Viewed

@@ -11,11 +11,7 @@ class SameContentFileExistsError(FileExistsError):
 class File:
     @staticmethod
-    def rename_extension(
-        file: str,
-        new_extension: str,
-        camel_case_filename: bool = False,
-    ) -> str:
+    def rename_extension(file: str, new_extension: str, camel_case_filename: bool = False) -> str:
         """Rename the extension of a file.\n
         --------------------------------------------------------------------------
         If the `camel_case_filename` parameter is true, the filename will be made
@@ -27,11 +23,7 @@ class File:
         return _os.path.join(directory, f"{filename}{new_extension}")
     @staticmethod
-    def create(
-        file: str,
-        content: str = "",
-        force: bool = False,
-    ) -> str:
+    def create(file: str, content: str = "", force: bool = False) -> str:
         """Create a file with ot without content.\n
         ----------------------------------------------------------------------
         The function will throw a `FileExistsError` if a file with the same

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_format_codes.py RENAMED Viewed

@@ -182,6 +182,8 @@ _COMPILED: dict[str, Pattern] = {  # PRECOMPILE REGULAR EXPRESSIONS
         + Regex.brackets("(", ")", is_group=True, strip_spaces=False, ignore_in_strings=False)
         + r")?"
     ),
+    "escape_char": _re.compile(r"(\s*)(\/|\\)"),
+    "escape_char_cond": _re.compile(r"(\s*\[\s*)(\/|\\)(?!\2+)"),
     "bg?_default": _re.compile(r"(?i)((?:" + _PREFIX_RX["BG"] + r")?)\s*default"),
     "bg_default": _re.compile(r"(?i)" + _PREFIX_RX["BG"] + r"\s*default"),
     "modifier": _re.compile(
@@ -265,9 +267,11 @@ class FormatCodes:
             return color in ANSI.color_map or Color.is_valid_rgba(color) or Color.is_valid_hexa(color)
         def replace_keys(match: _re.Match) -> str:
-            formats = match.group(1)
-            escaped = match.group(2)
+            _formats = formats = match.group(1)
+            auto_reset_escaped = match.group(2)
             auto_reset_txt = match.group(3)
+            if formats_escaped := bool(_COMPILED["escape_char_cond"].match(match.group(0))):
+                _formats = formats = _COMPILED["escape_char"].sub(r"\1", formats)  # REMOVE / OR \\
             if auto_reset_txt and auto_reset_txt.count("[") > 0 and auto_reset_txt.count("]") > 0:
                 auto_reset_txt = FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, False)
             if not formats:
@@ -279,7 +283,7 @@ class FormatCodes:
                 r if (r := FormatCodes.__get_replacement(k, default_color, brightness_steps)) != k else f"[{k}]"
                 for k in format_keys
             ]
-            if auto_reset_txt and not escaped:
+            if auto_reset_txt and not auto_reset_escaped:
                 reset_keys = []
                 for k in format_keys:
                     k_lower = k.lower()
@@ -308,17 +312,20 @@ class FormatCodes:
             else:
                 ansi_resets = []
             if not (len(ansi_formats) == 1 and ansi_formats[0].count(f"{ANSI.char}{ANSI.start}") >= 1) and not all(
-                    f.startswith(f"{ANSI.char}{ANSI.start}") for f in ansi_formats):
+                    f.startswith(f"{ANSI.char}{ANSI.start}") for f in ansi_formats):  # FORMATTING WAS INVALID
                 return match.group(0)
-            return (
-                "".join(ansi_formats) + (
-                    f"({FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, False)})"
-                    if escaped and auto_reset_txt else auto_reset_txt if auto_reset_txt else ""
-                ) + ("" if escaped else "".join(ansi_resets))
-            )
+            elif formats_escaped:  # FORMATTING WAS VALID BUT ESCAPED
+                return f"[{_formats}]({auto_reset_txt})" if auto_reset_txt else f"[{_formats}]"
+            else:
+                return (
+                    "".join(ansi_formats) + (
+                        f"({FormatCodes.to_ansi(auto_reset_txt, default_color, brightness_steps, False)})"
+                        if auto_reset_escaped and auto_reset_txt else auto_reset_txt if auto_reset_txt else ""
+                    ) + ("" if auto_reset_escaped else "".join(ansi_resets))
+                )
         string = "\n".join(_COMPILED["formatting"].sub(replace_keys, line) for line in string.split("\n"))
-        return (FormatCodes.__get_default_ansi(default_color) if _default_start else "") + string if use_default else string
+        return ((FormatCodes.__get_default_ansi(default_color) if _default_start else "") + string) if use_default else string
     @staticmethod
     def escape_ansi(ansi_string: str) -> str:
@@ -326,14 +333,33 @@ class FormatCodes:
         return ansi_string.replace(ANSI.char, ANSI.escaped_char)
     @staticmethod
-    def remove_ansi(ansi_string: str) -> str:
-        """Removes all ANSI codes from the string."""
-        return _COMPILED["ansi_seq"].sub("", ansi_string)
+    def remove_ansi(ansi_string: str, get_removals: bool = False) -> str | tuple[str, tuple[tuple[int, str], ...]]:
+        """Removes all ANSI codes from the string.\n
+        --------------------------------------------------------------------------------------------------
+        If `get_removals` is true, additionally to the cleaned string, a list of tuples will be returned.
+        Each tuple contains the position of the removed ansi code and the removed ansi code."""
+        if get_removals:
+            removals = []
+            def replacement(match: _re.Match) -> str:
+                start_pos = match.start() - sum(len(removed) for _, removed in removals)
+                if removals and removals[-1][0] == start_pos:
+                    start_pos = removals[-1][0]
+                removals.append((start_pos, match.group()))
+                return ""
+            clean_string = _COMPILED["ansi_seq"].sub(replacement, ansi_string)
+            return clean_string, tuple(removals)
+        else:
+            return _COMPILED["ansi_seq"].sub("", ansi_string)
     @staticmethod
-    def remove_formatting(string: str) -> str:
-        """Removes all formatting codes from the string."""
-        return _COMPILED["ansi_seq"].sub("", FormatCodes.to_ansi(string))
+    def remove_formatting(string: str, get_removals: bool = False) -> str | tuple[str, tuple[tuple[int, str], ...]]:
+        """Removes all formatting codes from the string.\n
+        ----------------------------------------------------------------------------------------------------
+        If `get_removals` is true, additionally to the cleaned string, a list of tuples will be returned.
+        Each tuple contains the position of the removed formatting code and the removed formatting code."""
+        return FormatCodes.remove_ansi(FormatCodes.to_ansi(string), get_removals=get_removals)
     @staticmethod
     def __config_console() -> None:

{xulbux-1.6.7 → xulbux-1.6.8}/src/xulbux/xx_regex.py RENAMED Viewed

@@ -55,11 +55,7 @@ class Regex:
         return rf'(?<!["\'])(?:{pattern})(?!["\'])'
     @staticmethod
-    def all_except(
-        disallowed_pattern: str,
-        ignore_pattern: str = "",
-        is_group: bool = False,
-    ) -> str:
+    def all_except(disallowed_pattern: str, ignore_pattern: str = "", is_group: bool = False) -> str:
         """Matches everything except `disallowed_pattern`, unless the `disallowed_pattern`
         is found inside a string (`'...'` or `"..."`).\n
         ------------------------------------------------------------------------------------

{xulbux-1.6.7 → xulbux-1.6.8/src/xulbux.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: xulbux
-Version: 1.6.7
+Version: 1.6.8
 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>
 License: MIT License
@@ -31,7 +31,7 @@ Project-URL: Documentation, https://github.com/XulbuX/PythonLibraryXulbuX/wiki
 Project-URL: Homepage, https://github.com/XulbuX/PythonLibraryXulbuX
 Project-URL: License, https://github.com/XulbuX/PythonLibraryXulbuX/blob/main/LICENSE
 Project-URL: Source Code, https://github.com/XulbuX/PythonLibraryXulbuX/tree/main/src
-Keywords: xulbux,python,library,utility,helper,functions,tools,classes,types,methods,cmd,console,constants,code,color,data,structures,env,environment,file,format,json,path,regex,string,system,operations,presets
+Keywords: args,arguments,attributes,classes,cmd,client,code,codes,color,commands,console,consts,constants,convert,conversion,data,debug,easier,env,environment,error,file,format,formatting,functions,helper,hex,hexa,hsl,hsla,info,input,json,library,log,logging,methods,nice,operations,path,presets,pretty,printing,properties,python,re,regex,rgb,rgba,string,structures,system,tools,types,utility,warn,warning,xulbux
 Classifier: Intended Audience :: Developers
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
@@ -102,8 +102,8 @@ from xulbux import rgba, hsla, hexa
 ## Modules
-| | |
-| :--------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
+| Module                                                                                           | Short Description                                                                                  |
+| :----------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------- |
 | <h3>[`xx_code`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_code)</h3>                 | advanced code-string operations (*changing the indent, finding function calls, ...*)               |
 | <h3>[`xx_color`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_color)</h3>               | everything around colors (*converting, blending, searching colors in strings, ...*)                |
 | <h3>[`xx_console`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_console)</h3>           | advanced actions related to the console (*pretty logging, advanced inputs, ...*)                   |
@@ -111,11 +111,11 @@ from xulbux import rgba, hsla, hexa
 | <h3>[`xx_env_path`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_env_path)</h3>         | getting and editing the PATH variable (*get paths, check for paths, add paths, ...*)               |
 | <h3>[`xx_file`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_file)</h3>                 | advanced working with files (*create files, rename file-extensions, ...*)                          |
 | <h3>[`xx_format_codes`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_format_codes)</h3> | easy pretty printing with custom format codes (*print, inputs, custom format codes to ANSI, ...*)  |
-| <h3>`xx_json`</h3>                                                                                   | advanced working with json files (*read, create, update, ...*)                                     |
-| <h3>`xx_path`</h3>                                                                                   | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
-| <h3>`xx_regex`</h3>                                                                                  | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
+| <h3>`xx_json`</h3>                                                                               | advanced working with json files (*read, create, update, ...*)                                     |
+| <h3>`xx_path`</h3>                                                                               | advanced path operations (*get paths, smart-extend relative paths, delete paths, ...*)             |
+| <h3>`xx_regex`</h3>                                                                              | generated regex pattern-templates (*match bracket- and quote pairs, match colors, ...*)            |
 | <h3>[`xx_string`](https://github.com/XulbuX/PythonLibraryXulbuX/wiki/xx_string)</h3>             | helpful actions when working with strings. (*normalize, escape, decompose, ...*)                   |
-| <h3>`xx_system`</h3>                                                                                 | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
+| <h3>`xx_system`</h3>                                                                             | advanced system actions (*restart with message, check installed Python libs, ...*)                 |
 <br>