集成Flask与Dill实现服务端Python会话dump/load时报变量未定义如何解决

问题结论 #

Dill完全可以和Flask搭配使用，你遇到的报错是作用域使用错误和序列化范围设置不当导致的，和二者兼容性无关，不需要更换实现方案，调整代码逻辑即可解决问题。

错误原因 #

• 你在start_counter视图函数中定义的x和导入的datetime都属于函数局部变量，而dill.dump_session默认只会序列化主模块全局作用域的对象，你定义的局部变量根本没有被写入到序列化文件中
• 即便变量被正确序列化到全局作用域，在count函数中，由于你后续执行了x = x + 1的赋值操作，Python解释器会默认将x识别为该函数的局部变量，不会去全局作用域查找已加载的x，因此抛出UnboundLocalError

解决方案 #

方案1：调整作用域适配dump_session逻辑 #

通过声明全局变量的方式，保证要序列化的内容都在全局作用域中，加载时也明确声明使用全局变量：

from flask import Flask
from dill import dump_session, load_session
import datetime

app = Flask(__name__)
app.config['SECRET_KEY'] = 'super secret'

session_file = '/tmp/session.pkl'
# 提前声明要共享的全局变量
x = 0

@app.route('/start_counter')
def start_counter():
    global x
    x = 0
    dump_session(filename=session_file)
    return 'New counter started!'

@app.route('/count')
def count():
    global x, datetime
    load_session(filename=session_file)
    x = x + 1
    now = datetime.datetime.now()
    dump_session(filename=session_file)
    return str(x) + '-' + str(now)

方案2（更推荐）：直接序列化需要的变量集合 #

放弃使用dump_session/load_session的全量会话序列化方式，手动管理需要持久化的变量字典，既可以避免全局作用域污染，也能控制序列化内容的大小和范围，稳定性更高：

from flask import Flask
import dill

app = Flask(__name__)
app.config['SECRET_KEY'] = 'super secret'
session_file = '/tmp/session.pkl'

@app.route('/start_counter')
def start_counter():
    import datetime
    session_data = {
        'x': 0,
        'datetime': datetime
    }
    with open(session_file, 'wb') as f:
        dill.dump(session_data, f)
    return 'New counter started!'

@app.route('/count')
def count():
    with open(session_file, 'rb') as f:
        session_data = dill.load(f)
    x = session_data['x'] + 1
    now = session_data['datetime'].datetime.now()
    session_data['x'] = x
    with open(session_file, 'wb') as f:
        dill.dump(session_data, f)
    return str(x) + '-' + str(now)

注意事项 #

如果你的Flask服务采用多worker部署，多个进程同时读写同一个pkl文件会出现资源竞争问题，这种场景下可以加文件锁控制读写权限，或者改用Redis等内存数据库存储序列化后的内容，性能和稳定性都会更高。

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