HOWTO · Python

Wie man prüft, ob eine Datei in Python existiert

Dieser How-To-Artikel stellt vor, wie man prüft, ob eine Datei in Python existiert

Auf dieser Seite

Eine Prüfung auf reguläre Dateien ist sinnvoll, wenn der nächste Schritt davon abhängt, dass ein Pfad eine Datei und kein Verzeichnis bezeichnet. Bei einem pathlib-Pfad verwenden Sie Path.is_file(). Die Methode gibt einen booleschen Wert zurück und folgt symbolischen Links zu regulären Dateien. Eine Prüfung ist nur eine Momentaufnahme: Der Pfad kann sich vor einem späteren Zugriff ändern. Öffnen Sie die Datei daher direkt, sobald Sie sie verwenden möchten.

Schnelle Antwort: Prüfen, ob der Pfad eine Datei bezeichnet

Führen Sie dieses Beispiel aus, um eine vom Programm erstellte reguläre Datei zu prüfen. Der Code und die angezeigten booleschen Werte bleiben unverändert und erscheinen als True beziehungsweise False:

Der Code und die angezeigten Bezeichnungen oder Ausgaben in diesem Abschnitt bleiben auf Englisch.

from pathlib import Path
from tempfile import TemporaryDirectory

with TemporaryDirectory() as folder:
    path = Path(folder) / "notes.txt"
    path.write_text("Hello, Python!", encoding="utf-8")
    print(path.is_file())

Das temporäre Verzeichnis macht das Beispiel in sich abgeschlossen. Path.is_file() ist die naheliegende Wahl, wenn Sie gezielt prüfen möchten, ob ein Pfad eine reguläre Datei bezeichnet. Bei einer regulären Datei lautet das Ergebnis True. False wird zurückgegeben, wenn der Pfad nicht vorhanden ist, ein Verzeichnis bezeichnet oder nicht als reguläre Datei bestätigt werden kann.

pathlib.Path.is_file() verwenden

pathlib stellt Dateisystempfade als Path-Objekte dar. Diese Methode passt daher zu Code, der bereits pathlib verwendet. Erstellen Sie einen Pfad aus einer Zeichenfolge oder verbinden Sie einen Verzeichnispfad mit einem Dateinamen, indem Sie / verwenden. Rufen Sie anschließend is_file() auf. Der Code und der darin ausgegebene Text bleiben auf Englisch:

from pathlib import Path

path = Path("reports") / "summary.txt"
if path.is_file():
    print("A regular file is available.")

Dieses Beispiel zeigt die Prüfung, ohne vorauszusetzen, dass reports/summary.txt auf dem System der Lesenden vorhanden ist. Die Datei wird dabei weder geöffnet noch gelesen. Berechtigungsprobleme oder Fehler des Betriebssystems können beeinflussen, was sich durch eine Prüfung feststellen lässt. Leiten Sie daher aus einem Ergebnis von False nicht ab, warum der Zugriff fehlgeschlagen ist.

os.path.isfile() verwenden

In Code, der os.path nutzt, rufen Sie dessen Funktion isfile() mit einem Pfad auf. Sie dient ebenso wie Path.is_file() dazu, reguläre Dateien zu prüfen. Der Code und der darin ausgegebene Text bleiben auf Englisch:

import os

path = os.path.join("reports", "summary.txt")
if os.path.isfile(path):
    print("A regular file is available.")

os.path.isfile() ist eine Funktion, während Path.is_file() eine Methode eines Path-Objekts ist. Wählen Sie die Form, die zum umgebenden Code passt. Beide unterscheiden reguläre Dateien von Verzeichnissen.

exists() wählen, wenn Verzeichnisse ebenfalls zählen

Verwenden Sie Path.exists() oder os.path.exists(), wenn Sie lediglich wissen müssen, ob ein Pfad vorhanden ist – unabhängig davon, ob er eine Datei oder ein Verzeichnis bezeichnet. Beide können für Verzeichnisse True zurückgeben und prüfen daher allgemeiner als eine Prüfung auf reguläre Dateien. Verwenden Sie beispielsweise Path("reports").exists(), wenn dort entweder eine Datei oder ein Verzeichnis zulässig ist, und Path("reports").is_file(), wenn nur eine reguläre Datei infrage kommt.

Diese Prüfungen garantieren nicht, dass ein späteres Lesen oder Schreiben gelingt. Der Pfad kann sich nach der Prüfung ändern, und seine Existenz bedeutet nicht, dass Ihr Prozess darauf zugreifen darf. Wenn es auf den Vorgang selbst ankommt, führen Sie ihn aus und behandeln Sie die dafür relevanten Fehler.

Die Datei direkt öffnen, wenn Sie sie verwenden möchten

Wenn Sie als Nächstes lesen möchten, vermeiden Sie mit dem direkten Öffnen die Abhängigkeit von einer Prüfung, deren Ergebnis inzwischen veraltet sein könnte. Fangen Sie FileNotFoundError nur dann ab, wenn Sie einen fehlenden Pfad behandeln möchten. Berechtigungsfehler und andere E/A-Fehler sollten sichtbar bleiben oder entsprechend den Anforderungen der Anwendung separat behandelt werden. Der Code und der darin ausgegebene Text bleiben auf Englisch:

from pathlib import Path

path = Path("settings.json")
try:
    with path.open(encoding="utf-8") as file:
        contents = file.read()
except FileNotFoundError:
    contents = None

if contents is None:
    print("The settings file is missing.")
else:
    print("The settings file was read.")

Dieses Muster versucht, die gewünschte Datei zu lesen, und behandelt einen fehlenden Pfad gezielt. Es wertet weder PermissionError noch einen anderen OSError als Beweis dafür, dass der Pfad fehlt. Verwenden Sie die vorherige Prüfung, wenn Sie den Pfadtyp melden oder abhängig davon verzweigen müssen. Öffnen Sie die Datei direkt, wenn Sie sie jetzt lesen möchten.