allure-framework / allure-framework/allure-python
Provide a custom repr for function params in `@step` decorator
- 主要言語
- Python
- スター
- 814
- フォーク
- 260
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
I have a function like:
```
@step
def foo(x: np.ndarray, y: Dict[str, np.ndarray]): ...
```
It is marked with `@step` decorator and my problem is that the output in the allure repo is too large. I see that the special case of `represnet` is here https://github.com/allure-framework/allure-python/blob/3c74fd540021f776be7b52f8078c9d34eee5c3b6/allure-python-commons/src/utils.py#L167
So I was wondering how to handle other objects like `np.ndarray` or `Dict[str, np.ndarray]`?
One way is to subclass `dict` and give a nice `repr` to it, but what with a single numpy array?Sublassing it just so it got a better `repr` for allure looks... excessive?
Can `@step` accept an additional argument that will explicitly tell it hot to handle `obj -> str` representation?
#### I'm submitting a ...
- [x ] feature request
#### What is the current behavior?
A long text output in the allure report for types like `np.ndarray` or `Dict[str, np.ndarray]` that have long `repr`.
#### What is the expected behavior?
Make `@step` that receives explicit formatter so I can write:
```
def _my_repr(x: np.ndarray, y: Dict[str, np.ndarray]):
return format_1(x), format_2(t) # <-- custom formatting code here
@step(formatter=_my_repr)
def foo(x: np.ndarray, y: Dict[str, np.ndarray]): ...
```
#### Please tell us about your environment:
allure-pytest==2.9.45
allure-python-commons==2.9.45
pytest==6.2.5
#### Other information
I am willing on implementing that feature conditional on the fact there is a way of accepting that change to the mainstream. Will you accept a PR that parametrize `@step` in such a way?
コントリビューションガイド
調査の方向性
allure-python-commons/src/utils.py の特殊ケースの表現ロジックから始め、@step が関数パラメーターをどのように収集するかを追跡します。明示的な formatter をパラメーターに対してどのように受け付け、適用するかを定義し、その後、numpy 配列と辞書がデフォルトの動作を変更せずに要求されたコンパクトな出力を生成することを確認します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- numpy, python
- 領域
- testing-qa
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100