rich-click 1.8.0.dev0__tar.gz → 1.8.0.dev2__tar.gz

{rich-click-1.8.0.dev0/src/rich_click.egg-info → rich-click-1.8.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rich-click
-Version: 1.8.0.dev0
+Version: 1.8.0.dev2
 Summary: Format click help output nicely with rich
 Author-email: Phil Ewels <phil@ewels.co.uk>
 Maintainer-email: Phil Ewels <phil@ewels.co.uk>, Daniel Reeves <xdanielreeves@gmail.com>
@@ -83,7 +83,7 @@ Requires-Dist: mkdocstrings[python]; extra == "docs"
 ---
 
 <p align="center">
-    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
+    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
 </p>
 
 ---

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2}/README.md

@@ -16,7 +16,7 @@
 ---
 
 <p align="center">
-    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
+    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
 </p>
 
 ---

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2}/src/rich_click/__init__.py

@@ -6,7 +6,7 @@ The intention is to provide attractive help output from Click, formatted with Ri
 customisation required.
 """
 
-__version__ = "1.8.0dev0"
+__version__ = "1.8.0dev2"
 
 # Import the entire click API here.
 # We need to manually import these instead of `from click import *` to force

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2}/src/rich_click/cli.py

@@ -110,6 +110,14 @@ class _RichHelpConfigurationParamType(click.ParamType):
     type=click.Choice(["html", "svg"], case_sensitive=False),
     help="Optionally render help text as HTML or SVG. By default, help text is rendered normally.",
 )
+@click.option(
+    "--suppress-warnings/--do-not-suppress-warnings",
+    is_flag=True,
+    default=False,
+    hidden=True,
+    help="Suppress warnings when there are conflicting entry_points."
+    " (This option is hidden because this situation is extremely rare).",
+)
 @click.option(
     # The rich-click CLI uses a special implementation of --help,
     # which is aware of the --rich-config object.
@@ -132,6 +140,7 @@ def main(
     ctx: RichContext,
     script_and_args: List[str],
     output: Literal[None, "html", "svg"],
+    suppress_warnings: bool,
     rich_config: Optional[RichHelpConfiguration],
     show_help: bool,
 ) -> None:
@@ -164,20 +173,50 @@ def main(
         click.echo(ctx.get_help(), color=ctx.color)
         ctx.exit()
 
-    sys.path.append(".")
-
     script, *args = script_and_args
 
-    _from_entry_points = False
-
-    scripts = {script.name: script for script in entry_points(group="console_scripts")}
-    if script in scripts:
-        module_path, function_name = scripts[script].value.split(":", 1)
-        _from_entry_points = True
-    elif ":" in script:
+    _selected: List[str] = []
+    module_path = ""
+    function_name = ""
+
+    for s in entry_points(group="console_scripts"):
+        if script == s.name:
+            if not _selected:
+                module_path, function_name = s.value.split(":", 1)
+            if suppress_warnings:
+                break
+            if s.value not in _selected:
+                _selected.append(s.value)
+
+    if len(_selected) > 1 and not suppress_warnings:
+        # This is an extremely rare edge case that comes up when the user sets the PYTHONPATH themselves.
+        if script in sys.argv:
+            _args = sys.argv.copy()
+            _args[_args.index(script)] = f"{module_path}:{function_name}"
+        else:
+            _args = ["rich-click", f"{module_path}:{function_name}"]
+
+        click.echo(
+            click.style(
+                f"WARNING: Multiple entry_points correspond with script '{script}': {_selected!r}."
+                "\nThis can happen when an 'egg-info' directory exists, you're using a virtualenv,"
+                " and you have set a custom PYTHONPATH."
+                f"\n\nThe selected script is '{module_path}:{function_name}', which is being executed now."
+                "\n\nIt is safer and recommended that you specify the MODULE:CLICK_COMMAND"
+                f" ('{module_path}:{function_name}') instead of the script ('{script}'), like this:"
+                f"\n\n>>> rich-click {' '.join(_args)}"
+                "\n\nAlternatively, you can pass --suppress-warnings to the rich-click CLI,"
+                " which will disable this message.",
+                fg="red",
+            ),
+            file=sys.stderr,
+        )
+
+    if ":" in script and not module_path:
         # the path to a function was passed
         module_path, function_name = script.split(":", 1)
-    else:
+
+    if not module_path:
         raise click.ClickException(f"No such script: {script_and_args[0]}")
 
     prog = module_path.split(".", 1)[0]

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2}/src/rich_click/rich_command.py

@@ -406,5 +406,3 @@ def prevent_incompatible_overrides(
     if hasattr(cmd.__class__, "format_commands"):
         if method_is_from_subclass_of(cmd.__class__, cls, "format_commands"):
             getattr(RichMultiCommand, "format_commands")(cmd, ctx, formatter)
-        else:
-            getattr(cmd, "format_commands")(ctx, formatter)

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2/src/rich_click.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rich-click
-Version: 1.8.0.dev0
+Version: 1.8.0.dev2
 Summary: Format click help output nicely with rich
 Author-email: Phil Ewels <phil@ewels.co.uk>
 Maintainer-email: Phil Ewels <phil@ewels.co.uk>, Daniel Reeves <xdanielreeves@gmail.com>
@@ -83,7 +83,7 @@ Requires-Dist: mkdocstrings[python]; extra == "docs"
 ---
 
 <p align="center">
-    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
+    <a href="https://ewels.github.io/rich-click">Documentation</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Source Code</a>&nbsp&nbsp·&nbsp&nbsp<a href="https://github.com/ewels/rich-click">Changelog</a>
 </p>
 
 ---

{rich-click-1.8.0.dev0 → rich-click-1.8.0.dev2}/tests/test_rich_click_cli.py

@@ -82,6 +82,7 @@ def test_simple_rich_click_cli(simple_script: Path, assert_str: AssertStr, comma
     res = subprocess.run(
         [sys.executable, "-m", "src.rich_click", "mymodule:cli", "--help"],
         stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
         env={**os.environ, "TERMINAL_WIDTH": "100", "FORCE_COLOR": "False"},
     )
     assert res.returncode == 0