python / python/cpython

`plstlib`: Raise `ValueError` instead of `TypeError` when loading a partial ISO 8601 date

Offen
#151,221 10 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

stdlib type-feature
Vorherrschende Sprache
Python
Sterne
77.2k
Forks
35.9k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Bug report

Bug description:

Bug report

plistlib is documented (in the code) to accept ISO 8601 <date> values where the smaller units are omitted: the date regex _dateParser makes the month, day and time components optional, and the comment above it says "Smaller units may be omitted with a loss of precision".

However, when a <date> value actually omits the day or month, loading fails with a confusing internal TypeError instead of producing a datetime:

>>> import plistlib
>>> plistlib.loads(b'<plist><date>2024-06Z</date></plist>')
Traceback (most recent call last):
  ...
TypeError: datetime() missing required argument 'day' (pos 3)
>>> plistlib.loads(b'<plist><date>2024Z</date></plist>')
Traceback (most recent call last):
  ...
TypeError: datetime() missing required argument 'month' (pos 2)

Dates that omit only the time components work fine:

>>> plistlib.loads(b'<plist><date>2024-06-07Z</date></plist>')
datetime.datetime(2024, 6, 7, 0, 0)
>>> plistlib.loads(b'<plist><date>2024-06-07T08Z</date></plist>')
datetime.datetime(2024, 6, 7, 8, 0)

The cause is in Lib/plistlib.py, _date_from_string(): it builds the positional argument list for datetime.datetime() by stopping at the first missing component, so for 2024-06Z it only passes (2024, 6) — fewer than the three required arguments (year, month, day).

The omitted components should default to the start of the period (month=1, day=1, hour/minute/second=0), consistent with how omitted time components already behave and with the documented "loss of precision".

I have a fix with a regression test ready (#151217).

CPython versions tested on:

3.16, CPython main branch

Operating systems tested on:

Linux

Linked PRs
  • gh-151217
  • gh-151285
  • gh-152958
  • gh-153244

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 in Lib/plistlib.py bei _date_from_string() und überprüfe den Kommentar zu _dateParser sowie das Matching-Verhalten für unvollständige ISO-8601-Datumsangaben. Verwende die Beispiele im Issue als Regressionsfälle und prüfe anschließend den verknüpften PR #151217 sowie die andere verknüpfte Arbeit, bevor du fortfährst; abgeschlossen ist die Aufgabe, wenn ausgelassene Monats-, Tages- und Zeitkomponenten ohne den gemeldeten TypeError geladen werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
data
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

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