python / python/devguide

Clarify usage of type hints in the standard-library modules

Offen
#1,304 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

topic-dev process topic-stdlib type-feature
Vorherrschende Sprache
Python
Sterne
2.1k
Forks
1k
Ø Merge
2 T. 12 Std.
Gemergte PRs (30 T.)
12

Beschreibung

I think that Alex summarized the issue pretty well:

In general our policy is currently not to add type hints to standard-library modules in the Lib/ directory (there are some exceptions, but they're all pretty specific). I think we still have yet to add some formal documentation around this in the devguide (we really need to!), but you can see some rationales here:

Originally posted by @AlexWaygood in https://github.com/python/cpython/pull/117583#discussion_r1556105954

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, die verlinkte Diskussion und die Kommentare zum Pull Request zu prüfen, um die aktuelle Richtlinie und ihre Begründung zu erfassen, und suche anschließend die passende devguide-Dokumentationsseite. Erledigt ist die Aufgabe, wenn der Leitfaden die Richtlinie der Standardbibliothek für Type Hints einschließlich ihrer Begründung und Ausnahmen formal erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

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

Neue Issues direkt in Ihr Postfach

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