python / python/cpython

pyexpat: xmlparser is actually XMLParserType

Offen
#140,771 1 Kommentar 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

3.13 3.14 3.15 docs extension-modules topic-XML
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

The type of the Expat parser is referred everywhere as xmlparser, although no anchor for this reference is defined. But this type is actually exposed in the pyexpat (public API is xml.parsers.expat) module as XMLParserType since 2000 (4ba298c3253d5c4d11cf822619457701b7b248c0). The class name is xmlparser.

>>> import xml.parsers.expat
>>> xml.parsers.expat.__name__
'xml.parsers.expat'
>>> xml.parsers.expat.XMLParserType
<class 'pyexpat.xmlparser'>
>>> xml.parsers.expat.XMLParserType.__name__
'xmlparser'
>>> xml.parsers.expat.XMLParserType.__qualname__
'xmlparser'
>>> xml.parsers.expat.XMLParserType.__module__
'pyexpat'

I was planned to add an anchor for the xmlparser class, but since it is available as XMLParserType, should not we simply change its name and all references in the documentation to XMLParserType? Or add an alias xmlparser? (the question is why it was not used from the beginning.)

Linked PRs
  • gh-144456

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

Beginne damit, dieses Issue und den verknüpften PR gh-144456 zu lesen, und ermittle dann, ob die Dokumentation XMLParserType oder xmlparser verwenden sollte. Erledigt ist die Aufgabe, wenn der gewählte öffentliche Name einen definierten Anker hat und die Dokumentationsverweise konsistent sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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