如何在Python控制台中脱离Django使用DRF Serializer？

问题背景 #

项目中使用如下DRF Serializer：

# my_serrializers.py
from rest_framework import serializers


class TssUpdateExtraVarsSerializer(serializers.Serializer):
    cluster_name = serializers.CharField(required=True)


class TssUpdateSerializer(serializers.Serializer):
    extra_vars = TssUpdateExtraVarsSerializer(required=True)

该Serializer在处理项目请求时工作正常，但在项目虚拟环境的Python控制台执行以下代码时：

# Python控制台
from my_serializers import TssUpdateSerializer

s = TssUpdateExtraVarsSerializer(data={"a": 1})

s.is_valid()

出现错误：

django.core.exceptions.ImproperlyConfigured: Requested setting USE_I18N, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.

错误原因 #

DRF的Serializer依赖Django的配置环境，直接在Python控制台调用时，没有初始化Django的设置模块。Serializer内部执行验证等操作时会访问Django的配置项（比如USE_I18N），此时因未加载配置，就会抛出该错误。

修复方法（在Django环境下运行） #

有两种可行方式：

• 方式一：设置环境变量
  启动Python控制台前，先设置DJANGO_SETTINGS_MODULE环境变量，指向项目的settings文件：

  export DJANGO_SETTINGS_MODULE="your_project.settings"
  

  之后再进入Python控制台执行代码即可。
• 方式二：代码中手动初始化Django
  在控制台中先完成Django配置初始化，再使用Serializer：

  import django
  from django.conf import settings
  
  if not settings.configured:
      settings.configure(
          DEBUG=True,
          USE_I18N=True,
          INSTALLED_APPS=[
              'rest_framework',
          ]
      )
      django.setup()
  
  # 导入并使用Serializer
  from my_serializers import TssUpdateExtraVarsSerializer
  s = TssUpdateExtraVarsSerializer(data={"a": 1})
  s.is_valid()
  

能否脱离Django使用该Serializer？怎么做？ #

可以脱离Django使用，有两种实现思路：

方法一：改用纯Python序列化库 #

比如用pydantic重构序列化逻辑，完全脱离Django依赖：

from pydantic import BaseModel, Field

class TssUpdateExtraVarsModel(BaseModel):
    cluster_name: str = Field(..., description="集群名称")

class TssUpdateModel(BaseModel):
    extra_vars: TssUpdateExtraVarsModel

使用时通过model_validate方法验证数据：

data = {"extra_vars": {"cluster_name": "test-cluster"}}
model = TssUpdateModel.model_validate(data)
# 验证失败会直接抛出ValidationError异常

方法二：配置最小化Django环境使用DRF Serializer #

如果一定要保留DRF Serializer的写法，可以初始化最小化的Django配置，无需完整项目结构：

import django
from django.conf import settings

# 配置最小化Django设置
if not settings.configured:
    settings.configure(
        DEBUG=False,
        USE_I18N=True,
        INSTALLED_APPS=[
            'rest_framework',
        ]
    )
    django.setup()

# 定义并使用DRF Serializer
from rest_framework import serializers

class TssUpdateExtraVarsSerializer(serializers.Serializer):
    cluster_name = serializers.CharField(required=True)

class TssUpdateSerializer(serializers.Serializer):
    extra_vars = TssUpdateExtraVarsSerializer(required=True)

# 验证示例
s = TssUpdateExtraVarsSerializer(data={"cluster_name": "test"})
print(s.is_valid())  # 输出True
print(s.errors)      # 输出{}

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