python / python/cpython

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

Abierto
#144,325 6 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

interpreter-core type-bug
Lenguaje dominante
Python
Estrellas
77.2k
Forks
35.9k
Métricas de merge de PR
Métricas de PR pendientes

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comience con Objects/unicode_format.c, particularmente con la lógica de formato a la que se hace referencia desde PR #142801, y compárela con el PR #144326 enlazado. Reproduzca los casos indicados de especificadores de formato y conversiones no válidos y, después, verifique que Unicode se escape de forma coherente y que la agrupación fraccionaria y la validación del campo de tipo sigan las reglas propuestas.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
compilers
Tipo de issue
Error
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.