Suppress output to show only Usage and Docstring

Question

I would like to suppress the output when using python-fire, for a given command line option.

The fire trace and everything apart from the docstring and usage is essentially useless to me and clutters up the terminal. Any way I can get rid of it ?

I'm creating the cli using python-fire like this, where "command" is a function defined earlier :

if __name__ == "__main__":


    fire.Fire(
        {
            "command": command
        }
)

$ python cli.py command
Fire trace:
1. Initial component
2. Accessed property "command"
3. ('The function received no value for the required argument:)

Type:        function
String form: <function list_property_versions at 0x10de5d840>
File:        ./cli.py
Line:        171
Docstring:   Does something

Usage:       cli.py command arg1 
             cli.py command --first-arg arg1

Expected Output:

$ python cli.py command1

Docstring:   Does something

Usage:       cli.py command1 arg1 
             cli.py command1 --first-arg arg1

Hi and welcome to SO. Please post the [MRE](https://stackoverflow.com/help/minimal-reproducible-example), then someone may be able to help. — michcio1234, Jul 17 '19 at 20:43
Hey, thank you. I added more code to help understand how the cli was built. — Utkarsh K, Jul 17 '19 at 20:56

score 0 · Accepted Answer · answered Jul 25 '19 at 18:34

0

You can achieve this by editing core.py in the python-fire library by commenting/deleting out the printing of the trace in the following if condition:

if component_trace.HasError():

It's hacky but it works for now.

answered Jul 25 '19 at 18:34

Utkarsh K

1
2

score 0 · Answer 2 · answered Aug 13 '19 at 17:09

0

The Fire trace is no longer shown by default in the latest version of Fire, starting with version v0.2.0. I think you'll find the output is much cleaner than it was in earlier versions.

pip install -U fire to upgrade.

answered Aug 13 '19 at 17:09

David Bieber

88
8

Suppress output to show only Usage and Docstring

2 Answers2