בדיקה אם קובץ קיים ב-Python: os.path, pathlib ו-try/except

התשובה הקצרה

כדי לבדוק אם קובץ קיים, השתמשו ב-os.path.isfile() מהספרייה הסטנדרטית. היא מחזירה True כשהנתיב מצביע על קובץ רגיל שקיים, ו-False בכל מקרה אחר. היא אף פעם לא זורקת שגיאה על נתיב חסר.

import os

# יוצרים קובץ אחד כדי שלדוגמה יהיה מה למצוא.
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

נתיבים הם יחסיים לתיקייה שבה התוכנית רצה (תיקיית העבודה הנוכחית), אלא אם מעבירים נתיב מוחלט כמו /home/ada/notes.txt או C:\Users\Ada\notes.txt.

שאר העמוד מכסה את הדרכים האחרות לשאול את השאלה, במה הן שונות, ואת המקרה שבו לא כדאי לשאול אותה בכלל.

os.path.exists מול isfile מול isdir

במודול os.path יש שלוש בדיקות קשורות, והן עונות על שאלות שונות במקצת:

ההבדל מתגלה ברגע שמעורבת תיקייה:

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

פלט:

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

os.path.exists("reports") מחזירה True למרות ש-reports היא תיקייה. אם הקוד שלכם עומד לקרוא את הנתיב כקובץ, exists היא הבדיקה הלא נכונה: תיקייה תעבור אותה, ואז open("reports") תיכשל (עם IsADirectoryError ב-Linux וב-macOS, ו-PermissionError ב-Windows). בחרו ב-isfile כשאתם מתכוונים לקובץ וב-isdir כשאתם מתכוונים לתיקייה.

עוד שני פרטים על שלוש הפונקציות האלה של os.path:

• הן עוקבות אחרי symlink. קישור שמצביע על קובץ אמיתי נחשב קובץ; קישור שבור (היעד שלו נעלם) מחזיר False בכל שלוש הבדיקות.
• אם ל-Python אין הרשאה להסתכל בתוך תיקייה, הבדיקה מחזירה False במקום לזרוק PermissionError. False פירושו "לא נמצא או לא נגיש", לא בהכרח "לא קיים".

בדיקה עם pathlib

pathlib הוא ה-API מונחה העצמים לנתיבים בספרייה הסטנדרטית, ורוב הקוד החדש משתמש בו. לאובייקט Path יש את אותן שלוש בדיקות בתור מתודות:

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() ו-Path.is_dir() מתנהגות כמו os.path.exists, isfile ו-isdir. האופרטור / מחבר חלקי נתיב עם המפריד הנכון למערכת ההפעלה, כך ש-folder / "summary.txt" עובד ב-Windows, ב-macOS וב-Linux באותה מידה. ראו טיפול בקבצים לקריאה וכתיבה דרך אובייקטי Path.

באיזו מהן להשתמש? אם שאר הקוד שלכם כבר מעביר אובייקטי Path, הישארו עם pathlib. אם אתם עובדים עם מחרוזות רגילות ופונקציות של os, os.path.isfile נכונה בדיוק באותה מידה. הן נותנות את אותן תשובות.

למה בדיקה מוקדמת יכולה להיות צעד שגוי

הסיבה הנפוצה ביותר לבדוק אם קובץ קיים היא כדי לפתוח אותו מיד אחר כך:

import os

if os.path.isfile("config.txt"):
    with open("config.txt") as f:      # ייתכן שהקובץ כבר נעלם
        settings = f.read()
else:
    settings = ""

יש כאן פער. בין הקריאה ל-isfile() לבין הקריאה ל-open(), תוכנית אחרת, thread אחר או המשתמש יכולים למחוק את הקובץ או לשנות את שמו. הבדיקה אמרה True, הפתיחה בכל זאת נכשלת, והתוכנית קורסת עם FileNotFoundError בכל מקרה. לפער הזה קוראים race condition, או "time of check to time of use". זה נדיר על המחשב הנייד שלכם והרבה פחות נדיר על שרת עמוס שבו כמה תהליכים חולקים תיקייה.

הפתרון הוא לוותר על הבדיקה הנפרדת ולתת ל-open() להיות הבדיקה. Python זורקת FileNotFoundError כשהקובץ חסר, ואתם מטפלים בזה ב-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"))

פלט:

theme=dark
(no settings file, using defaults)

עכשיו יש פעולה אחת במקום שתיים, כך שאין מול מה להתחרות. לסגנון הזה יש שם בקהילת Python: EAFP, "easier to ask forgiveness than permission" (קל יותר לבקש סליחה מאשר רשות). הסגנון ההפוך, לבדוק קודם, נקרא LBYL, "look before you leap" (הסתכל לפני שאתה קופץ). Python נוטה ל-EAFP בעבודה עם קבצים, כי מערכת ההפעלה היא היחידה שיודעת את התשובה ברגע שבו פותחים את הקובץ.

FileNotFoundError היא לא הדבר היחיד שיכול להשתבש. נתיב שהוא תיקייה זורק IsADirectoryError (PermissionError ב-Windows), וקובץ שאין הרשאה לקרוא אותו זורק PermissionError. שלושתן תת-מחלקות של OSError, כך ש-except OSError: תופס בבת אחת כל מקרה של "לא הצלחתי לפתוח". עמוד החריגות מסביר איך לבחור בין תפיסת שגיאה ספציפית אחת לתפיסת משפחה שלמה.

מתי בדיקה פשוטה זה בסדר

לבדוק קודם זה לא שגוי בכל מקרה. זה הכלי הנכון כשצריך רק את התשובה ולא עומדים לפעול על הקובץ בשורה הבאה:

• לבחור איזו הודעה להציג ("נמצאו 3 משחקים שמורים")
• לאמת נתיב שהמשתמש הקליד לפני שמתחילים משימה ארוכה
• לדלג על עבודה שכבר נעשתה, כשתשובה לא עדכנית עולה לכל היותר בחזרה על העבודה

כלל האצבע: אם אתם עומדים לפתוח, לקרוא, לכתוב או למחוק את הקובץ, עשו את זה בתוך try. אם אתם רק רוצים לדעת, isfile() או Path.is_file() זה בסדר.

יצירת קובץ רק אם הוא לא קיים

גם השאלה ההפוכה עולה: "כתבו את הקובץ הזה, אבל לעולם אל תדרסו קובץ קיים". הגרסה המתבקשת סובלת מאותו race כמו קודם:

if not os.path.exists("report.txt"):
    with open("report.txt", "w") as f:   # תהליך אחר עלול ליצור אותו קודם
        f.write("new report\n")

המצב "x" (יצירה בלעדית) עושה את שני הצעדים בבת אחת. הוא יוצר את הקובץ, או זורק FileExistsError אם השם כבר תפוס:

import os

if os.path.exists("report.txt"):
    os.remove("report.txt")   # מתחילים מתיקייה נקייה לצורך ההדגמה

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

פלט:

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

עבור תיקיות, os.makedirs(path, exist_ok=True) ו-Path(path).mkdir(parents=True, exist_ok=True) יוצרות את התיקייה ואת כל תיקיות האב החסרות, ולא עושות כלום אם היא כבר קיימת. אין צורך לקרוא קודם ל-isdir().

טעויות נפוצות

• שימוש ב-exists() כשהכוונה לקובץ. תיקייה באותו שם עוברת את הבדיקה. השתמשו ב-isfile() או ב-Path.is_file().
• שוכחים מאיפה מתחילים נתיבים יחסיים. את "data.txt" מחפשים בתיקיית העבודה הנוכחית, כלומר איפה שהפעלתם את התוכנית, ולא בהכרח בתיקייה שמכילה את הסקריפט. כדי למצוא קובץ שנמצא ליד הסקריפט, בנו את הנתיב מ-Path(__file__).parent.
• בודקים ואז פותחים. הקובץ יכול להשתנות בינתיים. פתחו בתוך try וטפלו ב-FileNotFoundError.
• תופסים כל חריגה. except Exception: סביב open() מסתיר גם שגיאות כתיב ובאגים בקוד שקורא את הקובץ. תפסו FileNotFoundError או OSError.