Make timeout duration unit self-documenting
还没有人认领这个 Issue。
评估
调研方向
首先查看当前的 @mark.timeout API，以及定义其持续时间单位的文档。比较提议的关键字参数接口和 timedelta 接口，包括兼容性和支持的单位。完成标准是选择并明确规定一个自说明的 API，并清楚记录其行为和迁移影响。
由索引模型根据 Issue 内容生成。
描述
In a statement like @mark.timeout(50) there is nothing to say the duration is defined in seconds. This has a few disadvantages:
- Many other timing mechanisms use milliseconds or minutes as their units, so we can't simply assume that it's seconds. A new or returning user has to read the documentation (or code) to ascertain this, wasting time and producing cognitive overhead.
- Extreme timeouts like
1200or0.00005have more cognitive overhead, since converting to the "natural" unit of minutes/microseconds etc isn't always trivial.
It would be nice if it instead were self-documenting. Some alternatives:
@mark.timeout(seconds=50)would make it pretty obvious, and would make it easy to support several units.@mark.timeout(timedelta(minutes=5))would make it more explicit, while supporting the widest possible range of units at no extra cost.@mark.timeout(seconds=timedelta(minutes=5).total_seconds())is a clunky workaround.
- 主要语言
- Python
- 星标
- 260
- 派生
- 70
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
pytest-dev/pytest-timeout 的其他 Issue
-
PR #200 introduced breaking change - `timeout` value in config is incompatible with older versions可能已有人在做 @Sanjays2402 于 51 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 48/100
pytest-dev/pytest-timeout#203 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
pytest-dev/pytest-timeout#190 · 9 条评论 ·
-
难度 4/5 3-5 天 新手友好度 35/100
pytest-dev/pytest-timeout#189 ·
-
难度 2/5 1-3 小时 新手友好度 35/100
pytest-dev/pytest-timeout#181 · 4 个 reaction ·
-
难度 2/5 1-3 小时 新手友好度 35/100
pytest-dev/pytest-timeout#178 · 1 条评论 ·
查看 pytest-dev/pytest-timeout 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 75/100
common-workflow-language/cwl-utils#477 ·
维护者通常 1 天内回复
-
Add dependabot未关闭feat
难度 2/5 1 小时以内 新手友好度 72/100
open-nudge/opentemplate#204 ·
维护者通常 1 天内回复
-
github-stale-ci-pr-closer: KV state is double-wrapped, never persists, and hits the depth-32 limit可能已有人在做 @VascoSch92 今天认领。 未关闭priority:medium ready-for-dev
难度 2/5 1-3 小时 新手友好度 72/100
OpenHands/extensions#781 ·
维护者通常 1 天内回复
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
curriculum documentation quality
难度 2/5 1-3 小时 新手友好度 78/100
githubnext/gh-aw-workshop#4638 ·
维护者通常 1 天内回复