درس ۲۳: مدیریت خطا در پایتون: Exception ،Traceback و Exception Handling¶

مقدمه¶

بروز خطا (Error) همواره جزیی از برنامه‌نویسی بوده و هست. خطاهای برنامه‌نویسی انواع گوناگونی دارند؛ «خطاهای زمان کامپایل» (Compile-time errors) که آنقدر فاحش هستند که مانع از ترجمه کدهای برنامه به زبان ماشین و در نهایت اجرای آن خواهند شد و برخی دیگر که می‌توانند آنقدر ناقلا باشند که تا مدت‌ها پس از اجرا نیز خودشان را نشان ندهند! به این دسته از خطاها به اصطلاح «خطاهای زمان اجرا» (Runtime errors) می‌گویند.

«خطاهای زمان کامپایل» (Compile-time errors) حاصل اشتباه فاحش برنامه‌نویس بوده و معمولا نیز کشف و برطرف نمودن آن‌ها نیز بسیار ساده می‌باشد و از عدم رعایت درست قواعد زبان برنامه‌نویسی مانند سینتکس نشات می‌گیرند.

اما بروز «خطاهای زمان اجرا» (Runtime errors) می‌تواند به عوامل گوناگونی وابسته باشد همانند دخالت یک عامل بیرونی یا مشکلات سخت‌افزاری که ناگهان به برنامه تحمیل می‌گردند که اگر از فرض این احتمال نیز صرف نظر کنیم!، باز هم برای دفاع در برابر این دسته از خطاها، برنامه‌نویس می‌بایست کاملا هوشیار باشد. به خصوص در زبان‌های برنامه‌نویسی پویا به مانند پایتون که انواع داده در زمان اجرا تعیین می‌گردند. برای مثال فرض کنید در داخل یک تابع قرار است با یک نوع int کار شود ولی به علت ضعف برنامه‌نویسی و عدم کنترل ورودی‌ها، یک داده با نوع str به آن ارسال گردد که در این صورت نتیجه مشخص است! البته جلوگیری از این دست خطاها نیز همچنان ساده می‌باشد!. گاهی ممکن است وضعیت آنچنان مهلک باشد که یا خیلی دیر به وجود یک خطا در برنامه پی ببریم یا برای کشف علت آن زمان زیادی صرف کنیم یا هر دو! به این نوع از خطاهای زمان اجرا، «خطاهای منطقی» (Logical errors) گفته می‌شود.

«خطاهای منطقی» (Logical errors) برخلاف دیگر خطاها باعث توقف اجرای برنامه نشده بلکه باعث تولید نتایج نادرستی می‌شوند که از دیدگاه برنامه‌نویسی درست بوده ولی از دیدگاه منطقی کاملا اشتباه هستند. به عنوان یک مثال ساده فرض کنید فرمول محاسبه معدل اشتباه پیاده‌سازی شده باشد! این نوع خطا مصداق بارز «باگ» (Bug) در برنامه است که همیشه پیشگیری، از کشف و اصلاح آن‌ها به مراتب ساده‌تر خواهد بود.

با وجود این توضیحات و همانطور که مشاهده خواهید کرد، بروز خطا همواره یک امر زشت و ناخواسته نبوده بلکه گاهی نیز یک استراتژی از سوی برنامه‌نویس خواهد بود تا یک وضعیت را به سطوح دیگر از برنامه اعلام یا اینکه مستقیما تغییری در روند اجرای برنامه ایجاد کند. در این صورت خطاها دیگر با نام زشت خطا خوانده نمی‌شوند بلکه به آنها استثنا یا اعتراض یا Exception می‌گویند.

به صورت کلی، Exception امکانی برای خروج برنامه از یک وضعیت مشخص است و بروز آن، همانند اعلام عمومی یک خبر مهم در برنامه می‌باشد. می‌توان با پیش‌بینی بروز Exceptionها در برنامه، به اصطلاح آن‌ها را catch نمود و فرآیندی - یا به اصطلاح یک handler - را برای مدیریت آن‌ها پیاده‌سازی کرد.

درک وقوع یک Exception و امکان ایجاد یک فرآیند برای مدیریت آن (پیاده‌سازی handler)، قابلیت مهمی در یک زبان‌برنامه‌نویسی محسوب می‌شود. چرا که می‌توان از Exception در دو نقش زیر بهره گرفت:

۱) مدیریت خطا (Error handling): هر Exception می‌تواند معرف یک نوع خطا یا وضعیتی نادرست در برنامه باشد، می‌توان بر اساس نوع Exception و خطایی که رخ داده برای آن از پیش چاره‌اندیشی و فرآیندی را برای مدیریت آن خطا در برنامه پیش‌بینی کرد.

۲) اطلاع‌رسانی یک رویداد (Event notification): از Exceptionها می‌توان برای اعلام وقوع یک حادثه مثبت نیز در برنامه استفاده کرد. به این صورت می‌توان در زمان اجرای برنامه و بر حسب شرایط، روند اجرای برنامه را تغییر داد.

اما مفهوم خطا در زبان برنامه‌نویسی پایتون چگونه است؟ انواع خطاها در پایتون را می‌توان در دو دسته کلی زیر در نظر گرفت:

• خطای سینتکس (Syntax error)

• خطای زمان اجرا (Runtime error)

برای درک این دسته‌بندی و مطابقت دادن آن با توضیحات پیش لازم است تا بار دیگر به روند اجرای کدهای پایتون توجه نماییم (درس سوم - پشت صحنه اجرا). می‌دانیم پایتون یک زبان مفسری است، ولی پیش‌ از اجرا، کدهای پایتون به یک زیان میانی به نام بایت‌کد (ByteCode) ترجمه یا کامپایل می‌شوند؛ در این مرحله قواعد پایتون بررسی و در صورتی که مشکل یا خطایی وجود نداشته باشد، بایت‌کد ایجاد و به اجرا در می‌آید. خطاهایی که در این مرحله (یعنی تلاش برای ترجمه و ایجاد بایت‌کد) ممکن است رخ دهند، در پایتون خطای سینتکس (Syntax error) نامیده می‌شوند.

زمانی که برنامه پایتونی به اجرا درمی‌آید، یعنی از نظر رعایت قوانین یا سینتکس مشکلی وجود نداشته است، بنابراین باقی خطاها در زمان اجرا رخ خواهند داد. در زبان برنامه‌نویسی پایتون تمام خطاهای زمان اجرا در قالب یک Exception اعلام یا به اصطلاح raise خواهند شد.

ردیابی خطا در پایتون (Traceback)¶

پس از وقوع یک خطا در زمان اجرای یک برنامه پایتونی، برای ردیابی و کشف علت رخ دادن آن خطا از Traceback استفاده می‌گردد. منظور از Traceback، گزارشی است که جهت راهنمایی برنامه‌نویس در هنگام وقوع یک خطای زمان اجرا، توسط مفسر پایتون ارائه داده می‌شود و گاهی نیز از آن به عنوان Stack Trace یاد می‌شود:

1def sum_int(a, b):
2    return a + b
3
4res = sum_int(2, 3)
5print(res)
6
7res = sum_int(3, 'C')
8print(res)

5
Traceback (most recent call last):
  File "sample.py", line 7, in <module>
    res = sum_int(3, 'C')
  File "sample.py", line 2, in sum_int
    return a + b
TypeError: unsupported operand type(s) for +: 'int' and 'str'

نمونه کد بالا نمایش مثالی از بروز خطا در زمان اجراست که پیش‌تر نیز به آن اشاره کردیم. در این مثال، یک اسکریپت با نام sample.py ایجاد کرده‌ایم که کد بالا در آن درج گردیده است. تابع sum_int یک بار با مقدار قابل پذیریش (هر دو از نوع int) فراخوانی می‌گردد (سطر ۴) و نتیجه (یعنی مقدار 5) نیز با موفقیت در خروجی چاپ می‌گردد (توسط دستور موجود در سطر ۵). اما در سطر هفتم، آرگومان‌هایی با نوع نامتناسب برای عملگر جمع ریاضی (+) ارسال می‌گردد و باعث بروز یک خطا یا اگر بهتر بگوییم، raise شدن یک Exception به نام TypeError می‌گردد.

خروجی حاصل از وقوع Exception فوق نمایش Traceback در پایتون می‌باشد. Traceback پایتون یک راهنمایی کامل از نوع Exception و مراتب وقوع آن را به برنامه‌نویس گزارش می‌دهد که درک درست آن یک الزام برای برنامه‌نویسی می‌باشد.

برخلاف برخی دیگر از زبان‌های برنامه‌نویسی به مانند Java باید توجه داشت که Traceback پایتون را می‌بایست از پایین، یعنی سطر پایانی مورد بررسی قرار داد، این سطر توضیحی از نوع Exception رخ داده را ارائه می‌دهد و از این سطر به بالا مراحلی از روند اجرای برنامه که باعث بروز این Exception شده است را به ترتیب نمایش می‌دهد. ترتیب نمایش مراتب Exception نیز، از نمایش نقطه بروز Exception به قبل می‌باشد. به عنوان نمونه برای مثال قبل، می‌توانیم مشاهده کنیم که گفته شده:

• نوع Exception چیست؟ Exception از نوع TypeError می‌باشد که در زمان استفاده از انواع نادرست از مقادیر برای عملگر + رخ داده است که در اینجا، این دو نوع عبارتند از: 'int' and 'str'.

• Exception در کجا رخ داده است؟‌ در سطر دوم از sample.py و داخل بدنه sum_int و هنگام اجرای دستور return a + b.

• نقطه قبل از ورود به ناحیه Exception کجا بوده است؟ در سطر هفتم از sample.py و داخل حوزه ماژول، تابع sum_int با مقادیر 3 و 'C' فراخوانی شده است:‌ res = sum_int(3, 'C').

• آیا نقطه قبل‌تری نیز وجود دارد؟ خیر

پایتون تا چندین سطح قبل‌تر از نقطه بروز Exception را توسط Traceback آشکار می‌کند. این امر کمک بسیاری در فهمیدن مسیر رسیدن به Exception را در اختیار برنامه‌نویس قرار می‌دهد.

اکنون اجازه دهید نمونه کد مربوط به مثال قبل یعنی اسکریپت sample.py را با حفظ مشکل TypeError و افزودن کمی تغییر برای نمایش خطای سینتکس (Syntax error) آماده نماییم، بر همین اساس به نمونه کد زیر که حاوی دو خطا از نوع Syntax error می‌باشد و خروجی آن در زمان اجرا توجه نمایید:

 1def sum_int(a, b)
 2    return a + b
 3
 4res = sum_int(2, 3)
 5print(res)
 6
 7res = sum_int(3, 'C')
 8print(res)
 9
10
11'

File "sample.py", line 1
    def sum_int(a, b)
                    ^
SyntaxError: invalid syntax

در نخستین بار اجرای اسکریپت sample.py، پایتون متوجه یک خطای SyntaxError در سطر یکم می‌شود و جلوی مراحل تبدیل به بایت‌کد و در نهایت اجرای برنامه را در همان نقطه می‌گیرد. طبق توضیحات چاپ شده، خطا مربوط به عدم رعایت سینتکس درست برای تعریف تابع می‌باشد. کاراکتر ^ به جایگاه نادرست اشاره می‌کند. در انتهای تعریف سرآیند تابع اشکالی وجود دارد که با کمی دقت می‌توان دریافت که علت به عدم وجود کاراکتر انتهایی سرآیند تابع در پایتون یعنی : می‌باشد. این مورد را اصلاح کرده و دوباره اقدام به اجرای اسکریپت sample.py می‌نماییم:

 1def sum_int(a, b):
 2    return a + b
 3
 4res = sum_int(2, 3)
 5print(res)
 6
 7res = sum_int(3, 'C')
 8print(res)
 9
10
11'

File "sample.py", line 11
    '
    ^
SyntaxError: EOL while scanning string literal

این‌بار فرآیند اجرای برنامه در نقطه‌ای دیگر متوقف می‌گردد، سطر یازدهم از sample.py. این خطا نیز از نوع SyntaxError می‌باشد ولی با توضیحی متفاوت. متن خطا می‌گوید که نحوه قرار گرفتن کاراکتر ' اشتباه است. سطر یازدهم با یک کاراکتر کوتیشن پایان یافته که جفت آن و نیز عبارت یا دستوری مرتبط با آن در سطر مذکور موجود نمی‌باشد.

با اصلاح این مشکل، برنامه از حالت SyntaxError خارج شده و کد اسکریپت sample.py با موفقیت به بایت‌کد ترجمه و به اجرا درمی‌آید. اکنون در زمان اجرا، با TypeError که پیش‌تر بررسی کردیم برخورد خواهیم کرد!

این نکته را نیز در نظر بگیرید - همانطور که اگر به خروجی‌های دقت کرده باشید حتما متوجه شده‌اید در دو حالت مربوط به گزارش خطای مربوط به SyntaxError خبری از سطر زیر که در حالت خطای زمان اجرای TypeError مشاهده کردیم، نمی‌باشد:

Traceback (most recent call last):

در واقع این سطر تنها در گزارش خطاهایی که پس از اجرای برنامه رخ دهند (Runtime errors)، نمایش داده خواهد شد. در زمان بررسی و ترجمه کد پایتون به بایت‌کد هرجا مشکلی باشد عملیات در همان نقطه متوقف می‌شود و صرفا گزارشی مبنی بر ابراز آن نقطه به برنامه‌نویس ارايه می‌گردد و نه چیزی که بتوان آن را یک گزارش ردیابی با Traceback نامید چرا که هنوز برنامه به اجرا درنیامده و اصلا نیازی به این کار نیست!

مدیریت خطا (Exception Handling)¶

در زبان‌های برنامه‌نویسی صدای اعتراض یک Exception قابل درک و تشخیص است و می‌توان برای آن‌ها فرآیندی را پیش‌بینی کرد که بروز آن‌ها نه تنها باعث اتمام برنامه نشود بلکه برنامه بتواند در مسیر درست به اجرای خود ادامه دهد.

در زبان برنامه‌نویسی پایتون دستور try/except برای همین منظور فراهم دیده شده است [اسناد پایتون] و در ادامه به بررسی انواع ساختار قابل پیاده‌سازی از این دستور خواهیم پرداخت.

try:
    pass

except:
    pass

>>> def print_int_sum(a, b):
...     try:
...         print(a + b)
...     except:
...         print(f'ERROR: {a}+{b}')
...
>>> print_int_sum(2, 3)
5
>>> print_int_sum(9, 3)
12
>>> print_int_sum(5, 'D')
ERROR: 5+D

1def print_int_sum(a, b):
2
3    try:
4        print(a + b)
5
6    except TypeError:
7        print(f'ERROR: {a}+{b}')

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except TypeError:
 9        print(f'TypeError: ({a}+{b!r})/{a}')
10
11    except:
12        print(f'OTHER ERROR: ({a}+{b!r})/{a}')
13
14
15print_sum_div_first(5, 6)
16print_sum_div_first(3, 'G')
17print_sum_div_first(0, 8)

2.2
TypeError: (3+'G')/3
OTHER ERROR: (0+8)/0

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except TypeError:
 9        print(f'TypeError: ({a}+{b!r})/{a}')
10
11    except ZeroDivisionError:
12        print(f'ZeroDivisionError: ({a}+{b!r})/{a}')
13
14
15print_sum_div_first(5, 6)
16print_sum_div_first(3, 'G')
17print_sum_div_first(0, 8)

2.2
TypeError: (3+'G')/3
ZeroDivisionError: (0+8)/0

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except (TypeError, ZeroDivisionError):
 9        print(f'Error: ({a}+{b!r})/{a}')
10
11
12print_sum_div_first(5, 6)
13print_sum_div_first(3, 'G')
14print_sum_div_first(0, 8)

2.2
Error: (3+'G')/3
Error: (0+8)/0

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except TypeError as te:
 9        print(f'{te.__class__.__name__}: ({a}+{b!r})/{a}')
10
11    except ZeroDivisionError as zde:
12        print(f'{zde.__class__.__name__}: ({a}+{b!r})/{a}')
13
14
15print_sum_div_first(5, 6)
16print_sum_div_first(3, 'G')
17print_sum_div_first(0, 8)

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except (TypeError, ZeroDivisionError) as err:
 9        print(f'{err.__class__.__name__}: ({a}+{b!r})/{a}')
10
11print_sum_div_first(5, 6)
12print_sum_div_first(3, 'G')
13print_sum_div_first(0, 8)

2.2
TypeError: (3+'G')/3
ZeroDivisionError: (0+8)/0

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6        print(div)
 7
 8    except Exception as err:
 9        print(f'{err.__class__.__name__}: ({a}+{b!r})/{a}')
10
11print_sum_div_first(5, 6)
12print_sum_div_first(3, 'G')
13print_sum_div_first(0, 8)

2.2
TypeError: (3+'G')/3
ZeroDivisionError: (0+8)/0

 1def print_sum_div_first(a, b):
 2
 3    try:
 4        sum = a + b
 5        div = sum / a
 6
 7    except Exception as err:
 8        print(f'{err.__class__.__name__}: ({a}+{b!r})/{a}')
 9
10    else:
11        print(f'result: ({a}+{b!r})/{a} = {div}')
12
13print_sum_div_first(5, 6)
14print_sum_div_first(3, 'G')
15print_sum_div_first(0, 8)

result: (5+6)/5 = 2.2
TypeError: (3+'G')/3
ZeroDivisionError: (0+8)/0

 1def write_to_log(text, write_mode):
 2    try:
 3        output = open('log_file.txt', write_mode)
 4        output.write(text)
 5
 6    except FileNotFoundError as fnfe:
 7        print('File Not Found!!!')
 8
 9    else:
10        output.close()
11        print('Successful, closed!')
12
13
14write_to_log('A text to insert in the log file', 'r') # WRONG mode!
15print('*' * 30)
16write_to_log('A text to insert in the log file', 'a')

File Not Found!!!
******************************
Successful, closed!

 1def print_sum_div_first(a, b):
 2    try:
 3        sum = a + b
 4        div = sum / a
 5        return 'Successful'
 6
 7    except Exception as err:
 8        return 'Failed'
 9
10    else:
11        return 'Successful, from else!'
12
13result = print_sum_div_first(5, 6)   # Successful
14print(result)
15
16result = print_sum_div_first(3, 'G') # Failed
17print(result)

Successful
Failed

 1def print_sum_div_first(a, b):
 2    try:
 3        print('----> try')
 4        sum = a + b
 5        div = sum / a
 6
 7    except Exception as err:
 8        print('----> except')
 9
10    else:
11        print('----> else')
12
13    finally:
14        print('----> finally')
15
16
17print_sum_div_first(5, 6)
18print('*' * 20)
19print_sum_div_first(3, 'G')

----> try
----> else
----> finally
********************
----> try
----> except
----> finally

 1def print_sum_div_first(a, b):
 2    try:
 3        sum = a + b
 4        div = sum / a
 5
 6    except TypeError as err:
 7        print(f'{err.__class__.__name__}: ({a}+{b!r})/{a} =', (a+b)/a)
 8
 9    finally:
10        print('----> finally')
11
12
13print_sum_div_first(5, 6)
14print('*' * 20)
15print_sum_div_first(3, 'G')

----> finally
********************
----> finally
Traceback (most recent call last):
  File "sample.py", line 3, in print_sum_div_first
    sum = a + b
TypeError: unsupported operand type(s) for +: 'int' and 'str'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "sample.py", line 15, in <module>
    print_sum_div_first(3, 'G')
  File "sample.py", line 7, in print_sum_div_first
    print(f'{err.__class__.__name__}: ({a}+{b!r})/{a} =', (a+b)/a)
TypeError: unsupported operand type(s) for +: 'int' and 'str'

 1def print_sum_div_first(a, b):
 2    try:
 3        sum = a + b
 4        div = sum / a
 5        return 'Successful'
 6
 7    except Exception as err:
 8        return 'Failed'
 9
10    else:
11        return 'Successful, from else!'
12
13    finally:
14        return '---------->finally!'
15
16result = print_sum_div_first(5, 6)   # Successful
17print(result)
18
19result = print_sum_div_first(3, 'G') # Failed
20print(result)

---------->finally!
---------->finally!

 1def print_sum_div_first(a, b):
 2    try:
 3        sum = a + b
 4        div = sum / a
 5        print(f'----> Result: {div}')
 6
 7    finally:
 8        print('--------> Finished!')
 9
10
11print_sum_div_first(5, 6)
12print('*' * 30)
13print_sum_div_first(3, 'G')

----> Result: 2.2
--------> Finished!
******************************
--------> Finished!
Traceback (most recent call last):
  File "sample.py", line 13, in <module>
    print_sum_div_first(3, 'G')
  File "sample.py", line 3, in print_sum_div_first
    sum = a + b
TypeError: unsupported operand type(s) for +: 'int' and 'str'

 1def print_sum_div_first(a, b):
 2    try:
 3        sum = a + b
 4        div = sum / a
 5        print(f'----> Result: {div}')
 6
 7    finally:
 8        print('--------> Finished!')
 9        return None
10
11
12print_sum_div_first(5, 6)
13print('*' * 30)
14print_sum_div_first(3, 'G')

----> Result: 2.2
--------> Finished!
******************************
--------> Finished!

 1def print_sum_div_first(a, b):
 2    sum = a + b
 3    div = sum / a
 4    print(div)
 5
 6
 7def action(a, b):
 8    try:
 9        if isinstance(a, int):
10           print_sum_div_first(a, b)
11
12    except ZeroDivisionError as err:
13        print(f'[action function ERROR!!!] {err.__class__.__name__}')
14
15
16try:
17    action(5, 6)    # Successfully
18    action(0, 8)    # raise ZeroDivisionError
19    action(3, 'G')  # raise TypeError
20
21except Exception as err:
22    print(f'[module ERROR!!!] {err.__class__.__name__}')

2.2
[action function ERROR!!!] ZeroDivisionError
[module ERROR!!!] TypeError

try:
    with ContextManager():
        do_something()
except Exception as err:
    pass

try:
    context_manager = ContextManager()

except Exception as err:
    # Handler for: '__init__'

else:
    try:
        with context_manager:
            try:
                do_something()

            except Exception as err:
                # Handler for: 'with' body

    except Exception as err:
        # Handler for: '__enter__' and '__exit__'

Exception Hierarchy¶

در زبان برنامه‌نویسی پایتون تمامی Exceptionهای از پیش آماده در قالب کلاس‌هایی در یک سلسله مراتب از وراثت ارايه شده است. برای مشاهده این کلاس‌ها و ساختار وراثت آن‌ها می‌توانید به اسناد پایتون مراجعه نمایید:‌ Exception hierarchy - این ساختار توسط تصویر پایین نمایش داده شده است:

کلاس BaseException در بالاترین سطح وراثت برای این دست کلاس‌ها قرار دارد و تمامی Exceptionها به صورت مستقیم یا غیر مستقیم از آن ارث‌بری دارند. از این بین تنها چهار کلاس هستند که مستقیم از BaseException ارث‌بری دارند:

• کلاس SystemExit [اسناد پایتون]: هرگاه به برنامه پایتونی با اراده برنامه‌نویس و با استفاده از تابع exit از ماژول sys [اسناد پایتون] فرمان توقف صادر شود، این Exception رخ خواهد داد.

• کلاس KeyboardInterrupt [اسناد پایتون]: هرگاه با استفاده از صفحه‌کلید (Keyboard) اقدام به توقف ناگهانی برنامه پایتون نماییم - معمولا با استفاده از کلیدهای ترکیبی:‌ Control+C، این Exception رخ خواهد داد.

• کلاس GeneratorExit [اسناد پایتون]: این Exception در زمانی که یک Generator (درس سیزدهم) بسته (Close) می‌شود [اسناد پایتون]، رخ می‌دهد.

• کلاس Exception [اسناد پایتون]: می‌توان این‌گونه شرح داد که این کلاس، supperclass تمام Exceptionها به غیر از سه مورد قبلی است!

except:

except BaseException as error:

😊 امیدوارم مفید بوده باشه