Improve template typing with specialized version
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
调研方向
未指定目标文件、测试或入口点。首先查看提议的 Template、specialized Template、Interpolation 和 convert 签名,然后在定义完整的类型覆盖范围应包括哪些内容之前,就设计和支持的插值数量寻求一致意见。
由索引模型根据 Issue 内容生成。
描述
This is the basic idea I had to improve typing for templates:
from collections.abc import Iterator
from types import GenericAlias
from typing import Any, Generic, Literal, TypeVar, final, overload, TypeAlias
_T = TypeVar("_T")
_T1_co = TypeVar("_T1_co", covariant=True)
_T2_co = TypeVar("_T2_co", covariant=True)
class __BaseTypingTemplate:
@overload
def __new__(cls, *args: str) -> __Special0.Template: ...
@overload
def __new__(cls, arg1: str, arg2: Interpolation[_T1_co], /, *args: str) -> __Special1.Template[_T1_co]: ...
@overload
def __new__(cls, arg1: str, arg2: Interpolation[_T1_co], arg3: str, arg4: Interpolation[_T2_co], /, *args: str) -> __Special2.Template[_T1_co, _T2_co]: ...
@overload
def __new__(cls, *args: str | Interpolation[Any]) -> Template: ...
def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
@final
class Template(__BaseTypingTemplate):
strings: tuple[str, ...]
interpolations: tuple[Interpolation[Any], ...]
def __iter__(self) -> Iterator[str | Interpolation[Any]]: ...
def __add__(self, other: Template | __Special0.Template | __Special1.Template, /) -> Template: ...
@property
def values(self) -> tuple[Any, ...]: ...
__GeneralTemplate = Template # Alias we need in the specialized classes to make referencing it possible
class __Special0:
@final
class Template(__BaseTypingTemplate):
strings: tuple[str]
interpolations: tuple[()]
def __iter__(self) -> Iterator[str]: ...
@overload
def __add__(self, other: __GeneralTemplate, /) -> __GeneralTemplate: ...
@overload
def __add__(self, other: __Special0.Template, /) -> __Special0.Template: ...
@overload
def __add__(self, other: __Special1.Template[_T1_co], /) -> __Special1.Template[_T1_co]: ...
@overload
def __add__(self, other: __Special2.Template[_T1_co, _T2_co], /) -> __Special2.Template[_T1_co, _T2_co]: ...
@property
def values(self) -> tuple[()]: ...
class __Special1:
@final
class Template(__BaseTypingTemplate, Generic[_T1_co]):
strings: tuple[str, str]
interpolations: tuple[Interpolation[_T1_co]]
def __iter__(self) -> Iterator[str | Interpolation[_T1_co]]: ...
@overload
def __add__(self, other: __GeneralTemplate, /) -> __GeneralTemplate: ...
@overload
def __add__(self, other: __Special0.Template, /) -> __Special1.Template[_T1_co]: ...
@overload
def __add__(self, other: __Special1.Template[_T2_co], /) -> __Special2.Template[_T1_co, _T2_co]: ...
@overload
def __add__(self, other: __Special2.Template[_T1_co, _T2_co], /) -> __GeneralTemplate: ... # 3 but we stop at 2 for now
@property
def values(self) -> tuple[_T1_co]: ...
class __Special2:
@final
class Template(__BaseTypingTemplate, Generic[_T1_co, _T2_co]):
strings: tuple[str, str, str]
interpolations: tuple[Interpolation[_T1_co], Interpolation[_T2_co]]
def __iter__(self) -> Iterator[str | Interpolation[_T1_co] | Interpolation[_T2_co]]: ...
def __add__(self, other: Template, /) -> Template: ...
@property
def values(self) -> tuple[_T1_co, _T2_co]: ...
@final
class Interpolation(Generic[_T1_co]):
value: _T1_co
expression: str
conversion: Literal["a", "r", "s"] | None
format_spec: str
__match_args__ = ("value", "expression", "conversion", "format_spec")
def __new__(
cls, value: _T1_co, expression: str = "", conversion: Literal["a", "r", "s"] | None = None, format_spec: str = ""
) -> Interpolation[_T1_co]: ...
def __class_getitem__(cls, item: Any, /) -> GenericAlias: ...
@overload
def convert(obj: _T, /, conversion: None) -> _T: ...
@overload
def convert(obj: object, /, conversion: Literal["r", "s", "a"]) -> str: ...
Side note: Before, the interpolation's value was invariant instead of covariant. I'm not sure why exactly, since interpolations and templates only have readonly attributes. For now I made them covariant.
My idea is basically making specialized version of Template. Since "class overloading" is not really a thing, this was the idea I came up with. We have the __SpecialX namespaces to be able to create multiple Template classes. Everything that should not be exposed I made "private", aka double underscored. Alternatively we could del of course.
What you might also notice is that the __new__ method always switches between str and Interpolation, exactly like __iter__ returns elements. This design choice has multiple reasons:
- This matches the
__iter__output and how (I think) templates are stored internally and therefore it would make it very easy for type checkers to support literal templates (t"...") with these specialized versions. Any literal could just be interpreted as a__new__call and it would make their typing much better as well. - This is the minimal way fully represent any template (up to n specialized templates we would support). If we removed some
strargs in the middle, then we would have to do so for every combination. This would already explode the amount of overloads. If we would add morestrargs, this would be even worse. - The final
argsofstrallows for morestrelements at the end for free. Havingargsin the middle or multiple times is not possible or logically sound.
This example only shows up to 2 interpolations. I would type it up to at least 8 interpolations.
Also, the base class is there for convenience and maybe could be factored out.
In summary I think this would be the perfect addition, especially to make it easy for type checkers to have more support the literal template syntax better.
What are your thoughts? Generally a good idea or some worries? Anything that could be simplified?
- 主要语言
- Python
- 星标
- 5.1k
- 派生
- 2.1k
- 平均合并
- 2 天 7 分钟
- 30 天内合并 PR
- 116
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
python/typeshed 的其他 Issue
-
`networkx.set_edge_attributes` should support scalar value + name可能已有人在做 @Fire162 于 9 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 67/100
维护者通常 1 天内回复
-
false alarm on decode call可能已有人在做 @jw9829 于 37 天前认领。 未关闭help wanted stubs: false positive
难度 2/5 1-3 小时 新手友好度 76/100
python/typeshed#16441 · 1 条评论 ·
维护者通常 1 天内回复
-
Don't run pyright basic checks on projects with strict pyright settings in CI可能已有人在做 @Mohith1612 于 73 天前认领。 未关闭project: infrastructure
难度 2/5 1-3 小时 新手友好度 68/100
python/typeshed#16005 · 1 条评论 ·
维护者通常 1 天内回复
-
stubs: improvement
难度 2/5 1-3 小时 新手友好度 72/100
python/typeshed#15548 · 5 条评论 ·
维护者通常 1 天内回复
-
stubs: improvement
难度 2/5 1-3 小时 新手友好度 64/100
python/typeshed#15529 · 5 条评论 ·
维护者通常 1 天内回复
相似的 Issue
-
Import errors are swallowed: PerthImplicitWatermarker silently becomes None可能已有人在做 @JonRC 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
resemble-ai/Perth#23 ·
-
correction metadata
难度 2/5 1 小时以内 新手友好度 65/100
acl-org/acl-anthology#10753 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
earthtojake/text-to-cad#758 ·
维护者通常 1 天内回复
-
难度 1/5 1-3 小时 新手友好度 70/100
DataTalksClub/faq#545 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复