python / python/typeshed

Missing reflected dunder methods from AbstractSet

Ouverte
#15,532 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Python
Étoiles
5.1k
Forks
2.1k
Merge moyen
1 j 19 h
PR mergées (30 j)
82

Description

Problem

Reflected operations (__rand__, __ror__, __rsub__, __rxor__) are missing from AbstractSet and its subclasses.

These are noted as explicit exclusions from tests: https://github.com/python/typeshed/blob/9f8f621918e4a187c49d68290a89f5f3dbe0cba9/stdlib/%40tests/stubtest_allowlists/common.txt#L50-L54

Example of consequences

@samueljsb and I have defined a protocol (in another project) for an object which has an __rsub__ method, and discovered that set, despite implementing this method, does not adhere to the protocol.

A simplified illustration of this issue is:

from typing import Any, Protocol

class Subtractable(Protocol):
    def __rsub__(self, other: Any) -> Any: ...

_: Subtractable = set()
$ mypy t.py
t.py:6: error: Incompatible types in assignment (expression has type "set[Never]", variable has type "Subtractable")  [assignment]
Found 1 error in 1 file (checked 1 source file)

Demonstrated with:

  • mypy 1.19.1 (compiled: yes)
  • Python 3.14.2 (main, Dec 5 2025, 16:49:16) [Clang 17.0.0 (clang-1700.4.4.1)]

Investigation

The exclusions reference https://github.com/python/typeshed/issues/7414, which was an attempt to add type hints for them. It was closed without merging because it encountered errors. We believe it encountered errors because the type signatures were wrong. Specifically, it didn't account for the return types of the operations matching the inputs.

For example, instead of:

def __rsub__(self, s: AbstractSet[_T]) -> AbstractSet[_T]: ...

We believe the signature needs to be (in the new syntax):

def __rsub__[T_Set: AbstractSet](self, other: T_Set) -> T_Set: ...

The above can be applied to __rsub__ and __rand__, because those methods return a subset of the input, and therefore will not change its type.

__ror__ and __rxor__ are more complicated because they return a type which is a superset of both inputs. We haven't yet looked into how to solve those.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par les exclusions dans stdlib/@tests/stubtest_allowlists/common.txt et comparez l’implémentation de AbstractSet dans Lib/_collections_abc.py de CPython. Suivez les stubs et les sous-classes de AbstractSet, déterminez des signatures compatibles pour les quatre méthodes réfléchies, puis confirmez que les exclusions peuvent être supprimées lorsque les tests de stub concernés passent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
devtools
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
38/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.