التحقق من وجود ملف في بايثون: os.path وpathlib وtry/except

الإجابة المختصرة

للتحقق من وجود ملف، استخدم os.path.isfile() من المكتبة القياسية. تُرجع True عندما يشير المسار إلى ملف عادي موجود، وFalse في غير ذلك. ولا تطلق أي خطأ إذا كان المسار غير موجود.

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

تُحسب المسارات نسبةً إلى المجلد الذي يعمل فيه البرنامج (مجلد العمل الحالي)، إلا إذا مرّرت مسارًا مطلقًا مثل /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 الثلاث:

• تتبع الدوال الرابط الرمزي. الرابط الذي يشير إلى ملف حقيقي يُحتسب ملفًا، أما الرابط المعطوب (الذي حُذف هدفه) فتُرجع معه الدوال الثلاث False.
• إذا لم يكن مسموحًا لبايثون بالاطلاع على محتوى مجلد، تُرجع الدالة False بدلًا من إطلاق PermissionError. أي أن False تعني "غير موجود أو لا يمكن الوصول إليه"، وليس "غير موجود" بالمعنى الدقيق.

التحقق باستخدام pathlib

pathlib هي واجهة المسارات الكائنية في المكتبة القياسية، ومعظم الكود الحديث يستخدمها. يملك الكائن 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:      # the file might be gone by now
        settings = f.read()
else:
    settings = ""

في هذا الكود ثغرة. بين استدعاء isfile() واستدعاء open() قد يحذف برنامج آخر، أو خيط (thread) آخر، أو المستخدم نفسه الملف أو يغيّر اسمه. التحقق قال True، ومع ذلك يفشل الفتح، وينهار البرنامج بخطأ FileNotFoundError في كل الأحوال. تُسمى هذه الثغرة حالة تسابق (race condition)، أو "من وقت التحقق إلى وقت الاستخدام" (time of check to time of use). هي نادرة على حاسوبك الشخصي، وأقل ندرة بكثير على خادم مزدحم تتشارك فيه عدة عمليات مجلدًا واحدًا.

الحل هو الاستغناء عن التحقق المنفصل وترك open() تقوم بدور التحقق. تطلق بايثون 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)

صارت لدينا عملية واحدة بدلًا من اثنتين، فلا يبقى شيء نتسابق معه. لهذا الأسلوب اسم في مجتمع بايثون: EAFP، أي "طلب الصفح أسهل من طلب الإذن" (easier to ask forgiveness than permission). والأسلوب المعاكس، أي التحقق أولًا، هو LBYL، أي "انظر قبل أن تقفز" (look before you leap). تميل بايثون إلى EAFP في العمل مع الملفات، لأن نظام التشغيل هو الوحيد الذي يعرف الإجابة لحظة فتح الملف.

FileNotFoundError ليس الشيء الوحيد الذي قد يسوء. المسار الذي هو مجلد يطلق IsADirectoryError (وPermissionError على Windows)، والملف الذي لا تملك صلاحية قراءته يطلق PermissionError. والثلاثة كلها أصناف فرعية من OSError، لذا يلتقط except OSError: كل حالات "تعذّر فتحه" دفعة واحدة. تشرح صفحة الاستثناءات كيف تختار بين التقاط خطأ واحد بعينه والتقاط عائلة كاملة من الأخطاء.

متى يكون التحقق البسيط مقبولًا

التحقق المسبق ليس خطأً في كل الحالات. إنه الأداة الصحيحة حين تحتاج الإجابة وحدها ولن تتصرف في الملف في السطر التالي:

• اختيار الرسالة التي تعرضها ("عُثر على 3 ألعاب محفوظة")
• التحقق من مسار كتبه المستخدم قبل بدء مهمة طويلة
• تخطي عمل أُنجز من قبل، حيث لا تكلّفك الإجابة القديمة سوى تكرار العمل

القاعدة العامة: إذا كنت ستفتح الملف أو تقرؤه أو تكتب فيه أو تحذفه، فافعل ذلك داخل try. وإذا كنت تريد المعرفة فقط، فإن isfile() أو Path.is_file() كافية.

إنشاء ملف فقط إذا لم يكن موجودًا

يظهر السؤال المعاكس أيضًا: "اكتب هذا الملف، لكن لا تستبدل ملفًا موجودًا أبدًا". والنسخة البديهية فيها التسابق نفسه كما في السابق:

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

الوضع "x" (الإنشاء الحصري) ينفّذ الخطوتين في خطوة واحدة. فهو يُنشئ الملف، أو يطلق FileExistsError إذا كان الاسم مستخدمًا:

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

المخرجات:

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.