Hacktoberfest 2026：維護者為十月標記出來的 issue，仍然開放、適合新手。 瀏覽 Hacktoberfest issue

set_key and unset_key don't fsync before replacing the .env file

未關閉
  • 哪裡不對？
#713 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 2 天內回覆

@Imkkey 已經在處理了。

開始於 2026年10月2日。

  • #717 來自 @Imkkey —— 未關閉
  • #739 來自 @yunaremaia —— 未關閉

評估

難度
3/5
預估耗時
1-2 天
新手友好度
72/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
python
領域
cli, tooling

研究方向

Start in src/dotenv/main.py at rewrite(), then trace its callers from set_key, unset_key, and the dotenv set/unset commands. Find the existing tests covering rewrite or key updates and add coverage that records fsync and os.replace ordering. Done means the temporary file is durable before replacement, with any directory-durability behavior covered consistently across supported platforms.

由索引模型根據 Issue 內容生成。

描述

enhancement

set_key and unset_key rewrite the .env file through rewrite() (src/dotenv/main.py): they write a temporary file next to the target, then os.replace it over the target. That makes the swap atomic for other processes, but nothing forces the new contents to disk before the rename. The temporary file is closed (which flushes Python's buffer to the OS) and then renamed, with no fsync.

What can go wrong

If the machine loses power or the kernel crashes shortly after set_key returns, the rename can reach the disk before the file's data does. After a reboot, .env can then be empty (zero length) or contain garbage, instead of holding either the old or the new contents. This applies to set_key, unset_key, and the dotenv set / dotenv unset commands.

How likely this is depends on the filesystem. ext4 with its default auto_da_alloc option flushes data before a rename that replaces an existing file, which covers this exact pattern. Other filesystems (XFS, and ext4 mounted with noauto_da_alloc) make no such promise, and a .env that has never existed before isn't covered by that heuristic at all. I haven't reproduced data loss; this is based on the documented semantics of rename(2) and fsync(2), and is the reason other write-then-rename implementations call fsync.

Since .env files often hold credentials, losing one silently is a bad outcome.

Proposed change

In rewrite(), before os.replace:

dest.flush()
os.fsync(dest.fileno())

This has to happen while the temporary file is still open, i.e. inside the with temp_file as dest: block, after the caller's writes have finished.

Optionally, after os.replace on POSIX, fsync the containing directory so the rename itself is durable:

if os.name == "posix":
    dir_fd = os.open(os.path.dirname(os.path.abspath(path)), os.O_RDONLY)
    try:
        os.fsync(dir_fd)
    finally:
        os.close(dir_fd)

Directory fsync isn't available on Windows, and some filesystems reject it with EINVAL. Since the file contents are already safe at that point, an OSError from it could reasonably be ignored.

Cost

.env files are small and set_key is not called in hot loops, so one or two fsync calls per write should not be noticeable. A test can check that os.fsync is called on the temporary file before os.replace, for example by patching both in dotenv.main and recording the call order.

Out of scope

Concurrent writers (two set_key calls at once can lose one update) and file-replacement side effects such as single-file Docker bind mounts are separate problems and not addressed here.

主要語言
Python
星號
8.9k
分支
617
平均合併
11 小時 19 分鐘
30 天內合併 PR
3

環境準備

  • 沒有 Dockerfile 或 Docker Compose 檔案
  • 沒有 Pull Request 範本
  • 閱讀貢獻指南

從這裡開始

  1. 先讀完整個 Issue，再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫，在一個分支上完成修改。
  4. 送出 Pull Request，並在描述裡引用這個 Issue 編號。

theskumar/python-dotenv 的其他 Issue

查看 theskumar/python-dotenv 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。