07th-mod / 07th-mod/python-patcher
Windows: file operations don't always succeed as expected
- 主要言語
- JavaScript
- スター
- 214
- フォーク
- 12
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
### Problems
- shutil.rmtree or os.remove does not always ensure that files are fully removed after function returns
- remove may take multiple attempts to succeed
- mkdir(path, exist_ok=True) might have a race condition if it is called just after the folder is "removed"
### Related Issues
- https://github.com/07th-mod/python-patcher/issues/33#issuecomment-489390131 "07th Mod - Install failed due to error: [WinError 145] The directory is not empty"
### Description
I noticed that sometimes in `travis_build_script.py`, try_remove_tree() didn't always remove the file immediately (the file would exist for some time after the function was called. The function used to be defined like this:
```python
def try_remove_tree(path):
try:
if os.path.isdir(path):
shutil.rmtree(path)
else:
os.remove(path)
except FileNotFoundError:
pass
```
but I changed it to this
```python
def try_remove_tree(path):
try:
if os.path.isdir(path):
shutil.rmtree(path)
else:
os.remove(path)
except FileNotFoundError:
pass
# Make sure the folder is really removed
poll_cnt = 0
while os.path.exists(path):
print(f"Waiting for {path} to be removed ({poll_cnt})")
if poll_cnt < 5:
time.sleep(1)
else:
raise Exception(f"Folder {path} could not be removed!")
poll_cnt += 1
```
The `# Make sure the folder is really removed` did trigger on my machine (at least once), and after 1 second the file was "properly" removed.
If this behavior can happen on windows, we should also update the installer scripts, which use the same functions, to add this kind of functionality.
The installer scripts currently don't do multiple attempts when doing operations like extraction, deletion etc, so it may be worth checking for those sort of issues as well.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
調査の方向性
ファイル操作を実行する try_remove_tree 関数とインストーラースクリプトについては、travis_build_script.py を参照してください。shutil.rmtree と os.remove に関する Windows 固有の競合状態を理解してください。ポーリングメカニズムをテストし、コードベース内の他のファイル操作に適用することを検討してください。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- cli, tooling
- issue の種類
- バグ
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 45/100