کلاس dircmp¶

class filecmp.dircmp(a, b, ignore=None, hide=None, *, shallow=True)¶

یک شیء جدید مقایسه‌ی پوشه می‌سازد، تا پوشه‌های a و b را مقایسه کند. ignore فهرستی از نام‌ها برای نادیده‌گرفتن است و مقدار پیش‌فرض آن filecmp.DEFAULT_IGNORES است. hide فهرستی از نام‌ها برای پنهان‌کردن است و مقدار پیش‌فرض آن [os.curdir, os.pardir] است.

کلاس dircmp به‌طور پیش‌فرض با استفاده از پارامتر shallow، پرونده‌ها را با انجام مقایسه‌های سطحی (shallow) مقایسه می‌کند، همان‌گونه که برای filecmp.cmp() شرح داده شده است.

تغییر یافته در نسخه‌ی 3.13: پارامتر shallow اضافه شد.

کلاس dircmp متدهای زیر را ارائه می‌کند:

report()¶

مقایسه‌ای بین a و b را (در sys.stdout) چاپ کنید.

report_partial_closure()¶

مقایسه‌ای میان a و b و زیرپوشه‌های مستقیم مشترک را چاپ می‌کند.

report_full_closure()¶

مقایسه‌ای بین a و b و زیرپوشه‌های مشترک (به‌صورت بازگشتی) را چاپ می‌کند.

کلاس dircmp تعدادی ویژگی جالب ارائه می‌دهد که می‌توان از آن‌ها برای دریافت اطلاعات گوناگون درباره درخت‌های پوشه مقایسه‌شده استفاده کرد.

توجه داشته باشید که از طریق قلاب‌های __getattr__()، همه ویژگی‌ها به‌صورت تنبل محاسبه می‌شوند، بنابراین اگر فقط از ویژگی‌هایی استفاده شود که محاسبه‌شان کم‌هزینه است، هیچ هزینه‌ای از نظر سرعت وجود ندارد.

left¶

پوشه‌ی a.

right¶

پوشه‌ی b.

left_list¶

پرونده‌ها و زیرپوشه‌های درون a، که با hide و ignore فیلتر شده‌اند.

right_list¶

پرونده‌ها و زیرپوشه‌های موجود در b، پالایش‌شده بر اساس hide و ignore.

common¶

پرونده‌ها و زیرپوشه‌ها در هر دو a و b.

left_only¶

پرونده‌ها و زیرپوشه‌ها فقط در a.

right_only¶

پرونده‌ها و زیرپوشه‌هایی که فقط در b وجود دارند.

common_dirs¶

زیرپوشه‌های موجود در هر دو a و b.

common_files¶

پرونده‌های موجود در هر دو a و b.

common_funny¶

نام‌هایی که در هر دو a و b وجود دارند، به‌طوری که نوع آن‌ها بین پوشه‌ها متفاوت است، یا نام‌هایی که os.stat() برای آن‌ها خطا گزارش می‌دهد.

same_files¶

پرونده‌هایی که در هر دو a و b یکسان هستند، با استفاده از عملگر مقایسه‌ی فایلِ کلاس.

diff_files¶

پرونده‌هایی که در هر دو a و b وجود دارند و محتوای آن‌ها بر اساس عملگر مقایسه‌ی فایلِ کلاس متفاوت است.

funny_files¶

پرونده‌هایی که در هر دو a و b وجود دارند، اما قابل مقایسه نبودند.

subdirs¶

دیکشنری‌ای که نام‌های موجود در common_dirs را به نمونه‌های dircmp نگاشت می‌کند (یا به نمونه‌های MyDirCmp، در صورتی که این نمونه از نوع MyDirCmp، که یک کلاس فرعی از dircmp است، باشد).

تغییر یافته در نسخه‌ی 3.10: پیش‌تر، مدخل‌ها همیشه نمونه‌های dircmp بودند. اکنون مدخل‌ها همان نوع self هستند، اگر self زیرکلاسی از dircmp باشد.

filecmp.DEFAULT_IGNORES¶

اضافه شده در نسخه‌ی 3.4.

فهرست پوشه‌هایی که به‌طور پیش‌فرض توسط dircmp نادیده گرفته می‌شوند.

در اینجا یک مثال ساده‌شده از استفاده از ویژگی subdirs برای جستجوی بازگشتی در دو پوشه جهت نمایش پرونده‌های مشترک متفاوت آمده است:

>>> from filecmp import dircmp
>>> def print_diff_files(dcmp):
...     for name in dcmp.diff_files:
...         print("diff_file %s found in %s and %s" % (name, dcmp.left,
...               dcmp.right))
...     for sub_dcmp in dcmp.subdirs.values():
...         print_diff_files(sub_dcmp)
...
>>> dcmp = dircmp('dir1', 'dir2')
>>> print_diff_files(dcmp)