docstring linting & small bugfix

Author: xulbux

CHANGELOG.md

@@ -27,7 +27,7 @@
 * All methods that should use positional-only and/or keyword-only params, now actually enforce that by using the `/` and `*` syntax in the method definitions.
 * Renamed the `Spinner` class from the `console` module to `Throbber`, since that name is closer to what it's actually used for.
 * Changed the name of the TypeAlias `DataStructure` to `DataObj` because that name is shorter and more general.
-* Changed both names `DataStructureTypes` and `IndexIterableTypes` to `DataObjTT` and `IndexIterableTT` respectively (`TT` *stands for types-tuple*).
+* Changed both names `DataStructureTypes` and `IndexIterableTypes` to `DataObjTT` and `IndexIterableTT` respectively (`TT` *stands for type-tuple*).
 * Made the return value of `String.single_char_repeats()` always be *`int`* and not <code>*int* | *bool*</code>.
 
 
@@ -498,10 +498,10 @@
 ## 21.12.2024 `v1.5.9`
 
 * Fixed bugs in method `to_ansi()` in module `xx_format_codes`:<br>
-  1. The method always returned an empty string, because the color validation was broken, and it would identify all colors as invalid.<br>
-    Now the validation `Color.is_valid_rgba()` and `Color.is_valid_hexa()` are fixed and now, if a color is identified as invalid, the method returns the original string instead of an empty string.
-  2. Previously the method `to_ansi()` couldn't handle formats inside `[]` because everything inside the brackets was recognized as an invalid format.<br>
-    Now you are able to use formats inside `[]` (*e.g.* `"[[red](Red text [b](inside) square brackets!)]"`).
+  1.  The method always returned an empty string, because the color validation was broken, and it would identify all colors as invalid.<br>
+      Now the validation `Color.is_valid_rgba()` and `Color.is_valid_hexa()` are fixed and now, if a color is identified as invalid, the method returns the original string instead of an empty string.
+  2.  Previously the method `to_ansi()` couldn't handle formats inside `[]` because everything inside the brackets was recognized as an invalid format.<br>
+      Now you are able to use formats inside `[]` (*e.g.* `"[[red](Red text [b](inside) square brackets!)]"`).
 * Introduced a new test for the `xx_format_codes` module.
 * Fixed a small bug in the help client-command:<br>
   Added back the default text color.
@@ -865,8 +865,8 @@
 ## 15.10.2024 `v1.0.1` `v1.0.2` `v1.0.3` `v1.0.4` `v1.0.5`
 
 * Fixed `f-string` issues for Python 3.10:
-  1. Not making use of same quotes inside f-strings any more.
-  2. No backslash escaping in f-strings.
+  1.  Not making use of same quotes inside f-strings any more.
+  2.  No backslash escaping in f-strings.
 
 
 <span id="release" /><span id="v1-0-0" />

src/xulbux/console.py

@@ -271,24 +271,24 @@ def get_args(cls, arg_parse_configs: ArgParseConfigs, /, *, flag_value_sep: str
         - `flag_value_sep` - the character/s used to separate flags from their values\n
         -------------------------------------------------------------------------------------------------
         The `arg_parse_configs` dictionary can have the following structures for each item:
-        1. Simple set of flags (when no default value is needed):
-           ```python
+        1.  Simple set of flags (when no default value is needed):
+          ```python
             "alias_name": {"-f", "--flag"}
-           ```
-        2. Dictionary with the`"flags"` set, plus a specified `"default"` value:
-           ```python
+          ```
+        2.  Dictionary with the`"flags"` set, plus a specified `"default"` value:
+          ```python
             "alias_name": {
                 "flags": {"-f", "--flag"},
                 "default": "some_value",
             }
-           ```
-        3. Positional value collection using the literals `"before"` or `"after"`:
-           ```python
+          ```
+        3.  Positional value collection using the literals `"before"` or `"after"`:
+          ```python
             # COLLECT ALL NON-FLAGGED VALUES THAT APPEAR BEFORE THE FIRST FLAG
             "alias_name": "before"
             # COLLECT ALL NON-FLAGGED VALUES THAT APPEAR AFTER THE LAST FLAG'S VALUE
             "alias_name": "after"
-           ```
+          ```
         #### Example usage:
         If you call the `get_args()` method in your script like this:
         ```python
@@ -699,15 +699,15 @@ def log_box_bordered(
         - `"strong" = ('┏', '━', '┓', '┃', '┛', '━', '┗', '┃', '┣', '━', '┫')`
         - `"double" = ('╔', '═', '╗', '║', '╝', '═', '╚', '║', '╠', '═', '╣')`\n
         The order of the characters is always:
-        1. top-left corner
-        2. top border
-        3. top-right corner
-        4. right border
-        5. bottom-right corner
-        6. bottom border
-        7. bottom-left corner
-        8. left border
-        9. left horizontal rule connector
+        1.  top-left corner
+        2.  top border
+        3.  top-right corner
+        4.  right border
+        5.  bottom-right corner
+        6.  bottom border
+        7.  bottom-left corner
+        8.  left border
+        9.  left horizontal rule connector
         10. horizontal rule
         11. right horizontal rule connector"""
         if w_padding < 0:

src/xulbux/format_codes.py

@@ -133,12 +133,12 @@
 ------------------------------------------------------------------------------------------------------------------------------------
 #### Additional Formatting Codes when a `default_color` is set
 
-1. `[*]` resets everything, just like `[_]`, but the text color will remain in `default_color`
-  (if no `default_color` is set, it resets everything, exactly like `[_]`)
-2. `[default]` will just color the text in `default_color`
-  (if no `default_color` is set, it's treated as an invalid formatting code)
-3. `[background:default]` `[BG:default]` will color the background in `default_color`
-  (if no `default_color` is set, both are treated as invalid formatting codes)\n
+1.  `[*]` resets everything, just like `[_]`, but the text color will remain in `default_color`
+    (if no `default_color` is set, it resets everything, exactly like `[_]`)
+2.  `[default]` will just color the text in `default_color`
+    (if no `default_color` is set, it's treated as an invalid formatting code)
+3.  `[background:default]` `[BG:default]` will color the background in `default_color`
+    (if no `default_color` is set, both are treated as invalid formatting codes)\n
 
 Unlike the standard console colors, the default color can be changed by using the following modifiers:
 

src/xulbux/regex.py

@@ -104,8 +104,8 @@ def all_except(cls, disallowed_pattern: str, /, ignore_pattern: str = "", *, is_
     @classmethod
     def func_call(cls, func_name: Optional[str] = None, /) -> str:
         """Match a function call, and get back two groups:
-        1. function name
-        2. the function's arguments\n
+        1.  The function name
+        2.  The function's arguments (content inside the parentheses)\n
         If no `func_name` is given, it will match any function call.\n
         ---------------------------------------------------------------------------------
         Attention: Requires non-standard library `regex`, not standard library `re`!"""

src/xulbux/string.py

@@ -70,7 +70,7 @@ def is_empty(cls, string: Optional[str], /, *, spaces_are_empty: bool = False) -
     @classmethod
     def single_char_repeats(cls, string: str, char: str, /) -> int:
         """- If the string consists of only the same `char`, it returns the number of times it is present.
-        - If the string doesn't consist of only the same character, it returns `0`.\n
+        - If the string is empty or doesn't consist of only the same character, it returns `0`.\n
         ---------------------------------------------------------------------------------------------------
         - `string` -⠀the string to check
         - `char` -⠀the character to check for repetition"""
@@ -80,7 +80,7 @@ def single_char_repeats(cls, string: str, char: str, /) -> int:
         if len(string) == string.count(char):
             return string.count(char)
         else:
-            return False
+            return 0
 
     @classmethod
     def decompose(cls, case_string: str, /, seps: str = "-_", *, lower_all: bool = True) -> list[str]:

tests/test_string.py

@@ -64,13 +64,13 @@ def test_is_empty():
 
 
 def test_single_char_repeats():
-    assert String.single_char_repeats("aaaaa", "a") == 5
     assert String.single_char_repeats("-----", "-") == 5
-    assert String.single_char_repeats("bbbbb", "a") is False
-    assert String.single_char_repeats("abcde", "a") is False
     assert String.single_char_repeats("", "a") == 0
     assert String.single_char_repeats("a", "a") == 1
-    assert String.single_char_repeats("aaaba", "a") is False
+    assert String.single_char_repeats("aaaaa", "a") == 5
+    assert String.single_char_repeats("aaaba", "a") == 0
+    assert String.single_char_repeats("abcde", "a") == 0
+    assert String.single_char_repeats("bbbbb", "a") == 0
 
 
 def test_decompose():