google / google/python-fire

Help Request - Disable NAME and SYNOPSIS Output

Open
#277 2 comments 2 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
28.2k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Description

I'm trying to find a way to disable the additional output that the fire library creates that comes after the process completes. It begins with NAME and includes SYNOPSIS. I have no need for this additional output in my scenario as it could potentially cause trouble for another external process that calls this and is examining the stdout for its own processing.

Here's an example of what I'm describing:
```
M:\Python\Workbench>FireHelpDocumentationExample.py --HowMuchPizza=1
()
NAME
FireHelpDocumentationExample.py --HowMuchPizza=1

SYNOPSIS
FireHelpDocumentationExample.py --HowMuchPizza=1 -
```

I would expect just:
`()`

An example of code I put together that was used to create this example [is here](https://gist.github.com/Sn3akyP3t3/f571c4baf272db191ed59f03359795c0).

Contributor guide

Open the contributing guide

Research direction

Reproduce the command shown in the issue and inspect Python Fire's help-output path to find where NAME and SYNOPSIS are emitted. Determine how disabling that output should be exposed, then add coverage showing that the example produces only `()` when the option is used.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.