`utcnow` deprecation note is misleading
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 77.2k
- Forks
- 36k
- PR-Merge-Kennzahlen
- PR-Kennzahlen ausstehend
Beschreibung
Documentation
Currently, the deprecation notice for datetime.utcnow() reads:
Deprecated since version 3.12: Use
datetime.now()withUTCinstead.
Unfortunately, applying this suggestion verbatim can easily break user code – especially when applying it to libraries. (See for example https://foss.heptapod.net/openpyxl/openpyxl/-/issues/2051). These datetime-related TypeErrors are easy to introduce, and fairly hard to fix. I suggest to amend the deprecation notice:
Deprecated since version 3.12: Use
datetime.now(UTC)instead. Please note that this will return an aware datetime object. If you need to remain compatible, usedatetime.now(UTC).replace(tzinfo=None).
Maybe someone can come up with a better wording.
Linked PRs
- gh-118571
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Überprüfe die Dokumentation zu datetime.datetime.utcnow() auf der verlinkten datetime-Seite und vergleiche die vorgeschlagene Formulierung mit PR gh-118571. Als erledigt gilt die Aufgabe, wenn der Deprecation-Hinweis eindeutig davor warnt, dass datetime.now(UTC) ein aware datetime zurückgibt, und die Kompatibilitätsoption replace(tzinfo=None) nennt oder eine vereinbarte bessere Formulierung übernimmt.
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
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100