Pip package - Cancel in-flight deep research task

[JoeRoddy]

Is there any recommended mechanism for cancelling an ongoing deep research task?

I have set up a Flask API that starts research tasks when hit, but I want to enable the ability to cancel research on the server via an endpoint thats hit by a cancel button.

I come from Typescript/JS world, so sorry if this is a stupid question with an obvious answer in Python. LLM is recommending not to use any tool exposed by the library, but to use asyncio's task.cancel(). It says it will cancel the next time an await is hit inside the package.

Is there a more correct way to do this, or would this be the standard approach?

Basic idea:

import asyncio
from gpt_researcher import GPTResearcher

tasks = {}

# invoked by research endpoint, put into tasks var
async def generate_report(query: str) -> str:
    researcher = GPTResearcher(query, "deep")
    research_task = asyncio.create_task(researcher.conduct_research())
    ## additional code
        
# Endpoint to cancel a background task by ID
@app.route('/cancel/<int:task_id>', methods=['POST'])
def cancel_task(task_id):
    task = tasks.get(task_id)
    if task is None:
        return jsonify({"error": f"No task with ID {task_id} found."}), 404
    task.cancel()
    return jsonify({"message": f"Cancellation requested for task {task_id}."})