Convert Type Parameters to follow PEP 695 syntax introduced in Python 3.12

未关闭
#11,730 9 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@FrancescoPezzella 已经在做这个了。

开始于 2026年10月14日。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
22/100
Issue 类型
重构
描述清晰度
基本清楚
活跃度
活跃
技术栈
python

调研方向

The issue gives one example: a pipe method with overloads that uses module-level TypeVar and ParamSpec declarations, in a file over 1000 lines. Before editing, check the project's minimum supported Python version and read the three comments to see whether maintainers have agreed to adopt PEP 695 syntax. Done would mean one module converted, its type checker passing, and any remaining TypeVar uses (such as covariant ones) explained.

由索引模型根据 Issue 内容生成。

描述

enhancement topic-typing
What is your issue?
Background

https://peps.python.org/pep-0695/ introduced new syntax for Type Parameters.

Out of interest, I took a quick look through the project due to another project I am working on and noticed that this project uses Python 3.12, but still uses a mix of syntax introduced in 3.5 (for reference: https://peps.python.org/pep-0484/) and 3.12, instead of fully modernizing the syntax (where it can be safely done) to the new one.

Sometimes a change cannot be done, for example, if a TypeVar declares covariance/contravariance in a Generic class, since these cases are handled automatically in Python 3.12, and there is no new way to define with the modern syntax.

Example

Old Syntax

from typing import (
    ...
    ParamSpec,
    TypeVar,
    ...
)
T_Resample = TypeVar("T_Resample", bound="Resample")
C = TypeVar("C")
T = TypeVar("T")
P = ParamSpec("P")
    @overload
    def pipe(
        self,
        func: Callable[Concatenate[Self, P], T],
        *args: P.args,
        **kwargs: P.kwargs,
    ) -> T: ...

    @overload
    def pipe(
        self,
        func: tuple[Callable[..., T], str],
        *args: Any,
        **kwargs: Any,
    ) -> T: ...

    def pipe(
        self,
        func: Callable[Concatenate[Self, P], T] | tuple[Callable[P, T], str],
        *args: P.args,
        **kwargs: P.kwargs,

This is a perfect example, where the code could greatly benefit from the new syntax. The file is over a 1000 lines long, the Type Variables are not used anywhere else nor exported. The new syntax would greatly simplify them. This follows Python conventions.

With the new syntax

    @overload
    def pipe[T, P**](
        self,
        func: Callable[Concatenate[Self, P], T],
        *args: P.args,
        **kwargs: P.kwargs,
    ) -> T: ...

    @overload
    def pipe[T](
        self,
        func: tuple[Callable[..., T], str],
        *args: Any,
        **kwargs: Any,
    ) -> T: ...

    def pipe[T, P**](
        self,
        func: Callable[Concatenate[Self, P], T] | tuple[Callable[P, T], str],
        *args: P.args,
        **kwargs: P.kwargs,

This is just one example. I am still looking into this just as interesting case study regarding my research. If this is something that the developers are interested in, I would be happy to look into it more, investigate each case and propose a change with a tool that I am still developing.

Let me know if you would further information, I am quite to making issues and contributions, so I tried my best to follow some examples I read here.

No AI was used in the writing of this.

主要语言
Python
星标
4.2k
派生
1.5k
平均合并
2 天 21 小时
30 天内合并 PR
74

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

pydata/xarray 的其他 Issue

查看 pydata/xarray 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。