Pythonでファイル/ディレクトリの存在確認・削除・一覧取得について解説

# exists, isfile, isdir の違いを確認するデモ
# 一時ディレクトリ内でファイルとサブディレクトリを作成して判定します

import os
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    file_path = os.path.join(tmp, "data.txt")
    dir_path = os.path.join(tmp, "subdir")

    # テスト用ファイルとディレクトリを作成
    with open(file_path, "w", encoding="utf-8") as f:
        f.write("hello")
    os.mkdir(dir_path)

    print("tmp =", tmp)
    print("exists(file):", os.path.exists(file_path))  # True
    print("isfile(file):", os.path.isfile(file_path))  # True
    print("isdir(file):", os.path.isdir(file_path))    # False
    print("exists(dir):", os.path.exists(dir_path))    # True
    print("isfile(dir):", os.path.isfile(dir_path))    # False
    print("isdir(dir):", os.path.isdir(dir_path))      # True

    # 存在しないパス
    missing = os.path.join(tmp, "missing.txt")
    print("exists(missing):", os.path.exists(missing)) # False

# pathlib 版の存在確認デモ
from pathlib import Path
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    base = Path(tmp)
    p_file = base / "note.txt"
    p_dir = base / "docs"

    p_file.write_text("memo", encoding="utf-8")
    p_dir.mkdir()

    print("base =", base)
    print("exists(file):", p_file.exists())  # True
    print("is_file(file):", p_file.is_file())  # True
    print("is_dir(file):", p_file.is_dir())    # False
    print("exists(dir):", p_dir.exists())    # True
    print("is_file(dir):", p_dir.is_file())  # False
    print("is_dir(dir):", p_dir.is_dir())    # True

    p_missing = base / "none.txt"
    print("exists(missing):", p_missing.exists())  # False

# よくあるNGパターン: 先にexistsで確認してから開く
# 直後に別プロセスが削除した場合、openで FileNotFoundError になる可能性があります
from pathlib import Path

p = Path("maybe_deleted.txt")
if p.exists():  # ここでTrueでも、この直後に削除され得る
    try:
        with p.open("r", encoding="utf-8") as f:
            data = f.read()
    except FileNotFoundError:
        print("消えていました")  # 競合に弱い

# 推奨パターン: 例外処理で包む(競合に強い)
from pathlib import Path

p = Path("maybe_deleted.txt")
try:
    with p.open("r", encoding="utf-8") as f:
        data = f.read()
except FileNotFoundError:
    print("そもそも存在しない/直前に削除されたため開けませんでした")

# os.listdir の基本。直下のエントリ名のみを取得します。
import os
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    open(os.path.join(tmp, "a.txt"), "w").close()
    os.mkdir(os.path.join(tmp, "images"))
    open(os.path.join(tmp, "b.log"), "w").close()

    print("listdir:", os.listdir(tmp))  # 並び順は環境依存

# os.scandir で名前・種別・サイズを表示する例
import os
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    # サンプルデータ
    with open(os.path.join(tmp, "readme.txt"), "w", encoding="utf-8") as f:
        f.write("Hello\n")
    os.mkdir(os.path.join(tmp, "data"))
    with open(os.path.join(tmp, "data.bin"), "wb") as f:
        f.write(b"\x00" * 10)

    with os.scandir(tmp) as it:
        for entry in it:
            kind = "dir" if entry.is_dir() else ("file" if entry.is_file() else "other")
            size = entry.stat().st_size if entry.is_file() else "-"
            print(f"{entry.name:12}  {kind:4}  size={size}")

# pathlib の iterdir で直下の Path を列挙
from pathlib import Path
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    p = Path(tmp)
    (p / "doc.md").write_text("# title\n", encoding="utf-8")
    (p / "out").mkdir()
    (p / "notes.txt").write_text("n", encoding="utf-8")

    for child in p.iterdir():
        print(child.name, "->", "dir" if child.is_dir() else "file")

# glob モジュールの基本と再帰検索
import glob
import os
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    open(os.path.join(tmp, "a.txt"), "w").close()
    open(os.path.join(tmp, "b.log"), "w").close()
    os.mkdir(os.path.join(tmp, "sub"))
    open(os.path.join(tmp, "sub", "c.txt"), "w").close()

    print("*.txt:", sorted(glob.glob(os.path.join(tmp, "*.txt"))))
    print("**/*.txt (recursive):", sorted(glob.glob(os.path.join(tmp, "**", "*.txt"), recursive=True)))

# pathlib の glob / rglob
from pathlib import Path
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    base = Path(tmp)
    (base / "x1.py").write_text("print(1)\n", encoding="utf-8")
    (base / "pkg").mkdir()
    (base / "pkg" / "x2.py").write_text("print(2)\n", encoding="utf-8")

    print("glob('*.py'):", [p.name for p in base.glob("*.py")])
    print("rglob('*.py'):", sorted(p.name for p in base.rglob("*.py")))

# ファイル削除の基本(存在するファイルを削除)
import os
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    target = os.path.join(tmp, "temp.txt")
    open(target, "w").close()
    print("before exists:", os.path.exists(target))  # True
    os.remove(target)  # または pathlib.Path(target).unlink()
    print("after exists :", os.path.exists(target))  # False

# 推奨: 例外を捕まえて安全に削除する関数
from pathlib import Path

def remove_file_safe(path: Path) -> bool:
    """
    指定ファイルを削除する。成功: True, 既にない: False を返す。
    PermissionError などは上位に伝播(ログに残すなど)。
    """
    try:
        path.unlink()
        return True
    except FileNotFoundError:
        return False  # 既にない
    # except IsADirectoryError:  # ディレクトリに対して呼ぶと出る
    #     ... (用途に応じて処理)

# デモ
if __name__ == "__main__":
    import tempfile
    with tempfile.TemporaryDirectory() as tmp:
        p = Path(tmp) / "to_delete.txt"
        p.write_text("x", encoding="utf-8")
        print("deleted:", remove_file_safe(p))       # True
        print("deleted again:", remove_file_safe(p)) # False

# 空ディレクトリの削除
import os
from pathlib import Path
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    empty_dir = Path(tmp) / "empty"
    empty_dir.mkdir()
    print("exists before:", empty_dir.exists())  # True
    empty_dir.rmdir()  # os.rmdir(str(empty_dir)) でも可
    print("exists after :", empty_dir.exists())  # False

# ディレクトリを中身ごと削除
from pathlib import Path
import shutil
import tempfile

with tempfile.TemporaryDirectory() as tmp:
    base = Path(tmp) / "project"
    (base / "src").mkdir(parents=True)
    (base / "src" / "main.py").write_text("print('hi')\n", encoding="utf-8")
    (base / "data").mkdir()
    (base / "data" / "input.txt").write_text("data\n", encoding="utf-8")

    print("exists before:", base.exists())  # True
    shutil.rmtree(base)  # 中身ごと消える
    print("exists after :", base.exists())  # False

# ドライラン付きで安全に削除するユーティリティ
from pathlib import Path
import shutil

def is_relative_to(child: Path, parent: Path) -> bool:
    """Python 3.9未満互換: child が parent 配下なら True"""
    try:
        child.resolve().relative_to(parent.resolve())
        return True
    except Exception:
        return False

def remove_tree_safe(target: Path, allow_base: Path, dry_run: bool = True) -> None:
    """
    allow_base 配下の target だけを削除対象とし、dry_run=True のときは一覧を表示して削除しない。
    """
    if not is_relative_to(target, allow_base):
        raise ValueError(f"危険: {target} は許可ベース {allow_base} の配下ではありません")

    if not target.exists():
        print(f"[info] {target} は存在しません")
        return

    if dry_run:
        print("[DRY-RUN] 次を削除予定:")
        for p in sorted(target.rglob("*"), key=lambda x: (x.is_file(), str(x))):
            kind = "DIR" if p.is_dir() else "FILE"
            print(f"  {kind}: {p}")
        print("[DRY-RUN] 実削除は行っていません")
    else:
        shutil.rmtree(target)
        print(f"[done] 削除しました: {target}")

# デモ
if __name__ == "__main__":
    import tempfile
    with tempfile.TemporaryDirectory() as tmp:
        base = Path(tmp)
        t = base / "sandbox"
        (t / "logs").mkdir(parents=True)
        (t / "logs" / "app.log").write_text("log\n", encoding="utf-8")
        (t / "data").mkdir()
        (t / "data" / "1.txt").write_text("1\n", encoding="utf-8")

        # まずドライラン
        remove_tree_safe(t, allow_base=base, dry_run=True)
        # 次に本当に削除
        remove_tree_safe(t, allow_base=base, dry_run=False)