كيفية إضافة وسيطات سطر الأوامر إلى نص بايثون

إذا قمت بتطوير برنامج نصي أو تطبيق Python من المفترض أن يتم تشغيله بشكل أساسي في برامج محاكاة المحطة الطرفية أو حتى تطبيقات واجهة المستخدم الرسومية ، فإن إضافة وسيطات سطر الأوامر يمكن أن يحسن قابليته للاستخدام ، وقراءة الكود ، وهيكل التطبيق ، وسهولة الاستخدام العام للتطبيق للمستخدمين النهائيين. تسمى وسيطات سطر الأوامر هذه أيضًا خيارات أو رموز تبديل وتعمل بشكل مشابه للوسيطات التي تراها عادةً في البرامج النصية bash والبرامج الأخرى المستندة إلى C / C ++.

لإضافة وسيطات إلى نصوص Python النصية ، سيتعين عليك استخدام وحدة نمطية مضمنة تسمى argparse. كما يوحي الاسم ، فإنه يوزع وسيطات سطر الأوامر المستخدمة أثناء تشغيل برنامج نصي أو تطبيق Python. يتم أيضًا فحص هذه الوسائط التي تم تحليلها بواسطة الوحدة النمطية argparse للتأكد من أنها من النوع المناسب. تظهر الأخطاء في حالة وجود قيم غير صالحة في الوسائط.

يمكن فهم استخدام وحدة argparse بشكل أفضل من خلال الأمثلة. فيما يلي بعض نماذج التعليمات البرمجية التي ستبدأ في استخدام وحدة argparse.

مثال 1: إنشاء وسيطة مساعدة ورسالة

ضع في اعتبارك نموذج الشفرة أدناه:

تستورد العبارة الأولى الوحدة النمطية argparse. بعد ذلك ، يتم إنشاء مثيل جديد لكائن ArgumentParser ويتم توفير وصف قصير للبرنامج كوسيطة. كائن ArgumentParser مطلوب لتحويل قيم وسيطة سطر الأوامر إلى أنواع بيانات مفهومة بواسطة Python. يتم ذلك بواسطة طريقة parse_args لكائن ArgumentParser ، كما هو موضح في العبارة الأخيرة.

بافتراض أنك قمت بحفظ نموذج الشفرة المذكور أعلاه في ملف يسمى test.py ، فإن تشغيل الأوامر أدناه سيوفر لك رسائل المساعدة المتعلقة بالبرنامج.

يجب أن تحصل على بعض المخرجات المشابهة لهذا:

لاحظ أنه لم يتم إضافة أي منطق للتعامل مع الوسائط التي تم تحليلها وتحويلها إلى كائنات إلى نموذج التعليمات البرمجية المذكور أعلاه. ومن ثم ، لا تظهر رسائل المساعدة للوسيطات الفردية في الإخراج. بمجرد إضافة منطق للتعامل مع قيم الوسائط التي تم تحليلها في برنامجك ، ستبدأ رسائل المساعدة في عرض وصف للوسائط الفردية.

مثال 2: التعامل مع وسيطة سلسلة

لإضافة وسيطات مقبولة بواسطة نص Python الخاص بك ، تحتاج إلى استخدام التابع add_argument. ألق نظرة على الكود التالي:

تمت إضافة بيان جديد يوضح استخدام طريقة add_argument. سيتم التعامل مع أي وسيطة تمت إضافتها عند تشغيل البرنامج النصي ككائن print_string بواسطة ArgumentParser.

لاحظ أنه افتراضيًا ، يتعامل أسلوب add_argument مع القيم المستردة من الوسيطات كسلاسل ، لذلك لا يتعين عليك تحديد النوع صراحةً في هذه الحالة. يتم أيضًا تعيين القيمة الافتراضية لـ None للوسيطات المضافة ، ما لم يتم تجاوزها.

ألق نظرة مرة أخرى على رسالة المساعدة:

أحد الأسطر في الإخراج يقول الحجج الموضعية. نظرًا لعدم تحديد أي كلمة أساسية للوسيطة ، يتم حاليًا التعامل مع الوسيطة على أنها وسيطة موضعية حيث يكون لترتيب وموضع الوسيطة المقدمة تأثير مباشر على البرنامج. تعتبر الوسائط الموضعية إلزامية أيضًا ، إلا إذا قمت بتغيير سلوكها يدويًا.

لتعريف الوسيطات الاختيارية وتحليلها ، يمكنك استخدام - (شرطة مزدوجة) وتغيير قيمها الافتراضية باستخدام الوسيطة الافتراضية.

الآن عند تشغيل البرنامج النصي test.py دون أي وسيطة ، يجب أن تحصل على سلسلة عشوائية. كإخراج. يمكنك أيضًا استخدام الكلمة الأساسية –print_string اختياريًا لطباعة أي سلسلة من اختيارك.

لاحظ أنه يمكنك جعل الوسيطة الاختيارية إلزامية باستخدام وسيطة إضافية مطلوبة = True.

أخيرًا ، يمكنك أيضًا تحديد إصدارات مختصرة من الوسيطة باستخدام - (شرطة مفردة) لتقليل الإسهاب.

يجب أن يمنحك تشغيل الأمر التالي نفس النتيجة المذكورة أعلاه:

مثال 3: التعامل مع وسيطة عدد صحيح

للتعامل مع الوسائط التي تحتاج إلى قيم صحيحة ، تحتاج إلى تعيين نوع الكلمة الأساسية للسماح بالتحقق من الصحة ورمي الأخطاء في حالة عدم استيفاء الشرط.

حاول تشغيل الأمر التالي:

يجب أن تحصل على خطأ مثل هذا:

سيعطيك توفير قيمة عدد صحيح النتيجة الصحيحة:

مثال 4: التعامل مع تبديلي الصواب والخطأ

يمكنك تمرير وسيطات بدون أي قيم للتعامل معها كعلامات صواب وخطأ باستخدام وسيطة الإجراء.

قم بتشغيل الأمر أدناه للحصول على True بسيط مثل الإخراج:

إذا قمت بتشغيل البرنامج النصي بدون الوسيطة -p ، فسيتم تعيين قيمة False بدلاً من ذلك. تقوم القيمة store_true للكلمة الأساسية للإجراء بتعيين قيمة True لمتغير print_string عندما يتم تحديد الوسيطة -p بوضوح ، وإلا يتم تعيين False للمتغير.

مثال 5: معاملة قيم الوسيطة كقائمة

إذا كنت ترغب في الحصول على قيم متعددة مرة واحدة وتخزينها في القائمة ، فأنت بحاجة إلى توفير كلمة nargs بالتنسيق التالي:

قم بتشغيل الأمر التالي لاختبار الكود أعلاه:

يجب أن تحصل على بعض الإخراج مثل هذا:

استنتاج

تعتبر وحدة argparse شاملة جدًا مع الكثير من الخيارات لتعديل سلوك تطبيقات سطر الأوامر وتحليل القيم التي يوفرها المستخدم. تلامس هذه الأمثلة الاستخدام الأساسي لوحدة argparse. بالنسبة للتطبيقات المتقدمة والمعقدة ، قد تحتاج إلى تطبيقات مختلفة. قم بزيارة الوثائق الرسمية للحصول على شرح كامل للوحدة.