الفرق بين المراجعتين ل"Bash/debugging Bash scripts"

من موسوعة حسوب
اذهب إلى التنقل اذهب إلى البحث
(إضافة 1.0)
(مراجعة 7: تعديل اسم مستخدم الطرفية)
 
(10 مراجعات متوسطة بواسطة مستخدمين اثنين آخرين غير معروضة)
سطر 1: سطر 1:
 
<noinclude>{{DISPLAYTITLE:تنقيح برامج Bash}}</noinclude>
 
<noinclude>{{DISPLAYTITLE:تنقيح برامج Bash}}</noinclude>
 +
==التنقيح على مستوى البرنامج ككل==
 +
حين تحدث مشكلة في البرنامج الذي كتبته فإنك في حاجة إلى وضع يدك على مكان المشكلة بالتحديد داخل الشيفرة، وتوفر Bash مزايا تنقيح شاملة لعل أشهرها هو بدء صدفة فرعية بخيار <code>x-</code> الذي سيبدأ الصدفة بالكامل في طور التنقيح، وستُطبَع آثار كل أمر إضافة إلى وسائطه (arguments) إلى خَرج قياسي (standard output) بعد توسيع الأوامر لكن قبل تنفيذها.
 +
 +
الشيفرة التالية هي لبرنامج <code>commented-script1.sh</code> من مثال [[Bash/script basics|أساسيات كتابة برامج Bash]]، وقد استدعينا الصدفة في طور التنقيح (debug mode)، لاحظ أن التعليقات المضافة ليست مرئية في خرج البرنامج:<syntaxhighlight lang="text">
 +
wiki@hsoub:~/scripts$ bash -x script1.sh
 +
+ clear
 +
 +
+ echo 'The script starts now.'
 +
The script starts now.
 +
+ echo 'Hi, wiki!'
 +
Hi, wiki!
 +
+ echo
 +
 +
+ echo 'I will now fetch you a list of connected users:'
 +
I will now fetch you a list of connected users:
 +
+ echo
 +
 +
+ w
 +
13:46:40 up 24 min,  1 user,  load average: 0.54, 0.33, 0.23
 +
USER    TTY      FROM            LOGIN@  IDLE  JCPU  PCPU WHAT
 +
wiki      tty7    :0              13:22  23:56  24.22s  0.21s /usr/li
 +
+ echo
 +
 +
+ echo 'I'\''m setting two variables now.'
 +
I'm setting two variables now.
 +
+ COLOUR=black
 +
+ VALUE=9
 +
+ echo 'This is a string: black'
 +
This is a string: black
 +
+ echo 'And this is a number: 9'
 +
And this is a number: 9
 +
+ echo
 +
 +
+ echo 'I'\''m giving you back your prompt now.'
 +
I'm giving you back your prompt now.
 +
+ echo
 +
 +
wiki@hsoub:~/scripts$
 +
</syntaxhighlight>ويوجد الآن منقِّح للصدفة به مزايا متطورة متاح على [http://bashdb.sourceforge.net/ SourceForge]، وتلك المزايا موجودة في أغلب الإصدارات الحديثة في الصدفة بدءًا من إصدار 3.1 .
 +
 +
== تنقيح أجزاء من الصدفة ==
 +
لنقل أنك لا تعرف ما يفعله أمر w في مثال <code>commented-script1.sh</code>، فنستخدم حينها أمر <code>set</code> لتشغيل البرنامج في الوضع العادي للأجزاء التي نعرف أنها بدون أخطاء، وعرض معلومات تنقيح عن الأجزاء التي بها مشاكل فقط، ففي مثالنا هنا نريد أن نعرف وظيفة أمر <code>w</code>، فنضع إشارة بدء التنقيح قبله وإنهاء التنقيح بعده، كما يلي:<syntaxhighlight lang="bash">
 +
set -x # بدء التنقيح من هنا
 +
w
 +
set +x # إيقاف التنقيح من هنا
 +
</syntaxhighlight>وسيكون خرج البرنامج  هكذا:<syntaxhighlight lang="text">
 +
wiki@hsoub:~/scripts$ commented-script1.sh
 +
 +
The script starts now.
 +
Hi, wiki!
 +
 +
I will now fetch you a list of connected users:
 +
 +
+ w
 +
16:15:53 up  2:10,  1 user,  load average: 1.27, 1.47, 1.11
 +
USER      TTY      FROM            LOGIN@  IDLE  JCPU  PCPU WHAT
 +
wiki      tty7    :0              14:05    2:10m  1:34  0.21s /usr/li
 +
+ set +x
 +
 +
I'm setting two variables now.
 +
This is a string: black
 +
And this is a number: 9
 +
 +
I'm giving you back your prompt now.
 +
 +
wiki@hsoub:~/scripts$
 +
 +
</syntaxhighlight>تستطيع إيقاف وتشغيل وضع التنقيح كما تشاء داخل نفس البرنامج بدون حد أقصى لمرات استخدامه. انظر الجدول أدناه حيث تجد بعض الخيارات المفيدة للصدفة:
 +
 +
نظرة عامة على خيارات أمر التنقيح <code>set</code>
 +
{| class="wikitable"
 +
!الشكل المختصر
 +
!الشكل المفصّل
 +
!النتيجة
 +
|-
 +
|<code>set -f</code>
 +
|<code>set -o noglob</code>
 +
|يعطل توليد اسم الملف باستخدام المحارف الخاصة (التجميع globbing).
 +
|-
 +
|<code>st -v</code>
 +
|<code>set -o verbose</code>
 +
|يطبع أسطر مدخلات الصدفة كما تُقرأ.
 +
|-
 +
|<code>set -x</code>
 +
|<code>set -o xtrace</code>
 +
|يطبع آثار الأمر قبل تنفيذه.
 +
|}
 +
تُستخدم الشَّرطة <code>-</code> لتفعيل خيار الصدفة وعلامة الإضافة <code>+</code> لإيقاف تفعيلها، انتبه كي لا تخلط بين العلامتين. انظر المثال التالي لتوضيح استخدامهما:<syntaxhighlight lang="bash">
 +
wiki@hsoub:~/scripts$ set -v
 +
 +
wiki@hsoub:~/scripts$ ls
 +
ls
 +
commented-scripts.sh script1.sh
 +
 +
wiki@hsoub:~/scripts$ set +v
 +
set +v
 +
 +
wiki@hsoub:~/scripts$ ls *
 +
commented-script1.sh  script1.sh
 +
 +
wiki@hsoub:~/scripts$ set -f
 +
 +
wiki@hsoub:~/scripts$ ls *
 +
ls: cannot access '*': No such file or directory
 +
 +
wiki@hsoub:~/scripts$ touch *
 +
 +
wiki@hsoub:~/scripts$ ls
 +
*  commented-script1.sh  script1.sh
 +
 +
wiki@hsoub:~/scripts$ rm *
 +
 +
wiki@hsoub:~/scripts$ ls
 +
commented-script1.sh  script1.sh
 +
 +
wiki@hsoub:~/scripts$
 +
 +
</syntaxhighlight>ويمكنك تحديد تلك الأوضاع داخل شيفرة البرنامج نفسه بإضافة الخيارات التي تريدها إلى تصريح الصدفة في السطر الأول -يمكنك جمع الخيارات معًا تمامًا مثل أوامر يونكس- :<syntaxhighlight lang="bash">
 +
#!/bin/bash -xv
 +
 +
 +
</syntaxhighlight>وبمجرد أن تجد ذلك الجزء الذي يسبب مشكلة في شيفرتك، يمكنك حينها أن تضع أمر <code>echo</code> لعرض محتويات المتغيرات في مراحل مختلفة من الشيفرة كي تضع يدك على الأخطاء:<syntaxhighlight lang="bash">
 +
echo "Variable VARNAME is now set to $VARNAME."
 +
 +
</syntaxhighlight>
  
−
== التنقيح على مستوى البرنامج ككل ==
+
== انظر أيضًا ==
−
حين تحدث مشكلة في البرنامج الذي كتبته فإنك في حاجة إلى وضع يدك على مكان المشكلة بالتحديد داخل الشيفرة، وتوفر Bash مزايا تنقيح شاملة لعل أشهرها هو بدء صدفة فرعية بخيار <code>x-</code> الذي سيبدأ الصدفة بالكامل في طور التنقيح، وستُطبَع آثار كل أمر إضافة إلى وسائطه (arguments) إلى خَرج قياسي (standard output) بعد توسيع الأوامر لكن قبل تنفيذها.
+
* [[Bash/types of variables|أنواع المتغيرات في Bash]].
 +
* [[Bash/array variables|المصفوفات في Bash]].
 +
* [[Bash/regular expressions|التعابير النمطية في Bash]].
  
−
الشيفرة التالية هي لبرنامج <code>commented-script1.sh</code> من مثال [[Bash/script basics|أساسيات كتابة برامج Bash]]، وقد استدعينا الصدفة في طور التنقيح (debug mode)، لاحظ أن التعليقات المضافة ليست مرئية في خرج البرنامج:
+
== مصادر ==
 +
* [http://tldp.org/LDP/Bash-Beginners-Guide/html/sect_02_03.html دليل Bash للمبتدئين، <span>صفحة تنقيح برامج Bash </span>].
 +
[[تصنيف:Bash]]
 +
[[تصنيف:Bash Debugging Scripts]]
 +
[[تصنيف:Bash Options]]

المراجعة الحالية بتاريخ 07:55، 8 سبتمبر 2018

التنقيح على مستوى البرنامج ككل

حين تحدث مشكلة في البرنامج الذي كتبته فإنك في حاجة إلى وضع يدك على مكان المشكلة بالتحديد داخل الشيفرة، وتوفر Bash مزايا تنقيح شاملة لعل أشهرها هو بدء صدفة فرعية بخيار x- الذي سيبدأ الصدفة بالكامل في طور التنقيح، وستُطبَع آثار كل أمر إضافة إلى وسائطه (arguments) إلى خَرج قياسي (standard output) بعد توسيع الأوامر لكن قبل تنفيذها.

الشيفرة التالية هي لبرنامج commented-script1.sh من مثال أساسيات كتابة برامج Bash، وقد استدعينا الصدفة في طور التنقيح (debug mode)، لاحظ أن التعليقات المضافة ليست مرئية في خرج البرنامج:

wiki@hsoub:~/scripts$ bash -x script1.sh
+ clear

+ echo 'The script starts now.'
The script starts now.
+ echo 'Hi, wiki!'
Hi, wiki!
+ echo

+ echo 'I will now fetch you a list of connected users:'
I will now fetch you a list of connected users:
+ echo

+ w
 13:46:40 up 24 min,  1 user,  load average: 0.54, 0.33, 0.23
USER     TTY      FROM             LOGIN@   IDLE   JCPU   PCPU WHAT
wiki       tty7     :0               13:22   23:56  24.22s  0.21s /usr/li
+ echo

+ echo 'I'\''m setting two variables now.'
I'm setting two variables now.
+ COLOUR=black
+ VALUE=9
+ echo 'This is a string: black'
This is a string: black
+ echo 'And this is a number: 9'
And this is a number: 9
+ echo

+ echo 'I'\''m giving you back your prompt now.'
I'm giving you back your prompt now.
+ echo

wiki@hsoub:~/scripts$

ويوجد الآن منقِّح للصدفة به مزايا متطورة متاح على SourceForge، وتلك المزايا موجودة في أغلب الإصدارات الحديثة في الصدفة بدءًا من إصدار 3.1 .

تنقيح أجزاء من الصدفة

لنقل أنك لا تعرف ما يفعله أمر w في مثال commented-script1.sh، فنستخدم حينها أمر set لتشغيل البرنامج في الوضع العادي للأجزاء التي نعرف أنها بدون أخطاء، وعرض معلومات تنقيح عن الأجزاء التي بها مشاكل فقط، ففي مثالنا هنا نريد أن نعرف وظيفة أمر w، فنضع إشارة بدء التنقيح قبله وإنهاء التنقيح بعده، كما يلي:

set -x			# بدء التنقيح من هنا
w
set +x			# إيقاف التنقيح من هنا

وسيكون خرج البرنامج هكذا:

wiki@hsoub:~/scripts$ commented-script1.sh

The script starts now.
Hi, wiki!

I will now fetch you a list of connected users:

+ w
 16:15:53 up  2:10,  1 user,  load average: 1.27, 1.47, 1.11
USER       TTY      FROM             LOGIN@   IDLE   JCPU   PCPU WHAT
wiki       tty7     :0               14:05    2:10m  1:34   0.21s /usr/li
+ set +x

I'm setting two variables now.
This is a string: black
And this is a number: 9

I'm giving you back your prompt now.

wiki@hsoub:~/scripts$

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

نظرة عامة على خيارات أمر التنقيح set

الشكل المختصر الشكل المفصّل النتيجة
set -f set -o noglob يعطل توليد اسم الملف باستخدام المحارف الخاصة (التجميع globbing).
st -v set -o verbose يطبع أسطر مدخلات الصدفة كما تُقرأ.
set -x set -o xtrace يطبع آثار الأمر قبل تنفيذه.

تُستخدم الشَّرطة - لتفعيل خيار الصدفة وعلامة الإضافة + لإيقاف تفعيلها، انتبه كي لا تخلط بين العلامتين. انظر المثال التالي لتوضيح استخدامهما:

wiki@hsoub:~/scripts$ set -v

wiki@hsoub:~/scripts$ ls
ls
commented-scripts.sh	script1.sh

wiki@hsoub:~/scripts$ set +v
set +v

wiki@hsoub:~/scripts$ ls *
commented-script1.sh  script1.sh

wiki@hsoub:~/scripts$ set -f

wiki@hsoub:~/scripts$ ls *
ls: cannot access '*': No such file or directory

wiki@hsoub:~/scripts$ touch *

wiki@hsoub:~/scripts$ ls
*  commented-script1.sh  script1.sh

wiki@hsoub:~/scripts$ rm *

wiki@hsoub:~/scripts$ ls
commented-script1.sh  script1.sh

wiki@hsoub:~/scripts$

ويمكنك تحديد تلك الأوضاع داخل شيفرة البرنامج نفسه بإضافة الخيارات التي تريدها إلى تصريح الصدفة في السطر الأول -يمكنك جمع الخيارات معًا تمامًا مثل أوامر يونكس- :

#!/bin/bash -xv

وبمجرد أن تجد ذلك الجزء الذي يسبب مشكلة في شيفرتك، يمكنك حينها أن تضع أمر echo لعرض محتويات المتغيرات في مراحل مختلفة من الشيفرة كي تضع يدك على الأخطاء:

echo "Variable VARNAME is now set to $VARNAME."

انظر أيضًا

مصادر

مجلوبة من "https://wiki.hsoub.com/index.php?title=Bash/debugging_Bash_scripts&oldid=17101"