اشکال‌زدایی کروتین‌های پایتون: تسلط بر حالت اشکال‌زدایی Asyncio

برنامه‌نویسی ناهمزمان با asyncio در پایتون، به ویژه برای عملیات I/O-bound، مزایای قابل توجهی در عملکرد ارائه می‌دهد. با این حال، اشکال‌زدایی کد ناهمزمان به دلیل جریان اجرای غیرخطی آن می‌تواند چالش‌برانگیز باشد. پایتون حالت اشکال‌زدایی داخلی برای asyncio ارائه می‌دهد که می‌تواند فرآیند اشکال‌زدایی را به طور قابل توجهی ساده کند. این راهنما چگونگی استفاده مؤثر از حالت اشکال‌زدایی asyncio برای شناسایی و حل مشکلات رایج در برنامه‌های ناهمزمان شما را بررسی خواهد کرد.

درک چالش‌های برنامه‌نویسی ناهمزمان

قبل از ورود به حالت اشکال‌زدایی، مهم است که چالش‌های رایج در اشکال‌زدایی کد ناهمزمان را درک کنید:

• اجرای غیرخطی: کد ناهمزمان به صورت متوالی اجرا نمی‌شود. کروتین‌ها کنترل را به حلقه رویداد باز می‌گردانند، که ردیابی مسیر اجرا را دشوار می‌کند.
• تعویض زمینه (Context Switching): تعویض مکرر زمینه بین وظایف می‌تواند منبع خطا را پنهان کند.
• انتشار خطا (Error Propagation): خطاها در یک کروتین ممکن است بلافاصله در کروتین فراخواننده آشکار نباشند، که تشخیص علت اصلی را دشوار می‌کند.
• شرایط رقابتی (Race Conditions): منابع مشترکی که به طور همزمان توسط چندین کروتین دسترسی دارند، می‌توانند منجر به شرایط رقابتی شوند و رفتار غیرقابل پیش‌بینی ایجاد کنند.
• بن‌بست (Deadlocks): کروتین‌هایی که منتظر یکدیگر برای همیشه هستند، می‌توانند باعث بن‌بست شوند و برنامه را متوقف کنند.

معرفی حالت اشکال‌زدایی Asyncio

حالت اشکال‌زدایی asyncio بینش‌های ارزشمندی در اجرای کد ناهمزمان شما ارائه می‌دهد. این حالت ویژگی‌های زیر را دارد:

• ورود به سیستم دقیق (Detailed Logging): رویدادهای مختلف مربوط به ایجاد، اجرا، لغو و مدیریت خطا در کروتین‌ها را ثبت می‌کند.
• هشدار منابع (Resource Warnings): سوکت‌های باز نشده، فایل‌های باز نشده و سایر نشتی‌های منبع را تشخیص می‌دهد.
• تشخیص بازگشت تماس (Callback) کند: بازگشت تماس‌هایی را که اجرای آن‌ها بیشتر از یک آستانه مشخص طول می‌کشد، شناسایی می‌کند و نشان‌دهنده گلوگاه‌های احتمالی عملکرد است.
• ردیابی لغو وظیفه (Task Cancellation Tracking): اطلاعاتی در مورد لغو وظایف ارائه می‌دهد و به شما کمک می‌کند تا دلیل لغو وظایف و اینکه آیا به درستی مدیریت می‌شوند را درک کنید.
• زمینه خطا (Exception Context): زمینه بیشتری را به خطاها (exceptions) که در درون کروتین‌ها رخ می‌دهند، ارائه می‌دهد و ردیابی خطا را به منبع آن آسان‌تر می‌کند.

فعال کردن حالت اشکال‌زدایی Asyncio

شما می‌توانید حالت اشکال‌زدایی asyncio را به چندین روش فعال کنید:

۱. استفاده از متغیر محیطی PYTHONASYNCIODEBUG

ساده‌ترین راه برای فعال کردن حالت اشکال‌زدایی، تنظیم متغیر محیطی PYTHONASYNCIODEBUG به 1 قبل از اجرای اسکریپت پایتون شماست:

            export PYTHONASYNCIODEBUG=1
python your_script.py
            

              
                Copy
              
            
          

این کار حالت اشکال‌زدایی را برای کل اسکریپت فعال می‌کند.

۲. تنظیم پرچم اشکال‌زدایی در asyncio.run()

اگر از asyncio.run() برای شروع حلقه رویداد خود استفاده می‌کنید، می‌توانید آرگومان debug=True را ارسال کنید:

            import asyncio

async def main():
    print("Hello, asyncio!")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

۳. استفاده از loop.set_debug()

شما همچنین می‌توانید حالت اشکال‌زدایی را با دریافت نمونه حلقه رویداد و فراخوانی set_debug(True) فعال کنید:

            import asyncio

async def main():
    print("Hello, asyncio!")

if __name__ == "__main__":
    loop = asyncio.get_event_loop()
    loop.set_debug(True)
    loop.run_until_complete(main())

            

              
                Copy
              
            
          

تفسیر خروجی اشکال‌زدایی

پس از فعال شدن حالت اشکال‌زدایی، asyncio پیام‌های ورود به سیستم دقیقی را تولید خواهد کرد. این پیام‌ها اطلاعات ارزشمندی در مورد اجرای کروتین‌های شما ارائه می‌دهند. در اینجا چند نوع رایج از خروجی اشکال‌زدایی و نحوه تفسیر آن‌ها آورده شده است:

۱. ایجاد و اجرای کروتین

حالت اشکال‌زدایی زمان ایجاد و شروع کروتین‌ها را ثبت می‌کند. این به شما کمک می‌کند چرخه عمر کروتین‌های خود را ردیابی کنید:

            asyncio | execute <Task pending name='Task-1' coro=<a() running at example.py:3>>
asyncio | Task-1: created at example.py:7
            

              
                Copy
              
            
          

این خروجی نشان می‌دهد که یک وظیفه به نام Task-1 در خط ۷ فایل example.py ایجاد شده و در حال حاضر در حال اجرای کروتین a() تعریف شده در خط ۳ است.

۲. لغو وظیفه

هنگامی که یک وظیفه لغو می‌شود، حالت اشکال‌زدایی رویداد لغو و دلیل لغو را ثبت می‌کند:

            asyncio | Task-1: cancelling
asyncio | Task-1: cancelled by <Task pending name='Task-2' coro=<b() running at example.py:10>>
            

              
                Copy
              
            
          

این نشان می‌دهد که Task-1 توسط Task-2 لغو شده است. درک لغو وظیفه برای جلوگیری از رفتار غیرمنتظره حیاتی است.

۳. هشدارهای منبع

حالت اشکال‌زدایی در مورد منابع باز نشده، مانند سوکت‌ها و فایل‌ها هشدار می‌دهد:

            ResourceWarning: unclosed <socket.socket fd=3, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=6, laddr=('127.0.0.1', 5000), raddr=('127.0.0.1', 60000)
            

              
                Copy
              
            
          

این هشدارها به شما کمک می‌کنند نشتی منابع را شناسایی و رفع کنید، که می‌تواند منجر به کاهش عملکرد و ناپایداری سیستم شود.

۴. تشخیص بازگشت تماس (Callback) کند

حالت اشکال‌زدایی می‌تواند بازگشت تماس‌هایی را که اجرای آن‌ها بیشتر از یک آستانه مشخص طول می‌کشد، تشخیص دهد. این به شما کمک می‌کند گلوگاه‌های عملکرد را شناسایی کنید:

            asyncio | Task was destroyed but it is pending!
pending time: 12345.678 ms

            

              
                Copy
              
            
          

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

حالت اشکال‌زدایی زمینه بیشتری را به خطاها (exceptions) که در درون کروتین‌ها رخ می‌دهند، از جمله وظیفه و کروتین که در آن خطا رخ داده است، ارائه می‌دهد:

            asyncio | Task exception was never retrieved
future: <Task finished name='Task-1' coro=<a() done, raised ValueError('Invalid value')>>
            

              
                Copy
              
            
          

این خروجی نشان می‌دهد که یک ValueError در Task-1 رخ داده و به درستی مدیریت نشده است.

نمونه‌های عملی اشکال‌زدایی با حالت اشکال‌زدایی Asyncio

بیایید به برخی نمونه‌های عملی در مورد چگونگی استفاده از حالت اشکال‌زدایی asyncio برای تشخیص مشکلات رایج نگاهی بیندازیم:

۱. تشخیص سوکت‌های باز نشده

کد زیر را که یک سوکت ایجاد می‌کند اما آن را به درستی نمی‌بندد، در نظر بگیرید:

            import asyncio
import socket

async def handle_client(reader, writer):
    data = await reader.read(100)
    message = data.decode()
    addr = writer.get_extra_info('peername')
    print(f"Received {message!r} from {addr!r}")

    print(f"Send: {message!r}")
    writer.write(data)
    await writer.drain()

    # Missing: writer.close()

async def main():
    server = await asyncio.start_server(
        handle_client,
        '127.0.0.1',
        8888
    )

    addr = server.sockets[0].getsockname()
    print(f'Serving on {addr}')

    async with server:
        await server.serve_forever()

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

هنگامی که این کد را با حالت اشکال‌زدایی فعال اجرا می‌کنید، یک ResourceWarning مبنی بر باز نشدن سوکت مشاهده خواهید کرد:

            ResourceWarning: unclosed <socket.socket fd=4, family=AddressFamily.AF_INET, type=SocketKind.SOCK_STREAM, proto=6, laddr=('127.0.0.1', 8888), raddr=('127.0.0.1', 54321)>
            

              
                Copy
              
            
          

برای رفع این مشکل، باید اطمینان حاصل کنید که سوکت به درستی بسته می‌شود، به عنوان مثال، با اضافه کردن writer.close() در تابع کروتین handle_client و فراخوانی آن:

                writer.close()
    await writer.wait_closed()
            

              
                Copy
              
            
          

۲. شناسایی بازگشت تماس‌های (Callbacks) کند

فرض کنید یک کروتین دارید که یک عملیات کند انجام می‌دهد:

            import asyncio
import time

async def slow_function():
    print("Starting slow function")
    time.sleep(2)
    print("Slow function finished")
    return "Result"

async def main():
    task = asyncio.create_task(slow_function())
    result = await task
    print(f"Result: {result}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

اگرچه خروجی اشکال‌زدایی پیش‌فرض مستقیماً بازگشت تماس‌های کند را مشخص نمی‌کند، اما ترکیب آن با ورود به سیستم دقیق و ابزارهای پروفایلینگ (مانند cProfile یا py-spy) به شما امکان می‌دهد بخش‌های کند کد خود را محدود کنید. ثبت زمان قبل و بعد از عملیات بالقوه کند را در نظر بگیرید. ابزارهایی مانند cProfile سپس می‌توانند روی فراخوانی‌های ثبت شده تابع برای جداسازی گلوگاه‌ها استفاده شوند.

۳. اشکال‌زدایی لغو وظیفه

سناریویی را در نظر بگیرید که در آن یک وظیفه به طور غیرمنتظره لغو می‌شود:

            import asyncio

async def worker():
    try:
        while True:
            print("Working...")
            await asyncio.sleep(0.5)
    except asyncio.CancelledError:
        print("Worker cancelled")

async def main():
    task = asyncio.create_task(worker())
    await asyncio.sleep(2)
    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("Task cancelled in main")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

خروجی اشکال‌زدایی، لغو وظیفه را نشان می‌دهد:

            asyncio | execute <Task pending name='Task-1' coro=<worker() running at example.py:3> started at example.py:16>
Working...
Working...
Working...
Working...
asyncio | Task-1: cancelling
Worker cancelled
asyncio | Task-1: cancelled by <Task finished name='Task-2' coro=<main() done, defined at example.py:13> result=None>
Task cancelled in main
            

              
                Copy
              
            
          

این تایید می‌کند که وظیفه توسط کروتین main() لغو شده است. بلوک except asyncio.CancelledError اجازه تمیزکاری قبل از پایان کامل وظیفه را می‌دهد و از نشتی منابع یا وضعیت ناسازگار جلوگیری می‌کند.

۴. مدیریت خطاها در کروتین‌ها

مدیریت صحیح خطاها در کد ناهمزمان بسیار مهم است. مثال زیر را با یک خطای مدیریت نشده در نظر بگیرید:

            import asyncio

async def divide(x, y):
    return x / y

async def main():
    result = await divide(10, 0)
    print(f"Result: {result}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

حالت اشکال‌زدایی یک خطای مدیریت نشده را گزارش خواهد کرد:

            asyncio | Task exception was never retrieved
future: <Task finished name='Task-1' coro=<main() done, defined at example.py:6> result=None, exception=ZeroDivisionError('division by zero')>
            

              
                Copy
              
            
          

برای مدیریت این خطا، می‌توانید از یک بلوک try...except استفاده کنید:

            import asyncio

async def divide(x, y):
    return x / y

async def main():
    try:
        result = await divide(10, 0)
        print(f"Result: {result}")
    except ZeroDivisionError as e:
        print(f"Error: {e}")

if __name__ == "__main__":
    asyncio.run(main(), debug=True)
            

              
                Copy
              
            
          

اکنون، خطا به طور صحیح گرفته و مدیریت خواهد شد.

بهترین شیوه‌ها برای اشکال‌زدایی Asyncio

در اینجا چند بهترین شیوه برای اشکال‌زدایی کد asyncio آورده شده است:

• فعال کردن حالت اشکال‌زدایی: همیشه حالت اشکال‌زدایی را در طول توسعه و آزمایش فعال کنید.
• استفاده از ورود به سیستم (Logging): ورود به سیستم دقیق را به کروتین‌های خود اضافه کنید تا جریان اجرای آن‌ها را ردیابی کنید. از logging.getLogger('asyncio') برای رویدادهای خاص asyncio و لاگرهای خود برای داده‌های مخصوص برنامه استفاده کنید.
• مدیریت خطاها: مدیریت خطای قوی را برای جلوگیری از کرش کردن برنامه شما توسط خطاهای مدیریت نشده پیاده‌سازی کنید.
• استفاده از گروه‌های وظیفه (Task Groups) (پایتون ۳.۱۱+): گروه‌های وظیفه مدیریت خطا و لغو را در درون گروه‌هایی از وظایف مرتبط ساده می‌کنند.
• پروفایل کردن کد خود: از ابزارهای پروفایلینگ برای شناسایی گلوگاه‌های عملکرد استفاده کنید.
• نوشتن تست‌های واحد (Unit Tests): تست‌های واحد کاملی برای تأیید رفتار کروتین‌های خود بنویسید.
• استفاده از راهنمای نوع (Type Hints): از راهنمای نوع برای تشخیص سریع خطاهای مرتبط با نوع استفاده کنید.
• در نظر گرفتن استفاده از دیباگر: ابزارهایی مانند `pdb` یا دیباگرهای IDE می‌توانند برای گام به گام کد asyncio استفاده شوند. با این حال، به دلیل ماهیت اجرای ناهمزمان، آن‌ها اغلب کمتر از حالت اشکال‌زدایی با ورود به سیستم دقیق مؤثر هستند.

تکنیک‌های اشکال‌زدایی پیشرفته

فراتر از حالت اشکال‌زدایی پایه، تکنیک‌های پیشرفته زیر را در نظر بگیرید:

۱. سیاست‌های سفارشی حلقه رویداد

شما می‌توانید سیاست‌های سفارشی حلقه رویداد را برای رهگیری و ورود به سیستم رویدادها ایجاد کنید. این به شما امکان می‌دهد کنترل دقیق‌تری بر فرآیند اشکال‌زدایی داشته باشید.

۲. استفاده از ابزارهای اشکال‌زدایی شخص ثالث

چندین ابزار اشکال‌زدایی شخص ثالث می‌توانند به شما در اشکال‌زدایی کد asyncio کمک کنند، مانند:

• PySnooper: یک ابزار اشکال‌زدایی قدرتمند که به طور خودکار اجرای کد شما را ثبت می‌کند.
• pdb++: نسخه بهبود یافته از دیباگر استاندارد pdb با ویژگی‌های پیشرفته.
• asyncio_inspector: یک کتابخانه که به طور خاص برای بازرسی حلقه‌های رویداد asyncio طراحی شده است.

۳. پچ کردن میمون (Monkey Patching) (با احتیاط استفاده شود)

در موارد شدید، می‌توانید از پچ کردن میمون برای تغییر رفتار توابع asyncio برای اهداف اشکال‌زدایی استفاده کنید. با این حال، این کار باید با احتیاط انجام شود، زیرا می‌تواند اشکالات ظریف ایجاد کند و نگهداری کد شما را دشوارتر کند. این معمولاً مگر اینکه کاملاً ضروری باشد، توصیه نمی‌شود.

نتیجه‌گیری

اشکال‌زدایی کد ناهمزمان می‌تواند چالش‌برانگیز باشد، اما حالت اشکال‌زدایی asyncio ابزارها و بینش‌های ارزشمندی را برای ساده‌سازی این فرآیند ارائه می‌دهد. با فعال کردن حالت اشکال‌زدایی، تفسیر خروجی، و پیروی از بهترین شیوه‌ها، می‌توانید مشکلات رایج را در برنامه‌های ناهمزمان خود به طور مؤثر شناسایی و حل کنید، که منجر به کد قوی‌تر و پربازده‌تر می‌شود. به یاد داشته باشید که حالت اشکال‌زدایی را با ورود به سیستم، پروفایلینگ، و تست جامع برای بهترین نتایج ترکیب کنید. با تمرین و ابزارهای مناسب، می‌توانید بر هنر اشکال‌زدایی کروتین‌های asyncio مسلط شوید و برنامه‌های ناهمزمان مقیاس‌پذیر، کارآمد و قابل اعتماد بسازید.