Document the current practice for SystemError

Ouverte
#95,799 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
c, python
Domaine
documentation

Piste de recherche

Commencez par la section SystemError à l’adresse docs.python.org/3/library/exceptions.html#SystemError et examinez la description de l’issue concernant l’utilisation incorrecte de la C API. Mettez à jour la documentation afin qu’elle reflète la pratique actuelle indiquée, y compris les utilisations incorrectes détectables dans les extensions, et assurez-vous que le texte qui en résulte n’implique plus que les erreurs internes de CPython en sont l’unique source.

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

Description

3.10 3.11 3.12 docs topic-C-API

@malemburg pointed that the documentation of SystemError only refers to CPython internal errors as the source.

https://docs.python.org/3/library/exceptions.html#SystemError

On practice, SystemError is also raised on improper use of the C API (like NULL pointer, or negative size, or wrong type in the concrete API) if it is possible to detect such error and it is not too costly (macros usually lack any argument checks). An alternative to SystemError is a crash or memory corruption. Currently the main source of SystemError is errors in third-party extensions, not in the Python core or standard extensions.

The documentation looks outdated, perhaps it predates the public C API.

Langage dominant
Python
Étoiles
77.2k
Forks
36k
Merge moyen
1 j 9 h
PR mergées (30 j)
558

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.

Autres issues de python/cpython

Toutes les issues de python/cpython

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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