nteract/papermill

Python parameter with `None | ` union type is logged as unknown

Open

#806 建立於 2024年9月5日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (5,381 star) (402 fork)batch import
bughelp wanted

描述

🐛 Bug

# template.ipynb parameters block
foo: None|str = None

$ papermill -p foo BAR ...
Passed unknown parameter: foo

Expected: this warning not to show up, foo should be recognized as a valid parameter.

Also note:

  • Despite the warning, the above example still properly injects the parameter value
  • Optional[str] does not suffer from this issue, just type union style
  • str|None (change the type order) produces the same warning log

papermill version == 2.6.0

貢獻者指南

技術棧
python
領域
cli
議題類型
bug
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic PythonUnderstanding of type hintsPapermill usage
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Look at the parameter parsing logic in papermill, likely in `papermill/parameter.py` or `papermill/iorw.py`. The bug is that `None | str` is not recognized as a valid type hint, while `Optional[str]` works. You'll need to modify the type detection to handle PEP 604 union syntax. Check how `typing.get type hints` or custom parsing is used, and ensure that `None | X` is treated as equivalent to `Optional[X]`.