First commit

Author: hamdanal

.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+ci:
+  autoupdate_schedule: "quarterly"
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.9.5
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        additional_dependencies: ["rich-argparse"]

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff",
+        "editor.formatOnSave": true,
+        "editor.codeActionsOnSave": {
+            "source.organizeImports.ruff": "explicit",
+        },
+    },
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ali Hamdan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,53 @@
+# auto-rich-argparse
+
+Automatically use [rich-argparse](https://github.com/hamdanal/rich-argparse) help formatters with
+argparse command line tools.
+
+## Usage
+
+Install auto-rich-argparse in the same environment as your command line tool.
+
+_Try it out with your favorite tool using `uvx --with auto-rich-argparse <YOUR_FAVORITE_TOOL> --help`_
+
+### Tools installed with `pipx`
+
+If your tool is installed with `pipx`, use the `pipx inject` command to add auto-rich-argparse to
+the tool's environment. For example, to use rich-argparse with `pre-commit`:
+
+```bash
+pipx inject pre-commit auto-rich-argparse
+```
+
+### Tools installed with `uv tool`
+
+If your tool is installed with `uv tool`, use the `--with` flag to install auto-rich-argparse:
+
+```bash
+uv tool install pre-commit --with auto-rich-argparse
+```
+
+### Tools in the current project
+
+You can also install auto-rich-argparse in you project's environment and it will be used by all
+tools that use argparse in that environment:
+
+```bash
+python -m pip install auto-rich-argparse
+```
+
+## How it works
+
+auto-rich-argparse works by monkey patching the `argparse.ArgumentParser` class to use a subclass of
+`RichHelpFormatter` from rich-argparse instead of the default `argparse.HelpFormatter`. The formatter
+tries to be compatible with the tool's formatter by setting the following options:
+
+```python
+FormatterClass.help_markup = False
+FormatterClass.text_markup = False
+FormatterClass.group_name_formatter = str
+```
+
+## Known limitations
+
+This doesn't currently work if the tool passes a function as the `formatter_class` argument to
+`ArgumentParser` instead of a class.

auto_rich_argparse.py

@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+import functools
+from argparse import ArgumentParser, HelpFormatter
+
+import rich_argparse
+from rich_argparse import RichHelpFormatter
+
+
+def make_rich_formatter_class(formatter_class: type[HelpFormatter]) -> type[HelpFormatter]:
+    for cls in formatter_class.mro():
+        if cls.__module__ == "argparse":
+            try:
+                # Find the corresponding rich formatter class
+                rich_formatter_class: type[RichHelpFormatter] = getattr(
+                    rich_argparse, cls.__name__.replace("HelpFormatter", "RichHelpFormatter")
+                )
+                if formatter_class.__module__ == "argparse":
+                    # If the formatter class itself is from argparse, replace it
+                    formatter_class = type(
+                        rich_formatter_class.__name__, (rich_formatter_class,), {}
+                    )
+                else:
+                    # Otherwise, inject the rich formatter class into its bases
+                    # This is necessary because we can't inherit from classes compiled with mypyc
+                    formatter_class.__bases__ = (rich_formatter_class,) + formatter_class.__bases__
+
+                # Disable rich-argparse's options that might have undesirable effects
+                setattr(formatter_class, "help_markup", False)
+                setattr(formatter_class, "text_markup", False)
+                setattr(formatter_class, "group_name_formatter", str)
+
+                return formatter_class
+            except Exception:
+                break
+    return formatter_class
+
+
+def patch_argument_parser_formatter_class() -> None:
+    original_init = ArgumentParser.__init__
+
+    @functools.wraps(original_init, updated=())
+    def __init__(*args, **kwargs):
+        formatter_class = kwargs.get("formatter_class", HelpFormatter)
+        if (
+            isinstance(formatter_class, type)
+            and issubclass(formatter_class, HelpFormatter)
+            and not issubclass(formatter_class, RichHelpFormatter)
+        ):
+            kwargs["formatter_class"] = make_rich_formatter_class(formatter_class)
+        return original_init(*args, **kwargs)
+
+    setattr(ArgumentParser, "__init__", __init__)

pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "auto-rich-argparse"
+version = "0.1.0"
+description = "Automatically use rich-argparse with argparse command line tools"
+readme = "README.md"
+license = "MIT"
+authors = [
+    { name = "Ali Hamdan", email = "[email protected]" }
+]
+requires-python = ">=3.8"
+dependencies = [
+    "rich-argparse>=1.7.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+include = [
+  "auto_rich_argparse.py",
+  "LICENSE",
+  "README.md",
+  "pyproject.toml",
+]
+
+[tool.hatch.build.targets.wheel]
+include = ["auto_rich_argparse.py"]
+
+[tool.hatch.build.hooks.autorun]
+dependencies = ["hatch-autorun"]
+code = "import auto_rich_argparse as _ara; _ara.patch_argument_parser_formatter_class()"
+
+[tool.ruff]
+line-length = 100