记录一次使用Flask开发过程中的bug

先下结论：自定义python装饰器时一定要记住使用@functools.wraps(func)
该bug在一次flask app开发中遇到的。

代码如下：

from flask import Blueprint
from middleware.authentications import login_required

basedata = Blueprint('basedata', __name__, url_prefix='/basedata')

@basedata.route('/getallcity')
@login_required
def getallcity():
    pass

@basedata.route('/getcitybyname')
@login_required
def getcitybyname():
    pass

注册该蓝本过后，开启服务报错：
一次开发flask的时候报错：
AssertionError: View function mapping is overwriting an existing endpoint function: basedata.wrapper

我们知道，如果路由名相同或者函数名相同才会报这个错，但这两个路由和函数名明显不同，但是去掉其中任意一个都可以正常运行，很奇怪。最后发现是@login_required装饰器写得有问题

def login_required(func):
    def wrapper(*args, **kwargs):
        from middleware import unpack_token
        token = request.headers.get('Authorization')
        if token is None:
            return jsonify({'code': -9006, 'data': {}, 'msg': '头部token不允许为空'})
        try:
            g.session_id_rpc = unpack_token(token)
            g.token = token
            return func(*args, **kwargs)
        except BadData as e:
            return jsonify({'code': -31993, 'data': {}, 'msg': '头部token认证失败'})
    return wrapper

因为忘记使用@functools.wraps修饰wrapper,这导致使用的时候，比如下面的代码：

@basedata.route('/getcitybyname')
@login_required
def getcitybyname():
    pass

这时候

@login_required
def getcitybyname():
    pass

返回的函数名叫wrapper而不是getcitybyname，所以上面的bug就很好理解了，

@login_required
def getcitybyname():

和

@login_required
def getallcity():

返回的函数名是一样的，于是报错。
注：@functools.wraps(func)的作用就是保留原有函数的名称和docstring