python / python/cpython

Error messages for `{}` style formatters for int, float, str, and complex

Aperta
#144,325 6 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

interpreter-core type-bug
Lingua principale
Python
Stelle
77.2k
Fork
35.9k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

Bug report

Bug description:

The {}-style formatters for int, float, str, and complex have several Unicode handling problems and confusion when generating ValueError messages.

There is an issue #142037 (and PR #142801) that focuses on %-style formatting, but the {}-style formatter has similar problems.

I am drafting a PR to fix the problems in the {} style formatter, and I would like to gather feedback on the proposed changes.


Invalid format specifier string
>>> f"{1:\n\\}"
Traceback (most recent call last):
  File "<python-input-0>", line 1, in <module>
    f"{1:\n\\}"
      ^^^^^^^^
ValueError: Invalid format specifier '
\' for object of type 'int'

In the above example, the error message is concatenated (%U) from the specifier string.

Suggestion: Use repr() (%R) to escape special characters.


Invalid type code in format specifier
>>> f"{1:\x7f}"
Traceback (most recent call last):
  File "<python-input-2>", line 1, in <module>
    f"{1:\x7f}"
      ^^^^^^^^
ValueError: Unknown format code '' for object of type 'int'
>>> f"{1:\t}"
Traceback (most recent call last):
  File "<python-input-3>", line 1, in <module>
    f"{1:\t}"
      ^^^^^^
ValueError: Unknown format code '\x9' for object of type 'int'
>>> f"{1:🐍}"
Traceback (most recent call last):
  File "<python-input-4>", line 1, in <module>
    f"{1:🐍}"
      ^^^^^^
ValueError: Unknown format code '\x1f40d' for object of type 'int'

The unprintable \x7f is concatenated, and \t and 🐍 are escaped improperly.

Suggestion: Use similar logic as in the %-style formatter in recent PR #142801:

https://github.com/python/cpython/blob/08d7bd28fecca524c648dda240022add704b8f8a/Objects/unicode_format.c#L768-L801


Conversion specifier

Same behavior as above:

>>> "{0!🐍}".format(1)
Traceback (most recent call last):
  File "<python-input-5>", line 1, in <module>
    "{0!🐍}".format(1)
    ~~~~~~~~~~~~~~~^^^
ValueError: Unknown conversion specifier \x1f40d

Suggestion: Apply the same logic as above, and so it is also consistent with the compile-time SyntaxError:

>>> f"{1!🐍}"
  File "<python-input-6>", line 1
    f"{1!🐍}"
         ^^
SyntaxError: invalid character '🐍' (U+1F40D)

Check for fractional part grouping separator

Currently, the check for thousands separator occurs when parsing the format specifier string, but may be omitted for the fractional part, so it passes to format a str (The parser processes the string without knowledge of the object type).

The 1st and 3rd are expected, the 2nd may be not:

>>> f'{123456.123456:.,}'
'123456.123,456'
>>> f'{"x":.,s}'
'x'
>>> f'{"x":,s}'
Traceback (most recent call last):
  File "<python-input-8>", line 1, in <module>
    f'{"x":,s}'
      ^^^^^^^^
ValueError: Cannot specify ',' with 's'.

Suggestion: I didn't find any PEP or document about where we can use the fractional part grouping separator, so I suggest that it can (and only can) be used for e, f, g, E, G, %, and F. For comparison, integer part supports above plus d, b, o, x, and X. None of these five has a fractional part.

Related reference:

  • Thousands separator was added in PEP 378.
  • Fractional part grouping separator was added in issue #87790.

Check type field before thousands separator
>>> f'{100000:+#020,🐍}'
Traceback (most recent call last):
  File "<python-input-10>", line 1, in <module>
    f'{100000:+#020,🐍}'
      ^^^^^^^^^^^^^^^^^
ValueError: Cannot specify ',' with '\x1f40d'.

This should be a type field issue that reports unknown format code, instead of misusing the thousands separator. Also, the character is not escaped properly.

Suggestion: Check the type field is valid first, then check the thousands separator. So we can also avoid repeating the Unicode codepoint logic when forming the error message.


I would appreciate any feedback or suggestions on these proposed changes. Thank you!

CPython versions tested on:

CPython main branch

Operating systems tested on:

macOS

Linked PRs
  • gh-144326

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con Objects/unicode_format.c, in particolare con la logica di formattazione a cui si fa riferimento da PR #142801, e confrontala con il PR #144326 collegato. Riproduci i casi elencati di specificatori di formato e conversioni non validi, quindi verifica che Unicode venga sottoposto a escape in modo coerente e che il raggruppamento frazionario e la convalida del campo del tipo seguano le regole proposte.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
compilers
Tipo di issue
Bug
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.