python / python/cpython

Subtle error in `getattr_hook` example in the Descriptor Guide

Ouverte
#126,090 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

docs
Langage dominant
Python
Étoiles
77.2k
Forks
35.9k
Métriques de merge des PR
Métriques de PR en attente

Description

Documentation

The example below, from the Descriptor Guide, does not seem to reflect the behaviour of the actual implementation.

https://github.com/python/cpython/blob/ced2691de4c9500ac9a5ccded00741a5fc2d9d2c/Doc/howto/descriptor.rst?plain=1#L733-L740

Unless I'm mistaken, line 736 return obj.__getattribute__(name) should actually read return type(obj).__getattribute__(obj, name).

It's easy to miss when thinking of class instances, but the issue becomes more evident when the example is applied to an attribute lookup on a class object instead. The example would call the __getattribute__ method of the class itself, while the actual implementation calls __getattribute__ on the metaclass (not to mention that in this case the call in the example would fail, due to a missing argument, as it is calling a plain function, rather than a bound method).

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

Ouvrez Doc/howto/descriptor.rst autour des lignes 733-740 et comparez l’exemple de getattr_hook avec le comportement de l’implémentation décrit dans l’issue, en particulier pour la recherche d’attributs des objets de classe. Si l’écart est confirmé, mettez à jour l’expression de retour documentée et vérifiez que le guide correspond à l’implémentation.

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

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
48/100

Recevez les nouvelles issues par e-mail

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