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

Ignoring convention that -- separate non-flag arguments in bash (apart from last -- for fire flags) #580

Open
jbcdnr opened this issue Jan 22, 2025 · 1 comment

Comments

@jbcdnr
Copy link

jbcdnr commented Jan 22, 2025

Beyond the fact that fire uses the last -- to separate flag argument from command arguments, it seems that previous -- are not parsed correctly. At least according to the common convention that a double dash ( -- ) is used in most Bash built-in commands and many other commands to signify the end of command options, after which only positional ("non-option") arguments are accepted (source).

I would like to use this to pass some other commands to a fire command, without the flags targeted to the extra command being parsed by fire. Here is a minimal example test.py:

import fire


def foo(*args: str, flag: int = 2) -> None:
    print(f"{args=} {flag=}")


fire.Fire(foo)

Current behavior:

$ python test.py -- other args 1 2 --flag 3 --
args=('args', 1, 2) flag=3
ERROR: Could not consume arg: --
Usage: test.py -- other args 1 2 -

For detailed information on this command, run:
  test.py -- other args 1 2 - --help

Expected behavior:

python test.py -- other args 1 2 --flag 3 --
args=('args', 1, 2, "--flag", 3) flag=2

Would you be fine with updating the parsing rules in

2a. If the current component is a class, instantiate it using args from args.
to consider all remaining args as positional arguments if it encounter a -- ? I could work on a PR if there is no major blocker.

@jbcdnr jbcdnr changed the title Ignoring convention that -- to separate non-flag arguments (more than -- one separating fire flags) Ignoring convention that -- separate non-flag arguments (more than -- one separating fire flags) Jan 22, 2025
@jbcdnr jbcdnr changed the title Ignoring convention that -- separate non-flag arguments (more than -- one separating fire flags) Ignoring convention that -- separate non-flag arguments in bash (apart from last -- for fire flags) Jan 22, 2025
@jbcdnr
Copy link
Author

jbcdnr commented Jan 24, 2025

Hello @dbieber,

Could you have a look at this issue? I implemented the feature in this fork with some tests. Happy to open a PR and polish it if you agree that this is following expected behavior in bash (and argparse).

Cheers,

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

No branches or pull requests

1 participant