如何消除Pylance对serializer.validated_data的下标访问误报？

问题描述 #

以下基于Django REST Framework实现的Actor模型视图集代码，实际运行无异常（服务器启动、请求发送均正常），但Pylance对print(serializer.validated_data['name'])一行标注红色下划线，触发误报：

代码示例 #

from rest_framework.decorators import api_view
from rest_framework.permissions import IsAuthenticated, AllowAny
from rest_framework.response import Response
from rest_framework import viewsets, status
from .models import Actor
from .serializers import ActorSerializer

# Create your views here.

class ActorView(viewsets.ModelViewSet):
    model = Actor
    queryset = model.objects.all()
    permission_classes = (AllowAny,)
    serializer_class = ActorSerializer
    http_method_names = ['get', 'post', 'put', 'delete']

    def list(self, request):
        serializer = ActorSerializer(self.queryset, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

    def create(self, request):
        serializer = ActorSerializer(data=request.data)
        if serializer.is_valid(raise_exception=True):
            print(serializer.validated_data['name'])
            return Response("OK", status=status.HTTP_200_OK)
        else: 
            return Response("nie ok")

误报错信息 #

"getitem" method not defined on type "empty"
Object of type "None" is not subscriptable

已尝试更换Pylance版本，问题仍存在，需消除此类误报。

解决方案 #

1. 添加类型注解明确validated_data类型 #

通过类型提示告诉Pylancevalidated_data是字典结构，避免其误判为None：

from typing import Dict, Any

# 修改create方法
def create(self, request):
    serializer = ActorSerializer(data=request.data)
    if serializer.is_valid(raise_exception=True):
        validated_data: Dict[str, Any] = serializer.validated_data
        print(validated_data['name'])
        return Response("OK", status=status.HTTP_200_OK)
    else: 
        return Response("nie ok")

2. 使用get方法访问字典键 #

改用dict.get()方法访问，既符合类型检查要求，还能兼容键不存在的场景（尽管is_valid已保证数据合法）：

print(serializer.validated_data.get('name'))

3. 配置Pylance忽略特定诊断规则 #

在VS Code的settings.json或项目的pyrightconfig.json中，将对应错误规则设为忽略：

• VS Code设置（settings.json）：

"python.analysis.diagnosticSeverityOverrides": {
    "reportOptionalSubscript": "none"
}

• 项目配置文件（pyrightconfig.json）：

{
    "diagnosticSeverityOverrides": {
        "reportOptionalSubscript": "none"
    }
}

4. 给序列化器字段添加类型提示 #

在序列化器类中明确字段类型，帮助Pylance更准确推断validated_data的结构：

from rest_framework import serializers
from .models import Actor
from typing import Optional

class ActorSerializer(serializers.ModelSerializer):
    name: Optional[str] = serializers.CharField()

    class Meta:
        model = Actor
        fields = ['name']  # 根据实际字段补充

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