MetricWrapperBase labels() method static typing for label names
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 30/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- python
调研方向
首先查看 MetricWrapperBase 及其 labels 方法,以及 issue 中描述的 TypeVarTuple 和 typing_extensions 思路。确定是否可以采用一种可进行类型检查的方法来保留现有的 label 和关键字参数用法;当所选设计能够检测不匹配的 label 参数,同时不破坏向后兼容性时,即视为完成。
由索引模型根据 Issue 内容生成。
描述
Hi, recently I was thinking about possible improvement for MetricWrapperBase and friends labels method.
Very common use case is described even in Counter's docstring:
from prometheus_client import Counter
c = Counter('my_requests_total', 'HTTP Failures', ['method', 'endpoint'])
c.labels('get', '/').inc()
c.labels('post', '/submit').inc()
But when having N different counters, especially with different number of label names, and legacy large codebase or just very hard to test edge cases in your code (or the effort to test them all is not acceptable for some reason) where you use metrics, after some time you end up with typo errors when number of arguments do not match those specified, for example with above example counter:
try:
do_something()
except VeryRareException:
if int(time.time()) % 99999 == 0:
c.labels('get').inc() # Surprise!!! ValueError
Maybe we can do better somehow? This would be extra useful if we could pass label names like ['method', 'endpoint'] in a way that type checkers could understand and yield errors even before actually running code. Ideally with 100% backward compability with existing implementations (that one will be hard).
To just give some silly ideas, there is for example TypeVarTuple https://docs.python.org/3/library/typing.html#typing.TypeVarTuple that could at least do the job but only with partial backward compability, here PoC for MetricWrapperBase:
Disclaimer both TypeVarTuple and Self are Python 3.11+
from typing import TypeVarTuple, Self
...
LabelNames = TypeVarTuple("LabelNames")
class MetricWrapperBase(Collector,Generic[*LabelNames]):
...
def __init__(self,
name: str,
documentation: str,
labelnames: tuple[*LabelNames] = (),
namespace: str = '',
subsystem: str = '',
unit: str = '',
registry: Optional[CollectorRegistry] = REGISTRY,
_labelvalues: Optional[Sequence[str]] = None,
) -> None:
...
def labels(self: T, *labelvalues: *LabelNames) -> Self:
... # breaking changes there, only args
With that we have desire result
x = MetricWrapperBase("x", "y", ("short name", "data"))
x.labels("Ok name", "Ok data")
x.labels("Forgot second arg")

Of course this is very far from perfect, note only tuples could be used (no list) and in labels only args not kwargs. Also Python 3.11 is questionable but there is typing_extensions lib plus that could always live as a optional stubs only or some nasty overloads.
I am not by any means python typing ninja, but maybe someone could come up with better ideas! Or have some thoughts on this topic, I am observing new typing features on every python release, there may be now solutions that didn't exist couple of years ago.
- 主要语言
- Python
- 星标
- 4.4k
- 派生
- 876
- 平均合并
- 8 天 4 小时
- 30 天内合并 PR
- 1
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
prometheus/client_python 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
prometheus/client_python#1177 · 1 条评论 ·
-
难度 4/5 3-5 天 新手友好度 45/100
prometheus/client_python#1210 ·
-
难度 2/5 1-3 小时 新手友好度 58/100
prometheus/client_python#1199 · 1 个 reaction ·
-
难度 5/5 一周以上 新手友好度 35/100
prometheus/client_python#1176 ·
-
难度 1/5 1-3 小时 新手友好度 52/100
prometheus/client_python#1126 · 2 条评论 ·
查看 prometheus/client_python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
stephrobert/dsoxlab#238 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
sublimehq/package_control#1780 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 70/100
nwg-piotr/nwg-displays#145 ·