remove unused imports and rename FormatCodes.__config_console() to _config_console()

Author: xulbux

CHANGELOG.md

@@ -21,6 +21,7 @@
 * Added a new class `LazyRegex` to the `regex` module, which is used to define regex patterns that are only compiled when they are used for the first time.
 * Removed unnecessary character escaping in the precompiled regex patterns in the `console` module.
 * Removed all the runtime type-checks that can also be checked using static type-checking tools, since you're supposed to use type checkers in modern python anyway, and to improve performance.
+* Renamed the internal class method `FormatCodes.__config_console()` to `FormatCodes._config_console()` to make it callable, but still indicate that it's internal.
 
 **BREAKING CHANGES:**
 * Replaced the internal `_COMPILED` regex pattern dictionaries with `LazyRegex` objects so it won't compile all regex patterns on library import, but only when they are used for the first time, which improves the library's import time.

src/xulbux/cli/help.py

@@ -72,6 +72,6 @@ def is_latest_version() -> Optional[bool]:
 
 
 def show_help() -> None:
-    FormatCodes.__config_console()
+    FormatCodes._config_console()
     print(CLI_HELP)
     Console.pause_exit(pause=True, prompt="  [dim](Press any key to exit...)\n\n")

src/xulbux/console.py

@@ -11,7 +11,7 @@
 from .color import Color, hexa
 from .regex import LazyRegex
 
-from typing import Generator, Callable, Optional, Literal, Mapping, Pattern, TypeVar, TextIO, cast
+from typing import Generator, Callable, Optional, Literal, Mapping, TypeVar, TextIO, cast
 from prompt_toolkit.key_binding import KeyPressEvent, KeyBindings
 from prompt_toolkit.validation import ValidationError, Validator
 from prompt_toolkit.styles import Style
@@ -25,10 +25,9 @@
 import time as _time
 import sys as _sys
 import os as _os
-import re as _re
 import io as _io
 
-# PRECOMPILE REGULAR EXPRESSIONS
+
 _PATTERNS = LazyRegex(
     hr=r"(?i){hr}",
     hr_no_nl=r"(?i)(?<!\n){hr}(?!\n)",

src/xulbux/format_codes.py

@@ -230,7 +230,7 @@ def print(
         --------------------------------------------------------------------------------------------------
         For exact information about how to use special formatting codes,
         see the `format_codes` module documentation."""
-        FormatCodes.__config_console()
+        FormatCodes._config_console()
         _sys.stdout.write(FormatCodes.to_ansi(sep.join(map(str, values)) + end, default_color, brightness_steps))
 
         if flush:
@@ -253,7 +253,7 @@ def input(
         --------------------------------------------------------------------------------------------------
         For exact information about how to use special formatting codes, see the
         `format_codes` module documentation."""
-        FormatCodes.__config_console()
+        FormatCodes._config_console()
         user_input = input(FormatCodes.to_ansi(str(prompt), default_color, brightness_steps))
 
         if reset_ansi:
@@ -497,8 +497,10 @@ def replacement(match: Match) -> str:
             return _PATTERNS.ansi_seq.sub("", ansi_string)
 
     @staticmethod
-    def __config_console() -> None:
-        """Configure the console to be able to interpret and render ANSI formatting."""
+    def _config_console() -> None:
+        """Internal method which configure the console to be able to interpret and render ANSI formatting.\n
+        -----------------------------------------------------------------------------------------------------
+        This method will only do something the first time it's called. Subsequent calls will do nothing."""
         global _CONSOLE_ANSI_CONFIGURED
         if not _CONSOLE_ANSI_CONFIGURED:
             _sys.stdout.flush()

src/xulbux/regex.py

@@ -196,7 +196,7 @@ def hexa_str(allow_alpha: bool = True) -> str:
 
     @staticmethod
     def _clean(pattern: str) -> str:
-        """Internal method, to make a multiline-string regex pattern into a single-line pattern."""
+        """Internal method to make a multiline-string regex pattern into a single-line pattern."""
         return "".join(l.strip() for l in pattern.splitlines()).strip()
 
 

tests/test_console.py

@@ -5,7 +5,6 @@
 from collections import namedtuple
 import builtins
 import pytest
-import time
 import sys
 import io