Cách chính xác để dọn sạch sau vòng lặp sự kiện bị gián đoạn là gì?

Question

Tôi có một vòng lặp sự kiện chạy một số đồng tác vụ như một phần của công cụ dòng lệnh. Người dùng có thể làm gián đoạn công cụ bằng thông thường Ctrl + C, tại thời điểm đó tôi muốn xóa sạch chính xác sau vòng lặp sự kiện bị gián đoạn.

Đây là những gì tôi đã thử.

import asyncio 


@asyncio.coroutine 
def shleepy_time(seconds): 
    print("Shleeping for {s} seconds...".format(s=seconds)) 
    yield from asyncio.sleep(seconds) 


if __name__ == '__main__': 
    loop = asyncio.get_event_loop() 

    # Side note: Apparently, async() will be deprecated in 3.4.4. 
    # See: https://docs.python.org/3.4/library/asyncio-task.html#asyncio.async 
    tasks = [ 
     asyncio.async(shleepy_time(seconds=5)), 
     asyncio.async(shleepy_time(seconds=10)) 
    ] 

    try: 
     loop.run_until_complete(asyncio.gather(*tasks)) 
    except KeyboardInterrupt as e: 
     print("Caught keyboard interrupt. Canceling tasks...") 

     # This doesn't seem to be the correct solution. 
     for t in tasks: 
      t.cancel() 
    finally: 
     loop.close() 

Chạy này và nhấn Ctrl + C sản lượng:

$ python3 asyncio-keyboardinterrupt-example.py 
Shleeping for 5 seconds... 
Shleeping for 10 seconds... 
^CCaught keyboard interrupt. Canceling tasks... 
Task was destroyed but it is pending! 
task: <Task pending coro=<shleepy_time() running at asyncio-keyboardinterrupt-example.py:7> wait_for=<Future cancelled> cb=[gather.<locals>._done_callback(1)() at /usr/local/Cellar/python3/3.4.3/Frameworks/Python.framework/Versions/3.4/lib/python3.4/asyncio/tasks.py:587]> 
Task was destroyed but it is pending! 
task: <Task pending coro=<shleepy_time() running at asyncio-keyboardinterrupt-example.py:7> wait_for=<Future cancelled> cb=[gather.<locals>._done_callback(0)() at /usr/local/Cellar/python3/3.4.3/Frameworks/Python.framework/Versions/3.4/lib/python3.4/asyncio/tasks.py:587]> 

Rõ ràng, tôi không dọn dẹp một cách chính xác. Tôi nghĩ có lẽ gọi cancel() về các nhiệm vụ sẽ là cách để làm điều đó.

Cách chính xác để làm sạch sau vòng lặp sự kiện bị gián đoạn là gì?

Answer 1

Khi bạn CTRL + C, vòng lặp sự kiện được dừng lại, vì vậy các cuộc gọi của bạn để t.cancel() không thực sự có hiệu lực. Đối với các tác vụ bị hủy, bạn cần phải khởi động lại vòng lặp.

Đây là cách bạn có thể xử lý nó:

import asyncio 

@asyncio.coroutine 
def shleepy_time(seconds): 
    print("Shleeping for {s} seconds...".format(s=seconds)) 
    yield from asyncio.sleep(seconds) 


if __name__ == '__main__': 
    loop = asyncio.get_event_loop() 

    # Side note: Apparently, async() will be deprecated in 3.4.4. 
    # See: https://docs.python.org/3.4/library/asyncio-task.html#asyncio.async 
    tasks = asyncio.gather(
     asyncio.async(shleepy_time(seconds=5)), 
     asyncio.async(shleepy_time(seconds=10)) 
    ) 

    try: 
     loop.run_until_complete(tasks) 
    except KeyboardInterrupt as e: 
     print("Caught keyboard interrupt. Canceling tasks...") 
     tasks.cancel() 
     loop.run_forever() 
     tasks.exception() 
    finally: 
     loop.close() 

Một khi chúng ta bắt KeyboardInterrupt, chúng ta gọi là tasks.cancel() và sau đó bắt đầu loop lên một lần nữa. run_forever sẽ thực sự thoát khỏi càng sớm càng tasks bị hủy (lưu ý rằng hủy Future trả về bởi asyncio.gather cũng hủy bỏ tất cả các Futures bên trong của nó), vì bị gián đoạn loop.run_until_complete gọi thêm một done_callback để tasks mà dừng vòng lặp. Vì vậy, khi chúng tôi hủy tasks, các cuộc gọi lại sẽ ngừng hoạt động và vòng lặp dừng lại. Tại thời điểm đó, chúng tôi gọi số tasks.exception, chỉ để tránh bị cảnh báo về việc không tìm nạp ngoại lệ từ _GatheringFuture.

Answer 2

Trừ khi bạn đang sử dụng Windows, hãy thiết lập trình xử lý tín hiệu dựa trên vòng lặp sự kiện cho SIGINT (và cả SIGTERM để bạn có thể chạy nó dưới dạng dịch vụ). Trong các trình xử lý này, bạn có thể thoát khỏi vòng lặp sự kiện ngay lập tức hoặc khởi tạo một số loại trình dọn dẹp và thoát ra sau.

Ví dụ trong tài liệu Python chính thức: https://docs.python.org/3.4/library/asyncio-eventloop.html#set-signal-handlers-for-sigint-and-sigterm

Answer 3

Dựa trên câu trả lời khác và một số suy nghĩ tôi đến giải pháp tiện dụng này mà nên làm việc gần như tất cả các trường hợp sử dụng và không phụ thuộc vào bạn tự theo dõi các công việc mà cần phải được làm sạch lên trên Ctrl + C :

loop = asyncio.get_event_loop() 
try: 
    # Here `amain(loop)` is the core coroutine that may spawn any 
    # number of tasks 
    sys.exit(loop.run_until_complete(amain(loop))) 
except KeyboardInterrupt: 
    # Optionally show a message if the shutdown may take a while 
    print("Attempting graceful shutdown, press Ctrl+C again to exit…", flush=True) 

    # Do not show `asyncio.CancelledError` exceptions during shutdown 
    # (a lot of these may be generated, skip this if you prefer to see them) 
    def shutdown_exception_handler(loop, context): 
     if "exception" not in context \ 
     or not isinstance(context["exception"], asyncio.CancelledError): 
      loop.default_exception_handler(context) 
    loop.set_exception_handler(shutdown_exception_handler) 

    # Handle shutdown gracefully by waiting for all tasks to be cancelled 
    tasks = asyncio.gather(*asyncio.Task.all_tasks(loop=loop), loop=loop, return_exceptions=True) 
    tasks.add_done_callback(lambda t: loop.stop()) 
    tasks.cancel() 

    # Keep the event loop running until it is either destroyed or all 
    # tasks have really terminated 
    while not tasks.done() and not loop.is_closed(): 
     loop.run_forever() 
finally: 
    loop.close() 

Đoạn mã trên sẽ có được tất cả các hiện nhiệm vụ từ vòng lặp sự kiện sử dụng asyncio.Task.all_tasks và đặt chúng trong một tương lai kết hợp duy nhất sử dụng asyncio.gather. Tất cả các tác vụ trong tương lai (tất cả đều đang chạy các tác vụ) sau đó sẽ bị hủy bằng phương thức .cancel() của tương lai. Sau đó, return_exceptions=True đảm bảo rằng tất cả các ngoại lệ đã nhận được asyncio.CancelledError được lưu trữ thay vì làm cho tương lai bị lỗi.

Mã trên sẽ ghi đè trình xử lý ngoại lệ mặc định để ngăn