Python/pathlib/Path
الصنف pathlib.Path في بايثون
هو الصنف العام للأصناف التي تتعامل مع المسارات مع السماح بالقيام بعمليات الإدخال والإخراج، وتُسمّى بأصناف المسارات الصلبة Concrete Paths.
البنية العامة
pathlib.Path(*args,**kwargs)
المعاملات
args*
يمكن تمرير عدد غير محدود من السلاسل النصية أو من كائنات من النوع Path حيث تمثل السلاسل النصية أسماء المجلدات والملفات بالترتيب من المستوى الأعلى للأدنى.
kwargs**
معامل غير مستخدم.
يمكنك مراجعة المقال التالي بخصوص هذا النوع من المعاملات.
الاستخدام الأساسي
يمكن إنشاء كائن من الصنف Path بثلاث طرق مختلفة:
1- باستخدام باني الصنف العام Path، وتعتمد هذه الطريقة على إنشاء كائن من الصنف PosixPath أو WindowsPath حسب نظام التشغيل الذي يتم تفسير الشيفرة عليه:
>>> Path('setup.py')
PosixPath('setup.py')
2- باستخدام باني الصنف الخاص بالأنظمة المغايرة لويندوز PosixPath
>>> PosixPath('/etc')
PosixPath('/etc')
3- باستخدام باني الصنف الخاص بنظام ويندوز WindowsPath
>>> WindowsPath('c:/Program Files/')
WindowsPath('c:/Program Files')
كما تجدر الإشارة إلى أنه لا يُسمح لإنشاء أحد الصنفين PosixPath أو WindowsPath على نظام مغاير له، حيث يرمي الباني الخاص بالصنف الاستثناء NotImplementedError كما يوضح المثال التالي:
>>>
>>> import os
>>> os.name
'posix' #نظام التشغيل الذي يتم تفسير الشيفرة عليه مغاير لويندوز
>>> Path('setup.py')
PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
>>> WindowsPath('setup.py') #لا تسمح أصناف المسارات الصلبة بإنشاء كائن مغاير لنوع النظام الذي يتم العمل عليه
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "pathlib.py", line 798, in __new__
% (cls.__name__,))
NotImplementedError: cannot instantiate 'WindowsPath' on your system
أمثلة على الاستخدام
تُوضح الشيفرات التالية أمثلةً لاستخدام هذا الصنف:
استيراد الصنف الأساسي من الوحدة pathlib:
>>> from pathlib import Path #استيراد الصنف الأساسي
ملاحظة: لن تتمكن من استيراد المكتبة على نسخ بايثون الأُقدم من 3.4 (استخدم os.path بدلًا منها) إنشاء كائن والتكرار على المجلدات والملفات التي بداخله باستخدام list comprehension:
>>> p = Path('.') #إنشاء كائن باستخدام باين الصنف العام
>>> [x for x in p.iterdir() if x.is_dir()] #تعداد المجلدات الموجودة ضمن المسار الحالي
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
PosixPath('__pycache__'), PosixPath('build')]
تعداد ملفات بايثون المصدرية في شجرة المجلدات الحالية باستخدام glob:
>>> list(p.glob('**/*.py'))
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
PosixPath('build/lib/pathlib.py')]
يمكن التنقّل ضمن شجرة المجلدات باستخدام عملية القسمة / المُعاد تعريفها:
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
PosixPath('/etc/rc.d/init.d/halt')
كما يمكن استخدام قائمة طويلة من التوابع للاستعلام عن خصائص المسار، مثل exists و is_dir:
>>> q.exists()
True
>>> q.is_dir()
False
يسمح التابع open بفتح الملفات بشكل مشابه للتابع open المضمن في بايثون:
>>> with q.open() as f: f.readline()
السطر الأول وأهلا بك
السطر الأخير وداعا
توابع الصنف Path
يتيح الصنف Path استخدام جميع التوابع الخاصة بالصنف PurePath وذلك لأنه يرث منه، ويضيف عليها التوابع التالية، التي تسمح بالقيام باستدعاءات النظام (system calls)، وترمي هذه التوابع استثناء OSError في حال فشل أيٍّ منها (كأن يكون المسار الذي يتم التعامل معه غير موجود مثلًا).
التابع Path.cwd
يعيد كائن مسار جديدًا يمثّل المسار الحالي (بشكل مشابه للتابع os.getcwd)
التابع Path.home
يعيد كائن مسار جديدًا يمثّل المسار الرئيسي (home directory) للمستخدم (بشكل مشابه للتابع os.path.expanduser مع الوسيط '~')
التابع Path.stat
يعيد معلومات عن المسار (مماثل للتابع os.stat) ، ويتم حساب المعلومات في كل مرة يتم فيها استدعاء التابع
التابع Path.chmod
يقوم هذا التابع بتغيير نمط الملف وصلاحياته (مماثل للتابع os.chmod)
التابع Path.exists
يدلّ على كون المسار مشيرًا إلى ملف أو مجلد حقيقي (موجود على نظام التشغيل) أم لا.
التابع Path.expanduser
يعيد كائن مسار جديد يمدد فيه المسار الرئيسي للمستخدم الممثل بالرمز '~'، مشابه للتابع os.path.expanduser
التابع Path.glob
يعيد جميع الملفات التي تحقق نمط glob المعطى، مهما كان نوع الملف.
التابع Path.group
يعيد هذا التابع اسم المجموعة التي ينتمي لها الملف، ويرمي بالخطأ KeyError إذا كان معرف المجموعة gid الخاص بالملف غير موجود في قاعدة بيانات النظام.
التابع Path.is_dir
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى مجلد (أو إلى اختصار يشير إلى مجلد)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
التابع Path.is_file
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى ملف نظامي(أو إلى اختصار يشير إلى ملف نظامي)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
التابع Path.is_mount
يعيد هذا التابع القيمة المنطقية True إذا كان المسار هو نقطة تثبيت (mount point) .
التابع Path.is_symlink
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى رابط دلالي (symbolic link)، وFalse فيما عدا ذلك.
التابع Path.is_socket
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى Unix socket (أو إلى اختصار يشير إلىUnix socket)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
التابع Path.is_fifo
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى FIFO (أو إلى اختصار يشير إلى FIFO)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
كما أنه يعيد False إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
التابع Path.is_block_device
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى block device (أو إلى اختصار يشير إلى block device)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
التابع Path.is_char_device
يعيد هذا التابع القيمة المنطقية True إذا كان المسار يشير إلى character device (أو إلى اختصار يشير إلى character device)، بينما يعيد False في حال كان المسار يشير إلى أي نوع آخر من الملفات.
التابع Path.iterdir
يُسمح باستخدام هذا التابع على كائنات المسارات التي تشير إلى مجلدات، حيث يُنتج كائنات مسارات لكل محتويات المجلد، وتكون النتيجة قابلة للتكرار.
التابع Path.lchmod
مشابه للتابع Path.chmod، ولكن عندما يشير المسار إلى اختصار، فإن هذا التابع يقوم بتغيير نمط الاختصار بدلًا من تغيير نمط الملف الذي يشير إليه الاختصار.
التابع Path.lstat
مشابه للتابع Path.stat ، ولكن عندما يشير المسار إلى اختصار، فإن هذا التابع يقوم بإعادة المعلومات المتعلقة بالاختصار ذاته بدلًا من إعادة المعلومات المرتبطة بالملف الذي يشير إليه الاختصار.
التابع Path.mkdir
يُنشئ هذا التابع مجلّدًا في المسار المُعطى بالخصائص التي يتم تحديدها في باقي الوسطاء.
التابع Path.open
يفتح الملف الذي يشير إليه المسار، بطريقة مشابهة للتابع المضمن open.
التابع Path.owner
يعيد هذا التابع اسم المستخدم المالك للملف. ويرمي استثناءً KeyError إن كان معرف المستخدم uid غير موجود في قاعدة بيانات النظام.
التابع Path.read_bytes
يعيد هذا التابع المحتوى المرمّز للملف المُشار إليه ككائن من النوع bytes.
التابع Path.read_text
يعيد هذا التابع المحتوى النصي للملف كسلسلة نصية.
التابع Path.rename
يعيد تسمية الملف أو المجلد بما يحدده الوسيط المُعطى. في نظام يونكس، وله سلوك مختلف في حال وجود ملف بنفس الاسم الجديد حسب نظام التشغيل.
التابع Path.replace
يستبدل الملف الحالي بملف الوجهة، حيث يقوم بإعادة التسمية إن لم تكن الوجهة موجودة، ويقوم بالاستبدال دون أي شرط في حال كانت الوجهة موجودة من قبل.
التابع Path.resolve
يجعل المسار مسارًا مطلقًا.
التابع Path.rglob
مشابه لاستدعاء التابع glob عند إضافة '**' في بداية النمط المُعطى
التابع Path.rmdir
يحذف المجلد إن كان خاليًا من الملفات.
التابع Path.samefile
يحدد فيما إذا كان المسار المعطى هو مطابقًا للمسار الخاص بالكائن.
التابع Path.symlink_to
يجعل من الكائن اختصارًا للملف المُعطى.
التابع Path.touch
يُنشئ ملفًّا في المسار المُعطى.
التابع Path.unlink
يحذف الملف أو الاختصار الذي يشير إليه الكائن، أما إذا كان المسار يشير إلى مجلد فيجب استخدام التابع Path.rmdir بدلًا من هذا التابع.
التابع Path.write_bytes
يفتح الملف المُشار إليه في نمط bytes، ويكتب البيانات فيه ثم يُغلقه.
التابع Path.write_text
يفتح الملف المٌشار إليه بالنمط النصي، ويكتب البيانات فيه ثم يُغلقه.
>>> p = Path('my_text_file')
>>> p.write_text('Text file contents')
18
>>> p.read_text()
'Text file contents'
<span> </span>
<span> </span>
تابع مُستحدث في السخة 3.5.
انظر أيضًا
للقيام بمعالجة منخفضة المستوى للمسارات على السلاسل النصية، يمكنك أيضًا استخدام الوحدة os.path
التقابل مع الوحدة os
يبيّن الجدول التالي تقابل عدة توابع من الوحدة os مع ما يقابلها و يكافئها من الوحدة Path.
| الوحدة os والوحدة os.path | الوحدة pathlib |
|---|---|
| os.path.abspath() | Path.resolve() |
| os.getcwd() | Path.cwd() |
| os.path.exists() | Path.exists() |
| os.path.expanduser() | Path.expanduser() و Path.home() |
| os.path.isdir() | Path.is_dir() |
| os.path.isfile() | Path.is_file() |
| os.path.islink() | Path.is_symlink() |
| os.stat() | Path.stat(),Path.owner(), Path.group() |