python / python/mypy

Incorrect str-format error for bytes interpolation when `__bytes__` method exists

Aperta
#19,724 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug topic-runtime-semantics
Lingua principale
Python
Stelle
20.6k
Fork
3.3k
Metriche di merge delle PR
Metriche PR in attesa

Descrizione

When the % operator is used to format a bytes string with a placeholder of %b (bytes) and an argument of type bytearray the interpolation will succeed as bytearray has a __bytes__ method as per PEP 0461. The same is also true of memoryview objects as well as any type with a __bytes__ method.

MyPy will not flag an error for bytearray or memoryview objects but will for classes with a __bytes__ method. If --disable-bytearray-promotion or --disable-memoryview-promotion are used then these string interpolations will be flagged as a str-format error - presumably is it stops silently treating these classes as equivalent to bytes.

PEP 0461 states that %b should be correct for any class with a __bytes__ method.

%b will insert a series of bytes. These bytes are collected in one of two ways:

  • input type supports Py_buffer [4]? use it to collect the necessary bytes
  • input type is something else? use its bytes method [5] ; if there isn’t one, raise a TypeError

To Reproduce

MyPy reports no errors with this code by default.

a = b"foo"
b = bytearray(a)
c = memoryview(a)

x = b"%b" % a
y = b"%b" % b
z = b"%b" % c

With --disable-bytearray-promotion it reports

/tmp/test.py:6: error: Incompatible types in string interpolation (expression has type "bytearray", placeholder has type "bytes") [str-format]

Similarly

class X:
    def __bytes__(self) -> bytes:
        return b"X"


m = b"%b" % X()

Will produce the error

/tmp/test.py:6: error: Incompatible types in string interpolation (expression has type "X", placeholder has type "bytes") [str-format]

Both of these samples run without error and with the expected behaviour.

Expected Behavior

No str-format error reported for interpolating %b placeholder in bytes string for objects with a __bytes__ method.

Your Environment

  • Mypy version used: 1.17.1
  • Mypy command-line flags: Defaults or --disable-bytearrary-promotion or --disable-memoryview-promotion
  • Mypy configuration options from mypy.ini (and other config files):
  • Python version used: 3.13.2

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

Non sono indicati file sorgente né test. Inizia eseguendo il riproduttore Python fornito con le impostazioni predefinite e con ciascun flag di promozione disabilitato, quindi individua il percorso di controllo della formattazione str per l'interpolazione di bytes %b. Il lavoro è completato quando gli oggetti con __bytes__, inclusa la classe personalizzata mostrata, non producono più un errore str-format, mentre i valori incompatibili continuano a produrlo.

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

Valutazione

Stack tecnologico
python
Ambito
devtools
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.