Merge release v1.9.3 into main

.github/workflows/build-and-publish.yml

@@ -0,0 +1,58 @@
+name: Build and Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v1.[0-9]+.[0-9]+"
+  workflow_dispatch: # ALLOW MANUAL TRIGGER
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v2.16.5
+        env:
+          CIBW_BUILD: cp310-* cp311-* cp312-* cp313-* cp314-*
+          CIBW_SKIP: "*-musllinux_*"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels-${{ matrix.os }}
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Build sdist
+        run: pipx run build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          pattern: "*"
+          merge-multiple: true
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,33 +1,15 @@
-# IDE & EDITOR SETTINGS
-.vscode/
-.python-version
-
-# CREDENTIALS & CONFIGURATION
-.env
-.npmrc
-.pypirc
-
 # COMPILED FILES & CACHES
 __pycache__/
+__pypackages__/
+.mypy_cache/
+.pytest_cache/
 *.py[cod]
 *$py.class
 
 # BUILD ARTIFACTS
+*.egg-info/
 build/
 dist/
-target/
-wheels/
-*.egg-info/
-.Python
-.pybuilder/
-.pytype/
-cython_debug/
-__pypackages__/
 
 # TESTING
 .venv/
-.pytest_cache/
-
-# MISCELLANEOUS
-.DS_Store
-Thumbs.db

CHANGELOG.md

@@ -15,9 +15,46 @@
 # <br><b>Changelog</b><br>
 
 
+<span id="v1-9-3" />
+
+## 01.01.2026 `v1.9.3` Big Update 🚀
+
+**𝓗𝓪𝓹𝓹𝔂 𝟚𝟘𝟚𝟞 🎉**
+
+* Added a new method `Color.str_to_hsla()` to parse HSLA colors from strings.
+* Changed the default syntax highlighting for `Data.to_str()` and therefore also `Data.print()` to use console default colors.
+* Added the missing but needed dunder methods to the `Args` and `ArgResult` classes and the `rgba`, `hsla` and `hexa` color objects for better usability and type checking.
+* Added three new methods to `Args`:
+  - `get()` returns the argument result for a given alias, or a default value if not found
+  - `existing()` yields only the existing arguments as tuples of `(alias, ArgResult)`
+  - `missing()` yields only the missing arguments as tuples of `(alias, ArgResult)`
+* Added a new attribute `is_positional` to `ArgResult`, which indicates whether the argument is a positional argument or not.
+* The `ArgResult` class now also has a `dict()` method, which returns the argument result as a dictionary.
+* Added new properties `is_tty` and `supports_color` to the `Console` class, `home` to the `Path` class and `is_win` to the `System` class.
+* Added the option to add format specifiers to the `{current}`, `{total}` and `{percentage}` placeholders in the `bar_format` and `limited_bar_format` of `ProgressBar`.
+* Finally fixed the `C901 'Console.get_args' is too complex (39)` linting error by refactoring the method into its own helper class.
+* Changed the string- and repr-representations of the `rgba` and `hsla` color objects and newly implemented it for the `Args` and `ArgResult` classes.
+* Made internal, global constants, which's values never change, into `Final` constants for better type checking.
+* The names of all internal classes and methods are all no longer prefixed with a double underscore (`__`), but a single underscore (`_`) instead.
+* Changed all methods defined as `@staticmethod` to `@classmethod` where applicable, to improve inheritance capabilities.
+* Adjusted the whole library's type hints to be way more strict and accurate, using `mypy` as static type checker.
+* Change the class-property definitions to be defined via `metaclass` and using `@property` decorators, to make them compatible with `mypyc`.
+* Unnest all the nested methods in the whole library for compatibility with `mypyc`.
+* The library is now compiled using `mypyc` when installing, which makes it run significantly faster. Benchmarking results:
+  - Simple methods like data and color operations had a speed improvement of around 50%.
+  - Complex methods like console logging had a speed improvement of up to 230%!
+
+**BREAKING CHANGES:**
+* Renamed `Data.to_str()` to `Data.render()`, since that describes its functionality better (*especially with the syntax highlighting option*).
+* Renamed the constant `ANSI.ESCAPED_CHAR` to `ANSI.CHAR_ESCAPED` for better consistency with the other constant names.
+* Removed the general `Pattern` and `Match` type aliases from the `base.types` module (*they are pointless since you should always use a specific type and not "type1 OR typeB"*).
+* Removed the `_` prefix from the param `_syntax_highlighting` in `Data.render()`, since it's no longer just for internal use.
+
+
 <span id="v1-9-2" />
 
 ## 16.12.2025 `v1.9.2`
+
 * 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.
@@ -40,6 +77,7 @@
 <span id="v1-9-1" />
 
 ## 26.11.2025 `v1.9.1`
+
 * Unified the module and class docstring styles throughout the whole library.
 * Moved the Protocol `ProgressUpdater` from the `console` module to the `types` module.
 * Added throttling to the `ProgressBar` update methods to impact the actual process' performance as little as possible.
@@ -55,6 +93,7 @@
 <span id="v1-9-0" />
 
 ## 21.11.2025 `v1.9.0` Big Update 🚀
+
 * Standardized the docstrings for all public methods in the whole library to use the same style and structure.
 * Replaced left over single quotes with double quotes for consistency.
 * Fixed a bug inside `Data.remove_empty_items()`, where types other than strings where passed to `String.is_empty()`, which caused an exception.
@@ -90,7 +129,9 @@
 
 <span id="v1-8-4" />
 
-## 11.11.2025 `v1.8.4` 𝓢𝓲𝓷𝓰𝓵𝓮𝓼 𝓓𝓪𝔂 🥇😉
+## 11.11.2025 `v1.8.4`
+
+**𝓢𝓲𝓷𝓰𝓵𝓮𝓼 𝓓𝓪𝔂 🥇😉**
 
 * Adjusted `Regex.hsla_str()` to not include optional degree (`°`) and percent (`%`) symbols in the captured groups.
 * Fixed that `Regex.hexa_str()` couldn't match HEXA colors anywhere inside a string, but only if the whole string was just the HEXA color.
@@ -158,7 +199,7 @@
 
 <span id="v1-8-0" />
 
-## 28.08.2025 `v1.8.0` **⚠️This release is broken!**
+## 28.08.2025 `v1.8.0` **⚠️ This release is broken!**
 
 * New options for the param `find_args` from the method `Console.get_args()`:<br>
   Previously you could only input a dictionary with items like `"alias_name": ["-f", "--flag"]` that specify an arg's alias and the flags that correspond to it.<br>
@@ -194,7 +235,7 @@
 ## 17.06.2025 `v1.7.2`
 
 * The `Console.w`, `Console.h` and `Console.wh` class properties now return a default size if there is no console, instead of throwing an error.
-* It wasn't actually possible to use default console-colors (*e.g.* `"red"`, `"green"`, ...) for the color params in `Console.log()` so that option was completely removed again.
+* It wasn't actually possible to use default console-colors (*e.g.* `"red"`, `"green"`, …) for the color params in `Console.log()` so that option was completely removed again.
 * Upgraded the speed of `FormatCodes.to_ansi()` by adding the internal ability to skip the `default_color` validation.
 * Fixed type hints for the whole library.
 * Fixed a small bug in `Console.pause_exit()`, where the key, pressed to unpause wasn't suppressed, so it was written into the next console input after unpausing.
@@ -208,7 +249,7 @@
 * Added a new method `Console.log_box_bordered()`, which does the same as `Console.log_box_filled()`, but with a border instead of a background color.
 * The module `xx_format_codes` now treats the `[*]` to-default-color-reset as a normal full-reset, when no `default_color` is set, instead of just counting it as an invalid format code.
 * Fixed bug where entering a color as HEX integer in the color params of the methods `Console.log()`, `Console.log_box_filled()` and `Console.log_box_bordered()` would not work, because it was not properly converted to a format code.
-* You can now use default console colors (*e.g.* `"red"`, `"green"`, ...) for the color params in `Console.log()`.
+* You can now use default console colors (*e.g.* `"red"`, `"green"`, …) for the color params in `Console.log()`.
 * The methods `Console.log_box_filled()` and `Console.log_box_bordered()` no longer right-strip spaces, so you can make multiple log boxes the same width, by adding spaces to the end of the text.
 
 **BREAKING CHANGES:**
@@ -332,7 +373,7 @@
 
 <span id="v1-6-3" />
 
-## 22.01.2025 `v1.6.3` **⚠️This release is broken!**
+## 22.01.2025 `v1.6.3` **⚠️ This release is broken!**
 
 * Fixed a small bug in `xx_format_codes`:<br>
   Inside print-strings, if there was a `'` or `"` inside an auto-reset-formatting (*e.g.* `[u](there's a quote)`), that caused it to not be recognized as valid, and therefore not be automatically reset.<br>
@@ -440,6 +481,8 @@
 
 ## 11.11.2024 `v1.5.6`
 
+**Again 𝓢𝓲𝓷𝓰𝓵𝓮𝓼 𝓓𝓪𝔂 🥇😉**
+
 * Moved the whole library to its own repository: **[PythonLibraryXulbuX](https://github.com/XulbuX/PythonLibraryXulbuX)**
 * Updated all connections and links correspondingly.
 
@@ -448,6 +491,8 @@
 
 ## 11.11.2024 `v1.5.5`
 
+**𝓢𝓲𝓷𝓰𝓵𝓮𝓼 𝓓𝓪𝔂 🥇😉**
+
 * Added methods to get the width and height of the console (*in characters and lines*):<br>
   - <code>Cmd.w() -> *int*</code> how many text characters the console is wide<br>
   - <code>Cmd.h() -> *int*</code> how many lines the console is high<br>
@@ -774,7 +819,7 @@ from XulbuX import rgb, hsl, hexa
   <thead>
     <tr>
       <th>Features</th>
-      <th>class, type, function, ...</th>
+      <th>class, type, function, …</th>
     </tr>
   </thead>
   <tbody>

pyproject.toml

@@ -1,19 +1,29 @@
 [build-system]
-requires = ["setuptools>=61.0"]
+requires = [
+  "setuptools>=80.0.0",
+  "wheel>=0.45.0",
+  "mypy>=1.19.0",
+  "mypy-extensions>=1.1.0",
+  # TYPES FOR MyPy
+  "types-regex",
+  "types-keyboard",
+  "prompt_toolkit>=3.0.41",
+]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "xulbux"
-version = "1.9.2"
+version = "1.9.3"
 authors = [{ name = "XulbuX", email = "xulbux.real@gmail.com" }]
 maintainers = [{ name = "XulbuX", email = "xulbux.real@gmail.com" }]
 description = "A Python library to simplify common programming tasks."
 readme = "README.md"
 license = "MIT"
-license-files = ["LICEN[CS]E.*"]
+license-files = ["LICENSE"]
 requires-python = ">=3.10.0"
 dependencies = [
   "keyboard>=0.13.5",
+  "mypy-extensions>=1.1.0",
   "prompt_toolkit>=3.0.41",
   "regex>=2023.10.3",
 ]
@@ -139,7 +149,7 @@ ensure_newline_before_comments = true
 max-complexity = 12
 max-line-length = 127
 select = ["E", "F", "W", "C90"]
-extend-ignore = ["E203", "E266", "W503"]
+extend-ignore = ["E203", "E266", "E502", "W503"]
 per-file-ignores = ["__init__.py:F403,F405"]
 
 [tool.setuptools]

setup.py

@@ -0,0 +1,20 @@
+from mypyc.build import mypycify
+from setuptools import setup
+import os
+
+
+def find_python_files(directory: str) -> list[str]:
+    python_files: list[str] = []
+    for root, _, files in os.walk(directory):
+        for file in files:
+            if file.endswith(".py"):
+                python_files.append(os.path.join(root, file))
+    return python_files
+
+
+source_files = find_python_files("src/xulbux")
+
+setup(
+    name="xulbux",
+    ext_modules=mypycify(source_files),
+)

src/xulbux/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.9.2"
+__version__ = "1.9.3"
 
 __author__ = "XulbuX"
 __email__ = "xulbux.real@gmail.com"