Google Colab中files.download异步下载失效问题的解决方案求助

问题背景 #

使用files.download时，代码执行顺序显示该方法是异步的：

from google.colab import files
files.download("sample_data/california_housing_train.csv")
print("done")

输出顺序为：

done
Downloading "california_housing_train.csv"

在循环场景中，每次启动下载后下一轮迭代会清除输出，若文件未完成下载就被清除，会导致下载失败。且无法通过手动下载、批量压缩下载规避，也不想用固定时长的sleep（文件加载时间不稳定）。

解决方案：通过JavaScript监听下载完成状态 #

利用Colab支持的IPython JavaScript交互，监听浏览器端的下载完成信号，确保Python代码等待下载完成后再执行后续操作（包括清除输出）。

实现代码

from google.colab import files
from IPython.display import Javascript, clear_output
import time

def download_and_wait(file_path):
    # 触发文件下载
    files.download(file_path)
    
    # 执行JavaScript监听下载完成状态
    display(Javascript("""
        async function waitForDownloadFinish() {
            return new Promise(resolve => {
                // 定时检查页面上的"取消下载"按钮是否存在
                const checkInterval = setInterval(() => {
                    const cancelBtn = document.querySelector('cr-button[aria-label="Cancel download"]');
                    if (!cancelBtn) {
                        clearInterval(checkInterval);
                        resolve();
                    }
                }, 300);
            });
        }
        await waitForDownloadFinish();
    """))
    
    # 给浏览器留出短暂的处理缓冲时间
    time.sleep(0.5)

# 循环下载示例
for iteration in range(2):
    # 模拟每次迭代生成的目标文件（替换为你的实际文件路径）
    target_file = f"sample_data/iter_{iteration}_housing_train.csv"
    !cp sample_data/california_housing_train.csv {target_file}
    
    # 执行带等待的下载
    download_and_wait(target_file)
    print(f"迭代 {iteration} 下载完成")
    
    # 执行清除输出操作（按需调整）
    clear_output(wait=True)

原理说明 #

• Colab的files.download本质是触发浏览器端的下载流程，Python端代码不会等待下载完成。
• 上述代码通过JavaScript定时检查页面上的「取消下载」按钮：当该按钮存在时，说明下载正在进行；按钮消失则代表下载已完成（或被取消，此处默认是正常完成）。
• JavaScript的Promise会等待下载完成后才返回，Python端会阻塞直到JS执行完毕，确保下载完成后再执行下一轮的清除输出操作，避免中断下载。

内容的提问来源于stack exchange，提问作者Priyansh Yadav