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

Aperta
#11,730 9 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@FrancescoPezzella ci sta già lavorando.

Dal 14/10/2026.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
22/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
python

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
4.2k
Fork
1.5k
Merge medio
2g 21h
PR unite (30g)
74

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pydata/xarray

Tutte le issue di pydata/xarray

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.