使用flask_testing测试Flask REST API时静态文件无法访问的解决方法

问题场景 #

使用Flask-RESTX开发Flask REST API，部分接口生成PDF文档时依赖static/目录下的字体文件和图片。API运行时一切正常，但测试调用相同接口时，出现文件找不到的错误：

OSError: Cannot open resource "static/logo.png"

目录结构如下：

/src
  /application
    /main
      app.py
    /test
      test.py
  /static
    logo.png

当前应用中访问资源的方式为硬编码相对路径：static/logo.png

核心原因 #

硬编码的相对路径依赖当前工作目录：

• 开发时通常在src/application/main目录启动服务，相对路径static/logo.png实际指向../../static/logo.png，能正确找到资源；
• 测试时可能在src/application/test目录运行测试脚本，此时相对路径static/logo.png会指向../static/logo.png，而实际静态资源在src/static，因此找不到文件。

优雅解决方案：使用绝对路径访问静态资源 #

不需要编写环境切换逻辑，通过计算项目根目录的方式生成静态资源的绝对路径，确保所有环境下路径一致。

步骤1：在app.py中统一静态路径配置 #

利用__file__变量计算项目根目录，再拼接静态文件夹路径：

from flask import Flask
from flask_restx import Api, Resource
import os

# 计算项目根目录（src/文件夹的绝对路径）
PROJECT_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '../../'))
# 静态资源文件夹的绝对路径
STATIC_DIR = os.path.join(PROJECT_ROOT, 'static')

# 初始化Flask应用（可选：指定static_folder属性，符合Flask规范）
app = Flask(__name__, static_folder=STATIC_DIR)
api = Api(app)

@api.route('/generate-pdf')
class PDFGenerator(Resource):
    def get(self):
        # 构建具体资源的绝对路径
        logo_path = os.path.join(STATIC_DIR, 'logo.png')
        # 后续PDF生成逻辑使用logo_path即可
        return {"status": "success", "logo_path": logo_path}

if __name__ == '__main__':
    app.run(debug=True)

步骤2：测试代码中复用统一路径 #

测试脚本直接导入应用中定义的STATIC_DIR，确保路径一致：

import pytest
from application.main.app import app, STATIC_DIR
import os

def test_pdf_resource_exists():
    # 验证静态资源是否存在
    assert os.path.exists(os.path.join(STATIC_DIR, 'logo.png'))

def test_pdf_generation_api():
    client = app.test_client()
    response = client.get('/generate-pdf')
    assert response.status_code == 200
    assert 'logo_path' in response.json

额外优化：利用Flask内置属性 #

如果初始化Flask应用时指定了static_folder，可以直接使用app.static_folder属性获取静态目录的绝对路径，无需手动计算：

logo_path = os.path.join(app.static_folder, 'logo.png')

这种方式更符合Flask的设计规范，同时保证路径的一致性。

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