Merge pull request #152 from dwreeves/fix-deprecation-warning

Fix deprecation warning
ewels · Jan 5, 2024 · 7d40b91 · 7d40b91
2 parents 8aba9a7 + 42a592b
commit 7d40b91
Show file tree

Hide file tree

Showing 27 changed files with 39 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,16 @@
 # Changelog: rich-click
 
+## Version 1.7.3
+
+- Fix false deprecation warning.
+
+## Version 1.7.2
+
+- Add support for rich formatting in epilog text [[#146](https://github.com/ewels/rich-click/pull/146)]
+
 ## Version 1.7.1
 
-- Fix bug with `rich-click` CLI not working with Python 3.12. [#141](https://github.com/ewels/rich-click/issues/141)
+- Fix bug with `rich-click` CLI not working with Python 3.12. [[#141](https://github.com/ewels/rich-click/issues/141)]
 - Fix compatibility issue with `dbt-core` CLI. [[#140](https://github.com/ewels/rich-click/issues/140)]
 
 ## Version 1.7.0

diff --git a/src/rich_click/__init__.py b/src/rich_click/__init__.py
@@ -6,7 +6,7 @@
 customisation required.
 """
 
-__version__ = "1.7.1"
+__version__ = "1.7.3"
 
 # Import the entire click API here.
 # We need to manually import these instead of `from click import *` to force mypy to recognize a few type annotation overrides for the rich_click decorators.

diff --git a/src/rich_click/cli.py b/src/rich_click/cli.py
@@ -9,17 +9,16 @@
     from importlib import metadata  # type: ignore[import,unused-ignore]
 except ImportError:
     # Python < 3.8
-    import importlib_metadata as metadata  # type: ignore[no-redef,import-not-found]
+    import importlib_metadata as metadata  # type: ignore[no-redef,import-not-found,unused-ignore]
 
 import click
 from rich.console import Console
 from rich.padding import Padding
 from rich.panel import Panel
 from rich.text import Text
 
-from rich_click import command as rich_command
-from rich_click import group as rich_group
-from rich_click import RichCommand, RichCommandCollection, RichGroup, RichMultiCommand
+from rich_click.decorators import command as rich_command
+from rich_click.decorators import group as rich_group
 from rich_click.rich_click import (
     ALIGN_ERRORS_PANEL,
     ERRORS_PANEL_TITLE,
@@ -29,6 +28,7 @@
     STYLE_USAGE,
     STYLE_USAGE_COMMAND,
 )
+from rich_click.rich_command import RichCommand, RichCommandCollection, RichGroup, RichMultiCommand
 
 console = Console()
 
@@ -70,7 +70,7 @@ def patch() -> None:
     click.Command = RichCommand  # type: ignore[misc]
     click.CommandCollection = RichCommandCollection  # type: ignore[misc]
     if "MultiCommand" in dir(click):
-        click.MultiCommand = RichMultiCommand  # type: ignore[assignment,misc]
+        click.MultiCommand = RichMultiCommand  # type: ignore[assignment,misc,unused-ignore]
 
 
 def entry_points(*, group: str) -> "metadata.EntryPoints":  # type: ignore[name-defined]

diff --git a/tests/expectations/test_rich_click[test arguments with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test arguments with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test arguments]-click7.config.json b/tests/expectations/test_rich_click[test arguments]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test command column alignment]-click7.config.json b/tests/expectations/test_rich_click[test command column alignment]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test context_settings]-click7.config.json b/tests/expectations/test_rich_click[test context_settings]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test custom errors help]-click7.config.json b/tests/expectations/test_rich_click[test custom errors help]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test custom errors with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test custom errors with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test declarative with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test declarative with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test declarative]-click7.config.json b/tests/expectations/test_rich_click[test declarative]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/...ectations/test_rich_click[test environment variables with rich_config]-click7.config.json b/...ectations/test_rich_click[test environment variables with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test envvar]-click7.config.json b/tests/expectations/test_rich_click[test envvar]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test group sorting]-click7.config.json b/tests/expectations/test_rich_click[test group sorting]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test groups sorting with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test groups sorting with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test markdown with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test markdown with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test markdown]-click7.config.json b/tests/expectations/test_rich_click[test markdown]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/...s/expectations/test_rich_click[test metavars default with rich_config]-click7.config.json b/...s/expectations/test_rich_click[test metavars default with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test metavars default]-click7.config.json b/tests/expectations/test_rich_click[test metavars default]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test metavars with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test metavars with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test metavars]-click7.config.json b/tests/expectations/test_rich_click[test metavars]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test rich markup with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test rich markup with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test rich markup]-click7.config.json b/tests/expectations/test_rich_click[test rich markup]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test simple with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test simple with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test simple]-click7.config.json b/tests/expectations/test_rich_click[test simple]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test table styles with rich_config]-click7.config.json b/tests/expectations/test_rich_click[test table styles with rich_config]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",

diff --git a/tests/expectations/test_rich_click[test table styles]-click7.config.json b/tests/expectations/test_rich_click[test table styles]-click7.config.json
@@ -7,6 +7,7 @@
   "style_metavar_append": "dim yellow",
   "style_metavar_separator": "dim",
   "style_header_text": "",
+  "style_epilog_text": "",
   "style_footer_text": "",
   "style_usage": "yellow",
   "style_usage_command": "bold",