python / python/cpython

Document the current practice for SystemError

Offen
#95,799 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.10 3.11 3.12 docs topic-C-API
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
36k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

@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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem Abschnitt SystemError unter docs.python.org/3/library/exceptions.html#SystemError und prüfen Sie die Beschreibung des Issues zur unsachgemäßen Verwendung der C API. Aktualisieren Sie die Dokumentation, sodass sie die angegebene aktuelle Praxis widerspiegelt, einschließlich erkennbaren Fehlgebrauchs in Extensions, und stellen Sie sicher, dass der resultierende Text nicht länger impliziert, dass interne CPython-Fehler die einzige Quelle sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
c, python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.