Skip to content

Fix completion suggesting --self for class-grouped commands#650

Open
shivamtiwari3 wants to merge 1 commit intogoogle:masterfrom
shivamtiwari3:fix/382
Open

Fix completion suggesting --self for class-grouped commands#650
shivamtiwari3 wants to merge 1 commit intogoogle:masterfrom
shivamtiwari3:fix/382

Conversation

@shivamtiwari3
Copy link

Fixes google/python-fire issue #382: #382

What happened
When using a class as the Fire component (to group commands), Fire’s --completion output could include the implicit bound argument self as a CLI flag (--self). This is confusing and incorrect since users can never pass self explicitly.

Example symptom (from completion script output):

opts="--arg1 --self ${GLOBAL_OPTIONS}"
opts="--self ${GLOBAL_OPTIONS}"
Root cause
The completion generator builds option flags from the callable’s argspec:

Completions() → inspectutils.GetFullArgSpec(component) → _CompletionsFromArgs(spec.args + spec.kwonlyargs)
For unbound methods (functions retrieved from a class), spec.args includes self (or cls), because Python includes that parameter in the signature even though it is implicitly supplied at call time.
_CompletionsFromArgs was converting every arg name into a -- completion, which incorrectly produced --self.

Fix
In fire/completion.py, _CompletionsFromArgs now skips a leading self / cls argument when present. This ensures completion suggestions only contain user-supplied parameters.

This is a minimal, targeted change that affects only completion flag generation from argument lists.

Reproduction
A standalone repro script is included:

python3 repro_issue_382.py
It generates completion output for a small example class and asserts that --self is not present in the completion script.

Tests
python3 -m unittest fire.completion_test -q
Notes
This change is limited to completion generation. It does not affect Fire’s argument parsing or invocation behavior.
Existing test testMethodCompletions already asserts that --self should not appear; this change ensures the completion script output also respects that constraint in the class-grouping scenario.

@google-cla
Copy link

google-cla bot commented Mar 8, 2026

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant