الفرق بين المراجعتين لصفحة: «Python/pathlib/Path»

من موسوعة حسوب
→ التعديل السابق
مرئينص الويكي
 
(20 مراجعات متوسطة بواسطة نفس المستخدم غير معروضة)
سطر 1: سطر 1:


==الصنف <code>pathlib.Path</code> في بايثون==
==الصنف <code>pathlib.Path</code> في بايثون==
هو الصنف العام للأصناف التي تتعامل مع المسارات مع السماح بالقيام بعمليات الإدخال والإخراج، وتُسمّى بأصناف المسارات الصلبة Concrete Paths، نورد فيما يلي طريقة الاستخدام الأساسية:
هو الصنف العام للأصناف التي تتعامل مع المسارات مع السماح بالقيام بعمليات الإدخال والإخراج، وتُسمّى بأصناف المسارات الصلبة Concrete Paths.
 
==البنية العامة==
استيراد الصنف الأساسي من الوحدة <code>pathlib</code>:<syntaxhighlight lang="python3">
<syntaxhighlight lang="python3">
>>> from pathlib import Path #استيراد الصنف الأساسي
pathlib.Path(*args,**kwargs)‎
 
</syntaxhighlight>
</syntaxhighlight>إنشاء كائن والتكرار على المجلدات والملفات التي بداخله:<syntaxhighlight lang="python3">
==المعاملات==
 
===<code>args*</code>===
>>> p = Path('.') #إنشاء كائن باستخدام باين الصنف العام
يمكن تمرير عدد غير محدود من السلاسل النصية أو من كائنات من النوع <code>Path</code> حيث تمثل السلاسل النصية أسماء المجلدات والملفات بالترتيب من المستوى الأعلى للأدنى.
 
===<code>kwargs**</code>===
>>> [x for x in p.iterdir() if x.is_dir()] #تعداد المجلدات الموجودة ضمن المسار الحالي
معامل غير مستخدم.
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
PosixPath('__pycache__'), PosixPath('build')]
 
</syntaxhighlight>تعداد ملفات بايثون المصدرية في شجر ة المجلدات هذه:<syntaxhighlight lang="python3">
>>> list(p.glob('**/*.py'))
 
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
PosixPath('build/lib/pathlib.py')]
 
 
</syntaxhighlight>التنقّل ضمن شجرة المجلدات، يظهر فيه استخدام عملية القسمة <code>/</code> المُعاد تعريفها لتقوم بالتنقل بين المجلدات:<syntaxhighlight lang="python3">
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q
 
PosixPath('/etc/init.d/reboot')
>>> q.resolve()
 
PosixPath('/etc/rc.d/init.d/halt')
 
 
</syntaxhighlight>الاستعلام عن خصائص المسار:<syntaxhighlight lang="python3">
>>> q.exists()
 
True
 
>>> q.is_dir()
 
False
 
 
</syntaxhighlight>فتح ملف:<syntaxhighlight lang="python3">
>>> with q.open() as f: f.readline()
 
السطر الأول وأهلا بك
السطر الأخير وداعا
 


</syntaxhighlight><span> </span>
يمكنك مراجعة [https://pythontips.com/2013/08/04/args-and-kwargs-in-python-explained/ المقال التالي] بخصوص هذا النوع من المعاملات.
===نكهات المسارات الصلبة===
==الاستخدام الأساسي==
يمكن إنشاء كائن من الصنف <code>Path</code> بثلاث طرق مختلفة:
يمكن إنشاء كائن من الصنف <code>Path</code> بثلاث طرق مختلفة:


سطر 72: سطر 34:




</syntaxhighlight>إلا أنه يجب الانتباه إلى عدم القيام بأي استدعاءات للنظام عندما ننشئ كائنًا من أحد الصنفين الفرعيين السابقين على نظام تشغيل مغاير له، كما يوضح المثال التالي<syntaxhighlight lang="python3">
</syntaxhighlight>كما تجدر الإشارة إلى أنه لا يُسمح لإنشاء أحد الصنفين <code>PosixPath</code>  أو <code>WindowsPath</code> على نظام مغاير له، حيث يرمي الباني الخاص بالصنف الاستثناء <code>NotImplementedError</code> كما يوضح المثال التالي:<syntaxhighlight lang="python3">
>>>
>>>


سطر 78: سطر 40:


>>> os.name
>>> os.name
'posix'    #نظام التشغيل الذي يتم تفسير الشيفرة عليه مغاير لويندوز
'posix'    #نظام التشغيل الذي يتم تفسير الشيفرة عليه مغاير لويندوز


>>> Path('setup.py')
>>> Path('setup.py')
PosixPath('setup.py')
PosixPath('setup.py')


>>> PosixPath('setup.py')
>>> PosixPath('setup.py')
PosixPath('setup.py')
PosixPath('setup.py')


>>> WindowsPath('setup.py')  #لا تسمح أصناف المسارات الصلبة بإنشاء كائن مغاير لنوع النظام الذي يتم العمل عليه
>>> WindowsPath('setup.py')  #لا تسمح أصناف المسارات الصلبة بإنشاء كائن مغاير لنوع النظام الذي يتم العمل عليه
Traceback (most recent call last):
Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
 File "<stdin>", line 1, in <module>
 File "pathlib.py", line 798, in __new__
 File "pathlib.py", line 798, in __new__
   % (cls.__name__,))
   % (cls.__name__,))
NotImplementedError: cannot instantiate 'WindowsPath' on your system
NotImplementedError: cannot instantiate 'WindowsPath' on your system
</syntaxhighlight>
</syntaxhighlight>
===توابع الصنف <code>Path</code>===
==أمثلة على الاستخدام==
يتيح الصنف <code>Path</code> استخدام جميع التوابع الخاصة بالصنف <code>PurePath</code> وذلك لأنه يرث منه، ويضيف عليها التوابع التالية، التي تسمح بالقيام باستدعاءات النظام (system calls)، وترمي هذه التوابع استثناء <code>OSError</code> في حال فشل أيٍّ منها (كأن يكون المسار الذي يتم التعامل معه غير موجود مثلًا).
تُوضح الشيفرات التالية أمثلةً لاستخدام هذا الصنف:
====التابع <code>Path.cwd</code>====
يعيد كائن مسار جديدًا يمثّل المسار الحالي (بشكل مشابه للتابع os.getcwd)<syntaxhighlight lang="python3">
>>> Path.cwd()


PosixPath('/home/antoine/pathlib')
استيراد الصنف الأساسي من الوحدة <code>pathlib</code>:<syntaxhighlight lang="python3">
>>> from pathlib import Path #استيراد الصنف الأساسي


</syntaxhighlight>ملاحظة: لن تتمكن من استيراد المكتبة على نسخ بايثون الأُقدم من 3.4 (استخدم [[Python/os.path|os.path]] بدلًا منها)


</syntaxhighlight>
إنشاء كائن والتكرار على المجلدات والملفات التي بداخله باستخدام [[Python/list#List Comprehensions|list comprehension]]:<syntaxhighlight lang="python3">
====التابع <code>Path.home</code>====
يعيد كائن مسار جديدًا يمثّل المسار الرئيسي (home directory) للمستخدم (بشكل مشابه للتابع os.path.expanduser مع الوسيط <code>'~'</code>)


وهو تابع جديد في النسخة 3.5<syntaxhighlight lang="python3">
>>> p = Path('.') #إنشاء كائن باستخدام باين الصنف العام
>>> Path.home()


PosixPath('/home/mostafa')
>>> [x for x in p.iterdir() if x.is_dir()] #تعداد المجلدات الموجودة ضمن المسار الحالي
[PosixPath('.hg'), PosixPath('docs'), PosixPath('dist'),
PosixPath('__pycache__'), PosixPath('build')]


</syntaxhighlight>تعداد ملفات بايثون المصدرية في شجرة المجلدات الحالية باستخدام [[Python/pathlib/Path/glob|glob]]:<syntaxhighlight lang="python3">
>>> list(p.glob('**/*.py'))


</syntaxhighlight>
[PosixPath('test_pathlib.py'), PosixPath('setup.py'),
====التابع <code>Path.stat</code>====
PosixPath('pathlib.py'), PosixPath('docs/conf.py'),
يعيد معلومات عن المسار (مماثل للتابع <code>os.stat</code>) ، ويتم حساب المعلومات في كل مرة يتم فيها استدعاء التابع<syntaxhighlight lang="python3">
PosixPath('build/lib/pathlib.py')]
>>> p = Path('setup.py')


>>> p.stat().st_size


956
</syntaxhighlight>يمكن التنقّل ضمن شجرة المجلدات باستخدام عملية القسمة <code>/</code>  المُعاد تعريفها:<syntaxhighlight lang="python3">
>>> p = Path('/etc')
>>> q = p / 'init.d' / 'reboot'
>>> q


>>> p.stat().st_mtime
PosixPath('/etc/init.d/reboot')
>>> q.resolve()


1327883547.852554
PosixPath('/etc/rc.d/init.d/halt')




</syntaxhighlight>
</syntaxhighlight>كما يمكن استخدام قائمة طويلة من التوابع للاستعلام عن خصائص المسار، مثل [[Python/pathlib/Path/exists|exists]] و [[Python/pathlib/Path/is dir|is_dir]]:<syntaxhighlight lang="python3">
====التابع <code>Path.chmod</code>====
>>> q.exists()
يقوم هذا التابع بتغيير نمط الملف وصلاحياته (مماثل للتابع <code>os.chmod</code>)<syntaxhighlight lang="python3">
>>>
 
>>> p = Path('setup.py')
 
>>> p.stat().st_mode
 
33277
 
>>> p.chmod(0o444)
 
>>> p.stat().st_mode
 
33060
 
 
</syntaxhighlight>
====التابع <code>Path.exists</code>====
يدلّ على كون المسار مشيرًا إلى ملف أو مجلد حقيقي أم لا<syntaxhighlight lang="python3">
>>>
 
>>> Path('.').exists()


True
True


>>> Path('setup.py').exists()
>>> q.is_dir()
 
True
 
>>> Path('/etc').exists()
 
True
 
>>> Path('nonexistentfile').exists()


False
False




</syntaxhighlight>ملاحظة: إذا كان المسار يشير إلى اختصار (symlink) فإن استدعاء التابع <code>exists</code> يدل على ما يشير إليه الاختصار.
</syntaxhighlight>يسمح التابع [[Python/pathlib/Path/open|open]] بفتح الملفات بشكل مشابه للتابع [[Python/open|open]] المضمن في بايثون:<syntaxhighlight lang="python3">
====التابع <code>Path.expanduser</code>====
>>> with q.open() as f: f.readline()
يعيد كائن مسار جديد يمدد فيه المسار الرئيسي للمستخدم الممثل بالرمز <code>'~'</code>، مشابه للتابع <code>os.path.expanduser</code><syntaxhighlight lang="python3">
>>>


>>> p = PosixPath('~/films/Monty Python')
السطر الأول وأهلا بك
السطر الأخير وداعا


>>> p.expanduser()


PosixPath('/home/eric/films/Monty Python')
</syntaxhighlight>
 
==<span> </span>توابع الصنف <code>Path</code>==
</syntaxhighlight>New in version 3.5.
يتيح الصنف <code>Path</code> استخدام جميع التوابع الخاصة بالصنف <code>PurePath</code> وذلك لأنه يرث منه، ويضيف عليها التوابع التالية، التي تسمح بالقيام باستدعاءات النظام (system calls)، وترمي هذه التوابع استثناء <code>OSError</code> في حال فشل أيٍّ منها (كأن يكون المسار الذي يتم التعامل معه غير موجود مثلًا).
====التابع <code>Path.glob</code>====
===[[Python/pathlib/Path/cwd|التابع <code>Path.cwd</code>]]===
تعيد جميع الملفات التي تحقق نمط [[wikipedia:Glob_(programming)|glob]] المعطى، مهما كان نوع الملف<syntaxhighlight lang="python3">
يعيد كائن مسار جديدًا يمثّل المسار الحالي (بشكل مشابه للتابع [[Python/os/getcwd|os.getcwd]])
>>>
===[[Python/pathlib/Path/home|التابع <code>Path.home</code>]]===
 
يعيد كائن مسار جديدًا يمثّل المسار الرئيسي (home directory) للمستخدم (بشكل مشابه للتابع <code>[[Python/os/path/expanduser|os.path.expanduser]]</code> مع الوسيط <code>'~'</code>)
>>> sorted(Path('.').glob('*.py'))
===[[Python/pathlib/Path/stat|التابع <code>Path.stat</code>]]===
 
يعيد معلومات عن المسار (مماثل للتابع <code>[[Python/os/stat|os.stat]]</code>) ، ويتم حساب المعلومات في كل مرة يتم فيها استدعاء التابع
[PosixPath('pathlib.py'), PosixPath('setup.py'), PosixPath('test_pathlib.py')]
===[[Python/pathlib/Path/chmod|التابع <code>Path.chmod</code>]]===
 
يقوم هذا التابع بتغيير نمط الملف وصلاحياته (مماثل للتابع <code>[[Python/os/chmod|os.chmod]]</code>)
>>> sorted(Path('.').glob('*/*.py'))
===[[Python/pathlib/Path/exists|التابع <code>Path.exists</code>]]===
 
يدلّ على كون المسار مشيرًا إلى ملف أو مجلد حقيقي (موجود على نظام التشغيل) أم لا.
[PosixPath('docs/conf.py')]
===[[Python/pathlib/Path/expanduser|التابع <code>Path.expanduser</code>]]===
 
يعيد كائن مسار جديد يمدد فيه المسار الرئيسي للمستخدم الممثل بالرمز <code>'~'</code>، مشابه للتابع <code>[[Python/os/path/expanduser|os.path.expanduser]]</code>
 
===[[Python/pathlib/Path/glob|التابع <code>Path.glob</code>]]===
</syntaxhighlight>يعني النمط <code>"**"</code> تحديد المجلد الحالي وجميه المجلدات الفرعية في داخله بشكل عودي (recursively)، وهو ما يسمّى recursive globbing<syntaxhighlight lang="python3">
يعيد جميع الملفات التي تحقق نمط [[wikipedia:Glob_(programming)|glob]] المعطى، مهما كان نوع الملف.
>>>
===[[Python/pathlib/Path/group|التابع <code>Path.group</code>]]===
 
يعيد هذا التابع اسم المجموعة التي ينتمي لها الملف، ويرمي بالخطأ <code>KeyError</code>  إذا كان معرف المجموعة <code>[https://whatis.techtarget.com/definition/GID-group-ID-or-global-index-file gid]</code> الخاص بالملف غير موجود في قاعدة بيانات النظام.
>>> sorted(Path('.').glob('**/*.py'))
===[[Python/pathlib/Path/is dir|التابع <code>Path.is_dir</code>]]===
 
[PosixPath('build/lib/pathlib.py'),
 
PosixPath('docs/conf.py'),
 
PosixPath('pathlib.py'),
 
PosixPath('setup.py'),
 
PosixPath('test_pathlib.py')]
 
 
</syntaxhighlight>ملاحظة: احذر من استخدام النمط <code>"**"</code> في أشجار المجلدات الكبيرة، فإن ذلك قد يستهلك كمية هائلة من الوقت,
====التابع <code>Path.group</code>====
يعيد هذا التابع اسم المجموعة التي ينتمي لها الملف، ويرمي بالخطأ <code>KeyError</code>  إذا كان معرف المجموعة <code>gid</code> الخاص بالملف غير موجود في قاعدة بيانات النظام.
====التابع <code>Path.is_dir</code>====
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى مجلد (أو إلى اختصار يشير إلى مجلد)، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى مجلد (أو إلى اختصار يشير إلى مجلد)، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
 
===[[Python/pathlib/Path/is file|التابع <code>Path.is_file</code>]]===
كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
====التابع <code>Path.is_file</code>====
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى ملف نظامي(أو إلى اختصار يشير إلى ملف نظامي)، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى ملف نظامي(أو إلى اختصار يشير إلى ملف نظامي)، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
 
===[[Python/pathlib/Path/is mount|التابع <code>Path.is_mount</code>]]===
كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
 
التابع <code>Path.is_mount</code>
 
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار هو نقطة تثبيت [https://unix.stackexchange.com/questions/3247/understanding-mount-as-a-concept-in-the-os (mount point)] .
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار هو نقطة تثبيت [https://unix.stackexchange.com/questions/3247/understanding-mount-as-a-concept-in-the-os (mount point)] .
====التابع <code>Path.is_symlink</code>====
===[[Python/pathlib/Path/is symlink|التابع <code>Path.is_symlink</code>]]===
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى رابط دلالي (symbolic link)، و<code>False</code> فيما عدا ذلك.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى رابط دلالي ([https://www.computerhope.com/jargon/s/symblink.htm symbolic link])، و<code>False</code> فيما عدا ذلك.
 
===[[Python/pathlib/Path/is socket|التابع <code>Path.is_socket</code>]]===
كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
====التابع <code>Path.is_socket</code>====
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [[wikipedia:Unix_domain_socket|Unix socket]] (أو إلى اختصار يشير إلى<nowiki/>[[wikipedia:Unix_domain_socket|Unix socket]])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [[wikipedia:Unix_domain_socket|Unix socket]] (أو إلى اختصار يشير إلى<nowiki/>[[wikipedia:Unix_domain_socket|Unix socket]])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
 
===[[Python/pathlib/Path/is fifo|التابع <code>Path.is_fifo</code>]]===
كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
====التابع <code>Path.is_fifo</code>====
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [[wikipedia:Named_pipe|FIFO]] (أو إلى اختصار يشير إلى [[wikipedia:Named_pipe|FIFO]])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [[wikipedia:Named_pipe|FIFO]] (أو إلى اختصار يشير إلى [[wikipedia:Named_pipe|FIFO]])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.


كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
كما أنه يعيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
====التابع <code>Path.is_block_device</code>====
===[[Python/pathlib/Path/is block device|التابع <code>Path.is_block_device</code>]]===
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [https://unix.stackexchange.com/questions/259193/what-is-a-block-device block device] (أو إلى اختصار يشير إلى [https://unix.stackexchange.com/questions/259193/what-is-a-block-device block device])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [https://unix.stackexchange.com/questions/259193/what-is-a-block-device block device] (أو إلى اختصار يشير إلى [https://unix.stackexchange.com/questions/259193/what-is-a-block-device block device])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
 
===[[Python/pathlib/Path/is char device|التابع <code>Path.is_char_device</code>]]===
كما أنه عيد <code>False</code> إذا كان المسار غير موجود أو أن الاختصار بشير إلى مسار غير موجود، كما يمكن لأخطاء أخرى (مثل عدم وجود صلاحيات) أن تظهر.
يعيد هذا التابع القيمة المنطقية <code>True</code> إذا كان المسار يشير إلى [https://arstechnica.com/civis/viewtopic.php?t=787631 character device] (أو إلى اختصار يشير إلى [https://arstechnica.com/civis/viewtopic.php?t=787631 character device])، بينما يعيد <code>False</code> في حال كان المسار يشير إلى أي نوع آخر من الملفات.
====التابع <code>Path.is_char_device</code>====
===[[Python/pathlib/Path/iterdir|التابع <code>Path.iterdir</code>]]===
Return True if the path points to a character device (or a symbolic link pointing to a character device), Falseif it points to another kind of file.
يُسمح باستخدام هذا التابع على كائنات المسارات التي تشير إلى مجلدات، حيث يُنتج كائنات مسارات لكل محتويات المجلد، وتكون النتيجة قابلة للتكرار.
 
===[[Python/pathlib/Path/lchmod|التابع <code>Path.lchmod</code>]]===
False is also returned if the path doesn’t exist or is a broken symlink; other errors (such as permission errors) are propagated.
مشابه للتابع <code>Path.chmod</code>، ولكن عندما يشير المسار إلى اختصار، فإن هذا التابع يقوم بتغيير نمط الاختصار بدلًا من تغيير نمط الملف الذي يشير إليه الاختصار.
====التابع <code>Path.iterdir</code>====
===[[Python/pathlib/Path/lstat|التابع <code>Path.lstat</code>]]===
When the path points to a directory, yield path objects of the directory contents:
مشابه للتابع <code>Path.stat</code> ، ولكن عندما يشير المسار إلى اختصار، فإن هذا التابع يقوم بإعادة المعلومات المتعلقة بالاختصار ذاته بدلًا من إعادة المعلومات المرتبطة بالملف الذي يشير إليه الاختصار.
 
===التابع <code>[[Python/pathlib/Path/mkdir|Path.mkdir]]</code>===
>>>
يُنشئ هذا التابع مجلّدًا في المسار المُعطى بالخصائص التي يتم تحديدها في باقي الوسطاء.
 
===[[Python/pathlib/Path/open|التابع <code>Path.open</code>]]===
>>> p = Path('docs')
يفتح الملف الذي يشير إليه المسار، بطريقة مشابهة للتابع المضمن <code>[[Python/open|open]]</code>.
 
===[[Python/pathlib/Path/owner|التابع <code>Path.owner</code>]]===
>>> for child in p.iterdir(): child
يعيد هذا التابع اسم المستخدم المالك للملف. ويرمي استثناءً <code>KeyError</code>  إن كان معرف المستخدم <code>[http://www.linfo.org/uid.html uid]</code> غير موجود في قاعدة بيانات النظام.
 
===[[Python/pathlib/Path/read bytes|التابع <code>Path.read_bytes</code>]]===
...
يعيد هذا التابع المحتوى المرمّز للملف المُشار إليه ككائن من النوع <code>[[Python/bytes|bytes]]</code>.
 
===[[Python/pathlib/Path/read text|التابع <code>Path.read_text</code>]]===
PosixPath('docs/conf.py')
يعيد هذا التابع المحتوى النصي للملف كسلسلة نصية.
 
===[[Python/pathlib/Path/rename|التابع <code>Path.rename</code>]]===
PosixPath('docs/_templates')
يعيد تسمية الملف أو المجلد بما يحدده الوسيط المُعطى. في نظام يونكس، وله سلوك مختلف في حال وجود ملف بنفس الاسم الجديد حسب نظام التشغيل.
 
===[[Python/pathlib/Path/replace|التابع <code>Path.replace</code>]]===
PosixPath('docs/make.bat')
يستبدل الملف الحالي بملف الوجهة، حيث يقوم بإعادة التسمية إن لم تكن الوجهة موجودة، ويقوم بالاستبدال دون أي شرط في حال كانت الوجهة موجودة من قبل.
 
===التابع <code>[[Python/pathlib/Path/resolve|Path.resolve]]</code>===
PosixPath('docs/index.rst')
يجعل المسار مسارًا مطلقًا.
 
===[[Python/pathlib/Path/rglob|التابع <code>Path.rglob</code>]]===
PosixPath('docs/_build')
مشابه لاستدعاء التابع <code>[[Python/pathlib/Path/glob|glob]]</code> عند إضافة <code>'**'</code> في بداية النمط المُعطى
 
===التابع <code>[[Python/pathlib/Path/rmdir|Path.rmdir]]</code>===
PosixPath('docs/_static')
يحذف المجلد إن كان خاليًا من الملفات.
 
===التابع <code>[[Python/pathlib/Path/samefile|Path.samefile]]</code>===
PosixPath('docs/Makefile')
يحدد فيما إذا كان المسار المعطى هو مطابقًا للمسار الخاص بالكائن.
====التابع <code>Path.lchmod</code>====
===التابع <code>[[Python/pathlib/Path/symlink to|Path.symlink_to]]</code>===
Like Path.chmod() but, if the path points to a symbolic link, the symbolic link’s mode is changed rather than its target’s.
يجعل من الكائن اختصارًا للملف المُعطى.
====التابع <code>Path.lstat</code>====
===التابع <code>[[Python/pathlib/Path/touch|Path.touch]]</code>===
Like Path.stat() but, if the path points to a symbolic link, return the symbolic link’s information rather than its target’s.
يُنشئ ملفًّا في المسار المُعطى.
====التابع <code>Path.mkdir</code>====
===[[Python/pathlib/Path/unlink|التابع <code>Path.unlink</code>]]===
Create a new directory at this given path. If mode is given, it is combined with the process’ umask value to determine the file mode and access flags. If the path already exists, FileExistsError is raised.
يحذف الملف أو الاختصار الذي يشير إليه الكائن، أما إذا كان المسار يشير إلى مجلد فيجب استخدام التابع <code>[[Python/pathlib/Path/rmdir|Path.rmdir]]</code> بدلًا من هذا التابع.
 
===[[Python/pathlib/Path/write bytes|التابع <code>Path.write_bytes</code>]]===
If parents is true, any missing parents of this path are created as needed; they are created with the default permissions without taking mode into account (mimicking the POSIX mkdir -p command).
يفتح الملف المُشار إليه في نمط <code>[[Python/bytes|bytes]]</code>، ويكتب البيانات فيه ثم يُغلقه.
 
===التابع <code>[[Python/pathlib/Path/write text|Path.write_text]]</code>===
If parents is false (the default), a missing parent raises FileNotFoundError.
يفتح الملف المٌشار إليه بالنمط النصي، ويكتب البيانات فيه ثم يُغلقه.<syntaxhighlight lang="python3">
 
If exist_ok is false (the default), FileExistsError is raised if the target directory already exists.
 
If exist_ok is true, FileExistsError exceptions will be ignored (same behavior as the POSIX mkdir -pcommand), but only if the last path component is not an existing non-directory file.
 
Changed in version 3.5: The exist_ok parameter was added.
====التابع <code>Path.open</code>====
Open the file pointed to by the path, like the built-in open() function does:
 
>>>
 
>>> p = Path('setup.py')
 
>>> with p.open() as f:
 
...    .readline()
 
...
 
'#!/usr/bin/env python3\n'
====التابع <code>Path.owner</code>====
Return the name of the user owning the file. KeyError is raised if the file’s uid isn’t found in the system database.
====التابع <code>Path.read_bytes</code>====
Return the binary contents of the pointed-to file as a bytes object:
 
>>>
 
>>> p = Path('my_binary_file')
 
>>> p.write_bytes(b'Binary file contents')
 
20
 
>>> p.read_bytes()
 
b'Binary file contents'
 
New in version 3.5.
====التابع <code>Path.read_text</code>====
Return the decoded contents of the pointed-to file as a string:
 
>>>
 
>>> p = Path('my_text_file')
 
>>> p.write_text('Text file contents')
 
18
 
>>> p.read_text()
 
'Text file contents'
 
The optional parameters have the same meaning as in open().
 
New in version 3.5.
====التابع <code>Path.rename</code>====
Rename this file or directory to the given target. On Unix, if target exists and is a file, it will be replaced silently if the user has permission. target can be either a string or another path object:
 
>>>
 
>>> p = Path('foo')
 
>>> p.open('w').write('some text')
 
9
 
>>> target = Path('bar')
 
>>> p.rename(target)
 
>>> target.open().read()
 
'some text'
====التابع <code>Path.replace</code>====
Rename this file or directory to the given target. If target points to an existing file or directory, it will be unconditionally replaced.
====التابع <code>Path.resolve</code>====
Make the path absolute, resolving any symlinks. A new path object is returned:
 
>>>
 
>>> p = Path()
 
>>> p
 
PosixPath('.')
 
>>> p.resolve()
 
PosixPath('/home/antoine/pathlib')
 
“..” components are also eliminated (this is the only method to do so):
 
>>>
 
>>> p = Path('docs/../setup.py')
 
>>> p.resolve()
 
PosixPath('/home/antoine/pathlib/setup.py')
 
If the path doesn’t exist and strict is True, FileNotFoundError is raised. If strict is False, the path is resolved as far as possible and any remainder is appended without checking whether it exists. If an infinite loop is encountered along the resolution path, RuntimeError is raised.
 
New in version 3.6: The strict argument.
====التابع <code>Path.rglob</code>====
This is like calling Path.glob() with “**” added in front of the given pattern:
 
>>>
 
>>> sorted(Path().rglob("*.py"))
 
[PosixPath('build/lib/pathlib.py'),
 
PosixPath('docs/conf.py'),
 
PosixPath('pathlib.py'),
 
PosixPath('setup.py'),
 
PosixPath('test_pathlib.py')]
 
Path.rmdir()
 
Remove this directory. The directory must be empty.
====التابع <code>Path.samefile</code>====
Return whether this path points to the same file as other_path, which can be either a Path object, or a string. The semantics are similar to os.path.samefile() and os.path.samestat().
 
An OSError can be raised if either file cannot be accessed for some reason.
 
>>>
 
>>> p = Path('spam')
 
>>> q = Path('eggs')
 
>>> p.samefile(q)
 
False
 
>>> p.samefile('spam')
 
True
 
New in version 3.5.
====التابع <code>Path.symlink_to</code>====
Make this path a symbolic link to target. Under Windows, target_is_directory must be true (default False) if the link’s target is a directory. Under POSIX, target_is_directory’s value is ignored.
 
>>>
 
>>> p = Path('mylink')
 
>>> p.symlink_to('setup.py')
 
>>> p.resolve()
 
PosixPath('/home/antoine/pathlib/setup.py')
 
>>> p.stat().st_size
 
956
 
>>> p.lstat().st_size
 
8
 
Note
 
The order of arguments (link, target) is the reverse of os.symlink()’s.
====التابع <code>Path.touch</code>====
Create a file at this given path. If mode is given, it is combined with the process’ umask value to determine the file mode and access flags. If the file already exists, the function succeeds if exist_ok is true (and its modification time is updated to the current time), otherwise FileExistsError is raised.
====التابع <code>Path.unlink</code>====
Remove this file or symbolic link. If the path points to a directory, use Path.rmdir() instead.
====التابع <code>Path.write_bytes</code>====
Open the file pointed to in bytes mode, write data to it, and close the file:
 
>>>
 
>>> p = Path('my_binary_file')
 
>>> p.write_bytes(b'Binary file contents')
 
20
 
>>> p.read_bytes()
 
b'Binary file contents'
 
An existing file of the same name is overwritten.
 
New in version 3.5.
====التابع <code>Path.write_text</code>====
Open the file pointed to in text mode, write data to it, and close the file:
 
>>>
 
>>> p = Path('my_text_file')
>>> p = Path('my_text_file')


>>> p.write_text('Text file contents')
>>> p.write_text('Text file contents')
18
18


>>> p.read_text()
>>> p.read_text()
'Text file contents'
'Text file contents'


سطر 494: سطر 193:


<span> </span>
<span> </span>
 
</syntaxhighlight>تابع مُستحدث في السخة 3.5.
New in version 3.5.
==انظر أيضًا==
{| class="wikitable"
للقيام بمعالجة منخفضة المستوى للمسارات على السلاسل النصية، يمكنك أيضًا استخدام الوحدة [[Python/os/path|os.path]]
|'''انظر أيضًا'''
===التقابل مع الوحدة <code>os</code>===
للقيام بمعالجة منخفضة المستوى للمسارات على السلاسل النصية، يمكنك أيضًا استخدام الوحدة os.path
يبيّن الجدول التالي تقابل عدة توابع من الوحدة <code>os</code>  مع ما يقابلها و يكافئها من الوحدة  <code>[[Python/pathlib/Path|Path]]</code>.
|}
===التقابل مع الوحدة os===
يبيّن الجدول التالي تقابل عدة توابع من الوحدة <code>os</code>  مع ما يقابلها و يكافئها من الوحدة  <code>Path</code>.
{| class="wikitable"
{| class="wikitable"
!الوحدة os والوحدة os.path
!الوحدة os والوحدة os.path
!الوحدة pathlib
!الوحدة pathlib
|-
|-
|os.path.abspath()
|os.path.abspath‎‎()‎
|Path.resolve()
|Path.resolve()‎
|-
|-
|os.getcwd()
|‎os.getcwd()‎
|Path.cwd()
|Path.cwd()‎
|-
|-
|os.path.exists()
|os.path.exists()‎
|Path.exists()
|Path.exists()‎
|-
|-
|os.path.expanduser()
|os.path.expanduser()‎
|Path.expanduser() و Path.home()
|Path.expanduser()‎ و Path.home()‎
|-
|-
|os.path.isdir()
|os.path.isdir()‎
|Path.is_dir()
|Path.is_dir()‎
|-
|-
|os.path.isfile()
|os.path.isfile()‎
|Path.is_file()
|Path.is_file()‎
|-
|-
|os.path.islink()
|os.path.islink()‎
|Path.is_symlink()
|Path.is_symlink()‎
|-
|-
|os.stat()
|os.stat()‎
|Path.stat(),Path.owner(), Path.group()
|Path.stat(),Path.owner(), Path.group()‎
|}ملاحظة:
|}
 
<span> </span>


بالرغم من وجود بعض التقاطع في حالات استخدام التابعين <code>os.path.relpath‎‎()</code>‎ والتابع <code>PurePath.relative_to()</code>‎ إلا أن مدلول كل منهما مختلف بما يدعو لعدم اعتبارهما متكافئين.
== المصادر ==
[https://docs.python.org/3/library/pathlib.html قسم الوحدة pathlib في توثيق بايثون الرسمي.]

المراجعة الحالية بتاريخ 10:41، 19 أغسطس 2018

الصنف 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()‎

المصادر

قسم الوحدة pathlib في توثيق بايثون الرسمي.

مجلوبة من «https://wiki.hsoub.com/index.php?title=Python/pathlib/Path&oldid=15224»