Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes to completions #355

Closed
wants to merge 2 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions src/cleo/commands/completions_command.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from cleo._compat import shell_quote
from cleo.commands.command import Command
from cleo.commands.completions.templates import TEMPLATES
from cleo.exceptions import CleoRuntimeError


if TYPE_CHECKING:
Expand Down Expand Up @@ -137,10 +138,32 @@ def render(self, shell: str) -> str:

raise RuntimeError(f"Unrecognized shell: {shell}")

@staticmethod
def _get_prog_name_from_stack() -> str:
package_name = ""
frame = inspect.currentframe()
f_back = frame.f_back if frame is not None else None
f_globals = f_back.f_globals if f_back is not None else None
# break reference cycle
# https://docs.python.org/3/library/inspect.html#the-interpreter-stack
del frame

if f_globals is not None:
package_name = f_globals.get("__name__")

if package_name == "__main__":
package_name = f_globals.get("__package__")

if package_name:
package_name = package_name.partition(".")[0]

if not package_name:
raise CleoRuntimeError("Can not determine package name")

return package_name

def _get_script_name_and_path(self) -> tuple[str, str]:
# FIXME: when generating completions via `python -m script completions`,
# we incorrectly infer `script_name` as `__main__.py`
script_name = self._io.input.script_name or inspect.stack()[-1][1]
script_name = self._io.input.script_name or self._get_prog_name_from_stack()
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did this work for you? ik it works for click, but would need tweaking

what about unifying the logic from the help command, which prefers self._application.name if defined? that feels more consistent and what I would expect:

if self._application:
current_script = self._application.name
else:
current_script = inspect.stack()[-1][1]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have only tested the _get_prog_name_from_stack method and it has returned the proper module name. Aplication.name is not always good, because you might have your program aliased on shell level (like having pipx installation with suffix).

script_path = posixpath.realpath(script_name)
script_name = os.path.basename(script_path)

Expand Down Expand Up @@ -215,6 +238,7 @@ def sanitize(s: str) -> str:
self._zsh_describe(f"--{opt.name}", sanitize(opt.description))
for opt in sorted(cmd.definition.options, key=lambda o: o.name)
)

cmds_opts += [
f" ({command_name})",
f" opts+=({options})",
Expand Down Expand Up @@ -258,11 +282,12 @@ def sanitize(s: str) -> str:
f"complete -c {script_name} -f -n '__fish{function}_no_subcommand' "
f"-a {command_name} -d '{sanitize(cmd.description)}'"
)

cmds_opts += [
f"# {command_name}",
f"# {cmd.name}",
*[
f"complete -c {script_name} -A "
f"-n '__fish_seen_subcommand_from {sanitize(command_name)}' "
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to make sure I understand, the syntax error was already fixed here with 6cc808d right? we just haven't had a release since then

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, the fix was making '__fish_seen_subcommand_from \'command name\'' entry, while this fix changes it to being '__fish_seen_subcommand_from "command name"' which feels like a more "proper" way to nest quotes.

f"""-n '__fish_seen_subcommand_from "{cmd.name}"' """
f"-l {opt.name} -d '{sanitize(opt.description)}'"
for opt in sorted(cmd.definition.options, key=lambda o: o.name)
],
Expand Down