Merge pull request #199 from dwreeves/fix-warning

Fix warning issue (again)

.pre-commit-config.yaml

@@ -22,11 +22,6 @@ repos:
     hooks:
       - id: pyproject-fmt
 
-  - repo: https://github.com/tox-dev/pyproject-fmt
-    rev: 1.7.0
-    hooks:
-      - id: pyproject-fmt
-
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
     rev: v0.1.7

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 1.8.2 (2023-05-14)
+
+- Fix another deprecation warning issue.
+
 ## Version 1.8.1 (2023-05-07)
 
 - Fixed bad deprecation warning with `highlighter`

src/rich_click/__init__.py

@@ -6,7 +6,7 @@
 customisation required.
 """
 
-__version__ = "1.8.1"
+__version__ = "1.8.2"
 
 # Import the entire click API here.
 # We need to manually import these instead of `from click import *` to force

src/rich_click/rich_help_configuration.py

@@ -172,17 +172,19 @@ class RichHelpConfiguration:
     legacy_windows: Optional[bool] = field(default=None)
 
     def __post_init__(self) -> None:  # noqa: D105
-        if self.highlighter is not None:
-            import warnings
-
-            warnings.warn(
-                "`highlighter` kwarg is deprecated in RichHelpConfiguration."
-                " Please do one of the following instead: either set highlighter_patterns=[...] if you want"
-                " to use regex; or for more advanced use cases where you'd like to use a different type"
-                " of rich.highlighter.Highlighter, subclass the `RichHelpFormatter` and update its `highlighter`.",
-                DeprecationWarning,
-                stacklevel=2,
-            )
+        # Todo: Fix this so that the deprecation warning works properly.
+
+        # if self.highlighter is not None:
+        #     import warnings
+        #
+        #     warnings.warn(
+        #         "`highlighter` kwarg is deprecated in RichHelpConfiguration."
+        #         " Please do one of the following instead: either set highlighter_patterns=[...] if you want"
+        #         " to use regex; or for more advanced use cases where you'd like to use a different type"
+        #         " of rich.highlighter.Highlighter, subclass the `RichHelpFormatter` and update its `highlighter`.",
+        #         DeprecationWarning,
+        #         stacklevel=2,
+        #     )
 
         self.__dataclass_fields__.pop("highlighter", None)