如何在Python Click中使用call_on_close并传递参数给清理回调

你可以通过三种简单的方式把tmp_file和host这类变量传给call_on_close的清理函数：

方法1：用Lambda闭包捕获变量 #

这是最直观的写法，直接在注册回调时用lambda把需要的变量包进去：

import click
import os
import tempfile

def remove_tmp_file(tmp_file, host):
    if host == "localhost":
        os.remove(tmp_file)
    else:
        delete_tmp_file_remote(tmp_file)

@click.command()
@click.pass_context
def main(ctx, host="localhost"):  # 假设host是参数或内部定义的变量
    tmp_file = tempfile.mktemp(prefix="my_prefix_", dir="/tmp")
    # 用lambda把tmp_file和host传给清理函数
    ctx.call_on_close(lambda: remove_tmp_file(tmp_file, host))
    # 后续业务逻辑
    print(f"使用临时文件: {tmp_file}")

方法2：用functools.partial绑定参数 #

如果不想用lambda，也可以用functools.partial把参数提前绑定到清理函数上：

import click
import os
import tempfile
from functools import partial

def remove_tmp_file(tmp_file, host):
    if host == "localhost":
        os.remove(tmp_file)
    else:
        delete_tmp_file_remote(tmp_file)

@click.command()
@click.pass_context
def main(ctx, host="localhost"):
    tmp_file = tempfile.mktemp(prefix="my_prefix_", dir="/tmp")
    # 绑定参数生成新的函数
    cleanup_func = partial(remove_tmp_file, tmp_file, host)
    ctx.call_on_close(cleanup_func)
    # 后续业务逻辑

方法3：把变量存入Click上下文对象 #

直接把需要的变量挂到ctx对象上，回调函数里从ctx获取：

import click
import os
import tempfile

def remove_tmp_file(ctx):
    tmp_file = ctx.obj["tmp_file"]
    host = ctx.obj["host"]
    if host == "localhost":
        os.remove(tmp_file)
    else:
        delete_tmp_file_remote(tmp_file)

@click.command()
@click.pass_context
def main(ctx, host="localhost"):
    tmp_file = tempfile.mktemp(prefix="my_prefix_", dir="/tmp")
    # 把变量存入ctx.obj（需要先初始化，避免KeyError）
    ctx.obj = {"tmp_file": tmp_file, "host": host}
    ctx.call_on_close(lambda: remove_tmp_file(ctx))
    # 后续业务逻辑

这三种方法里，lambda闭包是最常用的，代码简洁易懂，适合这种简单的参数传递场景。

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