Fix types and mark as typed (#43)

Package type information in order to make pyright/mypy identify this as typed.

Apart from this, I fixed the types: `group_name_formatter`, `styles`,
`highlights`, and `usage_markup` are `ClassVar`s, not instance
variables.

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Ali Hamdan <[email protected]>

Author: 3 people

.pre-commit-config.yaml

@@ -22,7 +22,10 @@ repos:
     rev: 5.10.1
     hooks:
       - id: isort
+        types_or: [python]
         args: [--add-import, "from __future__ import annotations"]
+      - id: isort
+        types_or: [pyi]
   - repo: https://github.com/psf/black
     rev: 22.10.0
     hooks:

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
-requires = ["flit_core >=3.2,<4"]
-build-backend = "flit_core.buildapi"
+requires = ["hatchling>=1.11.0"]
+build-backend = "hatchling.build"
 
 [project]
 name = "rich_argparse"
@@ -35,6 +35,13 @@ Documentation = "https://github.com/hamdanal/rich-argparse#rich-argparse"
 Issue-Tracker = "https://github.com/hamdanal/rich-argparse/issues"
 Changelog = "https://github.com/hamdanal/rich-argparse/blob/main/CHANGELOG.md"
 
+[tool.hatch.build]
+sources = ["stubs"]
+include = [
+  "rich_argparse-stubs",
+  "rich_argparse.py",
+]
+
 [tool.tox]
 legacy_tox_ini = """
 [tox]
@@ -64,6 +71,7 @@ line_length = 100
 [tool.mypy]
 strict = true
 show_error_codes = true
+explicit_package_bases = true
 
 [[tool.mypy.overrides]]
 module = ["tests.*"]

rich_argparse.py

@@ -4,7 +4,7 @@
 
 import argparse
 import sys
-from typing import TYPE_CHECKING, Callable, Iterable, Iterator
+from typing import TYPE_CHECKING, Callable, ClassVar, Iterable, Iterator
 
 # rich is only used to display help. It is imported inside the functions in order
 # not to add delays to command line tools that use this formatter.
@@ -28,20 +28,20 @@
 class RichHelpFormatter(argparse.HelpFormatter):
     """An argparse HelpFormatter class that renders using rich."""
 
-    group_name_formatter: Callable[[str], str] = str.upper
-    styles: dict[str, StyleType] = {
+    group_name_formatter: ClassVar[Callable[[str], str]] = str.upper
+    styles: ClassVar[dict[str, StyleType]] = {
         "argparse.args": "cyan",
         "argparse.groups": "dark_orange",
         "argparse.help": "default",
         "argparse.metavar": "dark_cyan",
         "argparse.syntax": "bold",
         "argparse.text": "default",
     }
-    highlights: list[str] = [
+    highlights: ClassVar[list[str]] = [
         r"(?:^|\s)(?P<args>-{1,2}[\w]+[\w-]*)",  # highlight --words-with-dashes as args
         r"`(?P<syntax>[^`]*)`",  # highlight text in backquotes as syntax
     ]
-    usage_markup: bool = False
+    usage_markup: ClassVar[bool] = False
 
     def __init__(
         self,
@@ -60,7 +60,7 @@ class _Section(argparse.HelpFormatter._Section):  # type: ignore[valid-type,misc
         def __init__(
             self,
             formatter: RichHelpFormatter,
-            parent: RichHelpFormatter._Section,
+            parent: RichHelpFormatter._Section | None,
             heading: str | None = None,
         ) -> None:
             if heading is not None:

stubs/rich_argparse-stubs/__init__.pyi

@@ -0,0 +1,22 @@
+import argparse
+from collections.abc import Callable
+from typing import ClassVar
+
+from rich.console import Console
+from rich.style import StyleType
+
+# flake8: noqa
+
+class RichHelpFormatter(argparse.HelpFormatter):
+    group_name_formatter: ClassVar[Callable[[str], str]]
+    styles: ClassVar[dict[str, StyleType]]
+    highlights: ClassVar[list[str]]
+    usage_markup: ClassVar[bool]
+    console: Console
+
+class RawDescriptionRichHelpFormatter(RichHelpFormatter): ...
+class RawTextRichHelpFormatter(RawDescriptionRichHelpFormatter): ...
+class ArgumentDefaultsRichHelpFormatter(
+    argparse.ArgumentDefaultsHelpFormatter, RichHelpFormatter
+): ...
+class MetavarTypeRichHelpFormatter(argparse.MetavarTypeHelpFormatter, RichHelpFormatter): ...