google / google/python-fire

Option to print help to std out

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

描述

Thanks for creating Fire. It's a fantastic argument parsing tool.

A minor request: I prefer my help strings to be printed to stdout instead of a console like `less`. When the output is sent to a `less`-like program you can't reference the script argument information when trying to type your next command.

The naive way to allow this option is adding a switch so the user can choose to send information console package or to stdout (code below).

https://github.com/google/python-fire/blob/d77453938a4b7a5a2bb71d9cb40397ee8bbc2e0a/fire/core.py#L171
to something like
```
if print_std:
print(text, file=out)
else:
console_io.More(
```

I don't see an elegant way to set `print_std` in your source code since you are not accepting contributions to your console package and the `Display` function is not a method of the Fire class. I don't see a straightforward way to have the user set this display option. Obviously, you know the code better than me so you may know a good way to add this option.

I am using fire version 0.2.1 and have seen this behavior with Ubuntu 16.04 and 18.04.

Thank you for your time!

貢獻指南

開啟貢獻指南

研究方向

首先閱讀第 171 行附近的 fire/core.py,以及關於 console_io.More 和 stdout 處理的 issue 討論。確定應如何提供使用者可選擇的顯示選項,然後驗證 help 可以傳送到 stdout,而不會出現目前類似 pager 的行為,同時保留現有的預設設定。

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

評估

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

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

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