Cek apakah file ada di Python: os.path, pathlib, dan try/except

Jawaban singkat

Untuk mengecek apakah sebuah file ada, pakai os.path.isfile() dari standard library. Fungsi ini mengembalikan True kalau path itu menunjuk ke file biasa yang ada, dan False kalau tidak. Fungsi ini tidak pernah memunculkan error untuk path yang tidak ada.

import os

# Create one file so the example has something to find.
with open("notes.txt", "w") as f:
    f.write("hello\n")

print(os.path.isfile("notes.txt"))    # True
print(os.path.isfile("missing.txt"))  # False

Path dihitung relatif terhadap folder tempat program dijalankan (current working directory), kecuali kamu memberikan path absolut seperti /home/ada/notes.txt atau C:\Users\Ada\notes.txt.

Bagian selanjutnya di halaman ini membahas cara lain untuk menanyakan hal yang sama, apa bedanya, dan kapan sebaiknya kamu tidak menanyakannya sama sekali.

os.path.exists vs isfile vs isdir

Modul os.path punya tiga pengecekan yang mirip, dan masing-masing menjawab pertanyaan yang sedikit berbeda:

Perbedaannya langsung terlihat begitu ada folder yang terlibat:

import os

os.makedirs("reports", exist_ok=True)
with open("reports/summary.txt", "w") as f:
    f.write("all good\n")

for path in ["reports", "reports/summary.txt", "reports/old.txt"]:
    print(path, os.path.exists(path), os.path.isfile(path), os.path.isdir(path))

Output:

reports True False True
reports/summary.txt True True False
reports/old.txt False False False

os.path.exists("reports") bernilai True walaupun reports adalah folder. Kalau kodemu akan membaca path itu sebagai file, exists adalah pengecekan yang salah: sebuah folder akan lolos, lalu open("reports") akan gagal (dengan IsADirectoryError di Linux dan macOS, PermissionError di Windows). Pilih isfile kalau yang kamu maksud file, dan isdir kalau yang kamu maksud folder.

Dua detail lagi tentang ketiga fungsi os.path ini:

• Symlink diikuti. Link yang menunjuk ke file nyata dihitung sebagai file; link yang rusak (targetnya sudah hilang) menghasilkan False dari ketiganya.
• Kalau Python tidak diizinkan melihat isi sebuah folder, pengecekan mengembalikan False, bukan memunculkan PermissionError. Jadi False berarti "tidak ditemukan atau tidak bisa dijangkau", bukan semata "tidak ada".

Mengecek dengan pathlib

pathlib adalah API path berbasis objek di standard library, dan kebanyakan kode baru memakainya. Objek Path punya tiga pengecekan yang sama dalam bentuk method:

from pathlib import Path

folder = Path("reports")
folder.mkdir(exist_ok=True)

summary = folder / "summary.txt"
summary.write_text("all good\n")

print(summary.exists())    # True
print(summary.is_file())   # True
print(summary.is_dir())    # False
print(folder.is_dir())     # True
print((folder / "old.txt").exists())  # False

Path.exists(), Path.is_file() dan Path.is_dir() berperilaku seperti os.path.exists, isfile dan isdir. Operator / menggabungkan bagian-bagian path dengan pemisah yang sesuai untuk sistem operasinya, jadi folder / "summary.txt" bekerja sama baiknya di Windows, macOS, maupun Linux. Lihat penanganan file untuk membaca dan menulis lewat objek Path.

Mana yang sebaiknya kamu pakai? Kalau bagian lain kodemu sudah memakai objek Path, tetap pakai pathlib. Kalau kamu bekerja dengan string biasa dan fungsi os, os.path.isfile juga sama benarnya. Jawaban keduanya sama.

Kenapa mengecek dulu bisa jadi langkah yang salah

Alasan paling umum untuk mengecek apakah file ada adalah untuk membukanya setelah itu:

import os

if os.path.isfile("config.txt"):
    with open("config.txt") as f:      # the file might be gone by now
        settings = f.read()
else:
    settings = ""

Ada celah di sini. Di antara pemanggilan isfile() dan open(), program lain, thread lain, atau pengguna bisa menghapus atau mengganti nama file itu. Pengecekan bilang True, tapi membuka file tetap gagal, dan programmu tetap crash dengan FileNotFoundError. Celah ini disebut race condition, atau "time of check to time of use". Di laptopmu sendiri ini jarang terjadi, tapi jauh lebih sering di server sibuk tempat beberapa proses memakai folder yang sama.

Solusinya: lewati pengecekan terpisah dan biarkan open() yang menjadi pengecekannya. Python memunculkan FileNotFoundError kalau file tidak ada, dan kamu menanganinya di except:

def read_settings(path):
    try:
        with open(path) as f:
            return f.read().strip()
    except FileNotFoundError:
        return "(no settings file, using defaults)"

with open("config.txt", "w") as f:
    f.write("theme=dark\n")

print(read_settings("config.txt"))
print(read_settings("other.txt"))

Output:

theme=dark
(no settings file, using defaults)

Sekarang hanya ada satu operasi, bukan dua, jadi tidak ada yang bisa saling mendahului. Gaya ini punya nama di komunitas Python: EAFP, "easier to ask forgiveness than permission" (lebih mudah minta maaf daripada minta izin). Gaya sebaliknya, mengecek dulu, disebut LBYL, "look before you leap" (lihat dulu sebelum melompat). Untuk urusan file, Python cenderung memakai EAFP karena hanya sistem operasi yang tahu jawabannya tepat saat kamu membuka file.

FileNotFoundError bukan satu-satunya hal yang bisa salah. Path yang ternyata folder memunculkan IsADirectoryError (PermissionError di Windows), dan file yang tidak bisa kamu baca memunculkan PermissionError. Ketiganya adalah subclass dari OSError, jadi except OSError: menangkap semua kasus "tidak bisa dibuka" sekaligus. Halaman exception membahas cara memilih antara menangkap satu error tertentu dan menangkap satu keluarga error.

Kapan pengecekan biasa tidak masalah

Mengecek dulu tidak selalu salah. Ini alat yang tepat kalau kamu hanya butuh jawabannya dan tidak akan langsung memakai file itu di baris berikutnya:

• memilih pesan yang akan ditampilkan ("Ditemukan 3 game yang tersimpan")
• memvalidasi path yang diketik pengguna sebelum memulai pekerjaan panjang
• melewati pekerjaan yang sudah pernah dilakukan, kalau jawaban yang usang paling-paling hanya membuat pekerjaan diulang

Patokannya: kalau kamu akan membuka, membaca, menulis, atau menghapus file itu, lakukan di dalam try. Kalau kamu hanya ingin tahu, isfile() atau Path.is_file() sudah cukup.

Membuat file hanya jika belum ada

Pertanyaan kebalikannya juga sering muncul: "tulis file ini, tapi jangan pernah menimpa file yang sudah ada". Versi yang paling jelas punya race yang sama seperti tadi:

if not os.path.exists("report.txt"):
    with open("report.txt", "w") as f:   # another process may create it first
        f.write("new report\n")

Mode "x" (exclusive creation) melakukan kedua langkah itu sekaligus. Mode ini membuat file, atau memunculkan FileExistsError kalau namanya sudah dipakai:

import os

if os.path.exists("report.txt"):
    os.remove("report.txt")   # start from a clean folder for the demo

for attempt in [1, 2]:
    try:
        with open("report.txt", "x") as f:
            f.write("first version\n")
        print(f"attempt {attempt}: created report.txt")
    except FileExistsError:
        print(f"attempt {attempt}: report.txt already exists, left it alone")

Output:

attempt 1: created report.txt
attempt 2: report.txt already exists, left it alone

Untuk folder, os.makedirs(path, exist_ok=True) dan Path(path).mkdir(parents=True, exist_ok=True) membuat foldernya beserta folder induk yang belum ada, dan tidak melakukan apa-apa kalau folder itu sudah ada. Tidak perlu memanggil isdir() dulu.

Kesalahan umum

• Memakai exists() padahal yang dimaksud file. Folder dengan nama yang sama akan lolos pengecekan. Pakai isfile() atau Path.is_file().
• Lupa dari mana path relatif dimulai. "data.txt" dicari di current working directory, yaitu tempat kamu menjalankan program, belum tentu folder yang berisi skripnya. Untuk mencari file di sebelah skrip, bangun path-nya dari Path(__file__).parent.
• Mengecek, lalu membuka. File bisa berubah di antaranya. Buka di dalam try dan tangani FileNotFoundError.
• Menangkap semua exception. except Exception: di sekitar open() juga menyembunyikan salah ketik dan bug di kode yang membaca file. Tangkap FileNotFoundError atau OSError.