google / google/python-fire

Allow to supress output.

未关闭
#532 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
28.2k
派生
1.5k
PR 合并指标
30 天内没有已合并 PR

描述

I propose we allow to supress output.
```
def Fire(component=None, command=None, name=None, serialize=None, supress_output=False):
...
if not supress_output:
_PrintResult(
component_trace, verbose=component_trace.verbose, serialize=serialize)
```
Why?

Let's try to wrap a function that returns a ```pd.DataFrame``` with ```Fire```:
```
import pandas as pd
from os import PathLike
from fire import Fire
from functools import wraps

def do_stuff_with_df(path: PathLike) -> pd.DataFrame:
df = pd.read_csv(path)
print("***Print inside func***")
# Do stuff here, save .csv and such.
...
# return for usage in other funcs
return df

if __name__ == "__main__":
Fire(do_stuff_with_df)
```
And this is the output.
```
python .\test.py --path dummy.csv
***Print inside func***
NAME
test.py --path dummy.csv - Two-dimensional, size-mutable, potentially heterogeneous tabular data.

SYNOPSIS
test.py --path dummy.csv GROUP | COMMAND | VALUE

DESCRIPTION
Data structure also contains labeled axes (rows and columns).
Arithmetic operations align on both row and column labels. Can be
thought of as a dict-like container for Series objects. The primary
pandas data structure.
(We can scroll down for more!)
...
```
We get a description of pd.DataFrame. And we have to press ```Q``` enter normal terminal again.
That's quite inconvenient. A user would have to create and apply wrapper to not get this description.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。