Jak sprawdzić, czy plik istnieje w Pythonie: os.path, pathlib i try/except

Krótka odpowiedź

Aby sprawdzić, czy plik istnieje, użyj os.path.isfile() z biblioteki standardowej. Zwraca True, gdy ścieżka wskazuje istniejący zwykły plik, a w przeciwnym razie False. Nigdy nie zgłasza błędu dla brakującej ścieżki.

import os

# Tworzy jeden plik, żeby przykład miał co znaleźć.
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

Ścieżki są względne wobec folderu, w którym uruchamia się program (bieżącego katalogu roboczego), chyba że podasz ścieżkę bezwzględną, na przykład /home/ada/notes.txt albo C:\Users\Ada\notes.txt.

Dalsza część strony opisuje inne sposoby zadania tego pytania, czym się różnią i sytuację, w której w ogóle nie warto go zadawać.

os.path.exists vs isfile vs isdir

Moduł os.path ma trzy pokrewne sprawdzenia, które odpowiadają na nieco inne pytania:

Różnica wychodzi, gdy tylko w grę wchodzi katalog:

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))

Wynik:

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

os.path.exists("reports") daje True, mimo że reports to folder. Jeśli twój kod ma zaraz odczytać ścieżkę jako plik, exists to złe sprawdzenie: katalog by je przeszedł, a potem open("reports") zakończyłoby się błędem (IsADirectoryError na Linuksie i macOS, PermissionError na Windowsie). Wybierz isfile, gdy chodzi ci o plik, i isdir, gdy chodzi o folder.

Jeszcze dwa szczegóły dotyczące tych trzech funkcji os.path:

• Dowiązania symboliczne są rozwijane. Dowiązanie wskazujące prawdziwy plik liczy się jako plik, a zerwane dowiązanie (jego cel zniknął) daje False we wszystkich trzech.
• Jeśli Python nie ma prawa zajrzeć do folderu, sprawdzenie zwraca False zamiast zgłaszać PermissionError. False znaczy "nie znaleziono albo brak dostępu", a nie ściśle "nie istnieje".

Sprawdzanie przez pathlib

pathlib to obiektowe API do ścieżek w bibliotece standardowej i większość nowego kodu z niego korzysta. Obiekt Path ma te same trzy sprawdzenia jako metody:

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() i Path.is_dir() działają jak os.path.exists, isfile i isdir. Operator / łączy części ścieżki właściwym separatorem dla systemu operacyjnego, więc folder / "summary.txt" działa tak samo na Windowsie, macOS i Linuksie. Zajrzyj do strony o obsłudze plików, by czytać i zapisywać przez obiekty Path.

Którego użyć? Jeśli reszta twojego kodu już przekazuje obiekty Path, zostań przy pathlib. Jeśli pracujesz na zwykłych napisach i funkcjach z os, os.path.isfile jest równie poprawne. Dają te same odpowiedzi.

Dlaczego sprawdzanie z góry może być błędem

Najczęstszy powód, by sprawdzić, czy plik istnieje, to otwarcie go zaraz potem:

import os

if os.path.isfile("config.txt"):
    with open("config.txt") as f:      # plik mógł już zniknąć
        settings = f.read()
else:
    settings = ""

Tu jest luka. Między wywołaniem isfile() a wywołaniem open() inny program, inny wątek albo sam użytkownik może usunąć plik lub zmienić jego nazwę. Sprawdzenie dało True, otwarcie i tak się nie udaje, a program pada z FileNotFoundError. Taka luka to wyścig (race condition), zwany też "time of check to time of use" (od chwili sprawdzenia do chwili użycia). Na własnym laptopie zdarza się rzadko, a dużo częściej na obciążonym serwerze, gdzie kilka procesów dzieli jeden folder.

Rozwiązanie: pomiń osobne sprawdzenie i niech open() będzie sprawdzeniem. Python zgłasza FileNotFoundError, gdy pliku brakuje, a ty obsługujesz to w 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"))

Wynik:

theme=dark
(no settings file, using defaults)

Teraz jest jedna operacja zamiast dwóch, więc nie ma się z czym ścigać. Ten styl ma w społeczności Pythona swoją nazwę: EAFP, "easier to ask forgiveness than permission" (łatwiej prosić o wybaczenie niż o pozwolenie). Styl przeciwny, czyli sprawdzanie z góry, to LBYL, "look before you leap" (rozejrzyj się, zanim skoczysz). Przy pracy z plikami Python skłania się ku EAFP, bo tylko system operacyjny zna odpowiedź w chwili otwierania pliku.

FileNotFoundError to nie jedyne, co może pójść źle. Ścieżka będąca katalogiem zgłasza IsADirectoryError (PermissionError na Windowsie), a plik, którego nie możesz odczytać, zgłasza PermissionError. Wszystkie trzy są podklasami OSError, więc except OSError: łapie naraz każdy przypadek "nie udało się otworzyć". Strona o wyjątkach wyjaśnia, jak wybrać między łapaniem jednego konkretnego błędu a łapaniem całej rodziny.

Kiedy zwykłe sprawdzenie wystarcza

Sprawdzanie z góry nie zawsze jest złe. To dobre narzędzie, gdy potrzebujesz tylko odpowiedzi i nie zamierzasz w następnej linii nic robić z plikiem:

• wybór komunikatu do pokazania ("Found 3 saved games")
• sprawdzenie ścieżki wpisanej przez użytkownika przed rozpoczęciem długiego zadania
• pominięcie pracy, która już została wykonana, gdy nieaktualna odpowiedź kosztuje tylko powtórkę

Zasada: jeśli masz otworzyć, odczytać, zapisać albo usunąć plik, zrób to w try. Jeśli chcesz tylko wiedzieć, isfile() albo Path.is_file() w zupełności wystarczy.

Tworzenie pliku tylko wtedy, gdy nie istnieje

Pojawia się też odwrotne pytanie: "zapisz ten plik, ale nigdy nie nadpisuj istniejącego". Oczywista wersja ma ten sam wyścig co wcześniej:

if not os.path.exists("report.txt"):
    with open("report.txt", "w") as f:   # inny proces może go utworzyć pierwszy
        f.write("new report\n")

Tryb "x" (wyłączne tworzenie) robi oba kroki naraz. Tworzy plik albo zgłasza FileExistsError, jeśli nazwa jest zajęta:

import os

if os.path.exists("report.txt"):
    os.remove("report.txt")   # zaczyna od czystego folderu na potrzeby 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")

Wynik:

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

Dla folderów os.makedirs(path, exist_ok=True) i Path(path).mkdir(parents=True, exist_ok=True) tworzą katalog i wszystkie brakujące katalogi nadrzędne, a nic nie robią, jeśli już istnieje. Nie trzeba wcześniej wywoływać isdir().

Częste błędy

• Używanie exists(), gdy chodzi o plik. Katalog o tej samej nazwie przejdzie sprawdzenie. Użyj isfile() albo Path.is_file().
• Zapominanie, skąd zaczynają się ścieżki względne. "data.txt" jest szukany w bieżącym katalogu roboczym, czyli tam, skąd uruchomiono program, a niekoniecznie w folderze ze skryptem. Aby znaleźć plik obok skryptu, zbuduj ścieżkę od Path(__file__).parent.
• Sprawdzanie, a potem otwieranie. Plik może się w międzyczasie zmienić. Otwieraj w try i obsługuj FileNotFoundError.
• Łapanie każdego wyjątku. except Exception: wokół open() ukrywa też literówki i błędy w kodzie, który czyta plik. Łap FileNotFoundError albo OSError.