Django 4.0项目：如何在validators.py中读取static目录下的文件？

解决步骤 #

1. 导入必要的Django模块 #

在validators.py中导入用于定位静态文件的工具：

from django.core.exceptions import ValidationError
from django.conf import settings
from django.contrib.staticfiles import finders

2. 加载脏话列表（模块初始化时读取一次） #

编写函数读取静态文件中的脏话列表，并在模块加载时完成读取，避免重复IO操作：

def load_bad_words():
    # 查找静态文件中file.txt的绝对路径
    file_path = finders.find('file.txt')
    if not file_path:
        raise FileNotFoundError("未在静态文件中找到file.txt，请检查文件位置")
    
    # 读取文件内容，按行处理（假设每行一个脏话）
    with open(file_path, 'r', encoding='utf-8') as f:
        bad_words = [line.strip() for line in f if line.strip()]
    
    return bad_words

# 模块加载时初始化脏话列表
BAD_WORDS = load_bad_words()

3. 实现脏话过滤验证器 #

基于加载的脏话列表编写验证器：

def bad_word_validator(value):
    # 不区分大小写检查内容
    lower_value = value.lower()
    for word in BAD_WORDS:
        if word.lower() in lower_value:
            raise ValidationError("内容包含不当词汇，请修改后提交。")
    return value

关键说明 #

• 静态文件定位：finders.find()会自动遍历Django配置的所有静态文件目录（包括各app下的static文件夹和项目根目录的static文件夹），无需手动拼接路径，适配不同的项目结构。
• 性能优化：在模块加载时仅读取一次文件，将脏话列表存入内存，避免每次验证都读取文件。
• 配置检查：确保settings.py中已正确配置静态文件相关项：
  • INSTALLED_APPS包含django.contrib.staticfiles（默认已添加）
  • 如果使用项目根目录的static文件夹，需配置：

    STATICFILES_DIRS = [BASE_DIR / "static"]
    

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