google / google/python-fire

help page shows unwanted information about groups

未關閉
#204 4 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Python
星號
28.2k
分支
1.5k
PR 合併指標
30 天內沒有已合併 PR

描述

I have a file called `neptune` that just has some standalone functions, no classes or groups.

I create my cli by doing
```
if __name__ == '__main__':
fire.Fire()
```

When I do `neptune --help`, I see

![Screen Shot 2019-10-11 at 1 32 24 PM](https://user-images.githubusercontent.com/26889933/66683139-95a6db80-ec2b-11e9-8a30-d928b3352538.png)

I don't understand why it says

f - "Character and line based layer over a BufferedIOBase object, buffer"

I don't want to see that information about the `f` group when I do `neptune --help`

A workaround I came up with was to do this instead
```
if __name__ == '__main__':
fire.Fire({
'cmd1': cmd1,
'cmd2': cmd2,
...
})
```
This doesn't seem intuitive.

I'd be happy to help fix this if someone wants to point me in the right direction!

貢獻指南

開啟貢獻指南

研究方向

Start by reproducing the issue with a standalone `neptune` file and the `fire.Fire()` entry point, then compare its `--help` output with the explicit command mapping workaround. The fix is done when standalone functions no longer cause an unrelated `f` group and its BufferedIOBase description to appear in help.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
cli
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
42/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。