Windows single-file mailbox rewrite can remove the mailbox when the fallback rename fails
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 36k
- Metriche di merge delle PR
- Metriche PR in attesa
Descrizione
Bug report
Bug description
Summary
On Windows, _singlefileMailbox.flush() cannot rename a temporary rewrite over an existing mailbox with os.rename(). Its FileExistsError fallback deletes the original mailbox and then performs a second rename. If that second filesystem operation fails, the mailbox pathname has already been removed.
The affected mailbox classes are mailbox.mbox, mailbox.MMDF, and mailbox.Babyl. The temporary replacement normally remains, so the contents are not necessarily irretrievable, but the original mailbox pathname is missing. This is a Windows-specific failure path because it depends on Windows os.rename() refusing to replace an existing destination.
Reproduction Code
import errno
import glob
import mailbox
import os
import tempfile
from unittest.mock import patch
with tempfile.TemporaryDirectory() as directory:
path = os.path.join(directory, "mailbox")
box = mailbox.mbox(path)
first = box.add(b"Subject: first\n\nfirst\n")
box.add(b"Subject: second\n\nsecond\n")
box.flush()
box.remove(first)
# Simulate Windows rejecting the first replacement attempt, followed by
# an I/O failure while the fallback performs its second rename.
with patch(
"mailbox.os.rename",
side_effect=[
FileExistsError(errno.EEXIST, "target exists"),
OSError(errno.EIO, "injected second rename failure"),
],
):
try:
box.flush()
except OSError as error:
print("flush:", type(error).__name__, error.errno)
print("mailbox exists:", os.path.exists(path))
print(
"temporary files:",
[os.path.basename(name) for name in glob.glob(path + ".*")],
)
Observed on a Windows CPython build:
flush: OSError 5
mailbox exists: False
temporary files: ['mailbox.1788174401.yuu.26684']
Actual Behavior
After the first os.rename() raises FileExistsError, flush() removes the existing mailbox pathname. If the second os.rename() then fails, the exception propagates after the original mailbox has already been removed.
The rewritten temporary file normally remains, but the mailbox is no longer available at its original pathname.
Expected Behavior
If replacement of the rewritten mailbox fails, the original mailbox pathname should remain intact. Replacing an existing mailbox should not require explicitly removing the destination before installing the rewritten file.
CPython versions tested on
CPython main branch
Operating systems tested on
Windows
Linked PRs
- gh-156700
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia nel modulo mailbox, in _singlefileMailbox.flush(), e rivedi il percorso di sostituzione per mailbox.mbox, mailbox.MMDF e mailbox.Babyl. Riproduci i due errori simulati di os.rename riportati nell’issue, quindi aggiungi o aggiorna un test di regressione in modo che il nome del percorso originale della mailbox rimanga quando la sostituzione fallisce; esamina la PR collegata gh-156700 prima di iniziare.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- backend
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 35/100