FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Clarify generic type parameter ordering by BHUVANSH855 · Pull Request #2289 · python/typing · GitHub

Repository navigation

Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
48 changes: 48 additions & 0 deletions docs/spec/generics.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,16 @@ Also consider the following example::

In this case ``MyDict`` has a single type parameter, ``T``.

Type parameter ordering
-----------------------

For classes using the Python 3.12 generic class syntax, the type
parameter order is determined by the order of parameters in the type
parameter list::

class NewStyle[T1, T2]:
...

Type variables are applied to the defined class in the order in which
they first appear in any generic base classes::

Expand All @@ -505,6 +515,44 @@ That ``Child`` definition is equivalent to::
class Child(Parent1[T1, T3], Parent2[T2, T3], Generic[T1, T3, T2]):
...

When ``Generic[...]`` is present in the base class list, the order of
type parameters is determined by the order of type arguments to
``Generic``::

from typing import Generic, TypeVar

T1 = TypeVar('T1')
T2 = TypeVar('T2')

class Base(Generic[T1, T2]):
...

class Child(Base[T2, T1], Generic[T1, T2]):
...

In this example, ``Child`` has type parameter order ``T1``, ``T2``.

Similarly, when a parameterized ``Protocol[...]`` base class is present,
the order of type parameters is determined by the order of type
arguments to ``Protocol``. A bare ``Protocol`` base class does not
affect type parameter ordering::

from typing import Protocol, TypeVar

T1 = TypeVar('T1')
T2 = TypeVar('T2')

class ProtoBase(Protocol[T1, T2]):
...

class ProtoChild(ProtoBase[T2, T1], Protocol[T1, T2]):
...

class BareProtoChild(ProtoBase[T1, T2], Protocol):
...

In all of the examples above, the type parameter order is ``T1``, ``T2``.

A type checker should report an error when the type variable order is
inconsistent::

Expand Down

Back | FazBrowse Home | New Git URL