如何用Flask的url_for覆盖路由默认值？

问题场景 #

我定义了包含两个变量的路由，并通过defaults指定默认值：

@app.route("/api/<a>/<b>", defaults={"a": 0, "b": 0})
def api(a, b):
    return f"{a=}, {b=}"

想要生成URL时仅覆盖b的值，保留a的默认值（比如生成/api/0/1），但调用url_for("api", b=1)时触发BuildError，提示必须指定a；传入两个变量时也报错。怎么实现无需传递所有变量就能生成URL？

问题根源 #

Flask的defaults参数是处理请求时的默认值，当用户访问不包含对应变量的URL时生效，但生成URL时，路由规则里的所有变量都必须显式传递——因为/api/<a>/<b>这个路由规则要求URL必须包含a和b两个部分，defaults不会自动填充到生成的URL路径中。

解决方案1：自定义url_for辅助函数 #

如果需要生成包含默认值的完整URL（比如/api/0/1），可以包装原生url_for，自动填充预设的默认参数：

from flask import Flask, url_for as flask_url_for

app = Flask(__name__)

def url_for(endpoint, **kwargs):
    # 为每个视图函数定义默认参数
    endpoint_defaults = {
        "api": {"a": 0, "b": 0}
    }
    # 合并默认值与传入参数，传入参数优先级更高
    if endpoint in endpoint_defaults:
        kwargs = {**endpoint_defaults[endpoint], **kwargs}
    return flask_url_for(endpoint, **kwargs)

@app.route("/api/<a>/<b>")
def api(a, b):
    return f"{a=}, {b=}"

# 测试调用
with app.test_request_context():
    print(url_for("api", b=1))  # 输出 /api/0/1
    print(url_for("api", a=5, b=2))  # 输出 /api/5/2

解决方案2：拆分路由规则（生成简化URL） #

如果不需要在URL中显示默认值（比如用/api/1代替/api/0/1），可以定义多个路由规则，对应不同的参数组合：

from flask import Flask, url_for

app = Flask(__name__)

# 完整参数路由
@app.route("/api/<a>/<b>")
# 仅传b时，a用默认值
@app.route("/api/<b>", defaults={"a": 0})
# 不传参数时，a和b都用默认值
@app.route("/api/", defaults={"a": 0, "b": 0})
def api(a, b):
    return f"{a=}, {b=}"

# 测试调用
with app.test_request_context():
    print(url_for("api", b=1))  # 输出 /api/1
    print(url_for("api", a=5, b=2))  # 输出 /api/5/2
    print(url_for("api"))  # 输出 /api/

关于“传入两个变量也报错”的说明 #

原代码的问题在于：路由规则/api/<a>/<b>要求URL必须包含两个变量部分，但你设置的defaults没有对应的无变量路由规则，所以访问/api/时会404。如果传入两个变量仍报错，大概率是变量类型不匹配（比如视图函数期望整数，但路由传递的是字符串），可以在路由中指定类型：

@app.route("/api/<int:a>/<int:b>", defaults={"a": 0, "b": 0})
def api(a, b):
    return f"{a=}, {b=}"

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